You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -2917,3 +2920,102 @@ To remove a single embedder, use the [update embedder settings endpoint](#update
2917
2920
```
2918
2921
2919
2922
You can use the returned `taskUid` to get more details on [the status of the task](/reference/api/tasks#get-one-task).
2923
+
2924
+
## Conversation
2925
+
2926
+
Conversational querying allows a more human-like interaction with your search engine. It enables you to ask questions and receive relevant answers based on the content of your documents.
2927
+
2928
+
### Chat object
2929
+
2930
+
The chat object in the index settings contains multiple settings to configure the conversational querying.
2931
+
2932
+
```json
2933
+
{
2934
+
"description": "Contains a bunch of movies from the IMdb database. Each movie has a title, overview, and rating.",
2935
+
"documentTemplate": "A movie titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}",
2936
+
"documentTemplateMaxBytes": 400,
2937
+
"searchParameters": {
2938
+
"hybrid": { "embedder": "my-embedder" },
2939
+
"limit": 20,
2940
+
}
2941
+
}
2942
+
```
2943
+
2944
+
These embedder objects may contain the following fields:
|**`description`**| String | Empty | The description of the index. Used to help the LLM decide which index to use when generating answers |
2949
+
|**`documentTemplate`**| String |`{% for field in fields %} {% if field.is_searchable and not field.value == nil %}{{ field.name }}: {{ field.value }} {% endif %} {% endfor %}`| Template defining the data Meilisearch sends to the LLM |
2950
+
|**`documentTemplateMaxBytes`**| Integer | 400 | Maximum allowed size of rendered document template |
2951
+
|**`searchParameters`**| Object | Empty | The search parameters to use when LLM is performing search requests |
2952
+
2953
+
### Search parameters object
2954
+
2955
+
Corresponds to a subset of the [search parameters object](/reference/api/search#search-parameters-object):
|**`index_uid`** * | String |[`uid`](/learn/getting_started/indexes#index-uid) of the requested index |
2975
+
2976
+
#### Example
2977
+
2978
+
<CodeSamplesGetEmbedders1 />
2979
+
2980
+
##### Response: `200 OK`
2981
+
2982
+
```json
2983
+
{
2984
+
"description": "",
2985
+
"documentTemplate": "{% for field in fields %} {% if field.is_searchable and not field.value == nil %}{{ field.name }}: {{ field.value }} {% endif %} {% endfor %}",
0 commit comments