langchain.js
    Preparing search index...

    Class ChatMessage<TStructure>

    Represents a chat message in a conversation.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    "[MESSAGE_SYMBOL]": true = ...
    additional_kwargs: {
        function_call?: FunctionCall;
        tool_calls?: OpenAIToolCall[];
        [key: string]: unknown;
    }

    Type Declaration

    • [key: string]: unknown
    • Optionalfunction_call?: FunctionCall

      Use "tool_calls" field on AIMessages instead

    • Optionaltool_calls?: OpenAIToolCall[]

      Use "tool_calls" field on AIMessages instead

    content: $InferMessageContent<TStructure, "generic">

    Array of content blocks that make up the message content

    id?: string

    Unique identifier for this message

    lc_kwargs: SerializedFields
    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.

    lc_serializable: boolean = true
    name?: string

    An optional name for the message participant.

    This property is primarily used to:

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

    2. 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"
    });
    response_metadata: NonNullable<
        BaseMessageFields<TStructure, TRole>["response_metadata"],
    >

    Metadata about the message

    role: string
    type: "generic" = ...

    The message type/role

    Accessors

    • get _printableFields(): Record<string, unknown>

      Returns Record<string, unknown>

    • get "[toStringTag]"(): any

      Returns any

    • get lc_aliases(): Record<string, string>

      A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

      Returns Record<string, string>

    • get lc_attributes(): undefined | SerializedFields

      A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

      Returns undefined | SerializedFields

    • get lc_id(): string[]

      The final serialized identifier for the module.

      Returns string[]

    • get lc_secrets(): undefined | { [key: string]: string }

      A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

      Returns undefined | { [key: string]: string }

    • get lc_serializable_keys(): undefined | string[]

      A manual list of keys that should be serialized. If not overridden, all fields passed into the constructor will be serialized.

      Returns undefined | string[]

    • get text(): string

      Get text content of the message.

      Returns string

    Methods

    • Returns MessageType

      Use .getType() instead or import the proper typeguard. For example:

      import { isAIMessage } from "@langchain/core/messages";

      const message = new AIMessage("Hello!");
      isAIMessage(message); // true
    • Parameters

      • value: undefined | string

      Returns void

    • Returns MessageType

      Use .type instead The type of the message.

    • Parameters

      • format: "pretty" = "pretty"

      Returns string

    • Returns typeof ChatMessage

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

      Returns string