Class ToolMessageChunk

Represents a chunk of a tool message, which can be concatenated with other tool message chunks.

Hierarchy

BaseMessageChunk
- ToolMessageChunk

Index

Constructors

Properties

additional_kwargs content tool_call_id name?

Accessors

Methods

concat toChunk toDict toJSON toJSONNotImplemented

Constructors

constructor

new ToolMessageChunk(fields): ToolMessageChunk
Parameters
- fields: ToolMessageFieldsWithToolCallId
Returns ToolMessageChunk
Overrides BaseMessageChunk.constructor
- Defined in langchain/src/schema/index.ts:585

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 BaseMessageChunk.text
- Defined in langchain/src/schema/index.ts:182

Methods

concat

concat(chunk): ToolMessageChunk
Parameters
- chunk: ToolMessageChunk
Returns ToolMessageChunk
Overrides BaseMessageChunk.concat
- Defined in langchain/src/schema/index.ts:600

toChunk

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

toDict

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

toJSON

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

toJSONNotImplemented

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

Generated using TypeDoc