ToolCallEvent
Encapsulates the data related to a tool call event.
Properties¶
| Property | Type | Description |
|---|---|---|
confirmToolCall? |
ToolCallConfirmationEvent |
Signals the user's approve/reject decision for a tool call that was emitted with requireConfirmation: true. |
endToolCall? |
ToolCallEndEvent |
Signals the end of a tool call. |
executingToolCall? |
ExecutingToolCallEvent |
Signals that the tool is about to be executed. For client-side tools, the client should begin executing its handler upon receiving this event. |
metaEvent? |
MetaEvent |
Allows additional events to be sent in the context of the enclosing event stream. |
startToolCall? |
ToolCallStartEvent |
Signals the start of a tool call. |
toolCallError? |
ErrorEvent |
Sent by the service to indicate an error condition impacting a tool call. |
toolCallId |
string |
Identifies the tool call. |