Class ChatMessage

Represents a chat message in a conversation.

Hierarchy (view full)

BaseMessage
- ChatMessage

Implements

ChatMessageFieldsWithRole

Index

Constructors

constructor

new ChatMessage(content, role): ChatMessage
Parameters
- content: string
- role: string
Returns ChatMessage
Overrides BaseMessage.constructor
- Defined in langchain-core/src/messages/chat.ts:31
new ChatMessage(fields): ChatMessage
Parameters
- fields: ChatMessageFieldsWithRole
Returns ChatMessage
Overrides BaseMessage.constructor
- Defined in langchain-core/src/messages/chat.ts:33

Properties

additional_kwargs

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

Additional keyword arguments

Type declaration

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

content

content: MessageContent

The content of the message.

response_metadata

response_metadata: Record<string, any>

Response metadata. For example: response headers, logprobs, token counts.

role

role: 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 BaseMessage.content instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.
Inherited from BaseMessage.text
- Defined in langchain-core/src/messages/base.ts:157

Methods

toDict

toDict(): StoredMessage
Returns StoredMessage
Inherited from BaseMessage.toDict
- Defined in langchain-core/src/messages/base.ts:205

toJSON

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

toJSONNotImplemented

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

`Static` isInstance

isInstance(message): message is ChatMessage
Parameters
- message: BaseMessage
Returns message is ChatMessage
- Defined in langchain-core/src/messages/chat.ts:48

Class ChatMessage

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

content: string

role: string

Returns ChatMessage

Parameters

fields: ChatMessageFieldsWithRole

Returns ChatMessage

Properties

additional_kwargs

Type declaration

[key: string]: unknown

Optional function_call?: FunctionCall

Optional tool_calls?: ToolCall[]

content

response_metadata

role

Optional name

Accessors

text

Returns string

⚠️ Deprecated ⚠️

Methods

toDict

Returns StoredMessage

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Static isInstance

Parameters

message: BaseMessage

Returns message is ChatMessage

Settings

Member Visibility

Theme

On This Page

`Optional` function_call?: FunctionCall

`Optional` tool_calls?: ToolCall[]

`Optional` name

`Static` isInstance