Skip to content

Commit

Permalink
Remove serverless public preview warnings (#214)
Browse files Browse the repository at this point in the history
## Problem
The serverless public preview warnings from January are still in
docstrings and documentation. Since we've expanded the number of regions
available, we should pull these out.

## Solution
Remove "public preview" warnings calling out the `us-west-2` environment
from README, docstrings, and the migration guide.

## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] This change requires a documentation update
- [ ] Infrastructure change (CI configs, etc)
- [X] Non-code change (docs, etc)
- [ ] None of the above: (explain here)

## Test Plan
CI, run the client reference action after merged to main to update
reference docs.
  • Loading branch information
austin-denoble authored May 8, 2024
1 parent 7d82cd9 commit 8498bde
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 19 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,9 @@ 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.
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. For more information on serverless and regional availability, see [Understanding indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes#serverless-indexes).

```typescript
import { Pinecone } from '@pinecone-database/pinecone';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ 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 more information on creating indexes,
* see [Understanding indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes).
*
* 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
6 changes: 1 addition & 5 deletions src/pinecone.ts
Original file line number Diff line number Diff line change
Expand Up @@ -304,14 +304,10 @@ 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.
* For more information on creating indexes, see [Understanding indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes).
* ```js
* import { Pinecone } from '@pinecone-database/pinecone';
* const pc = new Pinecone();
Expand Down
6 changes: 1 addition & 5 deletions v2-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,7 @@ 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`.
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`. For more information on serverless and regional availability, see [Understanding indexes](https://docs.pinecone.io/guides/indexes/understanding-indexes#serverless-indexes).

```typescript
import { Pinecone } from '@pinecone-database/pinecone';
Expand Down

0 comments on commit 8498bde

Please sign in to comment.