Changes related to the next Meilisearch release (v1.11.0)

.code-samples.meilisearch.yaml

@@ -759,10 +759,19 @@ search_parameter_reference_ranking_score_threshold_1: |-
 search_parameter_reference_retrieve_vectors_1: |-
   client.index('INDEX_NAME').search('kitchen utensils', {
     retrieveVectors: true,
-    hybrid: { embedder: 'default'}
+    hybrid: {
+      embedder: 'EMBEDDER_NAME'
+    }
+  })
+search_parameter_guide_hybrid_1: |-
+  client.index('INDEX_NAME').search('kitchen utensils', {
+    hybrid: {
+      semanticRatio: 0.9,
+      embedder: 'EMBEDDER_NAME'
+    }
   })
 get_similar_post_1: |-
-  client.index('INDEX_NAME').searchSimilarDocuments({ id: 'TARGET_DOCUMENT_ID'})
+  client.index('INDEX_NAME').searchSimilarDocuments({ id: 'TARGET_DOCUMENT_ID', embedder: 'default' })
 search_parameter_guide_matching_strategy_3: |-
   client.index('movies').search('white shirt', {
     matchingStrategy: 'frequency'
@@ -788,7 +797,7 @@ multi_search_federated_1: |-
     ]
   })
 search_parameter_reference_locales_1: |-
-  client.index('INDEX_NAME').search('進撃の巨人', { locales: ['jpn'] })
+  client.index('INDEX_NAME').search('QUERY TEXT IN JAPANESE', { locales: ['jpn'] })
 get_localized_attribute_settings_1: |-
   client.index('INDEX_NAME').getLocalizedAttributes()
 update_localized_attribute_settings_1: |-

.github/workflows/tests.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       meilisearch:
-        image: getmeili/meilisearch:latest
+        image: getmeili/meilisearch:v1.11.0
         env:
           MEILI_MASTER_KEY: 'masterKey'
           MEILI_NO_ANALYTICS: 'true'

src/types/types.ts

@@ -98,7 +98,7 @@ export type SearchForFacetValuesResponse = {
 };
 
 export type HybridSearch = {
-  embedder?: string;
+  embedder: string;
   semanticRatio?: number;
 };
 
@@ -153,8 +153,17 @@ export type SearchRequestGET = Pagination &
     locales?: Locale[];
   };
 
+export type MergeFacets = {
+  maxValuesPerFacet?: number | null;
+};
+
 export type FederationOptions = { weight: number };
-export type MultiSearchFederation = { limit?: number; offset?: number };
+export type MultiSearchFederation = {
+  limit?: number;
+  offset?: number;
+  facetsByIndex?: Record<string, string[]>;
+  mergeFacets?: MergeFacets | null;
+};
 
 export type MultiSearchQuery = SearchParams & { indexUid: string };
 export type MultiSearchQueryWithFederation = MultiSearchQuery & {
@@ -229,6 +238,14 @@ export type Hits<T = Record<string, any>> = Array<Hit<T>>;
 export type FacetStat = { min: number; max: number };
 export type FacetStats = Record<string, FacetStat>;
 
+export type FacetsByIndex = Record<
+  string,
+  {
+    distribution: FacetDistribution;
+    stats: FacetStats;
+  }
+>;
+
 export type SearchResponse<
   T = Record<string, any>,
   S extends SearchParams | undefined = undefined,
@@ -238,6 +255,7 @@ export type SearchResponse<
   query: string;
   facetDistribution?: FacetDistribution;
   facetStats?: FacetStats;
+  facetsByIndex?: FacetsByIndex;
 } & (undefined extends S
   ? Partial<FinitePagination & InfinitePagination>
   : true extends IsFinitePagination<NonNullable<S>>
@@ -389,6 +407,8 @@ export type OpenAiEmbedder = {
   dimensions?: number;
   distribution?: Distribution;
   url?: string;
+  documentTemplateMaxBytes?: number;
+  binaryQuantized?: boolean;
 };
 
 export type HuggingFaceEmbedder = {
@@ -397,12 +417,15 @@ export type HuggingFaceEmbedder = {
   revision?: string;
   documentTemplate?: string;
   distribution?: Distribution;
+  documentTemplateMaxBytes?: number;
+  binaryQuantized?: boolean;
 };
 
 export type UserProvidedEmbedder = {
   source: "userProvided";
   dimensions: number;
   distribution?: Distribution;
+  binaryQuantized?: boolean;
 };
 
 export type RestEmbedder = {
@@ -415,6 +438,8 @@ export type RestEmbedder = {
   request: Record<string, any>;
   response: Record<string, any>;
   headers?: Record<string, string>;
+  documentTemplateMaxBytes?: number;
+  binaryQuantized?: boolean;
 };
 
 export type OllamaEmbedder = {
@@ -425,6 +450,8 @@ export type OllamaEmbedder = {
   documentTemplate?: string;
   distribution?: Distribution;
   dimensions?: number;
+  documentTemplateMaxBytes?: number;
+  binaryQuantized?: boolean;
 };
 
 export type Embedder =

tests/__snapshots__/settings.test.ts.snap

@@ -249,8 +249,9 @@ exports[`Test on settings > Admin key: Update embedders settings  1`] = `
   "distinctAttribute": null,
   "embedders": {
     "default": {
-      "documentTemplate": "{% for field in fields %} {{ field.name }}: {{ field.value }}
-{% endfor %}",
+      "documentTemplate": "{% for field in fields %}{% if field.is_searchable and field.value != nil %}{{ field.name }}: {{ field.value }}
+{% endif %}{% endfor %}",
+      "documentTemplateMaxBytes": 400,
       "model": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
       "source": "huggingFace",
     },
@@ -804,8 +805,9 @@ exports[`Test on settings > Master key: Update embedders settings  1`] = `
   "distinctAttribute": null,
   "embedders": {
     "default": {
-      "documentTemplate": "{% for field in fields %} {{ field.name }}: {{ field.value }}
-{% endfor %}",
+      "documentTemplate": "{% for field in fields %}{% if field.is_searchable and field.value != nil %}{{ field.name }}: {{ field.value }}
+{% endif %}{% endfor %}",
+      "documentTemplateMaxBytes": 400,
       "model": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
       "source": "huggingFace",
     },

tests/embedders.test.ts

@@ -90,6 +90,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
             mean: 0.7,
             sigma: 0.3,
           },
+          binaryQuantized: false,
         },
       };
       const task: EnqueuedTask = await client
@@ -101,6 +102,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       const response: Embedders = await client.index(index.uid).getEmbedders();
 
       expect(response).toEqual(newEmbedder);
+      expect(response).not.toHaveProperty("documentTemplateMaxBytes");
     });
 
     test(`${permission} key: Update embedders with 'openAi' source`, async () => {
@@ -118,6 +120,8 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
             sigma: 0.3,
           },
           url: "https://api.openai.com/v1/embeddings",
+          documentTemplateMaxBytes: 500,
+          binaryQuantized: false,
         },
       };
       const task: EnqueuedTask = await client
