v1.13 (#3127)

* bump version number

* Update docker version (#3147)

* v1.13: Telemetry (#3149)

* v1.13: Add new fields to `/stats` response (#3152)

* v1.13: Dumpless upgrades (#3138)

* v1.13: AI-powered search breaking changes (#3137)

* update postman collection (#3148)

* v1.13: Add remote federated search documentation (#3144)

---------

Co-authored-by: Tamo <[email protected]>
Co-authored-by: Louis Dureuil <[email protected]>

Author: 3 people

.code-samples.meilisearch.yaml

@@ -1327,18 +1327,6 @@ distinct_attribute_guide_distinct_parameter_1: |-
       "q": "white shirt",
       "distinct": "sku"
     }'
-get_similar_post_1: |-
-  curl \
-    -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/similar' \
-    -H 'Content-Type: application/json' \
-    -H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
-    --data-binary '{
-      "id": TARGET_DOCUMENT_ID,
-      "embedder": "EMBEDDER_NAME"
-    }'
-get_similar_get_1: |-
-  curl \
-    -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/similar?id=TARGET_DOCUMENT_ID&embedder=EMBEDDER_NAME'
 search_parameter_reference_ranking_score_threshold_1: |-
   curl \
   -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
@@ -1372,12 +1360,22 @@ reset_localized_attribute_settings_1: |-
     -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/localized-attributes'
 get_all_batches_1: |-
   curl \
-    -X GET 'http://localhost:7700/batches'
+    -X GET 'http://MEILISEARCH_URL/batches'
 get_batch_1: |-
   curl \
-    -X GET 'http://localhost:7700/batches/BATCH_UID'
-
-### Code samples for experimental features
+    -X GET 'http://MEILISEARCH_URL/batches/BATCH_UID'
+get_similar_post_1: |-
+  curl \
+    -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/similar' \
+    -H 'Content-Type: application/json' \
+    -H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
+    --data-binary '{
+      "id": TARGET_DOCUMENT_ID,
+      "embedder": "EMBEDDER_NAME"
+    }'
+get_similar_get_1: |-
+  curl \
+    -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/similar?id=TARGET_DOCUMENT_ID&embedder=EMBEDDER_NAME'
 get_embedders_1: |-
   curl \
     -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'
@@ -1388,7 +1386,7 @@ update_embedders_1: |-
     --data-binary '{
       "default": {
         "source":  "openAi",
-        "apiKey": "anOpenAiApiKey",
+        "apiKey": "OPEN_AI_API_KEY",
         "model": "text-embedding-3-small",
         "documentTemplate": "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
       }
@@ -1397,7 +1395,7 @@ reset_embedders_1: |-
   curl \
     -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'
 search_parameter_guide_hybrid_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+  curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
     -H 'content-type: application/json' \
     --data-binary '{
       "q": "kitchen utensils",
@@ -1407,14 +1405,14 @@ search_parameter_guide_hybrid_1: |-
       }
     }'
 search_parameter_guide_vector_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+  curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
     -H 'content-type: application/json' \
     --data-binary '{ 
       "vector": [0, 1, 2],
       "embedder": "EMBEDDER_NAME"
     }'
 search_parameter_reference_retrieve_vectors_1: |-
-  curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
+  curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
     -H 'content-type: application/json' \
     --data-binary '{
       "q": "kitchen utensils",
@@ -1423,6 +1421,8 @@ search_parameter_reference_retrieve_vectors_1: |-
         "embedder": "EMBEDDER_NAME"
       }
     }'
+
+### Code samples for experimental features
 experimental_get_metrics_1: |-
   curl \
     -X GET 'MEILISEARCH_URL/metrics'
@@ -1444,3 +1444,46 @@ experimental_post_logs_stream_1: |-
 experimental_delete_logs_stream_1: |-
   curl \
     -X DELETE MEILISEARCH_URL/logs/stream
