-
Notifications
You must be signed in to change notification settings - Fork 382
Add AI Chat guide #4447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add AI Chat guide #4447
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
--- | ||
slug: /use-cases/AI_ML/AIChat | ||
sidebar_label: 'AI Chat' | ||
title: 'Using AI Chat in ClickHouse Cloud' | ||
pagination_prev: null | ||
pagination_next: null | ||
description: 'Guide to enabling and using the AI Chat feature in ClickHouse Cloud Console' | ||
keywords: ['AI', 'ClickHouse Cloud', 'Chat', 'SQL Console', 'Agent', 'Docs AI'] | ||
show_related_blogs: true | ||
sidebar_position: 2 | ||
--- | ||
|
||
import Link from '@docusaurus/Link'; | ||
import Image from '@theme/IdealImage'; | ||
import img_open from '@site/static/images/use-cases/AI_ML/AIChat/1_open_chat.png'; | ||
import img_consent from '@site/static/images/use-cases/AI_ML/AIChat/2_consent.png'; | ||
import img_modes from '@site/static/images/use-cases/AI_ML/AIChat/3_modes.png'; | ||
import img_thinking from '@site/static/images/use-cases/AI_ML/AIChat/4_thinking.png'; | ||
import img_history from '@site/static/images/use-cases/AI_ML/AIChat/5_history.png'; | ||
import img_result_actions from '@site/static/images/use-cases/AI_ML/AIChat/6_result_actions.png'; | ||
import img_new_tab from '@site/static/images/use-cases/AI_ML/AIChat/7_open_in_editor.png'; | ||
|
||
# Using AI Chat in ClickHouse Cloud | ||
|
||
> This guide explains how to enable and use the AI Chat feature in the ClickHouse Cloud Console. | ||
|
||
<VerticalStepper headerLevel="h2"> | ||
|
||
## Prerequisites {#prerequisites} | ||
|
||
1. You must have access to a ClickHouse Cloud organization with AI features enabled (contact your org admin or support if unavailable). | ||
|
||
## Open the AI Chat panel {#open-panel} | ||
|
||
1. Navigate to a ClickHouse Cloud service. | ||
2. In the left sidebar, click the sparkle icon labeled “Ask AI”. | ||
3. (Shortcut) Press <kbd>⌘</kbd> + <kbd>'</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>'</kbd> (Linux/Windows) to toggle open. | ||
|
||
<Image img={img_open} alt="Open AI Chat flyout" size="md"/> | ||
|
||
## Accept the data usage consent (first run) {#consent} | ||
|
||
1. On first use you are 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 will not open. | ||
|
||
<Image img={img_consent} alt="Consent dialog" size="md"/> | ||
|
||
## Choose a chat mode {#modes} | ||
|
||
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. | ||
|
||
<Image img={img_modes} alt="Mode selection" size="sm"/> | ||
|
||
## Compose and send a message {#compose} | ||
|
||
1. Type your question (e.g. “Create a materialized view to aggregate daily events by user”). | ||
2. Press <kbd>Enter</kbd> to send (use <kbd>Shift</kbd> + <kbd>Enter</kbd> for a newline). | ||
3. While the model is processing you can click “Stop” to interrupt. | ||
|
||
## Understanding “Agent” thinking steps {#thinking-steps} | ||
|
||
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. | ||
|
||
<Image img={img_thinking} alt="Thinking steps" size="md"/> | ||
|
||
## Starting new chats {#new-chats} | ||
|
||
Click the “New Chat” button to clear context and begin a fresh session. | ||
|
||
## Viewing chat history {#history} | ||
|
||
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. | ||
|
||
<Image img={img_history} alt="Chat history list" size="md"/> | ||
|
||
## Working with generated SQL {#sql-actions} | ||
|
||
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. | ||
|
||
<Image img={img_result_actions} alt="Result actions" size="md"/> | ||
|
||
<Image img={img_new_tab} alt="Open generated query in editor" size="md"/> | ||
|
||
## Stopping or interrupting a response {#interrupt} | ||
|
||
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. | ||
|
||
## Keyboard shortcuts {#shortcuts} | ||
|
||
| Action | Shortcut | | ||
| ------ | -------- | | ||
| Open AI Chat | `⌘ + '` / `Ctrl + '` | | ||
| Send message | `Enter` | | ||
| New line | `Shift + Enter` | | ||
|
||
</VerticalStepper> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
Uh oh!
There was an error while loading. Please reload this page.