Experimental vector search for MS v1.3.0 (#1535)

* Experimental vector search for MS v1.3.0

* Add vector search error codes

* Use permission as key when enabling the experimental prototype

Author: bidoubiwa

src/indexes.ts

@@ -137,6 +137,7 @@ class Index<T extends Record<string, any> = Record<string, any>> {
       attributesToRetrieve: options?.attributesToRetrieve?.join(','),
       attributesToCrop: options?.attributesToCrop?.join(','),
       attributesToHighlight: options?.attributesToHighlight?.join(','),
+      vector: options?.vector?.join(','),
     }
 
     return await this.httpRequest.get<SearchResponse<D, S>>(

src/types/types.ts

@@ -90,6 +90,7 @@ export type SearchParams = Query &
     matchingStrategy?: MatchingStrategies
     hitsPerPage?: number
     page?: number
+    vector?: number[] | null
   }
 
 // Search parameters for searches made with the GET method
@@ -105,6 +106,7 @@ export type SearchRequestGET = Pagination &
     attributesToHighlight?: string
     attributesToCrop?: string
     showMatchesPosition?: boolean
+    vector?: string | null
   }
 
 export type MultiSearchQuery = SearchParams & { indexUid: string }
@@ -142,6 +144,7 @@ export type SearchResponse<
   facetDistribution?: FacetDistribution
   query: string
   facetStats?: FacetStats
+  vector: number[]
 } & (undefined extends S
   ? Partial<FinitePagination & InfinitePagination>
   : true extends IsFinitePagination<NonNullable<S>>
@@ -560,12 +563,15 @@ export const enum ErrorStatusCode {
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_document_offset */
   INVALID_DOCUMENT_OFFSET = 'invalid_document_offset',
 
-  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_document_offset */
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_document_filter */
   INVALID_DOCUMENT_FILTER = 'invalid_document_filter',
 
-  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_document_offset */
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#missing_document_filter */
   MISSING_DOCUMENT_FILTER = 'missing_document_filter',
 
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_document_vectors_field */
+  INVALID_DOCUMENT_VECTORS_FIELD = 'invalid_document_vectors_field',
+
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#payload_too_large */
   PAYLOAD_TOO_LARGE = 'payload_too_large',
 
@@ -641,6 +647,9 @@ export const enum ErrorStatusCode {
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_search_matching_strategy */
   INVALID_SEARCH_MATCHING_STRATEGY = 'invalid_search_matching_strategy',
 
+  /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#invalid_search_vector */
+  INVALID_SEARCH_VECTOR = 'invalid_search_vector',
+
   /** @see https://www.meilisearch.com/docs/reference/errors/error_codes#bad_request */
   BAD_REQUEST = 'bad_request',
 

tests/get_search.test.ts

@@ -6,6 +6,8 @@ import {
   BAD_HOST,
   MeiliSearch,
   getClient,
+  HOST,
+  getKey,
 } from './utils/meilisearch-test-utils'
 
 const index = {
@@ -423,6 +425,25 @@ describe.each([
       'The filter query parameter should be in string format when using searchGet'
     )
   })
+  test(`${permission} key: search with vectors`, async () => {
+    const client = await getClient(permission)
+    const key = await getKey(permission)
+
+    await fetch(`${HOST}/experimental-features`, {
+      body: JSON.stringify({ vectorStore: true }),
+      headers: {
+        Authorization: `Bearer ${key}`,
+        'Content-Type': 'application/json',
+      },
+      method: 'PATCH',
+    })
+
+    const response = await client
+      .index(emptyIndex.uid)
+      .searchGet('', { vector: [1] })
+
+    expect(response.vector).toEqual([1])
+  })
 
   test(`${permission} key: Try to search on deleted index and fail`, async () => {
     const client = await getClient(permission)

tests/search.test.ts

@@ -8,8 +8,14 @@ import {
   MeiliSearch,
   getClient,
   datasetWithNests,
+  HOST,
+  getKey,
 } from './utils/meilisearch-test-utils'
 
+if (typeof fetch === 'undefined') {
+  require('cross-fetch/polyfill')
+}
+
 const index = {
   uid: 'movies_test',
 }
@@ -767,6 +773,26 @@ describe.each([
     expect(response.hits.length).toEqual(0)
   })
 
+  test(`${permission} key: search with vectors`, async () => {
+    const client = await getClient(permission)
+    const key = await getKey(permission)
+
+    await fetch(`${HOST}/experimental-features`, {
+      body: JSON.stringify({ vectorStore: true }),
+      headers: {
+        Authorization: `Bearer ${key}`,
+        'Content-Type': 'application/json',
+      },
+      method: 'PATCH',
+    })
+
+    const response = await client
+      .index(emptyIndex.uid)
+      .search('', { vector: [1] })
+
+    expect(response.vector).toEqual([1])
+  })
+
   test(`${permission} key: Try to search on deleted index and fail`, async () => {
     const client = await getClient(permission)
     const masterClient = await getClient('Master')