usearch 2.20.8 → 2.21.1

package/README.md

@@ -354,16 +354,16 @@ By now, the core functionality is supported across all bindings.
 Broader functionality is ported per request.
 In some cases, like Batch operations, feature parity is meaningless, as the host language has full multi-threading capabilities and the USearch index structure is concurrent by design, so the users can implement batching/scheduling/load-balancing in the most optimal way for their applications.
 
-|                         | C++ 11 | Python 3 | C 99  | Java  | JavaScript | Rust  | Go     | Swift |
-| :---------------------- | :----: | :------: | :---: | :---: | :--------: | :---: | :----: | :---: |
-| Add, search, remove     |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅    |   ✅   |
-| Save, load, view        |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅    |   ✅   |
-| User-defined metrics    |   ✅    |    ✅     |   ✅   |   ❌   |     ❌      |   ❌   |   ❌    |   ❌   |
-| Batch operations        |   ❌    |    ✅     |   ❌   |   ✅   |     ✅      |   ❌   |   ❌    |   ❌   |
-| Filter predicates       |   ✅    |    ❌     |   ✅   |   ❌   |     ❌      |   ✅   |   ❌    |   ❌   |
-| Joins                   |   ✅    |    ✅     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌    |   ❌   |
-| Variable-length vectors |   ✅    |    ❌     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌    |   ❌   |
-| 4B+ capacities          |   ✅    |    ❌     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌    |   ❌   |
+|                         | C++ 11 | Python 3 | C 99  | Java  | JavaScript | Rust  |  Go   | Swift |
+| :---------------------- | :----: | :------: | :---: | :---: | :--------: | :---: | :---: | :---: |
+| Add, search, remove     |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅   |   ✅   |
+| Save, load, view        |   ✅    |    ✅     |   ✅   |   ✅   |     ✅      |   ✅   |   ✅   |   ✅   |
+| User-defined metrics    |   ✅    |    ✅     |   ✅   |   ❌   |     ❌      |   ✅   |   ❌   |   ❌   |
+| Batch operations        |   ❌    |    ✅     |   ❌   |   ✅   |     ✅      |   ❌   |   ❌   |   ❌   |
+| Filter predicates       |   ✅    |    ❌     |   ✅   |   ❌   |     ❌      |   ✅   |   ❌   |   ✅   |
+| Joins                   |   ✅    |    ✅     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌   |   ❌   |
+| Variable-length vectors |   ✅    |    ❌     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌   |   ❌   |
+| 4B+ capacities          |   ✅    |    ❌     |   ❌   |   ❌   |     ❌      |   ❌   |   ❌   |   ❌   |
 
 ## Application Examples
 
