Forest Admin - API reference
    Preparing search index...

    Interface BaseMessage<TStructure, TRole>Abstract

    Base class for all types of messages in a conversation. It includes properties like content, name, and additional_kwargs. It also includes methods like toDict() and _getType().

    interface BaseMessage<
        TStructure extends MessageStructure = MessageStructure,
        TRole extends MessageType = MessageType,
    > {
        additional_kwargs: {
            function_call?: FunctionCall;
            tool_calls?: OpenAIToolCall[];
            [key: string]: unknown;
        };
        content: $InferMessageContent<TStructure, TRole>;
        id?: string;
        lc_kwargs: SerializedFields;
        lc_namespace: string[];
        lc_serializable: boolean;
        name?: string;
        response_metadata: NonNullable<
            BaseMessageFields<TStructure, TRole>["response_metadata"],
        >;
        type: TRole;
        get _printableFields(): Record<string, unknown>;
        get "[toStringTag]"(): any;
        get contentBlocks(): Standard[];
        get lc_aliases(): Record<string, string>;
        get lc_attributes(): SerializedFields;
        get lc_id(): string[];
        get lc_secrets(): { [key: string]: string };
        get lc_serializable_keys(): string[];
        get text(): string;
        _getType(): MessageType;
        _updateId(value: string): void;
        getType(): MessageType;
        toDict(): StoredMessage;
        toFormattedString(format?: "pretty"): string;
        toJSON(): Serialized;
        toJSONNotImplemented(): SerializedNotImplemented;
        readonly [key: symbol]: any;
    }

    Type Parameters

    • TStructure extends MessageStructure = MessageStructure
    • TRole extends MessageType = MessageType

    Hierarchy (View Summary)

    Implements

    Indexable

    • readonly [key: symbol]: any
    Index

    Properties

    additional_kwargs content id? lc_kwargs lc_namespace lc_serializable name? response_metadata type

    Accessors

    _printableFields [toStringTag] contentBlocks lc_aliases lc_attributes lc_id lc_secrets lc_serializable_keys text

    Methods

    _getType _updateId getType toDict toFormattedString toJSON toJSONNotImplemented

    Properties

    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

    content: $InferMessageContent<TStructure, TRole>

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

    Metadata about the message

    type: TRole

    The message type/role

    Accessors

    _printableFields

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

      Returns Record<string, unknown>

    • get "[toStringTag]"(): any

      Returns any

    • get contentBlocks(): Standard[]

      Returns Standard[]

    • 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(): 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 SerializedFields

    • get lc_id(): string[]

      The final serialized identifier for the module.

      Returns string[]

    • get lc_secrets(): { [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 { [key: string]: string }

    • get lc_serializable_keys(): string[]

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

      Returns string[]

    text

    • get text(): string

      Get text content of the message.

      Returns string

    Methods

    _getType

    • _getType(): MessageType

      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

    _updateId

    • _updateId(value: string): void

      Parameters

      • value: string

      Returns void

    • Returns MessageType

      Use .type instead The type of the message.

    • Returns StoredMessage

    • Parameters

      • Optionalformat: "pretty"

      Returns string

    • Returns Serialized

    • Returns SerializedNotImplemented

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods