TreeAgentToolCallMessage Interface

An assistant message requesting a tool call (e.g. to edit the tree).

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 TreeAgentToolCallMessage

Properties

Property	Alerts	Modifiers	Type	Description
role	Alpha	readonly	"tool_call"	Identifies the message type within a TreeAgentChatMessage array.
toolArgs	Alpha	readonly	Record<string, unknown>	The arguments to the tool call, as returned by the LLM.
toolCallId	Alpha	optional, readonly	string	An optional identifier for this tool invocation, used to correlate with the result.
toolName	Alpha	readonly	string	The name of the tool being called.

Property Details

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_call";

Type: "tool_call"

toolArgs

The arguments to the tool call, as returned by the LLM.

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 toolArgs: Record<string, unknown>;

Type: Record<string, unknown>

toolCallId

An optional identifier for this tool invocation, used to correlate with the result.

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

toolName

The name of the tool being called.

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 toolName: string;

Type: string