langchain.js
    Preparing search index...

    Class ToolMessage<TStructure>

    Represents a tool message in a conversation.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    [MESSAGE_SYMBOL] additional_kwargs artifact? content id? lc_direct_tool_output lc_kwargs lc_namespace lc_serializable name? response_metadata status? tool_call_id type

    Accessors

    _printableFields [toStringTag] contentBlocks lc_aliases lc_attributes lc_id lc_secrets lc_serializable_keys text

    Methods

    _getType _updateId getType toDict toJSON toJSONNotImplemented isInstance lc_name

    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

    artifact?: any

    Artifact of the Tool execution which is not meant to be sent to the model.

    Should only be specified if it is different from the message content, e.g. if only a subset of the full tool output is being passed as message content but the full output is needed in other parts of the code.

    content

    content: $InferMessageContent<TStructure, "tool">

    Array of content blocks that make up the message content

    id?: string

    Unique identifier for this message

    lc_direct_tool_output: true = ...
    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

    Optional name/identifier for the entity that created this message

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

    Metadata about the message

    status?: "success" | "error"

    Status of the tool invocation.

    0.2.19

    tool_call_id: string
    type: "tool" = ...

    The message type/role

    Accessors

    _printableFields

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

      Returns Record<string, unknown>

    • get "[toStringTag]"(): any

      Returns any

    • get contentBlocks(): ContentBlock.Standard[]

      Returns ContentBlock.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(): 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[]

    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: undefined | string): void

      Parameters

      • value: undefined | string

      Returns void

    • Returns MessageType

      Use .type instead The type of the message.

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods