Skip to main content
PATCH
/
indexes
/
{index_uid}
/
settings
/
chat
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
  }'
{
  "taskUid": 147,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-08-08T17:05:55.791772Z"
}

Authorizations

​
Authorization
string
header
required

An API key is a token that you provide when making API calls. Read more about how to secure your project.

Include the API key to the Authorization header, for instance:

-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'

If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:

const client = new MeiliSearch({
  host: 'MEILISEARCH_URL',
  apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'
});

Path Parameters

​
index_uid
string
required

Unique identifier of the index.

Body

application/json

Chat (conversation) settings: how the index is described to the LLM and how it is queried.

​
description
string | null
default:""

Index description shown to the LLM so it can decide when and how to query this index.

Example:

"A comprehensive movie database containing titles, overviews, genres, and release dates"

​
documentTemplate
string | null

Liquid template that defines the text sent to the LLM for each document.

Example:

"{% for field in fields %}{% if field.is_searchable and field.value != nil %}{{ field.name }}: {{ field.value }}\n{% endif %}{% endfor %}"

​
documentTemplateMaxBytes
integer | null
default:400

Maximum size in bytes of the rendered document template. Longer text is truncated.

Required range: x >= 0
Example:

400

​
searchParameters
object

Search parameters used when the LLM queries this index (hybrid, limit, sort, distinct, etc.).

Response

Task successfully enqueued.

A summarized view of a task, returned when a task is enqueued

​
taskUid
integer<u-int32>
required

Unique sequential identifier of the task.

Required range: x >= 0
​
status
enum<string>
required

Status of the task. Possible values are enqueued, processing, succeeded, failed, and canceled.

Available options:
enqueued,
processing,
succeeded,
failed,
canceled
Example:

"processing"

​
type
enum<string>
required

Type of operation performed by the task.

Available options:
documentAdditionOrUpdate,
documentEdition,
documentDeletion,
settingsUpdate,
indexCreation,
indexDeletion,
indexUpdate,
indexSwap,
taskCancelation,
taskDeletion,
dumpCreation,
snapshotCreation,
export,
upgradeDatabase,
indexCompaction,
networkTopologyChange
Example:

"documentAdditionOrUpdate"

​
enqueuedAt
string<date-time>
required

Date and time when the task was enqueued.

​
indexUid
string | null

Unique identifier of the targeted index. Null for global tasks.

​
customMetadata
string | null

Custom metadata attached to this task at creation. Use it to associate tasks with external systems or add application-specific information.