SAP AI SDK for JavaScript - v2.8.0
    Preparing search index...

    Class OrchestrationMessageChunk

    An AI Message Chunk containing intermediate results and request ID.

    Hierarchy

    • AIMessageChunk
      • OrchestrationMessageChunk

    Indexable

    • readonly [key: symbol]: any
    Index

    Constructors

    constructor

    Properties

    additional_kwargs content id? intermediate_results invalid_tool_calls? lc_kwargs lc_namespace lc_serializable name? request_id response_metadata tool_call_chunks? tool_calls? type usage_metadata?

    Accessors

    _printableFields [toStringTag] contentBlocks lc_aliases lc_attributes lc_id lc_secrets lc_serializable_keys text

    Methods

    _getType _updateId concat getType toDict toFormattedString toJSON toJSONNotImplemented isInstance lc_name

    Constructors

    • Parameters

      • fields: string | AIMessageChunkFields
      • intermediate_results: ModuleResultsStreaming
      • request_id: string

      Returns OrchestrationMessageChunk

    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: string | (ContentBlock | Text)[]

    Array of content blocks that make up the message content

    id?: string

    Unique identifier for this message

    intermediate_results: ModuleResultsStreaming
    invalid_tool_calls?: InvalidToolCall<string>[]
    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
    request_id: string
    response_metadata: NonNullable<
        BaseMessageFields<TStructure, TRole>["response_metadata"],
    >

    Metadata about the message

    tool_call_chunks?: ToolCallChunk<string>[]
    tool_calls?: {
        args: Record<string, any>;
        id?: string;
        name: string;
        type?: "tool_call";
    }[]
    type: "ai"
    usage_metadata?: UsageMetadata

    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>

      Returns Record<string, string>

    • get lc_attributes(): SerializedFields | undefined

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

    • get lc_id(): string[]

      The final serialized identifier for the module.

      Returns string[]

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

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

    • get lc_serializable_keys(): string[] | undefined

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

      Returns string[] | undefined

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

      Parameters

      • value: string | undefined

      Returns void

    • Parameters

      • chunk: AIMessageChunk<MessageStructure<MessageToolSet>>

      Returns this

    • Returns MessageType

      Use .type instead The type of the message.

    • Returns StoredMessage

    • Parameters

      • Optionalformat: "pretty"

      Returns string

    • Returns Serialized

    • Returns SerializedNotImplemented

    • Type guard to check if an object is an AIMessageChunk. Preserves the MessageStructure type parameter when called with a typed BaseMessage. When called with a typed BaseMessage, preserves the TStructure type

      Type Parameters

      • T extends MessageStructure<MessageToolSet>

      Parameters

      • obj: BaseMessage<T>

      Returns obj is BaseMessage<T, MessageType> & AIMessageChunk<T>

    • Type guard to check if an object is an AIMessageChunk. When called with unknown, returns base AIMessageChunk type

      Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.

      Parameters

      • obj: unknown

      Returns obj is AIMessageChunk<MessageStructure<MessageToolSet>>

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods