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

.code-samples.meilisearch.yaml

@@ -528,8 +528,14 @@ get_filterable_attributes_1: |-
 update_filterable_attributes_1: |-
   client.index('movies')
     .updateFilterableAttributes([
-      'genres',
-      'director'
+      "genres",
+      {
+        attributePatterns: ["genre"],
+        features: {
+          facetSearch: true,
+          filter: { equality: true, comparison: false },
+        },
+      }
     ])
 reset_filterable_attributes_1: |-
   client.index('movies').resetFilterableAttributes()

src/indexes.ts

@@ -782,8 +782,8 @@ export class Index<T extends RecordAny = RecordAny> {
    *
    * @returns Promise containing an array of filterable-attributes
    */
-  async getFilterableAttributes(): Promise<string[]> {
-    return await this.httpRequest.get<string[]>({
+  async getFilterableAttributes(): Promise<FilterableAttributes> {
+    return await this.httpRequest.get<FilterableAttributes>({
       path: `indexes/${this.uid}/settings/filterable-attributes`,
     });
   }

src/types/task_and_batch.ts

@@ -168,6 +168,9 @@ type BatchStats = {
   status: Record<TaskStatus, number>;
   types: Record<TaskType, number>;
   indexUids: Record<string, number>;
+  progressTrace: Record<string, number>;
+  // Do not type this field because the keys can change in a breaking way
+  internalDatabaseSizes?: Record<string, number>;
 };
 
 /**

src/types/types.ts

@@ -183,6 +183,11 @@ export type Crop = {
 // `facetName` becomes mandatory when using `searchForFacetValues`
 export type SearchForFacetValuesParams = Omit<SearchParams, "facetName"> & {
   facetName: string;
+  /**
+   * If true, the facet search will return the exhaustive count of the facet
+   * values.
+   */
+  exhaustiveFacetCount?: boolean;
 };
 
 export type FacetHit = {
@@ -469,6 +474,7 @@ export type RawDocumentAdditionOptions = DocumentOptions & {
 };
 
 export type DocumentsQuery<T = RecordAny> = ResourceQuery & {
+  ids?: string[] | number[];
   fields?: Fields<T>;
   filter?: Filter;
   limit?: number;
@@ -496,7 +502,17 @@ export type UpdateDocumentsByFunctionOptions = {
  ** Settings
  */
 
-export type FilterableAttributes = string[] | null;
+type GranularFilterableAttribute = {
+  attributePatterns: string[];
+  features: {
+    facetSearch: boolean;
+    filter: { equality: boolean; comparison: boolean };
+  };
+};
+
+export type FilterableAttributes =
+  | (string | GranularFilterableAttribute)[]
+  | null;
 export type DistinctAttribute = string | null;
 export type SearchableAttributes = string[] | null;
 export type SortableAttributes = string[] | null;
@@ -541,6 +557,7 @@ export type HuggingFaceEmbedder = {
   revision?: string;
   documentTemplate?: string;
   distribution?: Distribution;
+  pooling?: "useModel" | "forceMean" | "forceCls";
   documentTemplateMaxBytes?: number;
   binaryQuantized?: boolean;
 };
@@ -578,12 +595,19 @@ export type OllamaEmbedder = {
   binaryQuantized?: boolean;
 };
 
+export type CompositeEmbedder = {
+  source: "composite";
+  searchEmbedder: Embedder;
+  indexingEmbedder: Embedder;
+};
+
 export type Embedder =
   | OpenAiEmbedder
   | HuggingFaceEmbedder
   | UserProvidedEmbedder
   | RestEmbedder
   | OllamaEmbedder
+  | CompositeEmbedder
   | null;
 
 export type Embedders = Record<string, Embedder> | null;

tests/__snapshots__/facet_search.test.ts.snap

@@ -17,6 +17,19 @@ exports[`Test on POST search > Admin key: basic facet value search 1`] = `
 }
 `;
 
+exports[`Test on POST search > Admin key: facet value search with exhaustive facet count 1`] = `
+{
+  "facetHits": [
+    {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
 exports[`Test on POST search > Admin key: facet value search with filter 1`] = `
 {
   "facetHits": [
@@ -85,6 +98,19 @@ exports[`Test on POST search > Master key: basic facet value search 1`] = `
 }
 `;
 
+exports[`Test on POST search > Master key: facet value search with exhaustive facet count 1`] = `
+{
+  "facetHits": [
+    {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
 exports[`Test on POST search > Master key: facet value search with filter 1`] = `
 {
   "facetHits": [
@@ -153,6 +179,19 @@ exports[`Test on POST search > Search key: basic facet value search 1`] = `
 }
 `;
 
+exports[`Test on POST search > Search key: facet value search with exhaustive facet count 1`] = `
+{
+  "facetHits": [
+    {
+      "count": 1,
+      "value": "adventure",
+    },
+  ],
+  "facetQuery": "a",
+  "processingTimeMs": 0,
+}
+`;
+
 exports[`Test on POST search > Search key: facet value search with filter 1`] = `
 {
   "facetHits": [

tests/__snapshots__/settings.test.ts.snap

@@ -268,6 +268,7 @@ exports[`Test on settings > Admin key: Update embedders settings  1`] = `
 {% endif %}{% endfor %}",
       "documentTemplateMaxBytes": 400,
       "model": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+      "pooling": "useModel",
       "source": "huggingFace",
     },
   },
@@ -958,6 +959,7 @@ exports[`Test on settings > Master key: Update embedders settings  1`] = `
 {% endif %}{% endfor %}",
       "documentTemplateMaxBytes": 400,
       "model": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+      "pooling": "useModel",
       "source": "huggingFace",
     },
   },

tests/batch.test.ts

@@ -33,11 +33,14 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       const batches = await client.batches.getBatches();
       const batch = await client.batches.getBatch(batches.results[0].uid);
       expect(batch.uid).toEqual(batches.results[0].uid);
+
+      // Can't use toMatchSnapshot because the output changes every time
       expect(batch.details).toBeDefined();
       expect(batch.stats).toHaveProperty("totalNbTasks");
       expect(batch.stats).toHaveProperty("status");
       expect(batch.stats).toHaveProperty("types");
       expect(batch.stats).toHaveProperty("indexUids");
+      expect(batch.stats).toHaveProperty("progressTrace");
       expect(batch.duration).toBeDefined();
       expect(batch.startedAt).toBeDefined();
       expect(batch.finishedAt).toBeDefined();

tests/documents.test.ts

@@ -79,6 +79,18 @@ describe("Documents tests", () => {
         expect(document.id).toBeUndefined();
       });
 
+      test(`${permission} key: Get multiple documents by IDs`, async () => {
+        const client = await getClient(permission);
+        await client.index(indexPk.uid).addDocuments(dataset).waitTask();
+
+        const documents = await client
+          .index(indexPk.uid)
+          .getDocuments<Book>({ ids: [1, 2] });
+
+        expect(documents.results.length).toEqual(2);
+        expect(documents.results.map(({ id }) => id).sort()).toEqual([1, 2]);
+      });
+
       test(`${permission} key: Get documents with string fields`, async () => {
         const client = await getClient(permission);
 

tests/embedders.test.ts

@@ -6,6 +6,8 @@ import {
   BAD_HOST,
   MeiliSearch,
   getClient,
+  getKey,
+  HOST,
 } from "./utils/meilisearch-test-utils.js";
 
 const index = {
@@ -130,6 +132,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
             mean: 0.7,
             sigma: 0.3,
           },
+          pooling: "useModel",
           documentTemplateMaxBytes: 500,
           binaryQuantized: false,
         },
@@ -235,6 +238,51 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       expect(response).toEqual(newEmbedder);
     });
 
+    test(`${permission} key: Update embedders with composite embedder`, async () => {
+      const adminKey = await getKey("Admin");
+
+      // first enable the network endpoint.
+      await fetch(`${HOST}/experimental-features`, {
+        body: JSON.stringify({ compositeEmbedders: true }),
+        headers: {
+          Authorization: `Bearer ${adminKey}`,
+          "Content-Type": "application/json",
+        },
+        method: "PATCH",
+      });
+
+      const client = await getClient(permission);
+      const embedders = {
+        default: {
+          source: "composite",
+          searchEmbedder: {
+            source: "huggingFace",
+            model:
+              "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+            pooling: "useModel",
+          },
+          indexingEmbedder: {
+            source: "huggingFace",
+            model:
+              "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
+            documentTemplate: "{{doc.title}}",
+            pooling: "useModel",
+            documentTemplateMaxBytes: 500,
+          },
+        },
+      } satisfies Embedders;
+
+      const task = await client
+        .index(index.uid)
+        .updateEmbedders(embedders)
+        .waitTask();
+      const response: Embedders = await client.index(index.uid).getEmbedders();
+
+      const processedTask = await client.tasks.getTask(task.uid);
+      expect(processedTask.status).toEqual("succeeded");
+      expect(response).toEqual(embedders);
+    });
+
     test(`${permission} key: Reset embedders`, async () => {
       const client = await getClient(permission);
       await client.index(index.uid).resetEmbedders().waitTask();

tests/facet_search.test.ts

@@ -98,6 +98,21 @@ describe.each([
     // @TODO: This is flaky, processingTimeMs is not guaranteed
     expect(response).toMatchSnapshot();
   });
+
+  test(`${permission} key: facet value search with exhaustive facet count`, async () => {
+    const client = await getClient(permission);
+
+    const params = {
+      facetName: "genres",
+      facetQuery: "a",
+      q: "Alice",
+      exhaustiveFacetCount: true,
+    };
+    const response = await client.index(index.uid).searchForFacetValues(params);
+
+    // @TODO: This is flaky, processingTimeMs is not guaranteed
+    expect(response).toMatchSnapshot();
+  });
 });
 
 afterAll(() => {

tests/filterable_attributes.test.ts

@@ -53,6 +53,27 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
       expect(response?.sort()).toEqual([]);
     });
 
+    test(`${permission} key: Update attributes with granular attribute syntax`, async () => {
+      const client = await getClient(permission);
+      const newFilterableAttributes = [
+        "author",
+        {
+          attributePatterns: ["genre"],
+          features: {
+            facetSearch: true,
+            filter: { equality: true, comparison: false },
+          },
+        },
+      ];
+      await client
+        .index(index.uid)
+        .updateFilterableAttributes(newFilterableAttributes)
+        .waitTask();
+
+      const response = await client.index(index.uid).getFilterableAttributes();
+      expect(response).toEqual(newFilterableAttributes);
+    });
+
     test(`${permission} key: Reset attributes for filtering`, async () => {
       const client = await getClient(permission);
       await client.index(index.uid).resetFilterableAttributes().waitTask();