Get chat

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'
});

index_uid

string

required

Unique identifier of the index.

Returns the current value of the chat setting.

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.).

Show child attributes