Skip to content

v2.0.0 Release

Compare
Choose a tag to compare
@austin-denoble austin-denoble released this 16 Jan 13:22
· 100 commits to main since this release

This release sees the introduction of the ability to create and manage serverless indexes. There are fundamental changes to control plane operations which include adjustments to function arguments and responses. See below for a summary of changes, and for a more detailed guide take a look at the v2-migration.md, the README.md, or the client reference.

Serverless indexes are currently in public preview, so make sure to review the current limitations and test thoroughly before using in production.

Changes overview

  • Deploy Pinecone's new serverless indexes. The createIndex method has been refactored to accept an object conforming to the PodSpec or ServerlessSpec interfaces depending on how you would like to deploy your index. Many old properties such as podType, replicas, etc are moved into PodSpec since they do not apply to serverless indexes.
  • Understand cost. The quantity of read units consumed by each serverless query and fetch call are now returned with the responses.
  • Flexible API Keys. The v2.0.0 TypeScript SDK is consuming the new Control Plane API hosted at https://api.pinecone.io. This new API allows for a lot more flexibility in how API keys are used in comparison to the past when a rigid 1:1 relationship was enforced between projects and environments.
  • Richer Responses. The listIndexes and listCollections methods now return an array with full descriptions of each resource, not merely an array of names. See here.
  • Tidying up / Breaking changes
    • listIndexes now returns additional data, and the shape of the response has changed. See here.
    • listCollections now returns additional data, and the shape of the response has changed. See here.
    • describeIndex takes the same arguments as before (the index name), but returns data in a different shape reflecting the move of some configurations under the spec key and elevation of host to the top level. See a table of changed properties here.

Full Changelog: v1.1.3...v2.0.0