+multi_search_remote_federated_1: |-
+  curl \
+    -X POST 'MEILISEARCH_URL/multi-search' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "federation": {},
+      "queries": [
+        {
+          "indexUid": "movies",
+          "q": "batman",
+          "federationOptions": {
+            "remote": "ms-00"
+          }
+        },
+        {
+          "indexUid": "movies",
+          "q": "batman",
+          "federationOptions": {
+            "remote": "ms-01"
+          }
+        }
+      ]
+    }'
+get_network_1: |-
+  curl \
+    -X GET 'MEILISEARCH_URL/network'
+update_network_1: |-
+  curl \
+    -X PATCH 'MEILISEARCH_URL/network' \
+    -H 'Content-Type: application/json' \
+    --data-binary '{
+      "self": "ms-00",
+      "remotes": {
+        "ms-00": {
+          "url": "http://INSTANCE_URL",
+          "searchApiKey": "INSTANCE_API_KEY"
+        },
+        "ms-01": {
+          "url": "http://ANOTHER_INSTANCE_URL",
+          "searchApiKey": "ANOTHER_INSTANCE_API_KEY"
+        }
+      }
+    }'

assets/misc/meilisearch-collection-postman.json

@@ -1,7 +1,7 @@
 {
 	"info": {
-		"_postman_id": "cc6bb097-033d-4f65-8704-f10e4e4b10d0",
-		"name": "Meilisearch v1.12",
+		"_postman_id": "11c3d322-31f0-4b54-b0c7-138b5efc7f6b",
+		"name": "Meilisearch v1.13",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
 		"_exporter_id": "25294324"
 	},
@@ -434,6 +434,21 @@
 									"key": "locales",
 									"value": "\"cmn\",\"eng\"",
 									"disabled": true
+								},
+								{
+									"key": "hybrid",
+									"value": "{}",
+									"disabled": true
+								},
+								{
+									"key": "vector",
+									"value": "[0,1,2]",
+									"disabled": true
+								},
+								{
+									"key": "retrieveVectors",
+									"value": "false",
+									"disabled": true
 								}
 							]
 						}
@@ -2730,6 +2745,81 @@
 								}
 							},
 							"response": []
+						},
+						{
+							"name": "Get embedders",
+							"request": {
+								"method": "GET",
+								"header": [],
+								"url": {
+									"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
+									"host": [
+										"{{url}}"
+									],
+									"path": [
+										"indexes",
+										"{{indexUID}}",
+										"settings",
+										"embedders"
+									]
+								}
+							},
+							"response": []
+						},
+						{
+							"name": "Update embedders",
+							"protocolProfileBehavior": {
+								"disabledSystemHeaders": {
+									"content-type": true
+								}
+							},
+							"request": {
+								"method": "PATCH",
+								"header": [
+									{
+										"key": "Content-Type",
+										"value": "application/json",
+										"type": "text"
+									}
+								],
+								"body": {
+									"mode": "raw",
+									"raw": "{\n    \"EMBEDDER_NAME\": {\n        \"source\": \"openAi\",\n        \"apiKey\": \"API_KEY\",\n        \"model\": \"text-embedding-3-small\"\n    }\n}"
+								},
+								"url": {
+									"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
+									"host": [
+										"{{url}}"
+									],
+									"path": [
+										"indexes",
+										"{{indexUID}}",
+										"settings",
+										"embedders"
+									]
+								}
+							},
+							"response": []
+						},
+						{
+							"name": "Reset embedders",
+							"request": {
+								"method": "DELETE",
+								"header": [],
+								"url": {
+									"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
+									"host": [
+										"{{url}}"
+									],
+									"path": [
+										"indexes",
+										"{{indexUID}}",
+										"settings",
+										"embedders"
+									]
+								}
+							},
+							"response": []
 						}
 					]
 				},

config/redirects.json

