Class ToolMessage

Represents a tool message in a conversation.

Hierarchy

BaseMessage
- ToolMessage

Index

Constructors

Properties

additional_kwargs content tool_call_id name?

Accessors

Methods

toChunk toDict toJSON toJSONNotImplemented

Constructors

constructor

new ToolMessage(fields): ToolMessage
Parameters
- fields: ToolMessageFieldsWithToolCallId
Returns ToolMessage
Overrides BaseMessage.constructor
- Defined in langchain/src/schema/index.ts:551
new ToolMessage(fields, tool_call_id, name?): ToolMessage
Parameters
- fields: string | BaseMessageFields
- tool_call_id: string
- Optional name: string
Returns ToolMessage
Overrides BaseMessage.constructor
- Defined in langchain/src/schema/index.ts:553

Properties

additional_kwargs

additional_kwargs: {
    function_call?: FunctionCall;
    tool_calls?: ChatCompletionMessageToolCall[];
    [key: string]: unknown;
}

Additional keyword arguments

Type declaration

[key: string]: unknown
Optional function_call?: FunctionCall
Optional tool_calls?: ChatCompletionMessageToolCall[]

content

content: MessageContent

The content of the message.

tool_call_id

tool_call_id: string

`Optional` name

name?: string

The name of the message sender in a multi-user chat.

Accessors

text

get text(): string
Returns string

Deprecated
Use content instead.
Inherited from BaseMessage.text
- Defined in langchain/src/schema/index.ts:182

Methods

toChunk

toChunk(): BaseMessageChunk
Returns BaseMessageChunk
Inherited from BaseMessage.toChunk
- Defined in langchain/src/schema/index.ts:226

toDict

toDict(): StoredMessage
Returns StoredMessage
Inherited from BaseMessage.toDict
- Defined in langchain/src/schema/index.ts:218

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseMessage.toJSON
- Defined in langchain/src/load/serializable.ts:147

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseMessage.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:221

Generated using TypeDoc