Add initial implementation

Author: tsmith023

src/collections/index.ts

@@ -306,3 +306,4 @@ export * from './references/index.js';
 export * from './sort/index.js';
 export * from './tenants/index.js';
 export * from './types/index.js';
+export * from './vectors/index.js';

src/collections/query/index.ts

@@ -27,6 +27,7 @@ import {
   NearMediaType,
   NearOptions,
   NearTextOptions,
+  NearVectorInputType,
   Query,
   QueryReturn,
   SearchOptions,
@@ -255,9 +256,9 @@ class QueryManager<T> implements Query<T> {
       .then((reply) => this.parseGroupByReply(opts, reply));
   }
 
-  public nearVector(vector: number[], opts?: BaseNearOptions<T>): Promise<WeaviateReturn<T>>;
-  public nearVector(vector: number[], opts: GroupByNearOptions<T>): Promise<GroupByReturn<T>>;
-  public nearVector(vector: number[], opts?: NearOptions<T>): QueryReturn<T> {
+  public nearVector(vector: NearVectorInputType, opts?: BaseNearOptions<T>): Promise<WeaviateReturn<T>>;
+  public nearVector(vector: NearVectorInputType, opts: GroupByNearOptions<T>): Promise<GroupByReturn<T>>;
+  public nearVector(vector: NearVectorInputType, opts?: NearOptions<T>): QueryReturn<T> {
     return this.checkSupportForNamedVectors(opts)
       .then(() => this.connection.search(this.name, this.consistencyLevel, this.tenant))
       .then((search) =>

src/collections/query/types.ts

@@ -1,4 +1,5 @@
 import { FilterValue } from '../filters/index.js';
+import { MultiTargetVectorJoin } from '../index.js';
 import { Sorting } from '../sort/classes.js';
 import {
   GroupByOptions,
@@ -165,6 +166,10 @@ export type GroupByNearTextOptions<T> = BaseNearTextOptions<T> & {
 /** The type of the media to search for in the `query.nearMedia` method */
 export type NearMediaType = 'audio' | 'depth' | 'image' | 'imu' | 'thermal' | 'video';
 
+export type NearVectorInputType = number[] | number[][] | Record<string, number[]>;
+
+export type TargetVectorInputType = string | string[] | MultiTargetVectorJoin;
+
 interface Bm25<T> {
   /**
    * Search for objects in this collection using the keyword-based BM25 algorithm.
@@ -433,35 +438,35 @@ interface NearVector<T> {
    *
    * This overload is for performing a search without the `groupBy` param.
    *
-   * @param {number[]} vector - The vector to search for.
+   * @param {NearVectorInputType} vector - The vector(s) to search on.
    * @param {BaseNearOptions<T>} [opts] - The available options for the search excluding the `groupBy` param.
    * @returns {Promise<WeaviateReturn<T>>} - The result of the search within the fetched collection.
    */
-  nearVector(vector: number[], opts?: BaseNearOptions<T>): Promise<WeaviateReturn<T>>;
+  nearVector(vector: NearVectorInputType, opts?: BaseNearOptions<T>): Promise<WeaviateReturn<T>>;
   /**
    * Search for objects by vector in this collection using a vector-based similarity search.
    *
    * See the [docs](https://weaviate.io/developers/weaviate/search/similarity) for a more detailed explanation.
    *
    * This overload is for performing a search with the `groupBy` param.
    *
-   * @param {number[]} vector - The vector to search for.
+   * @param {NearVectorInputType} vector - The vector(s) to search for.
    * @param {GroupByNearOptions<T>} opts - The available options for the search including the `groupBy` param.
    * @returns {Promise<GroupByReturn<T>>} - The group by result of the search within the fetched collection.
    */
-  nearVector(vector: number[], opts: GroupByNearOptions<T>): Promise<GroupByReturn<T>>;
+  nearVector(vector: NearVectorInputType, opts: GroupByNearOptions<T>): Promise<GroupByReturn<T>>;
   /**
    * Search for objects by vector in this collection using a vector-based similarity search.
    *
    * See the [docs](https://weaviate.io/developers/weaviate/search/similarity) for a more detailed explanation.
    *
    * This overload is for performing a search with a programmatically defined `opts` param.
    *
-   * @param {number[]} vector - The vector to search for.
+   * @param {NearVectorInputType} vector - The vector(s) to search for.
    * @param {NearOptions<T>} [opts] - The available options for the search.
    * @returns {QueryReturn<T>} - The result of the search within the fetched collection.
    */
-  nearVector(vector: number[], opts?: NearOptions<T>): QueryReturn<T>;
+  nearVector(vector: NearVectorInputType, opts?: NearOptions<T>): QueryReturn<T>;
 }
 
 /** All the available methods on the `.query` namespace. */

src/collections/query/utils.ts

@@ -0,0 +1,30 @@
+import { MultiTargetVectorJoin } from '../index.js';
+import { NearVectorInputType, TargetVectorInputType } from './types.js';
+
+export class NearVectorInputGuards {
+  public static is1DArray(input: NearVectorInputType): input is number[] {
+    return Array.isArray(input) && input.length > 0 && !Array.isArray(input[0]);
+  }
+
+  public static is2DArray(input: NearVectorInputType): input is number[][] {
+    return Array.isArray(input) && input.length > 0 && Array.isArray(input[0]);
+  }
+
+  public static isObject(input: NearVectorInputType): input is Record<string, number[]> {
+    return !Array.isArray(input);
+  }
+}
+
+export class TargetVectorInputGuards {
+  public static isSingle(input: TargetVectorInputType): input is string {
+    return typeof input === 'string';
+  }
+
+  public static isMulti(input: TargetVectorInputType): input is string[] {
+    return Array.isArray(input);
+  }
+
+  public static isMultiJoin(input: TargetVectorInputType): input is MultiTargetVectorJoin {
+    return (input as MultiTargetVectorJoin).combination !== undefined;
+  }
+}