Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove serverless public preview warnings #214

Merged
merged 2 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,6 @@ const pc = new Pinecone({

#### Create a serverless index with minimal configuration

> ⚠️ **Warning**
>
> Serverless indexes are in **public preview** and are available only on AWS in the `us-west-2` region. Check the [current limitations](https://docs.pinecone.io/docs/limits#serverless-index-limitations) and test thoroughly before using it in production.

At a minimum, to create a serverless index you must specify a `name`, `dimension`, and `spec`. The `dimension` indicates the size of the records you intend to store in the index. For example, if your intention was to store and query embeddings generated with OpenAI's [textembedding-ada-002](https://platform.openai.com/docs/guides/embeddings/second-generation-models) model, you would need to create an index with dimension `1536` to match the output of that model.

The `spec` configures how the index should be deployed. For serverless indexes, you define only the cloud and region where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,10 @@ import {
} from './ServerlessSpec';

/**
* The spec object defines how the index should be deployed.
* The spec object defines how the index should be deployed. For serverless indexes, you define only the cloud and region
* where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted,
* the pod type and size to use, and other index characteristics.
*
* For serverless indexes, you define only the cloud and region where the index should be hosted. For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.
*
* Serverless indexes are in public preview and are available only on AWS in the us-west-2 region. Test thoroughly before using serverless indexes in production.
* @export
* @interface CreateIndexRequestSpec
*/
Expand Down
5 changes: 0 additions & 5 deletions src/pinecone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -304,11 +304,6 @@ export class Pinecone {
* ```
*
* @example
*
* > ⚠️ **Warning**
* >
* > Serverless indexes are in **public preview** and are available only on AWS in the `us-west-2` region. Check the [current limitations](https://docs.pinecone.io/docs/limits#serverless-index-limitations) and test thoroughly before using it in production.
*
* The `spec` object defines how the index should be deployed. For serverless indexes, you define only the cloud and region where the index should be hosted.
* For pod-based indexes, you define the environment where the index should be hosted, the pod type and size to use, and other index characteristics.
* In a different example, you can create a pod-based index by specifying the `pod` spec object with the `environment`, `pods`, `podType`, and `metric` properties.
Expand Down
4 changes: 0 additions & 4 deletions v2-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,6 @@ In the new `v2.0.0` client, there is a lot more flexibility in how indexes are c

### Creating a serverless index

> ⚠️ **Warning**
>
> Serverless indexes are in **public preview** and are available only on AWS in the `us-west-2` region. Check the [current limitations](https://docs.pinecone.io/docs/limits#serverless-index-limitations) and test thoroughly before using it in production.

Serverless indexes are newly available with the `v2.0.0` client, and you must be on this version or greater to work with them. Creating a serverless index requires defining the `cloud` and `region` where the server should be hosted via the `spec` object with the key `serverless`.

```typescript
Expand Down
Loading