Improve chat API documentation clarity based on customer feedback

[tpayet]

Summary

This PR improves the chat completions documentation based on feedback from customer support interactions. The changes make the documentation more welcoming and easier to understand for users setting up conversational search.

Changes

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

• Added a tip linking to index conversation settings for content optimization
• Clarified that PATCH /chats/{workspace}/settings automatically creates workspaces if they don't exist
• Added a new "Privacy and data storage" section explicitly stating that Meilisearch doesn't store conversation data

Getting Started Guide Updates (/guides/ai/getting_started_with_chat.mdx)

• Added friendly "Understanding workspaces" section explaining the concept with examples
• Added "Managing conversations" section with code examples showing how to handle stateless conversations
• Made the overall tone more encouraging and approachable

Related Issue

Based on customer support feedback about chat completions feature documentation.

Test plan

• [x] All markdown linting passes (npm run marklint)
• [x] Prose linting checked (npm run proselint)
• [x] Preview documentation changes in Mintlify
• [ ] Verify links work correctly
• [ ] Check that examples are clear and accurate

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added sections explaining workspaces and managing conversation history, including JavaScript and Python code examples, to the AI chat getting started guide.
  • Enhanced the /chats API documentation with tips on conversation settings, clarification on workspace creation, and a new section on privacy and data storage.
  • Improved formatting and readability in the tool calling section of the API docs.
  • Added a Python code sample for updating typo tolerance settings in the typo tolerance guide.

[coderabbitai[bot]]

Walkthrough

Documentation was updated to enhance guidance on AI chat workspaces, conversation management, and privacy. New sections explain workspace concepts, provide code examples for handling conversation history in JavaScript and Python, and clarify that conversation context is not stored server-side. A Python code sample was added for typo tolerance settings.

Changes

Files/Groups	Change Summary
guides/ai/getting_started_with_chat.mdx	Added sections on workspaces and managing conversations, with JavaScript/Python code examples and clarifications.
reference/api/chats.mdx	Added privacy and data storage section, workspace auto-creation note, tip on conversation settings per index, and formatting improvements in tool calling examples.
snippets/samples/code_samples_typo_tolerance_guide_5.mdx	Added Python code snippet for updating typo tolerance settings on numbers for the "movies" index.

Poem

In the warren of docs, new wisdom appears,
On workspaces and chats, the guidance is clear.
Python joins the party with typo control,
Privacy is honored, stateless the goal.
With snippets and notes, the path is in view—
A rabbit’s delight: fresh knowledge for you!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.