Merge branch 'main' into CaroFG-patch-2

Author: guimachiavelli

.code-samples.meilisearch.yaml

@@ -2,7 +2,7 @@
 # Every example written here will be automatically fetched by
 # the documentation on build
 ---
-## BEGIN /references/api 
+## BEGIN /references/api
 # get_indexes_indexUid
 get_one_index_1: |-
   curl \
@@ -68,7 +68,7 @@ add_or_update_documents_1: |-
 delete_all_documents_1: |-
   curl \
     -X DELETE 'MEILISEARCH_URL/indexes/movies/documents'
-# delete_indexes_indexUid_documentId
+# delete_indexes_indexUid_documents_documentId
 delete_one_document_1: |-
   curl \
     -X DELETE 'MEILISEARCH_URL/indexes/movies/documents/25684'
@@ -581,6 +581,24 @@ update_vector_store_settings_1: |-
 reset_vector_store_settings_1: |-
   curl \
     -X DELETE 'MEILISEARCH_URL/indexes/INDEX_UID/settings/vector-store'
+# get_indexes_indexUid_settings_chat
+get_chat_settings_1: |-
+  curl \
+    -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
+# patch_indexes_indexUid_settings_chat
+update_chat_settings_1: |-
+  curl \
+    -X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "description": "An index of movies.",
+      "documentTemplate": "A movie titled '{{doc.title}}' released in {{ doc.release_date }}",
+      "documentTemplateMaxBytes": 400
+    }'
+# delete_indexes_indexUid_settings_chat
+reset_chat_settings_1: |-
+  curl \
+    -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
 ### END settings + subroutes
 
 # post_dumps
@@ -655,6 +673,18 @@ delete_documents_by_filter_1: |-
     --data-binary '{
       "filter": "genres = action OR genres = adventure"
     }'
+# post_indexes_indexUid_documents_edit
+edit_documents_by_function_1: |-
+  curl \
+    -X POST 'MEILISEARCH_URL/indexes/movies/documents/edit' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "function": "doc.new_field = `a]new[value`",
+      "filter": "id > 3000",
+      "context": {
+        "max_title_length": 10
+      }
+    }'
 # get_experimental_features
 get_experimental_features_1: |-
   curl \
@@ -1740,7 +1770,7 @@ multi_search_remote_federated_1: |-
           }
         }
       ]
-  
+
 search_parameter_reference_media_1: |-
   curl \
   -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \

guides/docker.mdx

