Update chat/completions documentation with real-world implementation insights#3307
Merged
Conversation
…ation insights - Add critical prerequisites: master key requirement and auth setup - Document index chat configuration with description and documentTemplate - Clarify PUT/PATCH methods for workspace creation - Add authentication flow and finding Default Chat API Key - Document enabling database search with Meilisearch tools - Add comprehensive troubleshooting guide for common issues - Include complete working example from setup to usage - Fix -N flag requirement for curl streaming responses - Update API references to match implementation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
@tpayet, is this ready for review or is it still a draft? I am planning to review all chat completions documentation as part of v1.16, so the best way to avoid wasting anyone's work would be to to merge this as soon as it's ready so I'm reviewing the latest version of everything. |
guimachiavelli
approved these changes
Jul 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey @guimachiavelli 👋🏽
I've spend some time implementing the chat/completions route on the where2watch dataset, and here is some suggested updates for the documentation based on my experience implementing it.
Feel free to merge or discard the PR, I just wanted to give you visibility on what I was missing when implementing it ^^
Summary
This PR updates the Meilisearch chat/completions documentation based on real-world implementation experience and discovered requirements.
Key Updates
Prerequisites and Setup
--experimental-enable-chatflag in some versionsAuthentication
Index Configuration for Chat
Creating Chat Workspaces
Using the Chat Endpoint
Enabling Database Search
Troubleshooting Guide
Complete Working Example
Files Modified
guides/ai/getting_started_with_chat.mdx- Main getting started guide with all new contentreference/api/chats.mdx- API reference updates for clarity and -N flagreference/api/settings.mdx- Fixed chat settings documentation (was labeled as "Conversation")🤖 Generated with Claude Code