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
This guide walks you through implementing Meilisearch's chatCompletions feature to create conversational search experiences in your application.
9
+
This guide walks you through implementing Meilisearch's chat completions feature to create conversational search experiences in your application.
10
10
11
11
<Warning>
12
-
The chatCompletions feature is experimental and must be enabled before use. See [experimental features](/reference/api/experimental_features) for activation instructions.
12
+
The chat completions feature is experimental and must be enabled before use. See [experimental features](/reference/api/experimental_features) for activation instructions.
13
13
</Warning>
14
14
15
15
## Prerequisites
@@ -18,13 +18,13 @@ Before starting, ensure you have:
18
18
- Meilisearch instance running (v1.15.1 or later)
19
19
- An API key from an LLM provider (OpenAI, Azure OpenAI, Mistral, Gemini, or access to a vLLM server)
20
20
- At least one index with searchable content
21
-
- The chatCompletions experimental feature enabled
21
+
- The chat completions experimental feature enabled
22
22
23
23
## Quick start
24
24
25
-
### 1. Enable the chatCompletions feature
25
+
### 1. Enable the chat completions feature
26
26
27
-
First, enable the chatCompletions experimental feature:
27
+
First, enable the chat completions experimental feature:
28
28
29
29
```bash
30
30
curl \
@@ -36,7 +36,7 @@ curl \
36
36
}'
37
37
```
38
38
39
-
### 2. Configure a chatCompletions workspace
39
+
### 2. Configure a chat completions workspace
40
40
41
41
Create a workspace with your LLM provider settings. Here are examples for different providers:
42
42
@@ -115,7 +115,7 @@ curl \
115
115
116
116
</CodeGroup>
117
117
118
-
### 3. Send your first chatCompletions request
118
+
### 3. Send your first chat completions request
119
119
120
120
Now you can start a conversation:
121
121
@@ -219,4 +219,4 @@ for await (const chunk of stream) {
219
219
220
220
- Explore [advanced chat API features](/reference/api/chats)
221
221
- Learn about [conversational search concepts](/learn/ai_powered_search/conversational_search_with_chat)
222
-
- Review [security best practices](/learn/security/basic_security)
222
+
- Review [security best practices](/learn/security/basic_security)
Copy file name to clipboardExpand all lines: learn/ai_powered_search/conversational_search_with_chat.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,10 @@ description: Learn how to implement AI-powered conversational search using Meili
6
6
7
7
import { Warning } from'/snippets/notice_tag.mdx'
8
8
9
-
Meilisearch's chatCompletions feature enables AI-powered conversational search, allowing users to ask questions in natural language and receive direct answers based on your indexed content. This feature transforms the traditional search experience into an interactive dialogue.
9
+
Meilisearch's chat completions feature enables AI-powered conversational search, allowing users to ask questions in natural language and receive direct answers based on your indexed content. This feature transforms the traditional search experience into an interactive dialogue.
10
10
11
11
<Warning>
12
-
The chatCompletions feature is experimental and must be enabled through [experimental features](/reference/api/experimental_features). API specifications may change in future releases.
12
+
The chat completions feature is experimental and must be enabled through [experimental features](/reference/api/experimental_features). API specifications may change in future releases.
13
13
</Warning>
14
14
15
15
## What is conversational search?
@@ -22,7 +22,7 @@ Conversational search allows users to:
22
22
23
23
This approach bridges the gap between traditional search and modern AI experiences, making information more accessible and intuitive to find.
24
24
25
-
## How chatCompletions differs from traditional search
25
+
## How chat completions differs from traditional search
26
26
27
27
### Traditional search workflow
28
28
1. User enters keywords
@@ -37,21 +37,21 @@ This approach bridges the gap between traditional search and modern AI experienc
37
37
38
38
## RAG implementation simplified
39
39
40
-
The chatCompletions feature implements a complete Retrieval Augmented Generation (RAG) pipeline in a single API endpoint. Traditional RAG implementations require:
40
+
The chat completions feature implements a complete Retrieval Augmented Generation (RAG) pipeline in a single API endpoint. Traditional RAG implementations require:
41
41
42
42
- Multiple LLM calls for query optimization
43
43
- Separate vector database for semantic search
44
44
- Custom reranking solutions
45
45
- Complex pipeline management
46
46
47
-
Meilisearch's chatCompletions consolidates these into one streamlined process:
47
+
Meilisearch's chat completions consolidates these into one streamlined process:
48
48
49
49
1.**Query understanding**: Automatically transforms questions into optimal search parameters
50
50
2.**Hybrid retrieval**: Combines keyword and semantic search for superior relevance
51
51
3.**Answer generation**: Uses your chosen LLM to generate responses
52
52
4.**Context management**: Maintains conversation history automatically
53
53
54
-
## When to use chatCompletions vs traditional search
54
+
## When to use chat completions vs traditional search
55
55
56
56
### Use conversational search when:
57
57
- Users need direct answers to specific questions
@@ -67,7 +67,7 @@ Meilisearch's chatCompletions consolidates these into one streamlined process:
67
67
68
68
## Architecture overview
69
69
70
-
The chatCompletions feature operates through workspaces, which are isolated configurations for different use cases or tenants. Each workspace can:
70
+
The chat completions feature operates through workspaces, which are isolated configurations for different use cases or tenants. Each workspace can:
71
71
72
72
- Use different LLM sources (openAi, azureOpenAi, mistral, gemini, vLlm)
73
73
- Apply custom prompts
@@ -93,7 +93,7 @@ The chatCompletions feature operates through workspaces, which are isolated conf
93
93
94
94
## Security considerations
95
95
96
-
The chatCompletions feature integrates with Meilisearch's existing security model:
96
+
The chat completions feature integrates with Meilisearch's existing security model:
97
97
98
98
-**API key permissions**: Chat only accesses indexes visible to the provided API key
99
99
-**Tenant tokens**: Support for multi-tenant applications
@@ -102,6 +102,6 @@ The chatCompletions feature integrates with Meilisearch's existing security mode
102
102
103
103
## Next steps
104
104
105
-
-[Get started with chatCompletions implementation](/guides/ai/getting_started_with_chat)
106
-
-[Explore the chatCompletions API reference](/reference/api/chats)
107
-
-[Learn about experimental features](/reference/api/experimental_features)
105
+
-[Get started with chat completions implementation](/guides/ai/getting_started_with_chat)
106
+
-[Explore the chat completions API reference](/reference/api/chats)
107
+
-[Learn about experimental features](/reference/api/experimental_features)
Copy file name to clipboardExpand all lines: reference/api/chats.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,10 +10,10 @@ import { Warning } from '/snippets/notice_tag.mdx'
10
10
The `/chats` route enables AI-powered conversational search by integrating Large Language Models (LLMs) with your Meilisearch data. This feature allows users to ask questions in natural language and receive contextual answers based on your indexed content.
11
11
12
12
<Warning>
13
-
The chatCompletions feature is experimental and must be enabled through [experimental features](/reference/api/experimental_features). To enable it, set `"chatCompletions": true` in your experimental features configuration.
13
+
The chat completions feature is experimental and must be enabled through [experimental features](/reference/api/experimental_features). To enable it, set `"chatCompletions": true` in your experimental features configuration.
14
14
</Warning>
15
15
16
-
## ChatCompletions workspace object
16
+
## Chat completions workspace object
17
17
18
18
```json
19
19
{
@@ -23,9 +23,9 @@ The chatCompletions feature is experimental and must be enabled through [experim
0 commit comments