Documentation
¶
Overview ¶
Package toolconfirmation provides structures and utilities for handling Human-in-the-Loop tool execution confirmations within the ADK.
Index ¶
Constants ¶
const FunctionCallName = "adk_request_confirmation"
FunctionCallName defines the specific name for the FunctionCall event emitted by ADK when a Human-in-the-Loop confirmation is required.
The 'args' of this FunctionCall include:
- "toolConfirmation": A toolConfirmation with the hint.
- "originalFunctionCall": The original FunctionCall (including its name and arguments) that the agent intended to execute.
Client applications or frontends interacting with the ADK-powered agent must: 1. Listen for events containing a FunctionCall with this name. 2. Extract the details of the 'originalFunctionCall' from the arguments. 3. Present a clear confirmation prompt to the human user, explaining the action and potential consequences. 4. Capture the user's decision (e.g., true for yes/approve, false for no/deny). 5. Send a FunctionResponse message back to the ADK. This FunctionResponse MUST:
- Have the same 'id' as the received "adk_request_confirmation" FunctionCall.
- Have the name set to "adk_request_confirmation".
- Include a response payload, typically a map like {"confirmed": bool}.
Based on the boolean value in "confirmed", the ADK will either proceed to execute the 'originalFunctionCall' or block it and return an error.
Variables ¶
This section is empty.
Functions ¶
func OriginalCallFrom ¶
func OriginalCallFrom(functionCall *genai.FunctionCall) (*genai.FunctionCall, error)
OriginalCallFrom retrieves the underlying, original function call from a tool confirmation wrapper.
In the ADK Tool Confirmation workflow, the model will wrap a desired tool execution inside a "RequestConfirmation" call. This helper extracts that inner intent so it can be mapped back to pending requests or queued for execution.
It handles the "originalFunctionCall" argument in two formats:
- *genai.FunctionCall: Returns the object directly if already typed.
- map[string]any: Deserializes the raw JSON map received from the model.
Usage: This is typically used when processing a "RequestConfirmation" event to identify which tool the model actually wants to run.
Parameters:
- functionCall: The wrapper function call (e.g., RequestConfirmation) containing the arguments.
Returns:
- *genai.FunctionCall: The extracted original tool call.
- error: If the "originalFunctionCall" argument is missing or malformed.
Types ¶
type ToolConfirmation ¶
type ToolConfirmation struct {
// Hint is the message provided to the user to explain why the confirmation
// is needed and what action is being confirmed.
Hint string
// Confirmed indicates the user's decision.
// true if the user approved the action, false if they denied it.
// The state before the user has responded is typically handled outside
// this struct (e.g., by the absence of a result or a pending status).
Confirmed bool
// Payload contains any additional data or context related to the confirmation request.
// The structure of the Payload is application-specific.
Payload any
}
ToolConfirmation represents the state and details of a user confirmation request for a tool execution.
Source Files