Interface●Since v1.0

ToolMessageFields

interface ToolMessageFields

Bases

BaseMessageFields<TStructure, "tool">

Properties

property

artifact: any

Artifact of the Tool execution which is not meant to be sent to the model.

Should only be specified if it is different from the message content, e.g. if only a subset of the full tool output is being passed as message content but the full output is needed in other parts of the code.

property

property

contentBlocks: Standard[]

property

id: string

Unique identifier for this message

property

metadata: Record<string, unknown>

property

name: string

An optional name for the message participant.

This property is primarily used to:

Identify agent roles in multi-agent systems: When multiple agents collaborate, setting name helps distinguish which agent produced a message, preventing confusion about who said what.
Pass participant names to model providers: Some providers (notably OpenAI, e.g. see OpenAI Chat Completions API) use this field to differentiate between participants with the same role. For example, when using OpenAI's Chat Completions API, the name is included in the message payload sent to the model.

// Setting name on an AIMessage to identify the agent
const message = new AIMessage({
  content: "I'll handle the calendar scheduling.",
  name: "calendar_agent"
});

// In a multi-agent system, this helps track message origins
const researcherMessage = new AIMessage({
  content: "Here are the findings...",
  name: "researcher"
});
const writerMessage = new AIMessage({
  content: "I've drafted the report.",
  name: "writer"
});

property

response_metadata: Partial<$InferResponseMetadata<TStructure, "tool">>

property

status: "success" | "error"

property

tool_call_id: string

deprecatedproperty

additional_kwargs: __type

View source on GitHub

Properties

property

artifact: any

Artifact of the Tool execution which is not meant to be sent to the model.

property

contentBlocks: Standard[]

property

id: string

Unique identifier for this message

property

metadata: Record<string, unknown>

property

name: string

An optional name for the message participant.

This property is primarily used to:

Identify agent roles in multi-agent systems: When multiple agents collaborate, setting name helps distinguish which agent produced a message, preventing confusion about who said what.
Pass participant names to model providers: Some providers (notably OpenAI, e.g. see OpenAI Chat Completions API) use this field to differentiate between participants with the same role. For example, when using OpenAI's Chat Completions API, the name is included in the message payload sent to the model.

// Setting name on an AIMessage to identify the agent
const message = new AIMessage({
  content: "I'll handle the calendar scheduling.",
  name: "calendar_agent"
});

// In a multi-agent system, this helps track message origins
const researcherMessage = new AIMessage({
  content: "Here are the findings...",
  name: "researcher"
});
const writerMessage = new AIMessage({
  content: "I've drafted the report.",
  name: "writer"
});

property

response_metadata: Partial<$InferResponseMetadata<TStructure, "tool">>

property

status: "success" | "error"

property

tool_call_id: string

deprecatedproperty

additional_kwargs: __type

ToolMessageFields

Bases

Properties

LangChain Assistant

Menu

ToolMessageFields

Bases

Properties