Skip to content

Commit 3e8b7a7

Browse files
guimachiavelliirevoiredureuill
authored
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]>
1 parent deb024f commit 3e8b7a7

34 files changed

+938
-331
lines changed

‎.code-samples.meilisearch.yaml

Lines changed: 63 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,18 +1327,6 @@ distinct_attribute_guide_distinct_parameter_1: |-
13271327
"q": "white shirt",
13281328
"distinct": "sku"
13291329
}'
1330-
get_similar_post_1: |-
1331-
curl \
1332-
-X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/similar' \
1333-
-H 'Content-Type: application/json' \
1334-
-H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
1335-
--data-binary '{
1336-
"id": TARGET_DOCUMENT_ID,
1337-
"embedder": "EMBEDDER_NAME"
1338-
}'
1339-
get_similar_get_1: |-
1340-
curl \
1341-
-X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/similar?id=TARGET_DOCUMENT_ID&embedder=EMBEDDER_NAME'
13421330
search_parameter_reference_ranking_score_threshold_1: |-
13431331
curl \
13441332
-X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
@@ -1372,12 +1360,22 @@ reset_localized_attribute_settings_1: |-
13721360
-X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/localized-attributes'
13731361
get_all_batches_1: |-
13741362
curl \
1375-
-X GET 'http://localhost:7700/batches'
1363+
-X GET 'http://MEILISEARCH_URL/batches'
13761364
get_batch_1: |-
13771365
curl \
1378-
-X GET 'http://localhost:7700/batches/BATCH_UID'
1379-
1380-
### Code samples for experimental features
1366+
-X GET 'http://MEILISEARCH_URL/batches/BATCH_UID'
1367+
get_similar_post_1: |-
1368+
curl \
1369+
-X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/similar' \
1370+
-H 'Content-Type: application/json' \
1371+
-H 'Authorization: Bearer DEFAULT_SEARCH_API_KEY' \
1372+
--data-binary '{
1373+
"id": TARGET_DOCUMENT_ID,
1374+
"embedder": "EMBEDDER_NAME"
1375+
}'
1376+
get_similar_get_1: |-
1377+
curl \
1378+
-X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/similar?id=TARGET_DOCUMENT_ID&embedder=EMBEDDER_NAME'
13811379
get_embedders_1: |-
13821380
curl \
13831381
-X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'
@@ -1388,7 +1386,7 @@ update_embedders_1: |-
13881386
--data-binary '{
13891387
"default": {
13901388
"source": "openAi",
1391-
"apiKey": "anOpenAiApiKey",
1389+
"apiKey": "OPEN_AI_API_KEY",
13921390
"model": "text-embedding-3-small",
13931391
"documentTemplate": "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
13941392
}
@@ -1397,7 +1395,7 @@ reset_embedders_1: |-
13971395
curl \
13981396
-X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'
13991397
search_parameter_guide_hybrid_1: |-
1400-
curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
1398+
curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
14011399
-H 'content-type: application/json' \
14021400
--data-binary '{
14031401
"q": "kitchen utensils",
@@ -1407,14 +1405,14 @@ search_parameter_guide_hybrid_1: |-
14071405
}
14081406
}'
14091407
search_parameter_guide_vector_1: |-
1410-
curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
1408+
curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
14111409
-H 'content-type: application/json' \
14121410
--data-binary '{
14131411
"vector": [0, 1, 2],
14141412
"embedder": "EMBEDDER_NAME"
14151413
}'
14161414
search_parameter_reference_retrieve_vectors_1: |-
1417-
curl -X POST 'localhost:7700/indexes/INDEX_NAME/search' \
1415+
curl -X POST 'MEILISEARCH_URL/indexes/INDEX_NAME/search' \
14181416
-H 'content-type: application/json' \
14191417
--data-binary '{
14201418
"q": "kitchen utensils",
@@ -1423,6 +1421,8 @@ search_parameter_reference_retrieve_vectors_1: |-
14231421
"embedder": "EMBEDDER_NAME"
14241422
}
14251423
}'
1424+
1425+
### Code samples for experimental features
14261426
experimental_get_metrics_1: |-
14271427
curl \
14281428
-X GET 'MEILISEARCH_URL/metrics'
@@ -1444,3 +1444,46 @@ experimental_post_logs_stream_1: |-
14441444
experimental_delete_logs_stream_1: |-
14451445
curl \
14461446
-X DELETE MEILISEARCH_URL/logs/stream
1447+
multi_search_remote_federated_1: |-
1448+
curl \
1449+
-X POST 'MEILISEARCH_URL/multi-search' \
1450+
-H 'Content-Type: application/json' \
1451+
--data-binary '{
1452+
"federation": {},
1453+
"queries": [
1454+
{
1455+
"indexUid": "movies",
1456+
"q": "batman",
1457+
"federationOptions": {
1458+
"remote": "ms-00"
1459+
}
1460+
},
1461+
{
1462+
"indexUid": "movies",
1463+
"q": "batman",
1464+
"federationOptions": {
1465+
"remote": "ms-01"
1466+
}
1467+
}
1468+
]
1469+
}'
1470+
get_network_1: |-
1471+
curl \
1472+
-X GET 'MEILISEARCH_URL/network'
1473+
update_network_1: |-
1474+
curl \
1475+
-X PATCH 'MEILISEARCH_URL/network' \
1476+
-H 'Content-Type: application/json' \
1477+
--data-binary '{
1478+
"self": "ms-00",
1479+
"remotes": {
1480+
"ms-00": {
1481+
"url": "http://INSTANCE_URL",
1482+
"searchApiKey": "INSTANCE_API_KEY"
1483+
},
1484+
"ms-01": {
1485+
"url": "http://ANOTHER_INSTANCE_URL",
1486+
"searchApiKey": "ANOTHER_INSTANCE_API_KEY"
1487+
}
1488+
}
1489+
}'

‎assets/misc/meilisearch-collection-postman.json

Lines changed: 92 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
3-
"_postman_id": "cc6bb097-033d-4f65-8704-f10e4e4b10d0",
4-
"name": "Meilisearch v1.12",
3+
"_postman_id": "11c3d322-31f0-4b54-b0c7-138b5efc7f6b",
4+
"name": "Meilisearch v1.13",
55
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
66
"_exporter_id": "25294324"
77
},
@@ -434,6 +434,21 @@
434434
"key": "locales",
435435
"value": "\"cmn\",\"eng\"",
436436
"disabled": true
437+
},
438+
{
439+
"key": "hybrid",
440+
"value": "{}",
441+
"disabled": true
442+
},
443+
{
444+
"key": "vector",
445+
"value": "[0,1,2]",
446+
"disabled": true
447+
},
448+
{
449+
"key": "retrieveVectors",
450+
"value": "false",
451+
"disabled": true
437452
}
438453
]
439454
}
@@ -2730,6 +2745,81 @@
27302745
}
27312746
},
27322747
"response": []
2748+
},
2749+
{
2750+
"name": "Get embedders",
2751+
"request": {
2752+
"method": "GET",
2753+
"header": [],
2754+
"url": {
2755+
"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
2756+
"host": [
2757+
"{{url}}"
2758+
],
2759+
"path": [
2760+
"indexes",
2761+
"{{indexUID}}",
2762+
"settings",
2763+
"embedders"
2764+
]
2765+
}
2766+
},
2767+
"response": []
2768+
},
2769+
{
2770+
"name": "Update embedders",
2771+
"protocolProfileBehavior": {
2772+
"disabledSystemHeaders": {
2773+
"content-type": true
2774+
}
2775+
},
2776+
"request": {
2777+
"method": "PATCH",
2778+
"header": [
2779+
{
2780+
"key": "Content-Type",
2781+
"value": "application/json",
2782+
"type": "text"
2783+
}
2784+
],
2785+
"body": {
2786+
"mode": "raw",
2787+
"raw": "{\n \"EMBEDDER_NAME\": {\n \"source\": \"openAi\",\n \"apiKey\": \"API_KEY\",\n \"model\": \"text-embedding-3-small\"\n }\n}"
2788+
},
2789+
"url": {
2790+
"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
2791+
"host": [
2792+
"{{url}}"
2793+
],
2794+
"path": [
2795+
"indexes",
2796+
"{{indexUID}}",
2797+
"settings",
2798+
"embedders"
2799+
]
2800+
}
2801+
},
2802+
"response": []
2803+
},
2804+
{
2805+
"name": "Reset embedders",
2806+
"request": {
2807+
"method": "DELETE",
2808+
"header": [],
2809+
"url": {
2810+
"raw": "{{url}}/indexes/{{indexUID}}/settings/embedders",
2811+
"host": [
2812+
"{{url}}"
2813+
],
2814+
"path": [
2815+
"indexes",
2816+
"{{indexUID}}",
2817+
"settings",
2818+
"embedders"
2819+
]
2820+
}
2821+
},
2822+
"response": []
27332823
}
27342824
]
27352825
},

‎config/redirects.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,5 +633,10 @@
633633
"source": "/docs/guides/deployment/gcp",
634634
"destination": "/guides/deployment/running_production",
635635
"permanent": true
636+
},
637+
{
638+
"source": "/docs/learn/ai_powered_search/deactivate_ai_powered_search",
639+
"destination": "/docs/learn/ai_powered_search/getting_started_with_ai_search",
640+
"permanent": true
636641
}
637642
]

‎config/sidebar-learn.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,6 @@
4949
"label": "Use AI-powered search with user-provided embeddings",
5050
"slug": "search_with_user_provided_embeddings"
5151
},
52-
{
53-
"source": "learn/ai_powered_search/deactivate_ai_powered_search.mdx",
54-
"label": "Deactivate AI-powered search",
55-
"slug": "deactivate_ai_powered_search"
56-
},
5752
{
5853
"source": "learn/ai_powered_search/choose_an_embedder.mdx",
5954
"label": "Which embedder should I choose?",
@@ -277,6 +272,11 @@
277272
"label": "Using multi-search to perform a federated search",
278273
"slug": "performing_federated_search"
279274
},
275+
{
276+
"source": "learn/multi_search/implement_sharding.mdx",
277+
"label": "Implement sharding with remote federated search",
278+
"slug": "implement_sharding"
279+
},
280280
{
281281
"source": "learn/multi_search/multi_search_vs_federated_search.mdx",
282282
"label": "Differences between multi-search and federated search",

‎config/sidebar-reference.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@
2828
"label": "Multi-search",
2929
"slug": "multi_search"
3030
},
31+
{
32+
"source": "reference/api/network.mdx",
33+
"label": "Network",
34+
"slug": "network"
35+
},
3136
{
3237
"source": "reference/api/similar.mdx",
3338
"label": "Similar documents",

‎guides/computing_hugging_face_embeddings_gpu.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,14 @@ cargo build --release --features cuda
4747

4848
This might take a few moments. Once the compiler is done, you should have a CUDA-compatible Meilisearch binary.
4949

50-
## Enable vector search
50+
## Configure the Hugging Face embedder
5151

5252
Run your freshly compiled binary:
5353

5454
```sh
5555
./meilisearch
5656
```
5757

58-
Next, enable the vector store experimental feature:
59-
60-
```sh
61-
curl \
62-
-X PATCH 'MEILISEARCH_URL/experimental-features/' \
63-
-H 'Content-Type: application/json' \
64-
--data-binary '{ "vectorStore": true }'
65-
```
66-
6758
Then add the Hugging Face embedder to your index settings:
6859

6960
```sh

‎guides/docker.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Docker is a tool that bundles applications into containers. Docker containers en
1414
Docker containers are distributed in images. To use Meilisearch, use the `docker pull` command to download a Meilisearch image:
1515

1616
```sh
17-
docker pull getmeili/meilisearch:v1.12
17+
docker pull getmeili/meilisearch:v1.13
1818
```
1919

2020
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
3131
docker run -it --rm \
3232
-p 7700:7700 \
3333
-v $(pwd)/meili_data:/meili_data \
34-
getmeili/meilisearch:v1.12
34+
getmeili/meilisearch:v1.13
3535
```
3636

3737
### Configure Meilisearch
@@ -47,7 +47,7 @@ docker run -it --rm \
4747
-p 7700:7700 \
4848
-e MEILI_MASTER_KEY='MASTER_KEY'\
4949
-v $(pwd)/meili_data:/meili_data \
50-
getmeili/meilisearch:v1.12
50+
getmeili/meilisearch:v1.13
5151
```
5252

5353
#### Passing instance options with CLI arguments
@@ -58,7 +58,7 @@ If you want to pass command-line arguments to Meilisearch with Docker, you must
5858
docker run -it --rm \
5959
-p 7700:7700 \
6060
-v $(pwd)/meili_data:/meili_data \
61-
getmeili/meilisearch:v1.12 \
61+
getmeili/meilisearch:v1.13 \
6262
meilisearch --master-key="MASTER_KEY"
6363
```
6464

@@ -76,7 +76,7 @@ To keep your data intact between reboots, specify a dedicated volume by running
7676
docker run -it --rm \
7777
-p 7700:7700 \
7878
-v $(pwd)/meili_data:/meili_data \
79-
getmeili/meilisearch:v1.12
79+
getmeili/meilisearch:v1.13
8080
```
8181

8282
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
9191
docker run -it --rm \
9292
-p 7700:7700 \
9393
-v $(pwd)/meili_data:/meili_data \
94-
getmeili/meilisearch:v1.12 \
94+
getmeili/meilisearch:v1.13 \
9595
meilisearch --import-dump /meili_data/dumps/20200813-042312213.dump
9696
```
9797

@@ -111,7 +111,7 @@ To generate a Meilisearch snapshot with Docker, launch Meilisearch with `--sched
111111
docker run -it --rm \
112112
-p 7700:7700 \
113113
-v $(pwd)/meili_data:/meili_data \
114-
getmeili/meilisearch:v1.12 \
114+
getmeili/meilisearch:v1.13 \
115115
meilisearch --schedule-snapshot --snapshot-dir /meili_data/snapshots
116116
```
117117

@@ -123,7 +123,7 @@ To import a snapshot, launch Meilisearch with the `--import-snapshot` option:
123123
docker run -it --rm \
124124
-p 7700:7700 \
125125
-v $(pwd)/meili_data:/meili_data \
126-
getmeili/meilisearch:v1.12 \
126+
getmeili/meilisearch:v1.13 \
127127
meilisearch --import-snapshot /meili_data/snapshots/data.ms.snapshot
128128
```
129129

0 commit comments

Comments
 (0)