Welcome to the Meilisearch specifications!

# Separators Setting API

# 1. Summary

This specification describes the separatorTokens and nonSeparatorTokens index setting API endpoints.

# 2. Motivation

N/A

# 3. Functional Specification

# 3.1. Explanations

# 3.1.1. Usage Examples

Request payload PUT- /indexes/articles/settings/separator-tokens

["|", "/", "&sep"]

Request payload PUT- /indexes/articles/settings/non-separator-tokens

["@", "#"]

# 3.2. Global Settings API Endpoints Definition

separatorTokens and nonSeparatorTokens are sub-resources of /indexes/:index_uid/settings.

See Settings API.

# 3.3. API Endpoints Definition

Manipulate the separatorTokens and nonSeparatorTokens settings of a Meilisearch index.

# 3.3.1. GET

# 3.3.1.1. GET - indexes/:index_uid/settings/separator-tokens

Fetch the separatorTokens setting of a Meilisearch index.

Response Definition:

  • Type: Array of String
  • Default: []
# 3.3.1.2. GET - indexes/:index_uid/settings/non-separator-tokens

Fetch the nonSeparatorTokens setting of a Meilisearch index.

Response Definition:

  • Type: Array of String
  • Default: []
# 3.3.1.3. Errors
  • 🔴 Sending an invalid index uid format for the :index_uid path parameter returns an invalid_index_uid error.
  • 🔴 If the requested index_uid does not exist, the API returns an index_not_found error.

# 3.3.2. PUT

# 3.3.2.1. PUT - indexes/:index_uid/settings/separator-tokens

Modify the separatorTokens setting of a Meilisearch index.

# 3.3.2.1.1. Request Payload Definition
  • Type: Array of String / null

Setting null is equivalent to using the 3.3.3.1. DELETE - indexes/:index_uid/settings/separator-tokens API endpoint.

# 3.3.2.1.2. Response Definition

When the request is successful, Meilisearch returns the HTTP code 202 Accepted. The response's content is the summarized representation of the received asynchronous task.

See Summarized task Object for 202 Accepted.

# 3.3.2.2. PUT - indexes/:index_uid/settings/non-separator-tokens

Modify the nonSeparatorTokens setting of a Meilisearch index.

# 3.3.2.2.1. Request Payload Definition
  • Type: Array of String / null

Setting null is equivalent to using the 3.3.3.2. DELETE - indexes/:index_uid/settings/non-separator-tokens API endpoint.

# 3.3.2.2.2. Response Definition

When the request is successful, Meilisearch returns the HTTP code 202 Accepted. The response's content is the summarized representation of the received asynchronous task.

See Summarized task Object for 202 Accepted.

# 3.3.2.3. Errors
# 3.3.2.3.1. Async Errors

Otherwise, Meilisearch will create the index in a lazy way. See 3.2.2.4. Lazy Index Creation.

# 3.3.2.4. Lazy Index Creation

If the requested index_uid does not exist, and the authorization layer allows it (See 3.3.2.3.1. Async Errors), Meilisearch will create the index when the related asynchronous task resource is executed. See 3.3.2.2. Response Definition.

# 3.3.3. DELETE

# 3.3.3.1 DELETE - indexes/:index_uid/settings/separator-tokens

Reset the separatorTokens setting of a Meilisearch index to the default value [].

# 3.3.3.1.1. Response Definition

When the request is in a successful state, Meilisearch returns the HTTP code 202 Accepted. The response's content is the summarized representation of the received asynchronous task.

See Summarized task Object for 202 Accepted.

# 3.3.3.2 DELETE - indexes/:index_uid/settings/non-separator-tokens

Reset the nonSeparatorTokens setting of a Meilisearch index to the default value [].

# 3.3.3.2.1. Response Definition

When the request is in a successful state, Meilisearch returns the HTTP code 202 Accepted. The response's content is the summarized representation of the received asynchronous task.

See Summarized task Object for 202 Accepted.

# 3.3.3.3. Errors
  • 🔴 Sending an invalid index uid format for the :index_uid path parameter returns an invalid_index_uid error.
# 3.3.3.3.1. Asynchronous Index Not Found Error

# 3.3.4. General Errors

These errors apply to all endpoints described here.

# 3.3.4.1 Auth Errors

The auth layer can return the following errors if Meilisearch is secured (a master-key is defined).

  • 🔴 Accessing this route without the Authorization header returns a missing_authorization_header error.
  • 🔴 Accessing this route with a key that does not have permissions (i.e. other than the master-key) returns an invalid_api_key error.

# 4. Technical Details

# 4.1. Triggering Documents Re-Indexing

Meilisearch favors search speed and makes a trade-off on indexing speed by computing internal data structures to get search results as fast as possible.

Modifying this index setting cause documents to be re-indexed.

# 5. Future Possibilities

n/a

← Settings api →