Skip to content

v1.14 #3206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Apr 14, 2025
Merged

v1.14 #3206

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .code-samples.meilisearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,17 @@ update_filterable_attributes_1: |-
-H 'Content-Type: application/json' \
--data-binary '[
"genres",
"director"
"director",
{
"attributePatterns": ["*_ratings"],
"features": {
"facetSearch": false,
"filters": {
"equality": true,
"comparison": false
}
}
}
]'
reset_filterable_attributes_1: |-
curl \
Expand Down
9 changes: 7 additions & 2 deletions assets/misc/meilisearch-collection-postman.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info": {
"_postman_id": "11c3d322-31f0-4b54-b0c7-138b5efc7f6b",
"name": "Meilisearch v1.13",
"_postman_id": "b321d331-d809-4909-8e49-e29c8d749d32",
"name": "Meilisearch v1.14",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "25294324"
},
Expand Down Expand Up @@ -101,6 +101,11 @@
"key": "filter",
"value": "genre=\"adventure\"",
"disabled": true
},
{
"key": "ids",
"value": "1,2",
"disabled": true
}
]
}
Expand Down
16 changes: 8 additions & 8 deletions guides/docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.13
docker pull getmeili/meilisearch:v1.14
```

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.
Expand All @@ -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.13
getmeili/meilisearch:v1.14
```

### Configure Meilisearch
Expand All @@ -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.13
getmeili/meilisearch:v1.14
```

#### Passing instance options with CLI arguments
Expand All @@ -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.13 \
getmeili/meilisearch:v1.14 \
meilisearch --master-key="MASTER_KEY"
```

Expand All @@ -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.13
getmeili/meilisearch:v1.14
```

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.
Expand All @@ -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.13 \
getmeili/meilisearch:v1.14 \
meilisearch --import-dump /meili_data/dumps/20200813-042312213.dump
```

Expand All @@ -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.13 \
getmeili/meilisearch:v1.14 \
meilisearch --schedule-snapshot --snapshot-dir /meili_data/snapshots
```

Expand All @@ -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.13 \
getmeili/meilisearch:v1.14 \
meilisearch --import-snapshot /meili_data/snapshots/data.ms.snapshot
```

Expand Down
2 changes: 2 additions & 0 deletions learn/resources/experimental_features_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ Activating or deactivating experimental features this way does not require you t
| [Edit documents with function](/reference/api/documents#update-documents-with-function) | Use a RHAI function to edit documents directly in the Meilisearch database | API route |
| [`/network` route](/reference/api/network) | Enable `/network` route | API route |
| [Dumpless upgrade](/learn/self_hosted/configure_meilisearch_at_launch#dumpless-upgrade) | Upgrade Meilisearch without generating a dump | API route |
| [Composite embedders](/reference/api/settings#composite-embedders) | Enable composite embedders | API route |
| [Search query embedding cache](/learn/self_hosted/configure_meilisearch_at_launch#search-query-embedding-cache) | Enable a cache for search query embeddings | CLI flag or environment variable |
5 changes: 4 additions & 1 deletion learn/resources/telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `sortable_attributes.has_geo` | `true` if `_geo` is set as a sortable attribute | true
| `filterable_attributes.total` | Number of filterable attributes | 3
| `filterable_attributes.has_geo` | `true` if `_geo` is set as a filterable attribute | false
| `filterable_attributes.has_patterns` | `true` if `filterableAttributes` uses `attributePatterns` | true
| `searchable_attributes.total` | Number of searchable attributes | 4
| `searchable_attributes.with_wildcard` | `true` if `*` is specified as a searchable attribute | false
| `per_task_uid` | `true` if a `uids` is used to fetch a particular task resource | true
Expand Down Expand Up @@ -220,9 +221,11 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `indexes.total_single_index` | The total number of calls when only one index is queried | 2007
| `matching_strategy.most_used_strategy` | Most used word matching strategy | last
| `infos.with_configuration_file` | `true` if the instance is launched with a configuration file | false
| `infos.experimental_composite_embedders` | `true` if the `compositeEmbedders` feature is set to `true` for this instance | false
| `infos.experimental_contains_filter` | `true` if the `containsFilter` experimental feature is enabled | false
| `infos.experimental_edit_documents_by_function` | `true` if the `editDocumentsByFunction` experimental feature is enabled | false
| `infos.experimental_enable_metrics` | `true` if `--experimental-enable-metrics` is specified at launch | false
| `infos.experimental_embedding_cache_entries` | Size of configured embedding cache | 100
| `infos.experimental_replication_parameters` | `true` if `--experimental-replication-parameters` is specified at launch | false
| `infos.experimental_reduce_indexing_memory_usage` | `true` if `--experimental-reduce-indexing-memory-usage` is specified at launch | false
| `infos.experimental_logs_mode` | `human` or `json` depending on the value specified | human
Expand All @@ -243,7 +246,7 @@ This list is liable to change with every new version of Meilisearch. It's not be
| `scoring.ranking_score_threshold` | `true` if rankingScoreThreshold was specified in an aggregated list of requests | true
| `attributes_to_search_on.total_number_of_uses` | Total number of queries where `attributesToSearchOn` is set | 5
| `vector.max_vector_size` | Highest number of dimensions given for the `vector` parameter in this batch | 1536
| `vector.retrieve_vectors` | `true` if the retrieve_vectors parameter has been used in this batch. | false
| `vector.retrieve_vectors` | `true` if the retrieve_vectors parameter has been used in this batch. | false
| `hybrid.enabled` | `true` if hybrid search been used in the aggregated event | true
| `hybrid.semantic_ratio` | `true` if semanticRatio was used in this batch, otherwise false | false
| `embedders.total` | Numbers of defined embedders | 2
Expand Down
11 changes: 11 additions & 0 deletions learn/self_hosted/configure_meilisearch_at_launch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,17 @@ Sets the maximum size of [accepted payloads](/learn/getting_started/documents#da

Configure the maximum amount of simultaneous search requests. By default, Meilisearch queues up to 1000 search requests at any given moment. This limit exists to prevent Meilisearch from consuming an unbounded amount of RAM.

### Search query embedding cache <NoticeTag type="experimental" label="experimental" />

**Environment variable**: `MEILI_EXPERIMENTAL_EMBEDDING_CACHE_ENTRIES`<br />
**CLI option**: `--experimental-embedding-cache-entries`<br />
**Default value**: `0`<br />
**Expected value**: an integer

Sets the size of the search query embedding cache. By default, Meilisearch generates an embedding for every new search query. When this option is set to an integer bigger than 0, Meilisearch returns a previously generated embedding if it recently performed the same query.

The least recently used entries are evicted first. Embedders with the same configuration share the same cache, even if they were declared in distinct indexes.

### Schedule snapshot creation

**Environment variable**: `MEILI_SCHEDULE_SNAPSHOT`<br />
Expand Down
4 changes: 2 additions & 2 deletions learn/self_hosted/install_meilisearch_locally.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ These commands launch the **latest stable release** of Meilisearch.

```bash
# Fetch the latest version of Meilisearch image from DockerHub
docker pull getmeili/meilisearch:v1.13
docker pull getmeili/meilisearch:v1.14

# Launch Meilisearch in development mode with a master key
docker run -it --rm \
-p 7700:7700 \
-e MEILI_ENV='development' \
-v $(pwd)/meili_data:/meili_data \
getmeili/meilisearch:v1.13
getmeili/meilisearch:v1.14
# Use ${pwd} instead of $(pwd) in PowerShell
```

Expand Down
2 changes: 1 addition & 1 deletion learn/self_hosted/supported_os.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Use [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_s

## Linux

The Meilisearch binary works on all Linux distributions with `amd64/x86_64` or `aarch64/arm64` architecture using glibc 2.31 and later. You can check your glibc version using:
The Meilisearch binary works on all Linux distributions with `amd64/x86_64` or `aarch64/arm64` architecture using glibc 2.35 and later. You can check your glibc version using:

```
ldd --version
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "documentation",
"version": "1.13.0",
"version": "1.14.0",
"description": "",
"main": "index.js",
"dependencies": {},
Expand Down
22 changes: 20 additions & 2 deletions reference/api/batches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ The `/batches` route gives information about the progress of batches of [asynchr
},
"indexUids": {
"INDEX_NAME": 1
}
},
"progressTrace": { … },
"writeChannelCongestion": { … },
"internalDatabaseSizes": { … }
},
"duration": "PT0.250518S",
"startedAt": "2024-12-10T15:20:30.18182Z",
Expand Down Expand Up @@ -103,6 +106,18 @@ List with the `types` of tasks contained in the batch.

List of the number of tasks in the batch separated by the indexes they affect.

#### `progressTrace`

List with full paths for each operation performed in the batch, together with the processing time in human-readable format.

#### `writeChannelCongestion`

Object containing information on write operations computed during indexing. Can be useful when diagnosing performance issues associated with write speeds.

#### `internalDatabaseSizes`

Size of each internal database, including by how much it changed after a batch was processed.

### `duration`

**Type**: String<br />
Expand Down Expand Up @@ -191,7 +206,10 @@ For example, `?uids=0` returns a batch containing the task with a `taskUid` equa
},
"indexUids": {
"INDEX_NAME": 1
}
},
"progressTrace": { … },
"writeChannelCongestion": { … },
"internalDatabaseSizes": { … }
},
"duration": "PT0.110083S",
"startedAt": "2024-12-10T15:49:04.995321Z",
Expand Down
10 changes: 10 additions & 0 deletions reference/api/documents.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Use `offset` and `limit` to browse through documents.
| **`fields`** | Array of strings/`null` | `*` | Document attributes to show (case-sensitive, comma-separated) |
| **`filter`** | String/Array of array of strings/`null` | N/A | Refine results based on attributes in the `filterableAttributes` list |
| **`retrieveVectors`** | Boolean | `false` | Return document vector data with search result |
| **`ids`** | Array of primary keys | `null` | Return documents based on their primary keys |

<Capsule intent="note">
Sending an empty payload (`--data-binary '{}'`) will return all documents in the index.
Expand All @@ -50,6 +51,10 @@ Sending an empty payload (`--data-binary '{}'`) will return all documents in the
| **`limit`** | Integer | Number of documents returned |
| **`total`** | Integer | Total number of documents in the index |

<Capsule intent="note" title="Returned document order">
`/indexes/{index_uid}/documents/fetch` and `/indexes/{index_uid}/documents` responses do not return documents following the order of their primary keys.
</Capsule>

### Example

<CodeSamples id="get_documents_post_1" />
Expand Down Expand Up @@ -118,6 +123,7 @@ Using the query parameters `offset` and `limit`, you can browse through all your
| **`fields`** | `*` | Document attributes to show (case-sensitive, comma-separated) |
| **`filter`** | N/A | Refine results based on attributes in the `filterableAttributes` list |
| **`retrieveVectors`** | `false` | Return document vector data with search result |
| **`ids`** | `null` | Return documents based on their primary keys |

### Response

Expand All @@ -128,6 +134,10 @@ Using the query parameters `offset` and `limit`, you can browse through all your
| **`limit`** | Integer | Number of documents returned |
| **`total`** | Integer | Total number of documents in the index |

<Capsule intent="note" title="Returned document order">
`/indexes/{index_uid}/documents/fetch` and `/indexes/{index_uid}/documents` responses do not return documents following the order of their primary keys.
</Capsule>

### Example

<CodeSamples id="get_documents_1" />
Expand Down
Loading