You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/features/10_AI_ML/agents/builder/code-interpreter.md
+27-14Lines changed: 27 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,26 +9,34 @@ doc_type: 'reference'
9
9
---
10
10
11
11
import BetaBadge from '@theme/badges/BetaBadge';
12
+
import Image from '@theme/IdealImage';
13
+
import runCode from '@site/static/images/cloud/agent-builder/run-code/run-code.png';
12
14
13
15
<BetaBadge/>
14
16
15
17
The code interpreter lets an agent execute code in a managed sandbox. Use it for computation, data transformation, format conversion, plotting, and anything else better done in code than in natural language.
16
18
17
-
## Enable it {#enable-it}
19
+
## Enable the code interpreter {#enable-it}
18
20
19
-
Toggle **Code interpreter** in the Agent Builder's capabilities section, then save. The agent decides when to run code based on the user's request and the agent's instructions.
21
+
In the Agent Builder, enable **Run Code** in the **Capabilities** section, then save. The agent decides when to run code based on the user's request and the agent's instructions.
22
+
23
+
<Imageimg={runCode}alt="Run Code section of the Capabilities panel with the Run Code checkbox enabled and an Upload to Code Environment button"size="sm"/>
20
24
21
25
## Supported languages {#supported-languages}
22
26
23
27
The sandbox is a Unix environment with two general-purpose runtimes and a few shell utilities:
24
28
25
-
-**Python 3** — the default for data tasks.
26
-
-**Node.js (JavaScript)** — when an agent prefers JS for the job.
27
-
-**Bash** and **sh** — shell scripting for chaining commands and quick I/O.
28
-
-**AWK** and **sed** — line-oriented text processing.
29
-
-**bc** — arbitrary-precision math.
29
+
-**Python 3** - the default for data tasks.
30
+
-**Node.js (JavaScript)** - when an agent prefers JS for the job.
31
+
-**Bash** and **sh** - shell scripting for chaining commands and quick I/O.
32
+
-**AWK** and **sed** - line-oriented text processing.
33
+
-**bc** - arbitrary-precision math.
34
+
35
+
Agents reach for Python first for anything involving data parsing, transformation, or computation.
30
36
31
-
Agents reach for Python first for anything involving data parsing, transformation, or computation. Reserve the shell tools for tasks that genuinely benefit from a one-liner.
37
+
:::tip
38
+
Reserve the shell tools for tasks that genuinely benefit from a one-liner.
39
+
:::
32
40
33
41
## Files {#files}
34
42
@@ -42,10 +50,15 @@ Plan-specific resource limits (memory, files per run, monthly request quotas) ap
42
50
43
51
## When to use it {#when-to-use-it}
44
52
45
-
- Parse a CSV or JSON the user uploaded.
46
-
- Compute summary statistics or run a quick simulation.
47
-
- Convert between formats (Parquet, JSON, CSV).
48
-
- Generate a plot from query results.
49
-
- Anything where deterministic computation beats LLM reasoning.
53
+
Reach for the code interpreter when the answer requires deterministic computation that a language model can't produce reliably by reasoning alone.
54
+
Typical cases include:
55
+
56
+
- Parsing a CSV or JSON file the user uploaded.
57
+
- Computing summary statistics or running a quick simulation.
58
+
- Converting between formats (Parquet, JSON, CSV).
59
+
- Generating a plot from query results.
50
60
51
-
Avoid it for tasks the model can answer directly. Code execution adds latency and consumes quota.
61
+
:::tip
62
+
Avoid it for tasks the model can already answer from context.
Copy file name to clipboardExpand all lines: docs/cloud/features/10_AI_ML/agents/builder/image-generation.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,18 @@ doc_type: 'reference'
9
9
---
10
10
11
11
import BetaBadge from '@theme/badges/BetaBadge';
12
+
import Image from '@theme/IdealImage';
13
+
import toolsModal from '@site/static/images/cloud/agent-builder/tools-modal.png';
12
14
13
15
<BetaBadge/>
14
16
15
17
Image generation lets an agent produce new images from a text prompt or edit images the user has uploaded. The agent picks between generation and editing based on what was asked and the available context.
16
18
17
-
## Enable it {#enable-it}
19
+
## Enable image generation {#enable-it}
18
20
19
-
Toggle the image-generation tool in the Agent Builder's capabilities section. Some agents have access to multiple image providers (for example DALL-E and Flux); the agent picks the appropriate one or you can restrict it in instructions.
21
+
Image generation is added through the **Add Tools** modal in the Agent Builder (not the Capabilities section). Click **Add Tools** at the bottom of the Agent Builder panel, then add one of the image-model tools — for example **OpenAI Image Tools**, **DALL-E-3**, or **Stable Diffusion**. The agent picks the appropriate one based on the request, or you can restrict it in instructions.
22
+
23
+
<Imageimg={toolsModal}alt="Agent Tools modal showing image-model integrations including OpenAI Image Tools, DALL-E-3, and Stable Diffusion alongside other third-party tools"size="md"/>
The Agent Builder is where you create and configure agents. It opens as a side panel in the Cloud console.
14
+
The Agent Builder is where you create and configure agents.
15
15
16
-
The panel has three sections:
16
+
:::tip New to ClickHouse Agents?
17
+
Start with the [Quickstart](/cloud/features/ai-ml/agents/quickstart). The pages below cover each part of the builder in detail.
18
+
:::
17
19
18
-
-**Identity** at the top — name, description, avatar, and the instructions field (the system prompt).
19
-
-**Model configuration** in the middle — provider, model, and generation parameters.
20
-
-**Capabilities** at the bottom — the tools, MCP servers, skills, and subagents you attach.
20
+
This section covers each part of the Agent Builder and contains the following pages:
21
21
22
-
Save from the footer button. Edits take effect on the next conversation; in-flight runs aren't interrupted.
23
-
24
-
## Identity {#identity}
25
-
26
-
The instructions field is the agent's system prompt. Describe the role, the kinds of questions it should answer, and any rules it must follow. Be specific about schema conventions, calculated metrics, and terminology if the agent will query your ClickHouse service — the model can't infer your business definitions on its own.
27
-
28
-
## Core configuration {#core-configuration}
29
-
30
-
-[Model parameters](/cloud/features/ai-ml/agents/builder/model-parameters) — Pick a model and tune generation parameters. Save a configuration as a named preset to reuse it.
MCP servers can require credentials. ClickHouse Agents supports:
30
30
31
-
-**Bearer tokens** and other static headers — fixed values you provide when configuring the server.
32
-
-**OAuth 2.0**— interactive flow. The first time you (or any user with access) calls a tool on the server, the browser opens a sign-in window; tokens are managed and refreshed automatically.
33
-
-**Per-user credentials**— variables in the server config substituted from the calling user's profile, so each user authenticates with their own identity rather than a shared service account.
31
+
-**Bearer tokens** and other static headers - fixed values you provide when configuring the server.
32
+
-**OAuth 2.0**- interactive flow. The first time you (or any user with access) calls a tool on the server, the browser opens a sign-in window; tokens are managed and refreshed automatically.
33
+
-**Per-user credentials**- variables in the server config substituted from the calling user's profile, so each user authenticates with their own identity rather than a shared service account.
34
34
35
35
User-provided credentials are stored encrypted and scoped to the user who entered them. One user's credentials are never visible to another user's agent runs.
Model parameters control which model an agent uses and how that model generates responses. Configure them in the Agent Builder's **Model Parameters** panel.
16
+
Model parameters control which model an agent uses and how that model generates responses.
17
+
From the **Agent Builder** tab, click **Select a model** under the **Model** heading.
18
+
This will open the **Model Parameters** window.
16
19
17
20
## Provider and model {#provider-and-model}
18
21
19
-
-**Provider**— the upstream LLM provider.
20
-
-**Model**— the specific model from that provider. Different models have different strengths: large reasoning models for planning-heavy tasks, faster small models for routine queries.
22
+
-**Provider**- select the upstream LLM provider.
23
+
-**Model**- select the specific model from that provider. Different models have different strengths: large reasoning models for planning-heavy tasks, faster small models for routine queries.
21
24
22
-
Provider and model are required. The rest of the panel adapts based on what the selected model supports.
25
+
Both **Provider** and **Model** are required. The rest of the panel adapts based on what the selected model supports.
23
26
24
27
## Context and output limits {#context-and-output-limits}
25
28
26
-
-**Max Context Tokens**— caps total context the agent sends to the model. Leave as **System** to use the model's default. Lower it to reduce cost; raise it for agents that need to reason over large inputs.
27
-
-**Max Output Tokens**— caps the size of the agent's response. **System** uses the model's default. Set lower if responses are too long, higher if they're being cut off.
28
-
-**File Token Limit**— caps how many tokens a single uploaded file contributes to context. Useful when users attach large files and you don't want them to crowd out the rest of the conversation.
29
+
-**Max Context Tokens**- caps total context the agent sends to the model. Leave as **System** to use the model's default. Lower it to reduce cost; raise it for agents that need to reason over large inputs.
30
+
-**Max Output Tokens**- caps the size of the agent's response. **System** uses the model's default. Set lower if responses are too long, higher if they're being cut off.
31
+
-**File Token Limit**- caps how many tokens a single uploaded file contributes to context. Useful when users attach large files and you don't want them to crowd out the rest of the conversation.
29
32
30
33
## Sampling {#sampling}
31
34
32
-
-**Temperature**— randomness. Higher values (0.7–1.0) = more random, while lower values (0.0–0.3) = more focused and deterministic. We recommend altering this or Top P but not both.
33
-
-**Top P**— nucleus sampling. Changes how the model selects tokens for output.
34
-
-**Top K**— restricts sampling to the top K most likely tokens at each step. Supported by some providers; controls determinism along a different axis than temperature.
35
+
-**Temperature**- randomness. Higher values (0.7–1.0) = more random, while lower values (0.0–0.3) = more focused and deterministic. We recommend altering this or Top P but not both.
36
+
-**Top P**- nucleus sampling. Changes how the model selects tokens for output.
37
+
-**Top K**- restricts sampling to the top K most likely tokens at each step. Supported by some providers; controls determinism along a different axis than temperature.
35
38
36
-
If you're not tuning for a specific behavior, leave the sliders near their defaults — small changes here rarely move the needle and large ones can degrade output quality.
39
+
If you're not tuning for a specific behavior, leave the sliders near their defaults as small changes rarely move the needle and large ones can degrade output quality.
37
40
38
41
## Reasoning controls {#reasoning-controls}
39
42
40
43
Available on models that expose extended reasoning. The exact set varies by provider.
41
44
42
-
-**Thinking**— toggles the model's extended reasoning mode. When on, the model produces internal thinking tokens before its final answer; this usually improves accuracy on hard tasks at the cost of latency and tokens.
43
-
-**Thinking Budget**— token budget for the thinking phase. The model stops thinking and answers once it has spent this many tokens.
44
-
-**Effort**— high-level reasoning effort dial (**Auto**, low, medium, high). Used by reasoning models that don't expose a thinking-token budget directly.
45
-
-**Thought Visibility**— controls whether the model's thinking is shown to the user inline, hidden behind a collapsed view, or omitted entirely.
45
+
-**Thinking**- this toggles the model's extended reasoning mode. When on, the model produces internal thinking tokens before its final answer; this usually improves accuracy on hard tasks at the cost of latency and tokens.
46
+
-**Thinking Budget**- sets a token budget for the thinking phase. The model stops thinking and answers once it has spent this many tokens.
47
+
-**Effort**- high-level reasoning effort dial (**Auto**, low, medium, high). Used by reasoning models that don't expose a thinking-token budget directly.
48
+
-**Thought Visibility**- this controls whether the model's thinking is shown to the user inline, hidden behind a collapsed view, or omitted entirely.
46
49
47
50
## Conversation behavior {#conversation-behavior}
48
51
49
-
-**Resend Files**— when on, files attached in earlier turns are re-sent on every subsequent turn so the model doesn't lose track of them. Turn off to save tokens if the conversation is short or the model is summarizing files as it goes.
50
-
-**Use Prompt Caching**— when supported by the provider, caches reusable parts of the prompt to reduce cost and latency on conversations where instructions and tool descriptions repeat across turns.
51
-
-**Web Search**— toggles provider-native web search on supported models. This is distinct from the [Web search tool](/cloud/features/ai-ml/agents/builder/web-search), which runs as one of the agent's tools rather than as a provider capability.
52
+
-**Resend Files**- when on, files attached in earlier turns are re-sent on every subsequent turn so the model doesn't lose track of them. Turn off to save tokens if the conversation is short or the model is summarizing files as it goes.
53
+
-**Use Prompt Caching**- when supported by the provider, caches reusable parts of the prompt to reduce cost and latency on conversations where instructions and tool descriptions repeat across turns.
54
+
-**Web Search**- toggles provider-native web search on supported models. This is distinct from the [Web search tool](/cloud/features/ai-ml/agents/builder/web-search), which runs as one of the agent's tools rather than as a provider capability.
Copy file name to clipboardExpand all lines: docs/cloud/features/10_AI_ML/agents/builder/skills.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,20 +40,20 @@ When asked to generate a revenue report:
40
40
41
41
The frontmatter knobs that matter most:
42
42
43
-
-**`name`**— kebab-case identifier.
44
-
-**`description`**— short summary used by the model to decide when this skill is relevant. Treat this as the most important field. Write it specifically; vague descriptions lead to wrong-skill invocations.
45
-
-**`always-apply`**— when `true`, the skill is primed into every turn instead of being selected. Use sparingly; always-apply skills consume context on every message.
46
-
-**`user-invocable`**— when `true` (the default), the skill appears in the `$` popover for manual selection.
43
+
-**`name`**- kebab-case identifier.
44
+
-**`description`**- short summary used by the model to decide when this skill is relevant. Treat this as the most important field. Write it specifically; vague descriptions lead to wrong-skill invocations.
45
+
-**`always-apply`**- when `true`, the skill is primed into every turn instead of being selected. Use sparingly; always-apply skills consume context on every message.
46
+
-**`user-invocable`**- when `true` (the default), the skill appears in the `$` popover for manual selection.
47
47
48
48
You can bundle supporting files alongside the skill — reference docs, sample queries, small scripts — by uploading a `.zip` containing the `SKILL.md` and its assets.
49
49
50
50
## Use a skill {#use-a-skill}
51
51
52
52
Three ways an agent reaches for a skill in a conversation:
53
53
54
-
-**User invocation**— press `$` in the composer and pick the skill from the popover. The skill's content is primed for the next turn.
55
-
-**Model auto-selection**— based on the skill's `description`, the agent decides on its own when to apply it.
56
-
-**Always-apply**— primed on every turn for skills configured that way.
54
+
-**User invocation**- press `$` in the composer and pick the skill from the popover. The skill's content is primed for the next turn.
55
+
-**Model auto-selection**- based on the skill's `description`, the agent decides on its own when to apply it.
56
+
-**Always-apply**- primed on every turn for skills configured that way.
Copy file name to clipboardExpand all lines: docs/cloud/features/10_AI_ML/agents/builder/subagents.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,16 +20,16 @@ Use subagents to keep a parent agent focused. Long research passes, tool-heavy e
20
20
21
21
In the Agent Builder, open **Advanced settings** and toggle **Subagents**. Two more controls appear:
22
22
23
-
-**Allow self-spawn**— when on, the agent can spawn copies of itself for parallel work. Useful for fan-out patterns (one parent, several identical workers).
24
-
-**Additional subagents**— pick specific other agents this parent is allowed to delegate to. The parent decides at runtime which subagent (if any) to call based on the task.
23
+
-**Allow self-spawn**- when on, the agent can spawn copies of itself for parallel work. Useful for fan-out patterns (one parent, several identical workers).
24
+
-**Additional subagents**- pick specific other agents this parent is allowed to delegate to. The parent decides at runtime which subagent (if any) to call based on the task.
25
25
26
26
Save. When the agent runs, it has a new tool available for invoking subagents.
27
27
28
28
## When a subagent helps {#when-a-subagent-helps}
29
29
30
-
-**Research subtasks**— the parent decomposes a complex question, hands a slice to a subagent specialized for that slice, and synthesizes the responses.
31
-
-**Tool-heavy passes**— code interpreter sessions, multi-step web search loops, or anything that would consume the parent's context with intermediate tool output.
32
-
-**Specialized review**— one agent generates, another reviews, the reviewer's full reasoning stays in its own context window.
30
+
-**Research subtasks**- the parent decomposes a complex question, hands a slice to a subagent specialized for that slice, and synthesizes the responses.
31
+
-**Tool-heavy passes**- code interpreter sessions, multi-step web search loops, or anything that would consume the parent's context with intermediate tool output.
32
+
-**Specialized review**- one agent generates, another reviews, the reviewer's full reasoning stays in its own context window.
33
33
34
34
Avoid subagents for trivial calls. The handoff adds latency and tokens.
0 commit comments