Skip to content

feat: batch client tool continuations #792

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.

Sign up for GitHub

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
blove merged 1 commit into from
Jul 8, 2026
Merged

feat: batch client tool continuations #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 83 additions & 2 deletions apps/website/content/docs/chat/api/api-docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6309,6 +6309,12 @@
"description": "",
"optional": false
},
{
"name": "followUp",
"type": "boolean",
"description": "",
"optional": true
},
{
"name": "handler",
"type": "(args: any, context: FunctionToolHandlerContext) => unknown",
Expand Down Expand Up @@ -6353,6 +6359,12 @@
"description": "",
"optional": false
},
{
"name": "followUp",
"type": "boolean",
"description": "",
"optional": true
},
{
"name": "kind",
"type": "\"ask\"",
Expand Down Expand Up @@ -6700,6 +6712,20 @@
],
"examples": []
},
{
"name": "ClientToolContinuationOptions",
"kind": "interface",
"description": "Execution policy options for browser-executed function tools.",
"properties": [
{
"name": "followUp",
"type": "boolean",
"description": "False when the tool result should be recorded without forcing a continuation.",
"optional": true
}
],
"examples": []
},
{
"name": "ClientToolExecutionGuard",
"kind": "interface",
Expand Down Expand Up @@ -6745,6 +6771,12 @@
"kind": "interface",
"description": "Execution policy options for browser-executed function tools.",
"properties": [
{
"name": "followUp",
"type": "boolean",
"description": "False when the tool result should be recorded without forcing a continuation.",
"optional": true
},
{
"name": "idempotent",
"type": "boolean",
Expand Down Expand Up @@ -6824,6 +6856,12 @@
"type": "ClientToolExecutionGuard",
"description": "",
"optional": true
},
{
"name": "settleToolCall",
"type": "(toolCall: ToolCall, result: ClientToolResult) => void",
"description": "",
"optional": true
}
],
"examples": []
Expand Down Expand Up @@ -6872,6 +6910,25 @@
"optional": false
}
]
},
{
"name": "settle",
"signature": "settle(toolCallId: string, result: ClientToolResult): void",
"description": "Record a client tool's result without continuing the run.",
"params": [
{
"name": "toolCallId",
"type": "string",
"description": "",
"optional": false
},
{
"name": "result",
"type": "ClientToolResult",
"description": "",
"optional": false
}
]
}
],
"examples": []
Expand Down Expand Up @@ -7114,6 +7171,12 @@
"description": "",
"optional": false
},
{
"name": "followUp",
"type": "boolean",
"description": "",
"optional": true
},
{
"name": "handler",
"type": "(args: StandardSchemaInferOutput<S>, context: FunctionToolHandlerContext) => R | Promise<R>",
Expand Down Expand Up @@ -8005,6 +8068,12 @@
"description": "",
"optional": false
},
{
"name": "followUp",
"type": "boolean",
"description": "",
"optional": true
},
{
"name": "kind",
"type": "\"view\"",
Expand Down Expand Up @@ -8350,7 +8419,7 @@
"name": "ask",
"kind": "function",
"description": "Interactive (human-in-the-loop) component tool — the model fills the\ncomponent's props from the schema's output; the value the component emits\nback to the framework becomes the tool result sent to the model.\n\nThe component's signal inputs are checked against the schema output type\n(strict-but-flexible: every schema key must be a declared input with an\nassignable type; the component may declare extra inputs the schema doesn't\nfill). Author the component with `ViewProps<typeof schema>` to derive input\nprop types directly from the schema.",
"signature": "ask(description: string, schema: S, component: AcceptComponent<S, C>): AskToolDef<S, C>",
"signature": "ask(description: string, schema: S, component: AcceptComponent<S, C>, options: ClientToolContinuationOptions): AskToolDef<S, C>",
"params": [
{
"name": "description",
Expand All @@ -8369,6 +8438,12 @@
"type": "AcceptComponent<S, C>",
"description": "Angular component whose signal inputs must be compatible with\n the schema output. A type-level error is reported here when they diverge.",
"optional": false
},
{
"name": "options",
"type": "ClientToolContinuationOptions",
"description": "",
"optional": true
}
],
"returns": {
Expand Down Expand Up @@ -9374,7 +9449,7 @@
"name": "view",
"kind": "function",
"description": "Render-only component tool — the model fills the component's props from the\nschema's output; the tool call is auto-acknowledged once the component mounts.\n\nThe component's signal inputs are checked against the schema output type\n(strict-but-flexible: every schema key must be a declared input with an\nassignable type; the component may declare extra inputs the schema doesn't fill).\nAuthor the component with `ViewProps<typeof schema>` as the input type set to\nguarantee the shapes stay aligned.",
"signature": "view(description: string, schema: S, component: AcceptComponent<S, C>): ViewToolDef<S, C>",
"signature": "view(description: string, schema: S, component: AcceptComponent<S, C>, options: ClientToolContinuationOptions): ViewToolDef<S, C>",
"params": [
{
"name": "description",
Expand All @@ -9393,6 +9468,12 @@
"type": "AcceptComponent<S, C>",
"description": "Angular component whose signal inputs must be compatible with\n the schema output. A type-level error is reported here when they diverge.",
"optional": false
},
{
"name": "options",
"type": "ClientToolContinuationOptions",
"description": "",
"optional": true
}
],
"returns": {
Expand Down
Loading
Loading