@@ -12,7 +12,7 @@ Docker is a tool that bundles applications into containers. Docker containers en
 Docker containers are distributed in images. To use Meilisearch, use the `docker pull` command to download a Meilisearch image:
 
 ```sh
-docker pull getmeili/meilisearch:v1.16
+docker pull getmeili/meilisearch:latest
 ```
 
 Meilisearch deploys a new Docker image with every release of the engine. Each image is tagged with the corresponding Meilisearch version, indicated in the above example by the text following the `:` symbol. You can see [the full list of available Meilisearch Docker images](https://hub.docker.com/r/getmeili/meilisearch/tags#!) on Docker Hub.
@@ -29,7 +29,7 @@ After completing the previous step, use `docker run` to launch the Meilisearch i
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16
+  getmeili/meilisearch:latest
 ```
 
 ### Configure Meilisearch
@@ -45,7 +45,7 @@ docker run -it --rm \
   -p 7700:7700 \
   -e MEILI_MASTER_KEY='MASTER_KEY'\
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16
+  getmeili/meilisearch:latest
 ```
 
 #### Passing instance options with CLI arguments
@@ -56,7 +56,7 @@ If you want to pass command-line arguments to Meilisearch with Docker, you must
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16 \
+  getmeili/meilisearch:latest \
   meilisearch --master-key="MASTER_KEY"
 ```
 
@@ -74,7 +74,7 @@ To keep your data intact between reboots, specify a dedicated volume by running
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16
+  getmeili/meilisearch:latest 
 ```
 
 The example above uses `$(pwd)/meili_data`, which is a directory in the host machine. Depending on your OS, mounting volumes from the host to the container might result in performance loss and is only recommended when developing your application.
@@ -89,7 +89,7 @@ To import a dump, use Meilisearch's `--import-dump` command-line option and spec
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16 \
+  getmeili/meilisearch:latest \
   meilisearch --import-dump /meili_data/dumps/20200813-042312213.dump
 ```
 
@@ -109,7 +109,7 @@ To generate a Meilisearch snapshot with Docker, launch Meilisearch with `--sched
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16 \
+  getmeili/meilisearch:latest \
   meilisearch --schedule-snapshot --snapshot-dir /meili_data/snapshots
 ```
 
@@ -121,7 +121,7 @@ To import a snapshot, launch Meilisearch with the `--import-snapshot` option:
 docker run -it --rm \
   -p 7700:7700 \
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.16 \
+  getmeili/meilisearch:latest \
   meilisearch --import-snapshot /meili_data/snapshots/data.ms.snapshot
 ```
 

reference/api/search.mdx

@@ -1268,6 +1268,10 @@ If `q` is missing and `semanticRatio` is explicitly set to `0`, Meilisearch perf
 
 Return document and query embeddings with search results. If `true`, Meilisearch will display vector data in each [document's `_vectors` field](/reference/api/documents#_vectors).
 
+<Warning>
+`_vectors` must be included in the [displayedAttributes](/reference/api/settings#displayed-attributes) list to be returned in the response.
+</Warning>
+
 #### Example
 
 <CodeSamplesSearchParameterReferenceRetrieveVectors1 />

snippets/samples/code_samples_edit_documents_by_function_1.mdx

@@ -0,0 +1,15 @@
+<CodeGroup>
+
+```bash cURL
+curl \
+  -X POST 'MEILISEARCH_URL/indexes/movies/documents/edit' \
+  -H 'Content-Type: application/json' \
+  --data-binary '{
+    "function": "doc.new_field = `a]new[value`",
+    "filter": "id > 3000",
+    "context": {
+      "max_title_length": 10
+    }
+  }'
+```
+</CodeGroup>

snippets/samples/code_samples_get_chat_settings_1.mdx

@@ -0,0 +1,7 @@
+<CodeGroup>
+
+```bash cURL
+curl \
+  -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
+```
+</CodeGroup>

snippets/samples/code_samples_get_network_1.mdx

@@ -5,6 +5,10 @@ curl \
   -X GET 'MEILISEARCH_URL/network'
 ```
 
+```python Python
+client.get_all_networks()
+```
+
 ```php PHP
 $client->getNetwork();
 ```

snippets/samples/code_samples_reset_chat_settings_1.mdx

@@ -0,0 +1,7 @@
+<CodeGroup>
+
+```bash cURL
+curl \
+  -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat'
+```
+</CodeGroup>

snippets/samples/code_samples_update_chat_settings_1.mdx

@@ -0,0 +1,13 @@
+<CodeGroup>
+
+```bash cURL
+curl \
+  -X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/chat' \
+  -H 'Content-Type: application/json' \
+  --data-binary '{
+    "description": "An index of movies.",
+    "documentTemplate": "A movie titled '{{doc.title}}' released in {{ doc.release_date }}",
+    "documentTemplateMaxBytes": 400
+  }'
+```
+</CodeGroup>

snippets/samples/code_samples_update_network_1.mdx

@@ -19,6 +19,17 @@ curl \
   }'
 ```
 
+```python Python
+client.add_or_update_networks({
+    "remotes": {
+        "http://localhost:7700": {
+            "searchApiKey": "masterKey"
+        }
+    },
+    "leader": None
+})
+```
+
 ```php PHP
 $client->updateNetwork([
   'self' => 'ms-00',