Merge #1353

1353: Add vector search param r=Strift a=elzako

# Pull Request

## Related issue
Fixes #1351

## What does this PR do?
Add vector search param to support vector search with user-provided embedding


Co-authored-by: elzako <[email protected]>
Co-authored-by: Laurent Cazanove <[email protected]>

Author: 3 people

.changeset/strong-dodos-carry.md

@@ -0,0 +1,6 @@
+---
+"@meilisearch/instant-meilisearch": minor
+---
+
+Add `vector` field to the search params object to support user-provided embeddings
+

packages/instant-meilisearch/src/adapter/search-request-adapter/__tests__/search-params.test.ts

@@ -95,6 +95,19 @@ describe('Parameters adapter', () => {
     expect(searchParams.hybrid).toBe(hybridSearchConfig)
   })
 
+  test('vector can be set via search parameters', () => {
+    const vector = [0, 1, 2]
+
+    const searchParams = adaptSearchParams({
+      ...DEFAULT_CONTEXT,
+      meiliSearchParams: {
+        vector,
+      },
+    })
+
+    expect(searchParams.vector).toBe(vector)
+  })
+
   test('ranking score threshold can be set via search parameters', () => {
     const rankingScoreThreshold = 0.974
 

packages/instant-meilisearch/src/adapter/search-request-adapter/search-params-adapter.ts

@@ -238,6 +238,12 @@ export function MeiliParamsCreator(searchContext: SearchContext) {
         meiliSearchParams.hybrid = value
       }
     },
+    addVector() {
+      const value = overrideParams?.vector
+      if (value !== undefined) {
+        meiliSearchParams.vector = value
+      }
+    },
     addDistinct() {
       const value = overrideParams?.distinct
       if (value !== undefined) {
@@ -282,6 +288,7 @@ export function adaptSearchParams(
   meilisearchParams.addShowRankingScore()
   meilisearchParams.addAttributesToSearchOn()
   meilisearchParams.addHybridSearch()
+  meilisearchParams.addVector()
   meilisearchParams.addDistinct()
   meilisearchParams.addRankingScoreThreshold()
 

packages/instant-meilisearch/src/types/types.ts

@@ -57,6 +57,7 @@ export type OverridableMeiliSearchSearchParameters = Pick<
   | 'rankingScoreThreshold'
   | 'showMatchesPosition'
   | 'showRankingScore'
+  | 'vector'
 >
 
 type BaseInstantMeiliSearchOptions = {