Skip to content

Commit 3b6c2e2

Browse files
committed
Fix chat completions feature naming consistency
1 parent a25c614 commit 3b6c2e2

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

guides/ai/getting_started_with_chat.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ description: Learn how to implement AI-powered conversational search in your app
66

77
import { Warning, Note } from '/snippets/notice_tag.mdx'
88

9-
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.
1010

1111
<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.
1313
</Warning>
1414

1515
## Prerequisites
@@ -18,13 +18,13 @@ Before starting, ensure you have:
1818
- Meilisearch instance running (v1.15.1 or later)
1919
- An API key from an LLM provider (OpenAI, Azure OpenAI, Mistral, Gemini, or access to a vLLM server)
2020
- At least one index with searchable content
21-
- The chatCompletions experimental feature enabled
21+
- The chat completions experimental feature enabled
2222

2323
## Quick start
2424

25-
### 1. Enable the chatCompletions feature
25+
### 1. Enable the chat completions feature
2626

27-
First, enable the chatCompletions experimental feature:
27+
First, enable the chat completions experimental feature:
2828

2929
```bash
3030
curl \
@@ -36,7 +36,7 @@ curl \
3636
}'
3737
```
3838

39-
### 2. Configure a chatCompletions workspace
39+
### 2. Configure a chat completions workspace
4040

4141
Create a workspace with your LLM provider settings. Here are examples for different providers:
4242

@@ -115,7 +115,7 @@ curl \
115115

116116
</CodeGroup>
117117

118-
### 3. Send your first chatCompletions request
118+
### 3. Send your first chat completions request
119119

120120
Now you can start a conversation:
121121

@@ -219,4 +219,4 @@ for await (const chunk of stream) {
219219
220220
- Explore [advanced chat API features](/reference/api/chats)
221221
- 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)

learn/ai_powered_search/conversational_search_with_chat.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ description: Learn how to implement AI-powered conversational search using Meili
66

77
import { Warning } from '/snippets/notice_tag.mdx'
88

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

1111
<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.
1313
</Warning>
1414

1515
## What is conversational search?
@@ -22,7 +22,7 @@ Conversational search allows users to:
2222

2323
This approach bridges the gap between traditional search and modern AI experiences, making information more accessible and intuitive to find.
2424

25-
## How chatCompletions differs from traditional search
25+
## How chat completions differs from traditional search
2626

2727
### Traditional search workflow
2828
1. User enters keywords
@@ -37,21 +37,21 @@ This approach bridges the gap between traditional search and modern AI experienc
3737

3838
## RAG implementation simplified
3939

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:
4141

4242
- Multiple LLM calls for query optimization
4343
- Separate vector database for semantic search
4444
- Custom reranking solutions
4545
- Complex pipeline management
4646

47-
Meilisearch's chatCompletions consolidates these into one streamlined process:
47+
Meilisearch's chat completions consolidates these into one streamlined process:
4848

4949
1. **Query understanding**: Automatically transforms questions into optimal search parameters
5050
2. **Hybrid retrieval**: Combines keyword and semantic search for superior relevance
5151
3. **Answer generation**: Uses your chosen LLM to generate responses
5252
4. **Context management**: Maintains conversation history automatically
5353

54-
## When to use chatCompletions vs traditional search
54+
## When to use chat completions vs traditional search
5555

5656
### Use conversational search when:
5757
- Users need direct answers to specific questions
@@ -67,7 +67,7 @@ Meilisearch's chatCompletions consolidates these into one streamlined process:
6767

6868
## Architecture overview
6969

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:
7171

7272
- Use different LLM sources (openAi, azureOpenAi, mistral, gemini, vLlm)
7373
- Apply custom prompts
@@ -93,7 +93,7 @@ The chatCompletions feature operates through workspaces, which are isolated conf
9393

9494
## Security considerations
9595

96-
The chatCompletions feature integrates with Meilisearch's existing security model:
96+
The chat completions feature integrates with Meilisearch's existing security model:
9797

9898
- **API key permissions**: Chat only accesses indexes visible to the provided API key
9999
- **Tenant tokens**: Support for multi-tenant applications
@@ -102,6 +102,6 @@ The chatCompletions feature integrates with Meilisearch's existing security mode
102102

103103
## Next steps
104104

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)

reference/api/chats.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import { Warning } from '/snippets/notice_tag.mdx'
1010
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.
1111

1212
<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.
1414
</Warning>
1515

16-
## ChatCompletions workspace object
16+
## Chat completions workspace object
1717

1818
```json
1919
{
@@ -23,9 +23,9 @@ The chatCompletions feature is experimental and must be enabled through [experim
2323

2424
| Name | Type | Description |
2525
| :---------- | :----- | :-------------------------------------------------- |
26-
| **`uid`** | String | Unique identifier for the chatCompletions workspace |
26+
| **`uid`** | String | Unique identifier for the chat completions workspace |
2727

28-
## ChatCompletions settings object
28+
## Chat completions settings object
2929

3030
```json
3131
{
@@ -385,4 +385,4 @@ These tools are handled internally and are not directly accessible through the A
385385
- Only streaming responses are currently supported
386386
- Conversation history must be managed client-side
387387
- Token limits depend on the chosen LLM provider
388-
- No built-in conversation persistence
388+
- No built-in conversation persistence

0 commit comments

Comments
 (0)