TreeAgentToolResultMessage Interface
A tool result message containing the outcome of a tool invocation.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/tree-agent/alpha.
For more information about our API support guarantees, see here.
Signature
export interface TreeAgentToolResultMessage
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| content | Alpha | readonly | string | The result content (e.g. the EditResult serialized as text, or the new tree state). |
| role | Alpha | readonly | "tool_result" | Identifies the message type within a TreeAgentChatMessage array. |
| toolCallId | Alpha | optional, readonly | string | The identifier of the tool call this result corresponds to, if one was provided. |
Property Details
content
The result content (e.g. the EditResult serialized as text, or the new tree state).
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly content: string;
Type: string
role
Identifies the message type within a TreeAgentChatMessage array.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly role: "tool_result";
Type: "tool_result"
toolCallId
The identifier of the tool call this result corresponds to, if one was provided.
This API is provided as an alpha preview and may change without notice.
For more information about our API support guarantees, see here.
Signature
readonly toolCallId?: string;
Type: string