Official JS/TS client for easy interaction with a Weaviate instance.
typescript-client
Official Weaviate TypeScript Client
Description
Official Weaviate TypeScript Client
README
Release History
| Version | Changes | Urgency | Date |
|---|---|---|---|
| v3.12.0 | ## What's Changed * Support new backup restore statuses by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/391 * Add baseURL to cohere reranker by @tsmith023 in https://github.com/weaviate/typescript-client/pull/398 * Add `dropInvertedIndex` to `collection.config` namespace by @tsmith023 in https://github.com/weaviate/typescript-client/pull/397 * Feat: introduce batch data ingestion by @tsmith023 in https://github.com/weaviate/typescript-client/pull/386 * Add support | Low | 3/3/2026 |
| v3.12.0-alpha.0 | ## What's Changed * Support new backup restore statuses by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/391 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.11.0...v3.12.0-alpha.0 | Low | 2/24/2026 |
| v3.11.0 | ## What's Changed * Object TTL by @bevzzz in https://github.com/weaviate/typescript-client/pull/380 * feat: return backup size on backup status by @gkampitakis in https://github.com/weaviate/typescript-client/pull/381 * feat: voyage-multimodal-3.5 (video!) by @fzowl in https://github.com/weaviate/typescript-client/pull/379 * Feat: Added Contextual AI's Generative and Reranker Client by @jinashrouniyar-268 in https://github.com/weaviate/typescript-client/pull/355 * Reorganise repo to use `vi | Low | 1/26/2026 |
| v3.10.0 | ## What's Changed * feat: add return fields for list backups and support ordering by @gkampitakis in https://github.com/weaviate/typescript-client/pull/358 * Add zstd backup options by @databyjp in https://github.com/weaviate/typescript-client/pull/370 * Add `dimensions` property to Text2VecCohereConfig and update tests by @databyjp in https://github.com/weaviate/typescript-client/pull/366 * Add `dimensions` property to Text2VecVoyageAIConfig and update tests by @databyjp in https://github.c | Low | 11/28/2025 |
| v3.9.0 | ## What's Changed * Add `bm25Operator` to aggregate hybrid args type by @tsmith023 in https://github.com/weaviate/typescript-client/pull/337 * feat: support list backups by @bevzzz in https://github.com/weaviate/typescript-client/pull/330 * Feat/add configure uncompressed quantizer by @tsmith023 in https://github.com/weaviate/typescript-client/pull/339 * feat: `overwriteAlias` for backup restore by @bevzzz in https://github.com/weaviate/typescript-client/pull/338 * Remove all BC checks for | Low | 9/26/2025 |
| v3.8.0 | [The previous release](https://github.com/weaviate/typescript-client/releases/v3.7.0) contained some breaking changes, which had been accidentally introduced during a refactor. We've deprecated that version on NPM and are releasing `v3.8.0` instead, which fixes the broken APIs. Note, that, in order to accommodate multi-vector search, several types in the API have acquired a generic parameter, which you will need to specify after switching to `v3.8.0`. Please refer to [this announcement](http | Low | 7/23/2025 |
| v3.6.2 | ## What's Changed * Add client-side logic allowing to update property descriptions by @tsmith023 in https://github.com/weaviate/typescript-client/pull/305 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.6.1...v3.6.2 | Low | 7/21/2025 |
| v3.7.0 | > ‼️ While deprecating some APIs we've _accidentally_ introduced breaking changes. > > We are actively working on releasing the next stable version. This version will be deprecated shortly after. > Until then, please prefer using `v3.6.2` to avoid build issues. Massive release, loads of improvements! `v3.7.0` brings support to all Weaviate `v1.32` features, so you can: - Manage **collection aliases** - Compress your vectors with **Rotational Quantization** (RQ) - Move shards across | Low | 7/17/2025 |
| v3.6.0 | ## What's Changed * Support adding named vectors to a collection by @bevzzz in https://github.com/weaviate/typescript-client/pull/299 * BM25 and Hybrid search with minimum_should_match by @bevzzz in https://github.com/weaviate/typescript-client/pull/300 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.5.5...v3.6.0 | Low | 6/9/2025 |
| v3.5.3 | ## What's Changed * Adds support to modules for by @tsmith023 in https://github.com/weaviate/typescript-client/pull/287 * Adds a single retry of UNAVAILABLE to health check by @tsmith023 in https://github.com/weaviate/typescript-client/pull/291 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.5.2...v3.5.3 | Low | 5/6/2025 |
| v3.5.2 | ## What's Changed * fix: revert breaking change and add deprecation notices by @bevzzz in https://github.com/weaviate/typescript-client/pull/285 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.5.1...v3.5.2 | Low | 4/18/2025 |
| v3.5.3-alpha.0 | Dynamic users have a `lastTimeUsed` timestamp and a preview of the API keys (if requested by the cluster admin). Provide configuration options for `reranker-nvidia` and `generative-xai` modules. ## What's Changed * Add `generative-xai` when configuring collections and generate queries by @tsmith023 in https://github.com/weaviate/typescript-client/pull/283 * fix: revert breaking change and add deprecation notices by @bevzzz in https://github.com/weaviate/typescript-client/pull/285 * Adds s | Low | 4/17/2025 |
| v3.5.0 | ## What's Changed * Update WCS auth tests to use newly commisioned user by @tsmith023 in https://github.com/weaviate/typescript-client/pull/280 * feat: add the support of URLs for the `nearImage()` method by @pacyL2K19 in https://github.com/weaviate/typescript-client/pull/252 * Update alpha docstring by @databyjp in https://github.com/weaviate/typescript-client/pull/235 * Dev/1.30 by @tsmith023 in https://github.com/weaviate/typescript-client/pull/275 **Full Changelog**: https://github. | Low | 4/3/2025 |
| v3.4.0 | ## What's Changed * add Snowflake/snowflake-arctic-embed-l-v2.0 model to weaviate vectorizer by @augustas1 in https://github.com/weaviate/typescript-client/pull/257 * Support new Weaviate 1.29 features by @tsmith023 in https://github.com/weaviate/typescript-client/pull/261 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.3.6...v3.4.0 | Low | 3/4/2025 |
| v3.3.6 | **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.3.5...v3.3.6 | Low | 2/3/2025 |
| v3.3.4 | ## What's Changed * Fix bug in `configure.invertedIndex` where undefined `b` and `k1` were sent to the server by @tsmith023 in https://github.com/weaviate/typescript-client/pull/255 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.3.3...v3.3.4 | Low | 1/15/2025 |
| v3.3.3 | ## What's Changed * Improve UX of using timeouts by @tsmith023 in https://github.com/weaviate/typescript-client/pull/254 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.3.2...v3.3.3 | Low | 1/15/2025 |
| v3.3.2 | ## What's Changed * Ensure collection is deleted from WCD by @tsmith023 in https://github.com/weaviate/typescript-client/pull/248 * Improve generative/reranker config UX by @tsmith023 in https://github.com/weaviate/typescript-client/pull/249 * Add new vectorDistance param to hybrid query by @tsmith023 in https://github.com/weaviate/typescript-client/pull/245 * Make improvments to hybrid ux by @tsmith023 in https://github.com/weaviate/typescript-client/pull/246 **Full Changelog**: https: | Low | 1/13/2025 |
| v3.2.5 | ## What's Changed * unnest exports by @augustas1 in https://github.com/weaviate/typescript-client/pull/237 * Text2vec weaviate by @augustas1 in https://github.com/weaviate/typescript-client/pull/236 ## New Contributors * @augustas1 made their first contribution in https://github.com/weaviate/typescript-client/pull/237 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.2.4...v3.2.5 | Low | 12/2/2024 |
| v3.2.4 | ## What's Changed * Improve nestedProperties' type configuration by @pacyL2K19 in https://github.com/weaviate/typescript-client/pull/231 * Adjust generic for `NestedDataTypeConfig` when `ObjectDataType` by @tsmith023 in https://github.com/weaviate/typescript-client/pull/233 ## New Contributors * @pacyL2K19 made their first contribution in https://github.com/weaviate/typescript-client/pull/231 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.2.3...v3.2.4 | Low | 11/22/2024 |
| v3.2.3 | ## What's Changed * [Snyk] Upgrade nice-grpc from 2.1.9 to 2.1.10 by @aduis in https://github.com/weaviate/typescript-client/pull/210 * Grpc/add dynamic message size support by @tsmith023 in https://github.com/weaviate/typescript-client/pull/218 * Add `configure.multi2VecCohere` factory method and types for the module by @tsmith023 in https://github.com/weaviate/typescript-client/pull/227 * Remove all references to OctoAI since they've shutdown by @tsmith023 in https://github.com/weaviate/ty | Low | 11/13/2024 |
| v3.2.2 | ## What's Changed * Resolve `false` for `isFilePromise` if `stats` is undefined by @tsmith023 in https://github.com/weaviate/typescript-client/pull/224 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.2.1...v3.2.2 | Low | 11/6/2024 |
| v3.2.1 | ## What's Changed * Use `nice-grpc-client-middleware-retry` for auto-retry of UNAVAILABLE grpc error by @tsmith023 in https://github.com/weaviate/typescript-client/pull/217 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.2.0...v3.2.1 | Low | 10/25/2024 |
| v3.2.0 | ## What's Changed * Support backup cancellation by @tsmith023 in https://github.com/weaviate/typescript-client/pull/206 * Support configuring replication deletion strategy by @tsmith023 in https://github.com/weaviate/typescript-client/pull/204 * Deprecate `xPalm` types and methods in favour of `xGoogle` by @tsmith023 in https://github.com/weaviate/typescript-client/pull/213 * Support new HNSW filtering strategy config options by @tsmith023 in https://github.com/weaviate/typescript-client/pul | Low | 10/24/2024 |
| v3.1.5 | ## What's Changed * Add support for new modules by @tsmith023 in https://github.com/weaviate/typescript-client/pull/195 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.1.4...v3.1.5 | Low | 10/11/2024 |
| v3.1.4 | ## What's Changed * Fix parsing of `date` and `float` filters to gRPC message by @tsmith023 in https://github.com/weaviate/typescript-client/pull/179 * Add `Bm25QueryProperty` type for use in weighted `.bm25` and `.hybrid` by @tsmith023 in https://github.com/weaviate/typescript-client/pull/180 * Fix/merge with existing in collection update by @tsmith023 in https://github.com/weaviate/typescript-client/pull/183 * Add support for JinaAI reranker by @tsmith023 in https://github.com/weaviate/typ | Low | 8/6/2024 |
| v3.1.0 | ## What's Changed * Add support for the kagome_kr tokenizer by @databyjp in https://github.com/weaviate/typescript-client/pull/160 * Add support for configuring and reconfiguring SQ by @tsmith023 in https://github.com/weaviate/typescript-client/pull/166 * DevV3/Use new OFFLOAD nomenclature and updated OpenAPI schema by @tsmith023 in https://github.com/weaviate/typescript-client/pull/162 * DevV3/support multi vector search by @tsmith023 in https://github.com/weaviate/typescript-client/pull/16 | Low | 7/24/2024 |
| v3.0.9 | ## What's Changed * [Snyk] Upgrade nice-grpc-client-middleware-deadline from 2.0.11 to 2.0.12 by @aduis in https://github.com/weaviate/typescript-client/pull/157 * [Snyk] Upgrade nice-grpc from 2.1.8 to 2.1.9 by @aduis in https://github.com/weaviate/typescript-client/pull/156 * [Snyk] Upgrade graphql from 16.8.1 to 16.8.2 by @aduis in https://github.com/weaviate/typescript-client/pull/159 * Send vectors optimistically to handle legacy vectorizers in >1.24.0 by @tsmith023 in https://github.co | Low | 7/10/2024 |
| v3.0.6 | - Hotfixes methods with the `.collection.data` namespace when inserting both single and named vectors **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.5...v3.0.6 | Low | 6/25/2024 |
| v3.0.7 | - Hotfixes multi-tenancy aggregation bug **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.6...v3.0.7 | Low | 6/25/2024 |
| v3.0.8 | - Hotfixes issues surrounding encoding blobs and buffers into `base64` when working with `blob` properties and `nearMedia` queries **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.7...v3.0.8 | Low | 6/25/2024 |
| v3.0.5 | **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.4...v3.0.5 | Low | 6/14/2024 |
| v3.0.3 | **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.2...v3.0.3 | Low | 6/10/2024 |
| v3.0.2 | **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.1...v3.0.2 | Low | 6/10/2024 |
| v3.0.1 | **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v3.0.0...v3.0.1 | Low | 6/10/2024 |
| v3.0.0 | ## What's Changed * Create gRPC stubs by @tsmith023 in https://github.com/weaviate/typescript-client/pull/100 * make changes for 1.23 support by @tsmith023 in https://github.com/weaviate/typescript-client/pull/104 * Disable telemetry in test docker compose files by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/109 * Add support for named vectors in 1.24 release by @tsmith023 in https://github.com/weaviate/typescript-client/pull/110 * Collections/support named vector | Low | 6/10/2024 |
| v2.2.0 | ## What's Changed * Support backup & restore compression configuration by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/129 * Update to handle core `v1.25` changes by @tsmith023 in https://github.com/weaviate/typescript-client/pull/139 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v2.1.1...v2.2.0 | Low | 5/20/2024 |
| v2.1.1 | ## What's Changed * Add support for target vectors in hybrid queries by @joshdschneider in https://github.com/weaviate/typescript-client/pull/114 ## New Contributors * @joshdschneider made their first contribution in https://github.com/weaviate/typescript-client/pull/114 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v2.1.0...v2.1.1 | Low | 3/26/2024 |
| v2.1.0 | ## What's Changed * make changes for 1.23 support by @tsmith023 in https://github.com/weaviate/typescript-client/pull/104 * Disable telemetry in test docker compose files by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/109 * Add support for named vectors in 1.24 release by @tsmith023 in https://github.com/weaviate/typescript-client/pull/110 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v2.0.0...v2.1.0 | Low | 2/28/2024 |
| v2.0.0 | ## What's Changed * replace isomorphic-fetch with fetch by @tsmith023 in https://github.com/weaviate/typescript-client/pull/99 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v1.6.0...v2.0.0 | Low | 11/22/2023 |
| v1.6.0 | ## What's Changed * [Snyk] Upgrade graphql-request from 5.1.0 to 5.2.0 by @aduis in https://github.com/weaviate/typescript-client/pull/93 * Handle existing scheme in host by @thomashacker in https://github.com/weaviate/typescript-client/pull/88 * fix: pass-through tenant when batch-creating cross-references by @flipace in https://github.com/weaviate/typescript-client/pull/96 * Adjusts tests to auto schema improvements by @aliszka in https://github.com/weaviate/typescript-client/pull/98 * [S | Low | 10/31/2023 |
| v1.5.0 | ## What's Changed * instance_version_warning by @Abhijithchintu in https://github.com/weaviate/typescript-client/pull/81 * Activate deactivate tenants support by @aliszka in https://github.com/weaviate/typescript-client/pull/83 * ContainsAny & ContainsAll Filter Operators by @antas-marcin in https://github.com/weaviate/typescript-client/pull/85 * Add nearMedia filters for multi2vec-bind model by @tsmith023 in https://github.com/weaviate/typescript-client/pull/89 * Adds `.withConsistencyLeve | Low | 8/22/2023 |
| v1.4.0 | ## What's Changed * Add method to check if class exists by @tsmith023 in https://github.com/weaviate/typescript-client/pull/70 * Fix client data checker return by @tsmith023 in https://github.com/weaviate/typescript-client/pull/71 * Add support for multi tenancy endpoints by @antas-marcin in https://github.com/weaviate/typescript-client/pull/67 * Add hybrid fusion type support by @antas-marcin in https://github.com/weaviate/typescript-client/pull/74 * Add support for autocut by @antas-marci | Low | 7/6/2023 |
| v1.3.3 | ## What's Changed * Support fetch in all environments by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/69 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v1.3.2...v1.3.3 | Low | 6/14/2023 |
| v1.3.2 | ## What's Changed * UUIDv5 support by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/58 * Support properties field in generative groupedResult field by @antas-marcin in https://github.com/weaviate/typescript-client/pull/60 * Add step generating GitHub release after successful publish by @antas-marcin in https://github.com/weaviate/typescript-client/pull/62 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v1.3.1...v1.3.2 | Low | 5/26/2023 |
| v1.3.1 | ## What's Changed * Support class properties in hybrid search by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/55 **Full Changelog**: https://github.com/weaviate/typescript-client/compare/v1.3.0...v1.3.1 | Low | 5/16/2023 |
| v1.3.0 | This release introduces the use of [tsup](https://github.com/egoist/tsup) to build the client in both CommonJS and ESM, exporting the use of both builds in the package.json. This is in contrast to the previous setup of a single build which attempts to accommodate both build targets. This change fixes a broken setup which was discovered when trying to use the [embedded client](https://github.com/weaviate/typescript-embedded) within an esm project, which was a result of the emitted JS containin | Low | 5/8/2023 |
| v1.2.0 | ## New Features * Adds support for GQL `Get{}` consistency level by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/38 * Adds support for groupBy argument, new tokenization options, filterable/searchable inverted index options by @antas-marcin in https://github.com/weaviate/typescript-client/pull/49 * Adds support for uuid and uuid[] data types by @aliszka in https://github.com/weaviate/typescript-client/pull/51 ## New Contributors * @aliszka made their first contri | Low | 5/5/2023 |
| v1.1.0 | Restores client compatibility with the browser platform, after the previously introduced EmbeddedDB broke this. Since EmbeddedDB support requires server-side packages which are not available in the browser, it is removed, and will be re-introduced as its own NPM package. ## What's Changed * Export ConsistencyLevel type by @antas-marcin in https://github.com/weaviate/typescript-client/pull/36 * Browser compatibility by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/45 | Low | 4/21/2023 |
| v1.0.0 | 🎉 We are proud to introduce the Official Weaviate TypeScript client! After many requests for this client library, it is finally here. ## What's Changed * Sanitize connection parameters by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/29 * Complete type definitions from JS migration by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/28 * Export all public classes by @parkerduckworth in https://github.com/weaviate/typescript-client/pull/32 * | Low | 4/5/2023 |
Dependencies & License Audit
Loading dependencies...
Similar Packages
lancedbDeveloper-friendly OSS embedded retrieval library for multimodal AI. Search More; Manage Less.v0.28.0-beta.9
awesome-vector-databaseA curated list of awesome works related to high dimensional structure/vector search & databasemain@2026-04-13