hyperspace-sdk-ts 3.0.10 → 3.1.1

package/README.md

@@ -1,6 +1,6 @@
 # HyperspaceDB TypeScript SDK
 
-Official TypeScript client for HyperspaceDB gRPC API (v3.0.0-alpha.2).
+Official TypeScript client for HyperspaceDB gRPC API v3.1.0.
 
 Use this SDK for:
 - collection lifecycle management
@@ -147,6 +147,27 @@ const results = await client.search([0.1, 0.2, 0.3], 10, "coll", {
 });
 ```
 
+### Hybrid & Lexical Search (BM25)
+
+HyperspaceDB supports combined lexical and vector ranking.
+
+```ts
+// Hybrid Search (Semantic Vector + BM25 Lexical)
+const results = await client.search([0.1, -0.2, 0.5], 10, "coll", {
+  hybridQuery: "hybrid search implementation",
+  hybridAlpha: 0.7, // 70% vector weight
+  bm25: {
+    method: "bm25plus",
+    language: "english"
+  }
+});
+
+// Or Pure Lexical Search via searchText
+const lexicalResults = await client.searchText("full-text query", 10, "coll", {
+  bm25: { method: "lucene" }
+});
+```
+
 ### `searchBatch(vectors, topK, collection?)`
 
 Run multiple searches in one gRPC request to reduce RPC overhead.

package/dist/client.d.ts

@@ -48,6 +48,15 @@ export interface VacuumFilter {
     op: 'lt' | 'lte' | 'gt' | 'gte' | 'eq' | 'ne';
     value: number;
 }
+export interface Bm25Options {
+    method?: "bm25plus" | "bm25l" | "robertson" | "lucene" | "atire";
+    k1?: number;
+    b?: number;
+    delta?: number;
+    language?: string;
+    ngrams?: number;
+    fusionMethod?: "rrf" | "weighted";
+}
 export type EventTypeName = 'insert' | 'delete';
 export interface SubscribeOptions {
     types?: EventTypeName[];
@@ -77,12 +86,12 @@ export declare class HyperspaceClient {
     deleteCollection(name: string): Promise<boolean>;
     listCollections(): Promise<CollectionInfo[]>;
     delete(id: number, collection?: string): Promise<boolean>;
-    insert(vector: number[] | Float32Array | Float64Array, id: number, meta?: {
+    insert(id: number, vector: number[] | Float32Array | Float64Array, meta?: {
         [key: string]: string;
     }, collection?: string, durability?: DurabilityLevel, typedMetadata?: {
         [key: string]: TypedMetadataValue;
     }): Promise<boolean>;
-    insertText(text: string, id: number, meta?: {
+    insertText(id: number, text: string, meta?: {
         [key: string]: string;
     }, collection?: string, durability?: DurabilityLevel): Promise<boolean>;
     vectorize(text: string, metric?: string): Promise<number[]>;
@@ -100,9 +109,12 @@ export declare class HyperspaceClient {
         filters?: Filter[];
         hybridQuery?: string;
         hybridAlpha?: number;
+        bm25?: Bm25Options;
     }): Promise<SearchResult[]>;
     searchText(text: string, topK: number, collection?: string, options?: {
         filters?: Filter[];
+        bm25?: Bm25Options;
+        hybridAlpha?: number;
     }): Promise<SearchResult[]>;
     searchBatch(vectors: Array<number[] | Float32Array | Float64Array>, topK: number, collection?: string): Promise<SearchResult[][]>;
     getDigest(collection?: string): Promise<{

package/dist/client.js

@@ -296,7 +296,7 @@ class HyperspaceClient {
             });
         });
     }
-    insert(vector, id, meta, collection = '', durability = hyperspace_pb_1.DurabilityLevel.DEFAULT_LEVEL, typedMetadata) {
+    insert(id, vector, meta, collection = '', durability = hyperspace_pb_1.DurabilityLevel.DEFAULT_LEVEL, typedMetadata) {
         return new Promise((resolve, reject) => {
             const req = new hyperspace_pb_1.InsertRequest();
             req.setVectorList(HyperspaceClient.toVectorList(vector));
@@ -322,7 +322,7 @@ class HyperspaceClient {
             });
         });
     }
-    insertText(text, id, meta, collection = '', durability = hyperspace_pb_1.DurabilityLevel.DEFAULT_LEVEL) {
+    insertText(id, text, meta, collection = '', durability = hyperspace_pb_1.DurabilityLevel.DEFAULT_LEVEL) {
         return new Promise((resolve, reject) => {
             const req = new hyperspace_pb_1.InsertTextRequest();
             req.setText(text);
@@ -422,6 +422,26 @@ class HyperspaceClient {
                 req.setHybridQuery(options.hybridQuery);
             if ((options === null || options === void 0 ? void 0 : options.hybridAlpha) !== undefined)
                 req.setHybridAlpha(options.hybridAlpha);
+            if (options === null || options === void 0 ? void 0 : options.bm25) {
+                // @ts-ignore: Bm25Options might not be in generated proto yet
+                const bm25Msg = new hyperspace_pb.Bm25Options();
+                if (options.bm25.method !== undefined)
+                    bm25Msg.setMethod(options.bm25.method);
+                if (options.bm25.k1 !== undefined)
+                    bm25Msg.setK1(options.bm25.k1);
+                if (options.bm25.b !== undefined)
+                    bm25Msg.setB(options.bm25.b);
+                if (options.bm25.delta !== undefined)
+                    bm25Msg.setDelta(options.bm25.delta);
+                if (options.bm25.language !== undefined)
+                    bm25Msg.setLanguage(options.bm25.language);
+                if (options.bm25.ngrams !== undefined)
+                    bm25Msg.setNgrams(options.bm25.ngrams);
+                if (options.bm25.fusionMethod !== undefined)
+                    bm25Msg.setFusionMethod(options.bm25.fusionMethod);
+                // @ts-ignore
+                req.setBm25Options(bm25Msg);
+            }
             this.client.search(req, this.metadata, (err, resp) => {
                 if (err)
                     return reject(err);
@@ -480,6 +500,30 @@ class HyperspaceClient {
                 });
                 req.setFiltersList(protoFilters);
             }
+            if (options === null || options === void 0 ? void 0 : options.bm25) {
+                // @ts-ignore
+                const bm25Msg = new hyperspace_pb.Bm25Options();
+                if (options.bm25.method !== undefined)
+                    bm25Msg.setMethod(options.bm25.method);
+                if (options.bm25.k1 !== undefined)
+                    bm25Msg.setK1(options.bm25.k1);
+                if (options.bm25.b !== undefined)
+                    bm25Msg.setB(options.bm25.b);
+                if (options.bm25.delta !== undefined)
+                    bm25Msg.setDelta(options.bm25.delta);
+                if (options.bm25.language !== undefined)
+                    bm25Msg.setLanguage(options.bm25.language);
+                if (options.bm25.ngrams !== undefined)
+                    bm25Msg.setNgrams(options.bm25.ngrams);
+                if (options.bm25.fusionMethod !== undefined)
+                    bm25Msg.setFusionMethod(options.bm25.fusionMethod);
+                // @ts-ignore
+                req.setBm25Options(bm25Msg);
+            }
+            if ((options === null || options === void 0 ? void 0 : options.hybridAlpha) !== undefined) {
+                // @ts-ignore
+                req.setHybridAlpha(options.hybridAlpha);
+            }
             this.client.searchText(req, this.metadata, (err, resp) => {
                 if (err)
                     return reject(err);

package/dist/proto/hyperspace_pb.js

@@ -24,6 +24,7 @@ var global = (function() {
 goog.exportSymbol('proto.hyperspace.BatchInsertRequest', null, global);
 goog.exportSymbol('proto.hyperspace.BatchSearchRequest', null, global);
 goog.exportSymbol('proto.hyperspace.BatchSearchResponse', null, global);
+goog.exportSymbol('proto.hyperspace.Bm25Options', null, global);
 goog.exportSymbol('proto.hyperspace.CollectionStatsRequest', null, global);
 goog.exportSymbol('proto.hyperspace.CollectionStatsResponse', null, global);
 goog.exportSymbol('proto.hyperspace.CollectionSummary', null, global);
@@ -600,6 +601,27 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.hyperspace.SearchTextRequest.displayName = 'proto.hyperspace.SearchTextRequest';
 }
+/**
+ * Generated by JsPbCodeGenerator.
+ * @param {Array=} opt_data Optional initial data array, typically from a
+ * server response, or constructed directly in Javascript. The array is used
+ * in place and becomes part of the constructed object. It is not cloned.
+ * If no data is provided, the constructed object will be empty, but still
+ * valid.
+ * @extends {jspb.Message}
+ * @constructor
+ */
+proto.hyperspace.Bm25Options = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.hyperspace.Bm25Options, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.hyperspace.Bm25Options.displayName = 'proto.hyperspace.Bm25Options';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -6239,7 +6261,9 @@ proto.hyperspace.SearchTextRequest.toObject = function(includeInstance, msg) {
     topK: jspb.Message.getFieldWithDefault(msg, 3, 0),
     filterMap: (f = msg.getFilterMap()) ? f.toObject(includeInstance, undefined) : [],
     filtersList: jspb.Message.toObjectList(msg.getFiltersList(),
-    proto.hyperspace.Filter.toObject, includeInstance)
+    proto.hyperspace.Filter.toObject, includeInstance),
+    bm25Options: (f = msg.getBm25Options()) && proto.hyperspace.Bm25Options.toObject(includeInstance, f),
+    hybridAlpha: jspb.Message.getFloatingPointFieldWithDefault(msg, 7, 0.0)
   };
 
   if (includeInstance) {
@@ -6299,6 +6323,15 @@ proto.hyperspace.SearchTextRequest.deserializeBinaryFromReader = function(msg, r
       reader.readMessage(value,proto.hyperspace.Filter.deserializeBinaryFromReader);
       msg.addFilters(value);
       break;
+    case 6:
+      var value = new proto.hyperspace.Bm25Options;
+      reader.readMessage(value,proto.hyperspace.Bm25Options.deserializeBinaryFromReader);
+      msg.setBm25Options(value);
+      break;
+    case 7:
+      var value = /** @type {number} */ (reader.readFloat());
+      msg.setHybridAlpha(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -6361,6 +6394,21 @@ proto.hyperspace.SearchTextRequest.serializeBinaryToWriter = function(message, w
       proto.hyperspace.Filter.serializeBinaryToWriter
     );
   }
+  f = message.getBm25Options();
+  if (f != null) {
+    writer.writeMessage(
+      6,
+      f,
+      proto.hyperspace.Bm25Options.serializeBinaryToWriter
+    );
+  }
+  f = /** @type {number} */ (jspb.Message.getField(message, 7));
+  if (f != null) {
+    writer.writeFloat(
+      7,
+      f
+    );
+  }
 };
 
 
@@ -6478,6 +6526,515 @@ proto.hyperspace.SearchTextRequest.prototype.clearFiltersList = function() {
 };
 
 
+/**
+ * optional Bm25Options bm25_options = 6;
+ * @return {?proto.hyperspace.Bm25Options}
+ */
+proto.hyperspace.SearchTextRequest.prototype.getBm25Options = function() {
+  return /** @type{?proto.hyperspace.Bm25Options} */ (
+    jspb.Message.getWrapperField(this, proto.hyperspace.Bm25Options, 6));
+};
+
+
+/**
+ * @param {?proto.hyperspace.Bm25Options|undefined} value
+ * @return {!proto.hyperspace.SearchTextRequest} returns this
+*/
+proto.hyperspace.SearchTextRequest.prototype.setBm25Options = function(value) {
+  return jspb.Message.setWrapperField(this, 6, value);
+};
+
+
+/**
+ * Clears the message field making it undefined.
+ * @return {!proto.hyperspace.SearchTextRequest} returns this
+ */
+proto.hyperspace.SearchTextRequest.prototype.clearBm25Options = function() {
+  return this.setBm25Options(undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.SearchTextRequest.prototype.hasBm25Options = function() {
+  return jspb.Message.getField(this, 6) != null;
+};
+
+
+/**
+ * optional float hybrid_alpha = 7;
+ * @return {number}
+ */
+proto.hyperspace.SearchTextRequest.prototype.getHybridAlpha = function() {
+  return /** @type {number} */ (jspb.Message.getFloatingPointFieldWithDefault(this, 7, 0.0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.SearchTextRequest} returns this
+ */
+proto.hyperspace.SearchTextRequest.prototype.setHybridAlpha = function(value) {
+  return jspb.Message.setField(this, 7, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.SearchTextRequest} returns this
+ */
+proto.hyperspace.SearchTextRequest.prototype.clearHybridAlpha = function() {
+  return jspb.Message.setField(this, 7, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.SearchTextRequest.prototype.hasHybridAlpha = function() {
+  return jspb.Message.getField(this, 7) != null;
+};
+
+
+
+
+
+if (jspb.Message.GENERATE_TO_OBJECT) {
+/**
+ * Creates an object representation of this proto.
+ * Field names that are reserved in JavaScript and will be renamed to pb_name.
+ * Optional fields that are not set will be set to undefined.
+ * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
+ * For the list of reserved names please see:
+ *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
+ * @param {boolean=} opt_includeInstance Deprecated. whether to include the
+ *     JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @return {!Object}
+ */
+proto.hyperspace.Bm25Options.prototype.toObject = function(opt_includeInstance) {
+  return proto.hyperspace.Bm25Options.toObject(opt_includeInstance, this);
+};
+
+
+/**
+ * Static version of the {@see toObject} method.
+ * @param {boolean|undefined} includeInstance Deprecated. Whether to include
+ *     the JSPB instance for transitional soy proto support:
+ *     http://goto/soy-param-migration
+ * @param {!proto.hyperspace.Bm25Options} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.hyperspace.Bm25Options.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    method: jspb.Message.getFieldWithDefault(msg, 1, ""),
+    k1: jspb.Message.getFloatingPointFieldWithDefault(msg, 2, 0.0),
+    b: jspb.Message.getFloatingPointFieldWithDefault(msg, 3, 0.0),
+    delta: jspb.Message.getFloatingPointFieldWithDefault(msg, 4, 0.0),
+    language: jspb.Message.getFieldWithDefault(msg, 5, ""),
+    ngrams: jspb.Message.getFieldWithDefault(msg, 6, 0),
+    fusionMethod: jspb.Message.getFieldWithDefault(msg, 7, "")
+  };
+
+  if (includeInstance) {
+    obj.$jspbMessageInstance = msg;
+  }
+  return obj;
+};
+}
+
+
+/**
+ * Deserializes binary data (in protobuf wire format).
+ * @param {jspb.ByteSource} bytes The bytes to deserialize.
+ * @return {!proto.hyperspace.Bm25Options}
+ */
+proto.hyperspace.Bm25Options.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.hyperspace.Bm25Options;
+  return proto.hyperspace.Bm25Options.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.hyperspace.Bm25Options} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.hyperspace.Bm25Options}
+ */
+proto.hyperspace.Bm25Options.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    case 1:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setMethod(value);
+      break;
+    case 2:
+      var value = /** @type {number} */ (reader.readFloat());
+      msg.setK1(value);
+      break;
+    case 3:
+      var value = /** @type {number} */ (reader.readFloat());
+      msg.setB(value);
+      break;
+    case 4:
+      var value = /** @type {number} */ (reader.readFloat());
+      msg.setDelta(value);
+      break;
+    case 5:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setLanguage(value);
+      break;
+    case 6:
+      var value = /** @type {number} */ (reader.readUint32());
+      msg.setNgrams(value);
+      break;
+    case 7:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setFusionMethod(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.hyperspace.Bm25Options.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.hyperspace.Bm25Options.serializeBinaryToWriter(this, writer);
+  return writer.getResultBuffer();
+};
+
+
+/**
+ * Serializes the given message to binary data (in protobuf wire
+ * format), writing to the given BinaryWriter.
+ * @param {!proto.hyperspace.Bm25Options} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.hyperspace.Bm25Options.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = /** @type {string} */ (jspb.Message.getField(message, 1));
+  if (f != null) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+  f = /** @type {number} */ (jspb.Message.getField(message, 2));
+  if (f != null) {
+    writer.writeFloat(
+      2,
+      f
+    );
+  }
+  f = /** @type {number} */ (jspb.Message.getField(message, 3));
+  if (f != null) {
+    writer.writeFloat(
+      3,
+      f
+    );
+  }
+  f = /** @type {number} */ (jspb.Message.getField(message, 4));
+  if (f != null) {
+    writer.writeFloat(
+      4,
+      f
+    );
+  }
+  f = /** @type {string} */ (jspb.Message.getField(message, 5));
+  if (f != null) {
+    writer.writeString(
+      5,
+      f
+    );
+  }
+  f = /** @type {number} */ (jspb.Message.getField(message, 6));
+  if (f != null) {
+    writer.writeUint32(
+      6,
+      f
+    );
+  }
+  f = /** @type {string} */ (jspb.Message.getField(message, 7));
+  if (f != null) {
+    writer.writeString(
+      7,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string method = 1;
+ * @return {string}
+ */
+proto.hyperspace.Bm25Options.prototype.getMethod = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setMethod = function(value) {
+  return jspb.Message.setField(this, 1, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearMethod = function() {
+  return jspb.Message.setField(this, 1, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasMethod = function() {
+  return jspb.Message.getField(this, 1) != null;
+};
+
+
+/**
+ * optional float k1 = 2;
+ * @return {number}
+ */
+proto.hyperspace.Bm25Options.prototype.getK1 = function() {
+  return /** @type {number} */ (jspb.Message.getFloatingPointFieldWithDefault(this, 2, 0.0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setK1 = function(value) {
+  return jspb.Message.setField(this, 2, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearK1 = function() {
+  return jspb.Message.setField(this, 2, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasK1 = function() {
+  return jspb.Message.getField(this, 2) != null;
+};
+
+
+/**
+ * optional float b = 3;
+ * @return {number}
+ */
+proto.hyperspace.Bm25Options.prototype.getB = function() {
+  return /** @type {number} */ (jspb.Message.getFloatingPointFieldWithDefault(this, 3, 0.0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setB = function(value) {
+  return jspb.Message.setField(this, 3, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearB = function() {
+  return jspb.Message.setField(this, 3, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasB = function() {
+  return jspb.Message.getField(this, 3) != null;
+};
+
+
+/**
+ * optional float delta = 4;
+ * @return {number}
+ */
+proto.hyperspace.Bm25Options.prototype.getDelta = function() {
+  return /** @type {number} */ (jspb.Message.getFloatingPointFieldWithDefault(this, 4, 0.0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setDelta = function(value) {
+  return jspb.Message.setField(this, 4, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearDelta = function() {
+  return jspb.Message.setField(this, 4, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasDelta = function() {
+  return jspb.Message.getField(this, 4) != null;
+};
+
+
+/**
+ * optional string language = 5;
+ * @return {string}
+ */
+proto.hyperspace.Bm25Options.prototype.getLanguage = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 5, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setLanguage = function(value) {
+  return jspb.Message.setField(this, 5, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearLanguage = function() {
+  return jspb.Message.setField(this, 5, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasLanguage = function() {
+  return jspb.Message.getField(this, 5) != null;
+};
+
+
+/**
+ * optional uint32 ngrams = 6;
+ * @return {number}
+ */
+proto.hyperspace.Bm25Options.prototype.getNgrams = function() {
+  return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 6, 0));
+};
+
+
+/**
+ * @param {number} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setNgrams = function(value) {
+  return jspb.Message.setField(this, 6, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearNgrams = function() {
+  return jspb.Message.setField(this, 6, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasNgrams = function() {
+  return jspb.Message.getField(this, 6) != null;
+};
+
+
+/**
+ * optional string fusion_method = 7;
+ * @return {string}
+ */
+proto.hyperspace.Bm25Options.prototype.getFusionMethod = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 7, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.setFusionMethod = function(value) {
+  return jspb.Message.setField(this, 7, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.hyperspace.Bm25Options} returns this
+ */
+proto.hyperspace.Bm25Options.prototype.clearFusionMethod = function() {
+  return jspb.Message.setField(this, 7, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.Bm25Options.prototype.hasFusionMethod = function() {
+  return jspb.Message.getField(this, 7) != null;
+};
+
+
 
 
 
@@ -6945,7 +7502,8 @@ proto.hyperspace.SearchRequest.toObject = function(includeInstance, msg) {
     proto.hyperspace.Filter.toObject, includeInstance),
     hybridQuery: jspb.Message.getFieldWithDefault(msg, 6, ""),
     hybridAlpha: jspb.Message.getFloatingPointFieldWithDefault(msg, 7, 0.0),
-    useWasserstein: jspb.Message.getBooleanFieldWithDefault(msg, 8, false)
+    useWasserstein: jspb.Message.getBooleanFieldWithDefault(msg, 8, false),
+    bm25Options: (f = msg.getBm25Options()) && proto.hyperspace.Bm25Options.toObject(includeInstance, f)
   };
 
   if (includeInstance) {
@@ -7019,6 +7577,11 @@ proto.hyperspace.SearchRequest.deserializeBinaryFromReader = function(msg, reade
       var value = /** @type {boolean} */ (reader.readBool());
       msg.setUseWasserstein(value);
       break;
+    case 9:
+      var value = new proto.hyperspace.Bm25Options;
+      reader.readMessage(value,proto.hyperspace.Bm25Options.deserializeBinaryFromReader);
+      msg.setBm25Options(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -7102,6 +7665,14 @@ proto.hyperspace.SearchRequest.serializeBinaryToWriter = function(message, write
       f
     );
   }
+  f = message.getBm25Options();
+  if (f != null) {
+    writer.writeMessage(
+      9,
+      f,
+      proto.hyperspace.Bm25Options.serializeBinaryToWriter
+    );
+  }
 };
 
 
@@ -7328,6 +7899,43 @@ proto.hyperspace.SearchRequest.prototype.setUseWasserstein = function(value) {
 };
 
 
+/**
+ * optional Bm25Options bm25_options = 9;
+ * @return {?proto.hyperspace.Bm25Options}
+ */
+proto.hyperspace.SearchRequest.prototype.getBm25Options = function() {
+  return /** @type{?proto.hyperspace.Bm25Options} */ (
+    jspb.Message.getWrapperField(this, proto.hyperspace.Bm25Options, 9));
+};
+
+
+/**
+ * @param {?proto.hyperspace.Bm25Options|undefined} value
+ * @return {!proto.hyperspace.SearchRequest} returns this
+*/
+proto.hyperspace.SearchRequest.prototype.setBm25Options = function(value) {
+  return jspb.Message.setWrapperField(this, 9, value);
+};
+
+
+/**
+ * Clears the message field making it undefined.
+ * @return {!proto.hyperspace.SearchRequest} returns this
+ */
+proto.hyperspace.SearchRequest.prototype.clearBm25Options = function() {
+  return this.setBm25Options(undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.hyperspace.SearchRequest.prototype.hasBm25Options = function() {
+  return jspb.Message.getField(this, 9) != null;
+};
+
+
 
 /**
  * Oneof group definitions for this message. Each group defines the field

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperspace-sdk-ts",
-  "version": "3.0.10",
+  "version": "3.1.1",
   "description": "Official TypeScript SDK for HyperspaceDB gRPC API",
   "main": "dist/client.js",
   "types": "dist/client.d.ts",