@@ -147,6 +151,8 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
             mean: 0.7,
             sigma: 0.3,
           },
+          documentTemplateMaxBytes: 500,
+          binaryQuantized: false,
         },
       };
       const task: EnqueuedTask = await client
@@ -188,6 +194,8 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
           headers: {
             "Custom-Header": "CustomValue",
           },
+          documentTemplateMaxBytes: 500,
+          binaryQuantized: false,
         },
       };
       const task: EnqueuedTask = await client
@@ -219,6 +227,8 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
             sigma: 0.3,
           },
           dimensions: 512,
+          documentTemplateMaxBytes: 500,
+          binaryQuantized: false,
         },
       };
       const task: EnqueuedTask = await client
@@ -266,6 +276,58 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       expect(response).toEqual(null);
     });
 
+    test(`${permission} key: search (POST) with vectors`, async () => {
+      const client = await getClient(permission);
+
+      const { taskUid } = await client.index(index.uid).updateEmbedders({
+        default: {
+          source: "userProvided",
+          dimensions: 1,
+        },
+      });
+      await client.waitForTask(taskUid);
+
+      const response = await client.index(index.uid).search("", {
+        vector: [1],
+        hybrid: {
+          embedder: "default",
+          semanticRatio: 1.0,
+        },
+      });
+
+      expect(response).toHaveProperty("hits");
+      expect(response).toHaveProperty("semanticHitCount");
+      // Those fields are no longer returned by the search response
+      // We want to ensure that they don't appear in it anymore
+      expect(response).not.toHaveProperty("vector");
+      expect(response).not.toHaveProperty("_semanticScore");
+    });
+
+    test(`${permission} key: search (GET) with vectors`, async () => {
+      const client = await getClient(permission);
+
+      const { taskUid } = await client.index(index.uid).updateEmbedders({
+        default: {
+          source: "userProvided",
+          dimensions: 1,
+        },
+      });
+      await client.waitForTask(taskUid);
+
+      const response = await client.index(index.uid).searchGet("", {
+        vector: [1],
+        hybridEmbedder: "default",
+        hybridSemanticRatio: 1.0,
+      });
+
+      expect(response).toHaveProperty("hits");
+      expect(response).toHaveProperty("semanticHitCount");
+      // Those fields are no longer returned by the search response
+      // We want to ensure that they don't appear in it anymore
+      expect(response).not.toHaveProperty("vector");
+      expect(response).not.toHaveProperty("_semanticScore");
+    });
+
     test(`${permission} key: search for similar documents`, async () => {
       const client = await getClient(permission);
 
@@ -288,6 +350,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       await client.waitForTask(documentAdditionTask);
 
       const response = await client.index(index.uid).searchSimilarDocuments({
+        embedder: "manual",
         id: "143",
       });
 

tests/get_search.test.ts

@@ -457,41 +457,6 @@ 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 adminClient = await getClient("Admin");
-    const adminKey = await getKey("Admin");
-
-    await fetch(`${HOST}/experimental-features`, {
-      body: JSON.stringify({ vectorStore: true }),
-      headers: {
-        Authorization: `Bearer ${adminKey}`,
-        "Content-Type": "application/json",
-      },
-      method: "PATCH",
-    });
-
-    const { taskUid } = await adminClient
-      .index(emptyIndex.uid)
-      .updateEmbedders({
-        default: {
-          source: "userProvided",
-          dimensions: 1,
-        },
-      });
-    await adminClient.waitForTask(taskUid);
-
-    const response = await client
-      .index(emptyIndex.uid)
-      .searchGet("", { vector: [1], hybridSemanticRatio: 1.0 });
-
-    expect(response).toHaveProperty("hits");
-    expect(response).toHaveProperty("semanticHitCount");
-    // Those fields are no longer returned by the search response
-    // We want to ensure that they don't appear in it anymore
-    expect(response).not.toHaveProperty("vector");
-    expect(response).not.toHaveProperty("_semanticScore");
-  });
 
   test(`${permission} key: search without vectors`, async () => {
     const client = await getClient(permission);