Skip to content

Commit

Permalink
v3 README tweaks (#244)
Browse files Browse the repository at this point in the history
## Problem
We need a few final bits of polish for the README - link to external
inference docs, and upgrade details.

## Solution
Link to inference docs and add a section to help with upgrading the
client.

## 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
N/A
  • Loading branch information
austin-denoble authored Jul 19, 2024
1 parent 02370e5 commit b4187c0
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ The snippets shown in this README are intended to be concise. For more realistic
- [Article recommender](https://github.com/pinecone-io/recommender-example-typescript)
- [Image search](https://github.com/pinecone-io/image-search-example)

## Upgrading your client

#### Upgrading from `2.x` to `3.x`

There is a breaking change involving the `configureIndex` operation in this update. The structure of the object passed
when configuring an index has changed to include `deletionProtection`. The `podType` and `replicas` fields can now be updated through the `spec.pod` object. See [Configure pod-based indexes](#configure-pod-based-indexes) for an example of the code.

#### Upgrading from older versions

- **Upgrading to `2.x`** : There were many changes made in this release to support Pinecone's new Serverless index offering. The changes are covered in detail in the [**v2 Migration Guide**](https://github.com/pinecone-io/pinecone-ts-client/blob/main/v2-migration.md). Serverless indexes are only available in `2.x` release versions or greater.
- **Upgrading to `1.x`** : This release officially moved the SDK out of beta, and there are a number of breaking changes that need to be addressed when upgrading from a `0.x` client. See the [**v1 Migration Guide**](https://github.com/pinecone-io/pinecone-ts-client/blob/main/v1-migration.md) for details.

## Prerequisites

The Pinecone TypeScript client is compatible with TypeScript 4.1 and greater.
Expand Down Expand Up @@ -880,7 +892,8 @@ If you do not specify a namespace, the records in the default namespace `''` wil

## Inference

Interact with Pinecone's Inference API (currently in preview).
Interact with Pinecone's Inference API (currently in public preview). The Pinecone Inference API is a service that gives
you access to embedding models hosted on Pinecone's infrastructure. Read more at [Understanding Pinecone Inference](https://docs.pinecone.io/guides/inference/understanding-inference).

**Notes:**

Expand Down

0 comments on commit b4187c0

Please sign in to comment.