> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-trino-dialect.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# ClickHouse Assistant in ClickHouse Cloud
> Learn about, enable, and use ClickHouse Assistant in the ClickHouse Cloud console
export const Image = ({img, alt, size = "lg", background}) => {
const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
const backgroundColor = background === "white" ? "white" : background === "black" ? "rgb(31 31 28)" : undefined;
return
;
};
ClickHouse Assistant lets you use natural language to analyze data in a ClickHouse Cloud service. It can generate queries, visualizations, and summaries using context such as active tabs, saved queries, schemas, and dashboards.
The Assistant also includes a Docs AI mode for asking questions grounded in the ClickHouse documentation. Use this guide to enable the Assistant and work with both modes in the ClickHouse Cloud console.
1. You must have access to a ClickHouse Cloud organization with AI features enabled (contact your org admin or support if unavailable).
1. Navigate to a ClickHouse Cloud service.
2. In the left sidebar, click the sparkle icon labeled “ClickHouse Assistant”.
3. (Shortcut) Press ⌘ + ' (macOS) or Ctrl + ' (Linux/Windows) to toggle open.
1. On first use you're prompted with a consent dialog describing data handling and third‑party LLM sub-processors.
2. Review and accept to proceed. If you decline, the panel won't open.
AI Chat currently supports:
* **Agent**: Multi‑step reasoning over schema + metadata (service must be awake).
* **Docs AI (Ask)**: Focused Q\&A grounded in official ClickHouse documentation and best‑practice references.
Use the mode selector at the bottom-left of the flyout to switch.
1. Type your question (e.g. “Create a materialized view to aggregate daily events by user”).
2. Press Enter to send (use Shift + Enter for a newline).
3. While the model is processing you can click “Stop” to interrupt.
In Agent mode you may see expandable intermediate “thinking” or planning steps. These provide transparency into how the assistant forms its answer. Collapse or expand as needed.
Click the “New Chat” button to clear context and begin a fresh session.
1. The lower section lists your recent chats.
2. Select a previous chat to load its messages.
3. Delete a conversation using the trash icon.
When the assistant returns SQL:
* Review for correctness.
* Click “Open in editor” to load the query into a new SQL tab.
* Modify and execute within the Console.
If a response is taking too long or diverging:
1. Click the “Stop” button (visible while processing).
2. The message is marked as interrupted; you can refine your prompt and resend.
| Action | Shortcut |
| ------------ | -------------------- |
| Open AI Chat | `⌘ + '` / `Ctrl + '` |
| Send message | `Enter` |
| New line | `Shift + Enter` |