v0.28: Faceting settings

.code-samples.meilisearch.yaml

@@ -183,6 +183,9 @@ update_settings_1: |-
           "twoTypos": 10
         },
         "disableOnAttributes": ["title"]
+      },
+      "faceting": {
+        "maxValuesPerFacet": 200
       }
     }'
 reset_settings_1: |-
@@ -958,3 +961,16 @@ getting_started_typo_tolerance: |-
     --data-binary '{
       "minWordSizeForTypos": { "oneTypo": 4 }
   }'
+get_faceting_settings_1: |-
+  curl \
+    -X GET 'http://localhost:7700/indexes/books/settings/faceting'
+update_faceting_settings_1: |-
+  curl \
+    -X POST 'http://localhost:7700/indexes/books/settings/faceting' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "maxValuesPerFacet": 2
+    }'
+reset_faceting_settings_1: |-
+  curl \
+    -X DELETE 'http://localhost:7700/indexes/books/settings/faceting'

.vuepress/config.js

@@ -323,6 +323,7 @@ module.exports = {
                 },
                 '/reference/api/displayed_attributes',
                 '/reference/api/distinct_attribute',
+                '/reference/api/faceting',
                 '/reference/api/filterable_attributes',
                 '/reference/api/ranking_rules',
                 '/reference/api/searchable_attributes',

.vuepress/public/sample-template.yaml

@@ -146,3 +146,6 @@ updating_guide_retrieve_documents_old: |-
 updating_guide_update_settings_old: |-
 updating_guide_add_documents_old: |-
 getting_started_typo_tolerance: |-
+get_faceting_settings_1: |-
+update_faceting_settings_1: |-
+reset_faceting_settings_1: |-

reference/api/faceting.md

@@ -0,0 +1,94 @@
+# Faceting
+
+_Child route of the [settings route](/reference/api/settings.md)._
+
+This route allows you to configure the faceting settings for an index.
+
+Faceting settings can also be updated directly through the [global settings route](/reference/api/settings.md#update-settings) along with the other settings.
+
+To learn more about filtering and faceting, refer to our [dedicated guide](/learn/advanced/filtering_and_faceted_search.md).
+
+::: warning
+Updating the settings means overwriting the default settings of Meilisearch. You can reset to default values using the `DELETE` routes.
+:::
+
+## Get faceting settings
+
+<RouteHighlighter method="GET" route="/indexes/{index_uid}/settings/faceting"/>
+
+Get the faceting settings of an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
+
+### Example
+
+<CodeSamples id="get_faceting_settings_1" />
+
+#### Response: `200 OK`
+
+```json
+{
+  "maxValuesPerFacet": 100
+}
+```
+
+### Returned fields
+
+#### `maxValuesPerFacet`
+
+Maximum number of facet values returned for each facet.
+
+## Update faceting settings
+
+<RouteHighlighter method="PATCH" route="/indexes/{index_uid}/settings/faceting"/>
+
+Partially update the faceting settings for an index. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
+
+### Body
+
+#### `maxValuesPerFacet`
+
+**Type:** integer
+**Default value:** `100`
+
+Configure the maximum number of facet values returned for each facet. Values are alphabetically sorted.
+
+For example, suppose a query's search results contain a total of three values for a `colors` facet: `blue`, `green`, and `red`. If you set `maxValuesPerFacet` to `2`, Meilisearch will only return `blue` and `green` in the response body's `facetDistribution` object.
+
+#### Example
+
+<CodeSamples id="update_faceting_settings_1" />
+
+#### Response: `202 Accepted`
+
+```json
+{
+  "uid": 1,
+  "indexUid": "books",
+  "status": "enqueued",
+  "type": "settingsUpdate",
+  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
+}
+```
+
+You can use the returned `uid` to get more details on [the status of the task](/reference/api/tasks.md#get-task).
+
+## Reset faceting settings
+
+Reset an index's faceting settings to their default value. The index [`uid`](/learn/core_concepts/indexes.md#index-uid) is required.
+
+#### Example
+
+<CodeSamples id="reset_faceting_settings_1" />
+
+#### Response: `200 OK`
+
+```json
+{
+  "uid": 1,
+  "indexUid": "books",
+  "status": "enqueued",
+  "type": "settingsUpdate",
+  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
+}
+```
+
+You can use the returned `uid` to get more details on [the status of the task](/reference/api/tasks.md#get-task).