Class ChatMessage

Represents a chat message in a conversation.

Hierarchy

BaseMessage
- ChatMessage

Implements

ChatMessageFieldsWithRole

Index

Constructors

Properties

additional_kwargs content role name?

Accessors

Methods

toChunk toDict toJSON toJSONNotImplemented isInstance

Constructors

constructor

new ChatMessage(content, role): ChatMessage
Parameters
- content: string
- role: string
Returns ChatMessage
Overrides BaseMessage.constructor
- Defined in langchain/src/schema/index.ts:626
new ChatMessage(fields): ChatMessage
Parameters
- fields: ChatMessageFieldsWithRole
Returns ChatMessage
Overrides BaseMessage.constructor
- Defined in langchain/src/schema/index.ts:628

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.

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 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

`Static` isInstance

isInstance(message): message is ChatMessage
Parameters
- message: BaseMessage
Returns message is ChatMessage
- Defined in langchain/src/schema/index.ts:644

Generated using TypeDoc