Class●Since v0.3

ChatMessage

Represents a chat message in a conversation.

class ChatMessage

Bases

BaseMessage<TStructure, "generic">

Constructors

constructor→ ChatMessage<TStructure>

Properties

property

content: TStructure["outputVersion"] extends "v1" ? $InferMessageContentBlocks<TStructure, "generic">[] : string | ContentBlock | Text[]

Array of content blocks that make up the message content

property

id: string

Unique identifier for this message

property

lc_kwargs: SerializedFields

property

lc_namespace: string[]

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

property

lc_serializable: boolean

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: NonNullable<BaseMessageFields<TStructure, TRole>["response_metadata"]>

Metadata about the message

property

role: string

property

type: "generic"

The message type/role

property

_printableFields: Record<string, unknown>

property

[toStringTag]: any

property

contentBlocks: Standard[]

property

lc_aliases: Record<string, string>

property

lc_attributes: SerializedFields | undefined

property

lc_id: string[]

property

lc_secrets: __type | undefined

property

lc_serializable_keys: string[] | undefined

property

text: string

deprecatedproperty

additional_kwargs: __type

Methods

toDict→ StoredMessage

toFormattedString→ string

toJSON→ Serialized

toJSONNotImplemented→ SerializedNotImplemented

_chatMessageClass→ typeof ChatMessage

[hasInstance]→ obj is ChatMessage<MessageStructure<MessageToolSet>>

isInstance→ obj is ChatMessage<MessageStructure<MessageToolSet>>

lc_name→ string

The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

deprecatedmethod

_getType→ MessageType

deprecatedmethod

getType→ MessageType

Inherited fromBaseMessage

Properties

Padditional_kwargs: __type Pcontent: $InferMessageContent<TStructure, TRole>

Array of content blocks that make up the message content

Unique identifier for this message

Plc_kwargs: SerializedFields Plc_namespace: string[]

A path to the module that contains the class, eg. ["langchain", "llms"]

Plc_serializable: boolean Pname: string

An optional name for the message participant.

Presponse_metadata: NonNullable<BaseMessageFields<TStructure, TRole>["response_metadata"]>

Metadata about the message

The message type/role

P_printableFields: Record<string, unknown>PcontentBlocks: Standard[]Plc_aliases: Record<string, string>Plc_attributes: SerializedFields | undefined Plc_id: string[]Plc_secrets: __type | undefined Plc_serializable_keys: string[] | undefined Ptext: string

Methods

M_getType→ MessageType M_updateId MgetType→ MessageType MtoDict→ StoredMessage MtoFormattedString→ string MtoJSON→ Serialized MtoJSONNotImplemented→ SerializedNotImplemented MisInstance→ obj is BaseMessage<MessageStructure<MessageToolSet>, MessageType>Mlc_name→ string

The name of the serializable. Override to provide an alias or

Inherited fromSerializable

Properties

Plc_kwargs: SerializedFields Plc_namespace: string[]

A path to the module that contains the class, eg. ["langchain", "llms"]

Plc_serializable: boolean Plc_aliases: __type | undefined Plc_attributes: SerializedFields | undefined Plc_id: string[]Plc_secrets: __type | undefined Plc_serializable_keys: string[] | undefined

Methods

MtoJSON→ Serialized MtoJSONNotImplemented→ SerializedNotImplemented Mlc_name→ string

The name of the serializable. Override to provide an alias or

View source on GitHub