Add documentation for Meilisearch chat feature by tpayet · Pull Request #3273 · meilisearch/documentation

tpayet · 2025-06-11T08:50:59Z

Summary

Add comprehensive documentation for the new experimental chat feature
Create guides and references to help users implement AI-powered conversational search
Follow existing documentation patterns and style guidelines

Context

This PR documents the new chat feature being added to Meilisearch in meilisearch/meilisearch#5556. The chat feature enables AI-powered conversational search by integrating Large Language Models with Meilisearch's search capabilities.

Changes

1. Conceptual Overview (`learn/ai_powered_search/conversational_search_with_chat.mdx`)

Explains what conversational search is
Compares chat vs traditional search
Details the simplified RAG implementation
Describes the architecture and security model

2. API Reference (`reference/api/chats.mdx`)

Complete API documentation for all chat endpoints
Follows the existing API reference format (similar to indexes, documents, etc.)
Includes request/response examples
Documents OpenAI SDK compatibility

3. Implementation Guide (`guides/ai/getting_started_with_chat.mdx`)

Step-by-step quick start
Practical code examples for building chat interfaces
Best practices for prompts, streaming, and conversation management
Common use cases (customer support, documentation, e-commerce)

4. Supporting Updates

Updated experimental features page to include chat feature
Added navigation entries in docs.json following existing structure
Created new "AI" section in guides for AI-related content

Documentation Decisions

Terminology: Used "conversational search" for conceptual docs and "chat completions" for technical/API docs
Structure: Followed the learn/reference/guide pattern established in the codebase
Placement: Added chat to AI-powered search section (conceptual fit) and created dedicated API reference page
Examples: Focused on streaming examples since non-streaming is not yet implemented

Notes for Reviewers

All code examples are based on the OpenAI-compatible interface described in the PR
Security sections emphasize proper API key management and tenant token usage
Experimental feature warnings are prominently displayed
Content aligns with the product positioning from internal documentation

🤖 Generated with Claude Code

- Add conceptual overview of conversational search in learn/ai_powered_search/ - Add comprehensive API reference for /chats endpoints in reference/api/ - Add practical implementation guide in guides/ai/ - Update experimental features page to include chatCompletions - Support all 5 LLM sources: openAi, azureOpenAi, mistral, gemini, vLlm - Document OpenAI SDK compatibility with code examples - Add navigation entries in docs.json under Artificial intelligence section

mintlify Bot deployed to staging June 11, 2025 08:51 View deployment

mintlify Bot deployed to staging June 11, 2025 08:58 View deployment

tpayet force-pushed the docs/chat-feature branch from 2239ac7 to b4b2834 Compare June 11, 2025 08:59

mintlify Bot deployed to staging June 11, 2025 09:01 View deployment

Kerollmops marked this pull request as draft June 11, 2025 09:04

mintlify Bot deployed to staging June 11, 2025 09:06 View deployment

tpayet force-pushed the docs/chat-feature branch from 8c03737 to 298ac04 Compare June 11, 2025 09:07

mintlify Bot deployed to staging June 11, 2025 09:08 View deployment

mintlify Bot deployed to staging June 11, 2025 09:09 View deployment

tpayet force-pushed the docs/chat-feature branch from dc6b028 to 298ac04 Compare June 11, 2025 09:19

mintlify Bot deployed to staging June 11, 2025 09:21 View deployment

tpayet force-pushed the docs/chat-feature branch from 17bc9d1 to c6ad6aa Compare June 11, 2025 09:39

mintlify Bot deployed to staging June 11, 2025 09:41 View deployment

tpayet force-pushed the docs/chat-feature branch from 02ab8b1 to a86e1cf Compare June 11, 2025 09:44

mintlify Bot deployed to staging June 11, 2025 09:45 View deployment

mintlify Bot deployed to staging June 11, 2025 09:46 View deployment

tpayet force-pushed the docs/chat-feature branch from 33ad956 to a40b34c Compare June 11, 2025 09:56

mintlify Bot deployed to staging June 11, 2025 09:58 View deployment

mintlify Bot deployed to staging June 11, 2025 10:00 View deployment

tpayet force-pushed the docs/chat-feature branch 2 times, most recently from bc5be35 to 5307fb9 Compare June 11, 2025 10:18

mintlify Bot deployed to staging June 11, 2025 10:18 View deployment

mintlify Bot deployed to staging June 11, 2025 10:19 View deployment

tpayet force-pushed the docs/chat-feature branch from e1182e4 to 5e7e71c Compare June 11, 2025 10:19

mintlify Bot deployed to staging June 11, 2025 10:20 View deployment

mintlify Bot deployed to staging June 11, 2025 10:21 View deployment

tpayet force-pushed the docs/chat-feature branch 2 times, most recently from 5b7bb24 to bc2f35f Compare June 11, 2025 10:24

mintlify Bot deployed to staging June 11, 2025 10:25 View deployment

mintlify Bot deployed to staging June 11, 2025 10:26 View deployment

tpayet force-pushed the docs/chat-feature branch from 5ec474f to f707cfa Compare June 11, 2025 10:27

Update code samples [skip ci]

a25c614

mintlify Bot deployed to staging June 11, 2025 10:28 View deployment

mintlify Bot deployed to staging June 11, 2025 10:44 View deployment

Kerollmops added 2 commits June 11, 2025 13:44

Fix chat completions feature naming consistency

3b6c2e2

Improve the chat documentation

dc3ce92

mintlify Bot deployed to staging June 11, 2025 12:25 View deployment

Document the chat index setting

df236f5

mintlify Bot deployed to staging June 11, 2025 12:53 View deployment

Mark the chat index settings as experimental

21a9485

mintlify Bot deployed to staging June 11, 2025 12:58 View deployment

Improve the chat experimental enabling guide

ebe63a9

mintlify Bot deployed to staging June 11, 2025 13:01 View deployment

Add more information about the tools to use

c34ad20

mintlify Bot deployed to staging June 11, 2025 15:22 View deployment

Add more info about the Error Handling

9a19c36

Kerollmops force-pushed the docs/chat-feature branch from c2d01c8 to 9a19c36 Compare June 11, 2025 15:28

mintlify Bot deployed to staging June 11, 2025 15:29 View deployment

Kerollmops marked this pull request as ready for review June 11, 2025 15:30

mintlify Bot deployed to staging June 11, 2025 15:30 View deployment

Kerollmops approved these changes Jun 11, 2025

View reviewed changes

Kerollmops merged commit 44fd90f into main Jun 11, 2025
3 checks passed

Kerollmops deleted the docs/chat-feature branch June 11, 2025 15:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add documentation for Meilisearch chat feature#3273

Add documentation for Meilisearch chat feature#3273
Kerollmops merged 9 commits into
mainfrom
docs/chat-feature

tpayet commented Jun 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

tpayet commented Jun 11, 2025

Summary

Context

Changes

1. Conceptual Overview (learn/ai_powered_search/conversational_search_with_chat.mdx)

2. API Reference (reference/api/chats.mdx)

3. Implementation Guide (guides/ai/getting_started_with_chat.mdx)

4. Supporting Updates

Documentation Decisions

Notes for Reviewers

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

1. Conceptual Overview (`learn/ai_powered_search/conversational_search_with_chat.mdx`)

2. API Reference (`reference/api/chats.mdx`)

3. Implementation Guide (`guides/ai/getting_started_with_chat.mdx`)