Merge pull request #475 from M4xymm/RDBC-899

RDBC-899 - Added Vector Search to Client API, updated client version to 7.0

Author: M4xymm

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ravendb",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "RavenDB client for Node.js",
   "files": [
     "dist"

package.json

@@ -2,6 +2,7 @@ import { DocumentConventions } from "../Conventions/DocumentConventions.js";
 import { IndexDefinition, IndexDefinitionBuilder } from "./IndexDefinition.js";
 import { AbstractGenericIndexCreationTask } from "./AbstractGenericIndexCreationTask.js";
 import { INDEXES } from "../../Constants.js";
+import { ObjectUtil } from "../../Utility/ObjectUtil.js";
 
 /**
  * Base class for creating indexes using C# code in string.
@@ -39,6 +40,7 @@ export abstract class AbstractCsharpIndexCreationTask extends AbstractGenericInd
         indexDefinitionBuilder.suggestionsOptions = this.indexSuggestions;
         indexDefinitionBuilder.termVectorsStrings = this.termVectorsStrings;
         indexDefinitionBuilder.spatialIndexesStrings = this.spatialOptionsStrings;
+        indexDefinitionBuilder.vectorFieldStrings = this.vectorOptionsStrings
         indexDefinitionBuilder.outputReduceToCollection = this.outputReduceToCollection;
         indexDefinitionBuilder.patternForOutputReduceToCollectionReferences = this.patternForOutputReduceToCollectionReferences;
         indexDefinitionBuilder.patternReferencesCollectionName = this.patternReferencesCollectionName;
@@ -54,6 +56,8 @@ export abstract class AbstractCsharpIndexCreationTask extends AbstractGenericInd
 
         if (this.searchEngineType && this.searchEngineType !== "None") {
             indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = this.searchEngineType;
+        } else if (!ObjectUtil.isEmpty(this.vectorOptionsStrings)) {
+            indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = "Corax";
         }
 
         return indexDefinitionBuilder.toIndexDefinition(this.conventions);

src/Documents/Indexes/AbstractCsharpIndexCreationTask.ts

@@ -3,6 +3,7 @@ import { IndexDefinition, IndexDefinitionBuilder } from "./IndexDefinition.js";
 import { DocumentConventions } from "../Conventions/DocumentConventions.js";
 import { AbstractGenericIndexCreationTask } from "./AbstractGenericIndexCreationTask.js";
 import { INDEXES } from "../../Constants.js";
+import { ObjectUtil } from "../../Utility/ObjectUtil.js";
 
 export class AbstractCsharpMultiMapIndexCreationTask extends AbstractGenericIndexCreationTask {
 
@@ -49,9 +50,12 @@ export class AbstractCsharpMultiMapIndexCreationTask extends AbstractGenericInde
         indexDefinitionBuilder.priority = this.priority;
         indexDefinitionBuilder.state = this.state;
         indexDefinitionBuilder.deploymentMode = this.deploymentMode;
+        indexDefinitionBuilder.vectorFieldStrings = this.vectorOptionsStrings;
 
         if (this.searchEngineType) {
             indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = this.searchEngineType;
+        } else if (!ObjectUtil.isEmpty(this.vectorOptionsStrings)) {
+            indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = "Corax";
         }
 
         const indexDefinition = indexDefinitionBuilder.toIndexDefinition(this.conventions, false);

src/Documents/Indexes/AbstractCsharpMultiMapIndexCreationTask.ts

@@ -5,6 +5,7 @@ import { CONSTANTS } from "../../Constants.js";
 import { IndexDefinition } from "./IndexDefinition.js";
 import { AdditionalAssembly } from "./AdditionalAssembly.js";
 import { throwError } from "../../Exceptions/index.js";
+import { FieldVectorOptions } from "../Queries/VectorSearch/VectorSearchOptions.js";
 
 type FieldOrAllFields<TField> = TField | "__all_fields";
 
@@ -19,6 +20,7 @@ export abstract class AbstractGenericIndexCreationTask<TField extends string = s
     protected indexSuggestions: Set<FieldOrAllFields<TField>>;
     protected termVectorsStrings: Record<FieldOrAllFields<TField>, FieldTermVector>;
     protected spatialOptionsStrings: Record<FieldOrAllFields<TField>, SpatialOptions>;
+    protected vectorOptionsStrings: Record<FieldOrAllFields<TField>, FieldVectorOptions>;
 
     protected outputReduceToCollection: string;
     protected patternForOutputReduceToCollectionReferences: string;
@@ -33,6 +35,7 @@ export abstract class AbstractGenericIndexCreationTask<TField extends string = s
         this.indexSuggestions = new Set<FieldOrAllFields<TField>>();
         this.termVectorsStrings = {} as Record<FieldOrAllFields<TField>, FieldTermVector>;
         this.spatialOptionsStrings = {} as Record<FieldOrAllFields<TField>, SpatialOptions>;
+        this.vectorOptionsStrings = {} as Record<FieldOrAllFields<TField>, FieldVectorOptions>;
     }
 
     abstract get isMapReduce(): boolean;
@@ -93,4 +96,8 @@ export abstract class AbstractGenericIndexCreationTask<TField extends string = s
 
         this.additionalAssemblies.push(assembly);
     }
+
+    protected vectorField(field: FieldOrAllFields<TField>, vector: FieldVectorOptions): void {
+        this.vectorOptionsStrings[field] = vector;
+    }
 }

src/Documents/Indexes/AbstractGenericIndexCreationTask.ts

@@ -6,6 +6,7 @@ import { DocumentConventions } from "../Conventions/DocumentConventions.js";
 import { IndexFieldOptions } from "./IndexFieldOptions.js";
 import { IndexDeploymentMode } from "./IndexDeploymentMode.js";
 import { AdditionalAssembly } from "./AdditionalAssembly.js";
+import { FieldVectorOptions } from "../Queries/VectorSearch/VectorSearchOptions.js";
 
 export abstract class AbstractIndexDefinitionBuilder<TIndexDefinition extends IndexDefinition> {
     protected readonly _indexName: string;
@@ -18,7 +19,7 @@ export abstract class AbstractIndexDefinitionBuilder<TIndexDefinition extends In
     public suggestionsOptions: Set<string>;
     public termVectorsStrings: { [key: string]: FieldTermVector };
     public spatialIndexesStrings: { [key: string]: SpatialOptions };
-
+    public vectorFieldStrings: { [key: string]: FieldVectorOptions };
     public lockMode: IndexLockMode;
     public priority: IndexPriority;
     public state: IndexState;
@@ -45,6 +46,8 @@ export abstract class AbstractIndexDefinitionBuilder<TIndexDefinition extends In
         this.analyzersStrings = {};
         this.termVectorsStrings = {};
         this.spatialIndexesStrings = {};
+        this.vectorFieldStrings = {};
+
         this.configuration = {};
     }
 
@@ -78,6 +81,8 @@ export abstract class AbstractIndexDefinitionBuilder<TIndexDefinition extends In
                 (options, value) => options.spatial = value);
             this._applyValues(indexDefinition, suggestions,
                 (options, value) => options.suggestions = value);
+            this._applyValues(indexDefinition, this.vectorFieldStrings,
+                (options, value) => options.vector = value);
 
             indexDefinition.additionalSources = this.additionalSources;
             indexDefinition.additionalAssemblies = this.additionalAssemblies;

src/Documents/Indexes/AbstractIndexDefinitionBuilder.ts

@@ -13,6 +13,7 @@ import { DocumentConventions } from "../Conventions/DocumentConventions.js";
 import { StringBuilder } from "../../Utility/StringBuilder.js";
 import { BaseJavaScriptIndexCreationTask } from "./BaseJavaScriptIndexCreationTask.js";
 import { INDEXES } from "../../Constants.js";
+import { ObjectUtil } from "../../Utility/ObjectUtil.js";
 
 export class AbstractJavaScriptIndexCreationTask<TDocument extends object, TMapResult extends object = any>
     extends BaseJavaScriptIndexCreationTask<keyof TMapResult & string> {
@@ -100,6 +101,7 @@ export class AbstractJavaScriptIndexCreationTask<TDocument extends object, TMapR
         indexDefinitionBuilder.suggestionsOptions = this.indexSuggestions;
         indexDefinitionBuilder.termVectorsStrings = this.termVectorsStrings;
         indexDefinitionBuilder.spatialIndexesStrings = this.spatialOptionsStrings;
+        indexDefinitionBuilder.vectorFieldStrings = this.vectorOptionsStrings;
         indexDefinitionBuilder.outputReduceToCollection = this.outputReduceToCollection;
         indexDefinitionBuilder.patternForOutputReduceToCollectionReferences = this.patternForOutputReduceToCollectionReferences;
         indexDefinitionBuilder.patternReferencesCollectionName = this.patternReferencesCollectionName;
@@ -114,6 +116,8 @@ export class AbstractJavaScriptIndexCreationTask<TDocument extends object, TMapR
 
         if (this.searchEngineType) {
             indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = this.searchEngineType;
+        } else if (!ObjectUtil.isEmpty(this.vectorOptionsStrings)) {
+            indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = "Corax";
         }
 
 

src/Documents/Indexes/AbstractJavaScriptIndexCreationTask.ts

@@ -13,6 +13,7 @@ import { DocumentConventions } from "../Conventions/DocumentConventions.js";
 import { StringBuilder } from "../../Utility/StringBuilder.js";
 import { BaseJavaScriptIndexCreationTask } from "./BaseJavaScriptIndexCreationTask.js";
 import { INDEXES } from "../../Constants.js";
+import { ObjectUtil } from "../../Utility/ObjectUtil.js";
 
 export class AbstractJavaScriptMultiMapIndexCreationTask<TMapResult extends object = any>
     extends BaseJavaScriptIndexCreationTask<keyof TMapResult & string> {
@@ -85,6 +86,7 @@ export class AbstractJavaScriptMultiMapIndexCreationTask<TMapResult extends obje
         indexDefinitionBuilder.storesStrings = this.storesStrings;
         indexDefinitionBuilder.suggestionsOptions = this.indexSuggestions;
         indexDefinitionBuilder.termVectorsStrings = this.termVectorsStrings;
+        indexDefinitionBuilder.vectorFieldStrings = this.vectorOptionsStrings;
         indexDefinitionBuilder.spatialIndexesStrings = this.spatialOptionsStrings;
         indexDefinitionBuilder.outputReduceToCollection = this.outputReduceToCollection;
         indexDefinitionBuilder.patternForOutputReduceToCollectionReferences = this.patternForOutputReduceToCollectionReferences;
@@ -99,6 +101,8 @@ export class AbstractJavaScriptMultiMapIndexCreationTask<TMapResult extends obje
 
         if (this.searchEngineType) {
             indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = this.searchEngineType;
+        } else if (!ObjectUtil.isEmpty(this.vectorOptionsStrings)) {
+            indexDefinitionBuilder.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = "Corax";
         }
 
         const indexDefinition = indexDefinitionBuilder.toIndexDefinition(this.conventions, false);

src/Documents/Indexes/AbstractJavaScriptMultiMapIndexCreationTask.ts

@@ -106,6 +106,8 @@ export class AbstractRawJavaScriptIndexCreationTask extends AbstractIndexCreatio
 
         if (this.searchEngineType && this.searchEngineType !== "None") {
             this._definition.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = this.searchEngineType;
+        } else if (this._definition.fields && Object.values(this._definition.fields).some(fieldOptions => fieldOptions.vector)) {
+            this._definition.configuration[INDEXES.INDEXING_STATIC_SEARCH_ENGINE_TYPE] = "Corax";
         }
 
         return this._definition;

src/Documents/Indexes/AbstractRawJavaScriptIndexCreationTask.ts

@@ -1,5 +1,6 @@
 import { AggregationOperation, AutoFieldIndexing, FieldStorage, GroupByArrayBehavior } from "./Enums.js";
 import { AutoSpatialOptions } from "./Spatial/AutoSpatialOptions.js";
+import { AutoVectorOptions } from "../Queries/VectorSearch/VectorSearchOptions.js";
 
 export interface AutoIndexFieldOptions {
     storage: FieldStorage;
@@ -9,4 +10,5 @@ export interface AutoIndexFieldOptions {
     groupByArrayBehavior: GroupByArrayBehavior;
     suggestions: boolean;
     isNameQuoted: boolean;
+    vector: AutoVectorOptions;
 }