@@ -633,5 +633,10 @@
     "source": "/docs/guides/deployment/gcp",
     "destination": "/guides/deployment/running_production",
     "permanent": true
+  },
+  {
+    "source": "/docs/learn/ai_powered_search/deactivate_ai_powered_search",
+    "destination": "/docs/learn/ai_powered_search/getting_started_with_ai_search",
+    "permanent": true
   }
 ]

config/sidebar-learn.json

@@ -49,11 +49,6 @@
         "label": "Use AI-powered search with user-provided embeddings",
         "slug": "search_with_user_provided_embeddings"
       },
-      {
-        "source": "learn/ai_powered_search/deactivate_ai_powered_search.mdx",
-        "label": "Deactivate AI-powered search",
-        "slug": "deactivate_ai_powered_search"
-      },
       {
         "source": "learn/ai_powered_search/choose_an_embedder.mdx",
         "label": "Which embedder should I choose?",
@@ -277,6 +272,11 @@
         "label": "Using multi-search to perform a federated search",
         "slug": "performing_federated_search"
       },
+      {
+        "source": "learn/multi_search/implement_sharding.mdx",
+        "label": "Implement sharding with remote federated search",
+        "slug": "implement_sharding"
+      },
       {
         "source": "learn/multi_search/multi_search_vs_federated_search.mdx",
         "label": "Differences between multi-search and federated search",

config/sidebar-reference.json

@@ -28,6 +28,11 @@
         "label": "Multi-search",
         "slug": "multi_search"
       },
+      {
+        "source": "reference/api/network.mdx",
+        "label": "Network",
+        "slug": "network"
+      },
       {
         "source": "reference/api/similar.mdx",
         "label": "Similar documents",

guides/computing_hugging_face_embeddings_gpu.mdx

@@ -47,23 +47,14 @@ cargo build --release --features cuda
 
 This might take a few moments. Once the compiler is done, you should have a CUDA-compatible Meilisearch binary.
 
-## Enable vector search
+## Configure the Hugging Face embedder
 
 Run your freshly compiled binary:
 
 ```sh
 ./meilisearch
 ```
 
-Next, enable the vector store experimental feature:
-
-```sh
-curl \
-  -X PATCH 'MEILISEARCH_URL/experimental-features/' \
-  -H 'Content-Type: application/json'  \
-  --data-binary '{ "vectorStore": true }'
-```
-
 Then add the Hugging Face embedder to your index settings:
 
 ```sh

guides/docker.mdx

@@ -14,7 +14,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.12
+docker pull getmeili/meilisearch:v1.13
 ```
 
 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.
@@ -31,7 +31,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.12
+  getmeili/meilisearch:v1.13
 ```
 
 ### Configure Meilisearch
@@ -47,7 +47,7 @@ docker run -it --rm \
   -p 7700:7700 \
   -e MEILI_MASTER_KEY='MASTER_KEY'\
   -v $(pwd)/meili_data:/meili_data \
-  getmeili/meilisearch:v1.12
+  getmeili/meilisearch:v1.13
 ```
 
 #### Passing instance options with CLI arguments
@@ -58,7 +58,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.12 \
+  getmeili/meilisearch:v1.13 \
   meilisearch --master-key="MASTER_KEY"
 ```
 
@@ -76,7 +76,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.12
+  getmeili/meilisearch:v1.13
 ```
 
 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.
@@ -91,7 +91,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.12 \
+  getmeili/meilisearch:v1.13 \
   meilisearch --import-dump /meili_data/dumps/20200813-042312213.dump
 ```
 
@@ -111,7 +111,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.12 \
+  getmeili/meilisearch:v1.13 \
   meilisearch --schedule-snapshot --snapshot-dir /meili_data/snapshots
 ```
 
@@ -123,7 +123,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.12 \
+  getmeili/meilisearch:v1.13 \
   meilisearch --import-snapshot /meili_data/snapshots/data.ms.snapshot
 ```