pref: HttpClient vector search (#343)

* fix: HttpClient query and search types

* feat: HttpClient add hybridSearch

milvus/const/error.ts

@@ -70,4 +70,5 @@ export enum ErrorCode {
   UpsertAutoIDTrue = 'UpsertAutoIDTrue',
   CollectionNotExists = 'CollectionNotExists',
   IllegalArgument = 'IllegalArgument',
+  RateLimit = 'RateLimit',
 }

milvus/http/Vector.ts

@@ -12,6 +12,7 @@ import {
   HttpBaseResponse,
   FetchOptions,
   HttpVectorUpsertResponse,
+  HttpVectorHybridSearchReq,
 } from '../types';
 
 /**
@@ -79,6 +80,14 @@ export function Vector<T extends Constructor<HttpBaseClient>>(Base: T) {
       return await this.POST<HttpVectorSearchResponse>(url, data, options);
     }
 
+    async hybridSearch(
+      data: HttpVectorHybridSearchReq,
+      options?: FetchOptions
+    ) {
+      const url = `${this.vectorPrefix}/hybrid_search`;
+      return await this.POST<HttpVectorSearchResponse>(url, data, options);
+    }
+
     // POST delete collection
     async delete(
       data: HttpVectorDeleteReq,

milvus/types/Http.ts

@@ -194,7 +194,7 @@ export interface HttpVectorQueryReq extends HttpBaseReq {
   filter?: string;
   limit?: number;
   offset?: number;
-  params?: Record<string, string | number>;
+  partitionNames?: string[];
 }
 
 type QueryResult = Record<string, any>[];
@@ -204,10 +204,32 @@ export interface HttpVectorQueryResponse
   extends HttpBaseResponse<QueryResult> {}
 
 // search request
-export interface HttpVectorSearchReq
-  extends Omit<HttpVectorQueryReq, 'filter'> {
+export interface HttpVectorSearchReq extends HttpVectorQueryReq {
   data: FloatVector[];
+  annsField?: string;
+  groupingField?: string;
+  searchParams?: Record<string, any>;
+}
+
+// hybrid search request
+interface HttpVectorHybridSearchParams {
+  data: FloatVector[];
+  limit: number;
   filter?: string;
+  outputFields?: string[];
+  offset?: number;
+  annsField?: string;
+  ignoreGrowing?: boolean;
+  metricType?: string;
+  params?: Record<string, string | number>;
+}
+
+export interface HttpVectorHybridSearchReq extends HttpBaseReq {
+  search: HttpVectorHybridSearchParams[];
+  rerank: Record<string, any>;
+  partitionNames?: string[];
+  outputFields?: string[];
+  limit?: number;
 }
 
 export interface HttpVectorSearchResponse extends HttpVectorQueryResponse {

package.json

@@ -2,7 +2,7 @@
   "name": "@zilliz/milvus2-sdk-node",
   "author": "[email protected]",
   "version": "2.4.4",
-  "milvusVersion": "v2.4.4",
+  "milvusVersion": "v2.4.6",
   "main": "dist/milvus",
   "files": [
     "dist"

test/grpc/Data.spec.ts

@@ -144,7 +144,11 @@ describe(`Data.API`, () => {
     const res = await milvusClient.flush({
       collection_names: [COLLECTION_NAME],
     });
-    const segIDs = res.coll_segIDs[COLLECTION_NAME].data;
+    if (res.status.error_code === ErrorCode.RateLimit) {
+      expect(res.coll_segIDs[COLLECTION_NAME]).toBeUndefined();
+      return;
+    }
+    const segIDs = res.coll_segIDs[COLLECTION_NAME]?.data;
     await milvusClient.getFlushState({
       segmentIDs: segIDs,
     });

test/http/test.ts

@@ -197,6 +197,30 @@ export function generateTests(
       expect(upsert.data.upsertIds).toEqual([target.id]);
     });
 
+    it('should hybrid search data successfully', async () => {
+      const search = await client.hybridSearch({
+        collectionName: createParams.collectionName,
+        outputFields: ['*'],
+        rerank: {
+          strategy: 'rrf',
+          params: {
+            k: 5,
+          },
+        },
+        search: [
+          {
+            data: [[1, 2, 3, 4]],
+            outputFields: ['*'],
+            limit: 5,
+          },
+        ],
+      });
+
+      expect(search.code).toEqual(0);
+      expect(search.data.length).toEqual(5);
+      expect(typeof search.data[0].distance).toEqual('number');
+    });
+
     it('should query data and get data and delete successfully', async () => {
       const query = await client.query({
         collectionName: createParams.collectionName,