@@ -534,13 +534,14 @@ index = Index(ndim=ndim, metric=CompiledMetric(
 - [x] TiDB & TiFlash: [C++](https://github.com/pingcap/tiflash), [announcement](https://www.pingcap.com/article/introduce-vector-search-indexes-in-tidb/).
 - [x] YugaByte: [C++](https://github.com/yugabyte/yugabyte-db/blob/366b9f5e3c4df3a1a17d553db41d6dc50146f488/src/yb/vector_index/usearch_wrapper.cc).
 - [x] Google: [UniSim](https://github.com/google/unisim), [RetSim](https://arxiv.org/abs/2311.17264) paper.
-- [x] Memgraph: [C++](https://github.com/memgraph/memgraph/blob/784dd8520f65050d033aea8b29446e84e487d091/src/storage/v2/indices/vector_index.cpp), [announcement](https://memgraph.com/blog/simplify-data-retrieval-memgraph-vector-search).
+- [x] MemGraph: [C++](https://github.com/memgraph/memgraph/blob/784dd8520f65050d033aea8b29446e84e487d091/src/storage/v2/indices/vector_index.cpp), [announcement](https://memgraph.com/blog/simplify-data-retrieval-memgraph-vector-search).
 - [x] LanternDB: [C++](https://github.com/lanterndata/lantern), [Rust](https://github.com/lanterndata/lantern_extras), [docs](https://lantern.dev/blog/hnsw-index-creation).
 - [x] LangChain: [Python](https://github.com/langchain-ai/langchain/releases/tag/v0.0.257) and [JavaScript](https://github.com/hwchase17/langchainjs/releases/tag/0.0.125).
 - [x] Microsoft Semantic Kernel: [Python](https://github.com/microsoft/semantic-kernel/releases/tag/python-0.3.9.dev) and C#.
 - [x] GPTCache: [Python](https://github.com/zilliztech/GPTCache/releases/tag/0.1.29).
 - [x] Sentence-Transformers: Python [docs](https://www.sbert.net/docs/package_reference/quantization.html#sentence_transformers.quantization.semantic_search_usearch).
 - [x] Pathway: [Rust](https://github.com/pathwaycom/pathway).
+- [x] Vald: [GoLang](https://github.com/vdaas/vald).
   
 
 ## Citations
@@ -551,7 +552,7 @@ doi = {10.5281/zenodo.7949416},
 author = {Vardanian, Ash},
 title = {{USearch by Unum Cloud}},
 url = {https://github.com/unum-cloud/usearch},
-version = {2.20.8},
+version = {2.21.1},
 year = {2023},
 month = oct,
 }

package/include/usearch/index.hpp

@@ -8,8 +8,8 @@
 #define UNUM_USEARCH_HPP
 
 #define USEARCH_VERSION_MAJOR 2
-#define USEARCH_VERSION_MINOR 20
-#define USEARCH_VERSION_PATCH 8
+#define USEARCH_VERSION_MINOR 21
+#define USEARCH_VERSION_PATCH 1
 
 // Inferring C++ version
 // https://stackoverflow.com/a/61552074

package/javascript/dist/cjs/usearch.d.ts

@@ -120,7 +120,7 @@ export declare class Index {
      * @throws Will throw an error if the length of keys doesn't match the number of vectors
      *         or if it's not a single key.
      */
-    add(keys: bigint | bigint[] | BigUint64Array, vectors: Vector, threads?: number): void;
+    add(keys: bigint | bigint[] | BigUint64Array, vectors: VectorOrMatrix, threads?: number): void;
     /**
      * Perform a k-nearest neighbor search on the index.
      *
@@ -143,7 +143,8 @@ export declare class Index {
      * @throws Will throw an error if `k` is not a positive integer or if the size of the vectors is not a multiple of dimensions.
      * @throws Will throw an error if `vectors` is not a valid input type (TypedArray or an array of TypedArray) or if its flattened size is not a multiple of dimensions.
      */
-    search(vectors: VectorOrMatrix, k: number, threads?: number): Matches | BatchMatches;
+    search(vectors: Vector, k: number, threads: number): Matches;
+    search(vectors: Matrix, k: number, threads: number): BatchMatches;
     /**
      * Verifies the presence of one or more keys in the index.
      *

package/javascript/dist/cjs/usearch.js

@@ -300,28 +300,6 @@ class Index {
         // Call the compiled method
         __classPrivateFieldGet(this, _Index_compiledIndex, "f").add(normalizedKeys, normalizedVectors, threads);
     }
-    /**
-     * Perform a k-nearest neighbor search on the index.
-     *
-     * This method accepts a matrix of query vectors and returns the closest vectors
-     * from the index for each query. The method returns an object containing the keys,
-     * distances, and counts of the matches found.
-     *
-     * Vectors should be provided as a flat typed array representing a matrix where
-     * each row is a vector. The matrix should be of size n * d, where n is the
-     * number of query vectors, and d is their dimensionality.
-     *
-     * The parameter `k` specifies the number of nearest neighbors to return for each
-     * query vector. If there are not enough results for a query, the result array is
-     * padded with -1s.
-     *
-     * @param {Float32Array|Float64Array|Int8Array|Array<Array<number>>} vectors - Input matrix representing query vectors, can be a TypedArray or an array of TypedArray.
-     * @param {number} k - The number of nearest neighbors to search for each query vector.
-     * @param {number} [threads=0] - Optional, default is 0. Number of threads to use for searching. If set to 0, the number of threads is determined automatically.
-     * @return {Matches|BatchMatches} - Search results for one or more queries, containing keys, distances, and counts of the matches found.
-     * @throws Will throw an error if `k` is not a positive integer or if the size of the vectors is not a multiple of dimensions.
-     * @throws Will throw an error if `vectors` is not a valid input type (TypedArray or an array of TypedArray) or if its flattened size is not a multiple of dimensions.
-     */
     search(vectors, k, threads = 0) {
         if ((!Number.isNaN(k) && typeof k !== "number") || k <= 0) {
             throw new Error("`k` must be a positive integer representing the number of nearest neighbors to search for.");

package/javascript/dist/esm/usearch.d.ts

@@ -120,7 +120,7 @@ export declare class Index {
      * @throws Will throw an error if the length of keys doesn't match the number of vectors
      *         or if it's not a single key.
      */
-    add(keys: bigint | bigint[] | BigUint64Array, vectors: Vector, threads?: number): void;
+    add(keys: bigint | bigint[] | BigUint64Array, vectors: VectorOrMatrix, threads?: number): void;
     /**
      * Perform a k-nearest neighbor search on the index.
      *
@@ -143,7 +143,8 @@ export declare class Index {
      * @throws Will throw an error if `k` is not a positive integer or if the size of the vectors is not a multiple of dimensions.
      * @throws Will throw an error if `vectors` is not a valid input type (TypedArray or an array of TypedArray) or if its flattened size is not a multiple of dimensions.
      */
-    search(vectors: VectorOrMatrix, k: number, threads?: number): Matches | BatchMatches;
+    search(vectors: Vector, k: number, threads: number): Matches;
+    search(vectors: Matrix, k: number, threads: number): BatchMatches;
     /**
      * Verifies the presence of one or more keys in the index.
      *

package/javascript/dist/esm/usearch.js

@@ -252,28 +252,6 @@ export class Index {
         // Call the compiled method
         this.#compiledIndex.add(normalizedKeys, normalizedVectors, threads);
     }
-    /**
-     * Perform a k-nearest neighbor search on the index.
-     *
-     * This method accepts a matrix of query vectors and returns the closest vectors
-     * from the index for each query. The method returns an object containing the keys,
-     * distances, and counts of the matches found.
-     *
-     * Vectors should be provided as a flat typed array representing a matrix where
-     * each row is a vector. The matrix should be of size n * d, where n is the
-     * number of query vectors, and d is their dimensionality.
-     *
-     * The parameter `k` specifies the number of nearest neighbors to return for each
-     * query vector. If there are not enough results for a query, the result array is
-     * padded with -1s.
-     *
-     * @param {Float32Array|Float64Array|Int8Array|Array<Array<number>>} vectors - Input matrix representing query vectors, can be a TypedArray or an array of TypedArray.
-     * @param {number} k - The number of nearest neighbors to search for each query vector.
-     * @param {number} [threads=0] - Optional, default is 0. Number of threads to use for searching. If set to 0, the number of threads is determined automatically.
-     * @return {Matches|BatchMatches} - Search results for one or more queries, containing keys, distances, and counts of the matches found.
-     * @throws Will throw an error if `k` is not a positive integer or if the size of the vectors is not a multiple of dimensions.
-     * @throws Will throw an error if `vectors` is not a valid input type (TypedArray or an array of TypedArray) or if its flattened size is not a multiple of dimensions.
-     */
     search(vectors, k, threads = 0) {
         if ((!Number.isNaN(k) && typeof k !== "number") || k <= 0) {
             throw new Error("`k` must be a positive integer representing the number of nearest neighbors to search for.");

package/javascript/usearch.ts

@@ -332,7 +332,7 @@ export class Index {
    * @throws Will throw an error if the length of keys doesn't match the number of vectors
    *         or if it's not a single key.
    */
-  add(keys: bigint | bigint[] | BigUint64Array, vectors: Vector, threads: number = 0): void {
+  add(keys: bigint | bigint[] | BigUint64Array, vectors: VectorOrMatrix, threads: number = 0): void {
     let normalizedKeys = normalizeKeys(keys);
     let normalizedVectors = normalizeVectors(
       vectors,
@@ -386,6 +386,8 @@ export class Index {
    * @throws Will throw an error if `k` is not a positive integer or if the size of the vectors is not a multiple of dimensions.
    * @throws Will throw an error if `vectors` is not a valid input type (TypedArray or an array of TypedArray) or if its flattened size is not a multiple of dimensions.
    */
+  search(vectors: Vector, k: number, threads: number): Matches;
+  search(vectors: Matrix, k: number, threads: number): BatchMatches;
   search(vectors: VectorOrMatrix, k: number, threads: number = 0): Matches | BatchMatches {
     if ((!Number.isNaN(k) && typeof k !== "number") || k <= 0) {
       throw new Error(

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "usearch",
-    "version": "2.20.8",
+    "version": "2.21.1",
     "description": "Smaller & Faster Single-File Vector Search Engine from Unum",
     "author": "Ash Vardanian (https://ashvardanian.com/)",
     "license": "Apache 2.0",