| v9.1.0 | v9.1.0 lets a document index embed text for you, so Pinecone can embed a field's text on write and your query text on search. Read responses now report billed egress, the client retries transient connection failures, and HTTP 413 has its own error class. It targets the same `2026-07` API as v9.0.0, and nothing is removed or renamed. ## What's new ### Integrated embedding in document indexes Declare `embed` (dense) or `sparseEmbed` (sparse) on a `string` field, upsert plain text, and sea | High | 10/20/2026 |
| v9.0.0 | # Pinecone TypeScript SDK v9.0.0 v9 brings schema-based document operations into the main client, adds recurring backup schedules, and targets Pinecone API version `2026-07`. It requires Node.js 22 or later. Classic vector methods such as `index.upsert`, `query`, and `fetch` remain available, and deprecated flat control methods retain supported v8 request shapes. Review the breaking changes below for response-type changes, preview migration, and index-configuration restrictions. The [v9 mi | High | 9/9/2026 |
| v8.2.0 | ## `AdminClient`: manage organizations, projects, and access (`2026-04`) This release adds `AdminClient`, a second top-level entry point covering the Pinecone Admin API. It manages an organization and the resources beneath it including projects, API keys, service accounts, role bindings, invites, and users. The Admin API authenticates differently from the rest of the SDK using service-account OAuth2 rather than a project `Api-Key`. ### Authentication Create a service account in the [ | High | 7/31/2026 |
| v8.1.0 | ## Preview: `list` and `update` for schema-based index documents (alpha) > **โ ๏ธ Alpha surface** โ all `pc.preview.*` APIs target the `2026-01.alpha` API version and are not covered by the SDK's backward-compatibility guarantee. Signatures may change before these operations graduate to stable. This release rounds out the document operations on `pc.preview.index(...)` introduced in v8.0.0 with two new methods โ `listDocuments` and `updateDocuments` โ and adds an n-gram (substring) tokenizer | High | 7/21/2026 |
| v8.0.0 | This version of the Pinecone Node SDK depends on version `2026-04` of the Pinecone API. You can read more about versioning [here](https://docs.pinecone.io/reference/api/introduction#versioning). This v8 SDK release line should continue to receive fixes as long as the `2026-04` API version is in support. ## Breaking Changes ### Assistant file operations are now asynchronous The 2026-04 API made all file mutation operations asynchronous. `uploadFile` and `deleteFile` now return an `Operat | High | 6/16/2026 |
| v7.2.0 | ### Streaming file uploads for Assistant `uploadFile` now accepts a `Buffer`, `Blob`, or Node.js `ReadableStream` directly, in addition to the existing local file path. This makes it possible to forward an incoming HTTP upload to the Assistant without writing the file to disk or buffering it in memory first. ```typescript // Existing path-based usage โ unchanged await assistant.uploadFile({ path: 'report.pdf' }); // New: upload from a Buffer (e.g. multer memory storage) await assista | High | 4/10/2026 |
| v7.1.0 | This release adds support for creating and configuring index `readCapacity` for BYOC indexes. ```typescript // Create a BYOC index with dedicated read capacity await pinecone.createIndex({ name: 'my-byoc-index', dimension: 1536, metric: 'cosine', spec: { byoc: { environment: 'aws-us-east-1-b921', readCapacity: { mode: 'Dedicated', nodeType: 'b1', manual: { replicas: 1, shards: 1 }, }, }, }, }); ``` It also include | Low | 2/19/2026 |
| v7.0.0 | # Release v7.0.0 This version of the Pinecone Node SDK depends on version `2025-10` of the Pinecone API. You can read more about versioning [here](https://docs.pinecone.io/reference/api/introduction#versioning). This v7 SDK release line should continue to receive fixes as long as the `2025-10` API version is in support. ## Breaking Changes ### Index Targeting The preferred way to target an index has changed. You must now pass an options object to `pc.index()` instead of string argume | Low | 2/1/2026 |
| v6.1.4 | ## What's changed This patch release adds an optional configuration that can allow AI coding agents working with the SDK to identify themselves. This information is incorporated into request User-Agent headers to help us track how our product is being used. ```typescript const pc = new Pinecone({ apiKey: 'your-api-key', caller: { provider: 'google', model: 'gemini' } }); ``` **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v6.1.3.. | Low | 1/22/2026 |
| v6.1.3 | This release fixes a bug in `Assistant.listFiles()` when using a `filter` - there's no need to provide a top-level `metadata` key inside of the filter object. ## What's Changed * Handle errors in `cleanupResources` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/351 * Add `tsx` as a `devDependency`, clean up `setup` GH action by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/352 * Fix list files with filter in Assistant by @avi1mizrah | Low | 11/3/2025 |
| v6.1.2 | `Assistant.describeFile` now exposes `includeUrl` as an optional argument, and it will default to `true` if not provided. `sourceCollection` is also now exposed on `CreateIndexServerlessSpec` and `IndexModel`. ## What's Changed * Expose `includeUrl` in `Assistant.describeFile`, add `sourceCollection` for serverless by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/349 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v6.1.1...v6.1.2 | Low | 7/22/2025 |
| v6.1.1 | ## What's Changed * Regenerate core, expose `privateHost` on `IndexModel`, and `temperature` on `ChatOptions` and `ChatCompletionOptions` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/348 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v6.1.0...v6.1.1 | Low | 6/14/2025 |
| v6.1.0 | This release adds a new `ChatContextOptions` type which allows passing `contextOptions` in `ChatOptions` when calling `chat` or `chatStream`. `ChatContextOptions` supports passing `topK` and `snippetSize`. There have also been fixes made to `context` and `chat` methods to fix issues with argument parameters not being properly passed with the requests. ## What's Changed * Add `ChatContextOptions` to `ChatOptions` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/347 | Low | 6/1/2025 |
| v6.0.1 | This patch fixes an issue with the `listBackups` method not applying pagination to project-level operations. There have also been additional types exported from the top of the package for working with backups and inference models. ## What's Changed * Regenerate `2025-04`, add pagination to list project backups by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/346 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v6.0.0...v6.0.1 | Low | 5/20/2025 |
| v6.0.0 | This version of the Pinecone Node SDK depends on version `2025-04` of the Pinecone API. You can read more about versioning [here](https://docs.pinecone.io/reference/api/versioning). This v6 SDK release line should continue to receive fixes as long as the `2025-04` API version is in support. ## Features ### Namespaces You now have the ability to work more explicitly with namespaces that are associated with an index. There have been several namespace methods added to the `Index` class:
| Low | 5/10/2025 |
| v5.1.2 | This patch corrects an issue with runtime validation and TypeScript types not allowing the `embed` parameter in `ConfigureIndexRequest`. Several dev dependencies for jest have also been updated, along with some tweaks to the integration test suite to prevent hangs in CI. ## What's Changed * Allow `embed` as a parameter to `configureIndex` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/338 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client | Low | 4/23/2025 |
| v5.1.1 | Fixes an issue where the typing for the `upsertRecords` method did not accept `_id` as an object argument. The `_id` and `_score` values are now properly returned from the `searchRecords` method instead of mapped values. ## What's Changed * Fix `_id` and `_score` in records APIs by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/334 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v5.1.0...v5.1.1 | Low | 3/4/2025 |
| v5.1.0 | ## Features ### Indexes with Integrated Inference This release adds a new `createIndexForModel` method as well as `upsertRecords`, and `searchRecords` methods. Together these methods provide a way for you to easily store your data and let us manage the process of creating embeddings. To learn about available models, see the [Model Gallery](https://docs.pinecone.io/models/overview). ```typescript import { Pinecone } from '@pinecone-database/pinecone'; // 1. Instantiate the Pinecone c | Low | 2/28/2025 |
| v5.0.2 | Types `Embedding` and `EmbeddingsListUsage` are now exported from the top of the client package. **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v5.0.1...v5.0.2 | Low | 2/20/2025 |
| v5.0.1 | ## What's Changed * Remove `EmbeddingsList` custom class by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/330 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v5.0.0...v5.0.1 | Low | 2/20/2025 |
| v5.0.0 | This version of the Pinecone Node SDK depends on version `2025-01` of the Pinecone API. You can read more about versioning [here](https://docs.pinecone.io/reference/api/versioning). This v5 SDK release line should continue to receive fixes as long as the `2025-01` API version is in support. ## Features ### Sparse index support You can now work with sparse-only indexes. These indexes enable direct indexing and retrieval of sparse vectors, supporting traditional methods like BM25 and learne | Low | 2/15/2025 |
| 4.1.0 | --- ## Features ### Index tags Users can now [tag indexes](https://docs.pinecone.io/guides/indexes/manage-indexes#configure-index-tags) with key:value pairs for categorizing and identifying indexes. You can add tags when [creating an index](https://docs.pinecone.io/guides/indexes/create-an-index), or modify/delete tags when [configuring an index](https://docs.pinecone.io/guides/indexes/manage-indexes). Example code: ```typescript import { Pinecone } from '@pinecone-database/pinecone'; c | Low | 1/9/2025 |
| v4.0.0 | --- ## Features This version of the Typescript client introduces two new endpoints: [Rerank](https://docs.pinecone.io/guides/inference/rerank) and [Import](https://docs.pinecone.io/guides/data/import-data). ### Rerank `Rerank` provides users the ability to rerank documents in descending relevance-order against a given query. Reranking documents is a common ["second-pass" ranking strategy](https://www.pinecone.io/learn/refine-with-rerank/) broadly used in retrieval applications. Example | Low | 10/23/2024 |
| v3.0.3 | ## Fixes * Remove extra logging from getFetch() s/o @maxmetcalfe in https://github.com/pinecone-io/pinecone-ts-client/pull/280 * Some general fixes/internal enhancements to CI workflows ## New Contributors * @maxmetcalfe made their first contribution in https://github.com/pinecone-io/pinecone-ts-client/pull/280 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/3.0.2...v3.0.3 | Low | 9/11/2024 |
| 3.0.2 | ## Fixes ### Remove `util:node` function This patch removes a native Node utility function that was causing issues for users running in `Edge`. There are no downstream affects of its removal; code should run as it previously was without interruptions or changes. ## New Contributors * @anawishnoff made their first contribution in https://github.com/pinecone-io/pinecone-ts-client/pull/245 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v3.0.1...3.0.2 | Low | 8/26/2024 |
| v3.0.1 | ## Fixes ### Compatibility with Edge runtimes This patch removes the `@sinclair/typebox` and `ajv` libraries, which caused compatibility issues for users running in Edge runtimes (Cloudflare, Vercel, etc.). ### Removal of `crossFetch` ponyfill Since this Typescript client no longer supports versions of Node <18, we can remove the `crossFetch` ponyfill from `src/utils/fetch.ts`, as it was only necessary as a failsafe for users running older versions of Node. ## New Contributors * @j | Low | 8/20/2024 |
| v3.0.0 | ## Features ### API versioning This updated release of the Pinecone TypeScript SDK depends on API version `2024-07`. This v3 SDK release line should continue to receive fixes as long as the `2024-07` API version is in support. ### Inference API Try out Pinecone's new [Inference API](https://docs.pinecone.io/guides/inference/understanding-inference), currently in public preview. ```typescript import { Pinecone } from '@pinecone-database/pinecone'; const client = new Pinecone({ | Low | 7/19/2024 |
| v2.2.2 | This patch fixes a bug when instantiating multiple instances of `Pinecone` and using multiple API keys targeting different indexes. The singleton cache that resolves index addresses will no longer hang on to the first API key it used to describe an index. ## What's Changed * Update README.md by @lnhsingh in https://github.com/pinecone-io/pinecone-ts-client/pull/216 * Fix `IndexHostSingleton` holding onto one instance of `ManageIndexesAPI` by @austin-denoble in https://github.com/pinecone-io | Low | 6/1/2024 |
| v2.2.1 | This patch fixes an issue with using `sourceTag` as an argument without disabling runtime validations. ## What's Changed * Remove `merge` workflow by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/213 * Remove serverless public preview warnings by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/214 * Include `sourceTag` in `PineconeConfigurationSchema` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/215 ** | Low | 5/10/2024 |
| v2.2.0 | ### `sourceTag` added to `PineconeConfiguration` The SDK now supports optionally passing a `sourceTag` when instantiating the Pinecone client. This tag allows requests made by the SDK to be attributed via the user-agent. ```javascript import { Pinecone } from '@pinecone-database/pinecone'; const pc = new Pinecone({ apiKey: 'my-api-key', sourceTag: 'my-source-tag' }); // Requests made from the client will now have this tag applied to the user-agent ``` ## What's Changed * Add `sourc | Low | 3/27/2024 |
| v2.1.1 | Exports the `ListResponse` interface so it can be used by consumers of the client. ## What's Changed * Export `ListResponse` type from generated core, add docstring for `ListOptions` by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/210 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v2.1.0...v2.1.1 | Low | 3/26/2024 |
| v2.1.0 | ## Listing record ids by prefix in a namespace (for serverless indexes) We've [implemented](https://github.com/pinecone-io/pinecone-ts-client/pull/202) SDK support for a new data plane endpoint used to list ids by prefix in a given namespace. If no prefix or an empty string is passed, this can be used to list all ids in a namespace. The index class now has a `listPaginated` function. With clever assignment of record ids, this can be used to help model hierarchical relationships between dif | Low | 3/6/2024 |
| v2.0.1 | Fixes a build issue that was caused during our automated release process. ## What's Changed * Remove spruce workflows and references to release in version.json by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/195 **Full Changelog**: https://github.com/pinecone-io/pinecone-ts-client/compare/v2.0.0...v2.0.1 | Low | 1/17/2024 |
| v2.0.0 | 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](https://github.com/pinecone-io/pinecone-ts-client/blob/main/v2-migration.md), the [README.md](https://github.com/pinecone-io/pinecone-ts-client/blob/main/README.md), or the [client refe | Low | 1/16/2024 |
| v1.1.3 | In this release we've updated the client reference documentation link in the `README.md`, and moved a number of non-runtime dependencies into `devDependencies`. ## What's Changed * Update README Reference Documentation link by @austin-denoble in https://github.com/pinecone-io/pinecone-ts-client/pull/150 * Move non-runtime related deps to devDependencies by @SalmonMode in https://github.com/pinecone-io/pinecone-ts-client/pull/175 ## New Contributors * @SalmonMode made their first contrib | Low | 1/13/2024 |
| v1.1.2 | In this release we've included a fix for handling the global `process` object on certain edge platforms such as Cloudflare Workers. This should prevent runtime errors in environments where `process` is not available. ## What's Changed ### Fixes & troubleshooting * Check for `process` existence before accessing it by @omarestrella in https://github.com/pinecone-io/pinecone-ts-client/pull/147 ### Docs * Fix <a /> styling in dark mode by @austin-denoble in https://github.com/pinecone-io/pi | Low | 10/24/2023 |
| v1.1.1 | We are still working with some users to troubleshoot [unexplained problems with the `query` method](https://github.com/pinecone-io/pinecone-ts-client/issues/124). These errors seem to be somehow related to a specific environment, dependency, or usage pattern because the have not been able to reproduce the `query` error in our integration testing and sample projects, including a [nextjs project running on Vercel](https://github.com/pinecone-io/pinecone-vercel-starter). In this release, we have | Low | 10/10/2023 |
| v1.1.0 | ## Fixed: Next.js fetch compatibility In this release we made some adjustments to how we polyfill `fetch` (which is not natively supported in all versions of node) to avoid conflicting with the Next.js framework. Next.js expects you to use `@vercel/fetch` and stubs out other polyfills to keep the bundle small, so the [cross-fetch](https://www.npmjs.com/package/cross-fetch) polyfill we depend on was not working as expected. We have tested these changes in an updated version of our [pinecon | Low | 9/28/2023 |
| v1.0.1 | This fast-follow to last week's v1 release addresses a number of issues that have been reported by our users. Thank you to everyone who provided feedback. ## Bugs addressed in this release - #102 Typescript version-specific compilation problems - #105 Configuration-specific conflicts with web types in `lib.dom.d.ts` - #118 Some methods failing due to improper usage of the `cross-fetch` polyfill - #108 Use of node libraries breaking [Edge Runtime](https://edge-runtime.vercel.app/) In | Low | 9/14/2023 |
| v1.0.0 | This release adds a new module export, `Pinecone`, that is an all-new client for calling Pinecone from your TypeScript applications. See the [README](./README.md) docs and [Migration guide](./v1-migration.md) to get started. ## Features in this release - **Simplified library initialization**. Now you can simply `new Pinecone()` to make a client instance without the need for any awkward async initialization steps. The new client can also read the `PINECONE_ENVIRONMENT` and `PINECONE_API_KE | Low | 9/7/2023 |
| v0.1.5 | ### Fixes - Remove `process.nextTick()` to fix error in edge runtime #44 | Low | 5/10/2023 |