LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangChain
  • Universal
  • Hub
  • Node
  • Load
  • Serializable
  • Encoder Backed
  • File System
  • In Memory
LangChain Core
  • Agents
  • Caches
  • Base
  • Dispatch
  • Web
  • Manager
  • Promises
  • Chat History
  • Context
  • Base
  • Langsmith
  • Documents
  • Embeddings
  • Errors
  • Example Selectors
  • Indexing
  • Base
  • Chat Models
  • Llms
  • Profile
  • Load
  • Serializable
  • Memory
  • Messages
  • Tool
  • Output Parsers
  • Openai Functions
  • Openai Tools
  • Outputs
  • Prompt Values
  • Prompts
  • Retrievers
  • Document Compressors
  • Runnables
  • Graph
  • Singletons
  • Stores
  • Structured Query
  • Tools
  • Base
  • Console
  • Log Stream
  • Run Collector
  • Tracer Langchain
  • Stream
  • Async Caller
  • Chunk Array
  • Context
  • Env
  • Event Source Parse
  • Format
  • Function Calling
  • Hash
  • Json Patch
  • Json Schema
  • Math
  • Ssrf
  • Stream
  • Testing
  • Tiktoken
  • Types
  • Vectorstores
Text Splitters
MCP Adapters
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangChain
UniversalHubNodeLoadSerializableEncoder BackedFile SystemIn Memory
LangChain Core
AgentsCachesBaseDispatchWebManagerPromisesChat HistoryContextBaseLangsmithDocumentsEmbeddingsErrorsExample SelectorsIndexingBaseChat ModelsLlmsProfileLoadSerializableMemoryMessagesToolOutput ParsersOpenai FunctionsOpenai ToolsOutputsPrompt ValuesPromptsRetrieversDocument CompressorsRunnablesGraphSingletonsStoresStructured QueryToolsBaseConsoleLog StreamRun CollectorTracer LangchainStreamAsync CallerChunk ArrayContextEnvEvent Source ParseFormatFunction CallingHashJson PatchJson SchemaMathSsrfStreamTestingTiktokenTypesVectorstores
Text Splitters
MCP Adapters
Language
Theme
JavaScriptlangchainindexBaseMessageChunk
Class●Since v1.1

BaseMessageChunk

Represents a chunk of a message, which can be concatenated with other message chunks. It includes a method _merge_kwargs_dict() for merging additional keyword arguments from another BaseMessageChunk into this one. It also overrides the __add__() method to support concatenation of BaseMessageChunk instances.

Copy
class BaseMessageChunk

Bases

BaseMessage<TStructure, TRole>

Used in Docs

  • SearchAPI integration
  • Searxng search integration

Constructors

constructor
constructor

Properties

property
[MESSAGE_SYMBOL]: true
property
additional_kwargs: __type
property
content: $InferMessageContent<TStructure, TRole>

Array of content blocks that make up the message content

property
id: string

Content block identifier, which can be either

  • generated by the provider (e.g., a provider-specific ID)
  • generated by LangChain upon creation (a uuid prefixed with 'lc-')
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

The name of the tool being called

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

Metadata about the message

property
type: TRole

Type of the content block

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

Methods

method
_updateId
method
concat→ this
method
toDict→ StoredMessage
method
toFormattedString→ string
method
toJSON→ Serialized
method
toJSONNotImplemented→ SerializedNotImplemented
method
isInstance→ obj is BaseMessage<T, MessageType> & AIMessage<T>

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

method
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: __typePcontent: TStructure["outputVersion"] extends "v1" ? $InferMessageContentBlocks<TStructure, "ai">[] : string | ContentBlock | Text[]
—

Array of content blocks that make up the message content

Pid: string
—

Content block identifier, which can be either

Plc_kwargs: SerializedFieldsPlc_namespace: string[]
—

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

Plc_serializable: booleanPname: TName
—

The name of the tool being called

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

Metadata about the message

Ptype: "file" | "image" | "audio"
—

Type of the content block

P_printableFields: Record<string, unknown>PcontentBlocks: Standard[]Plc_aliases: Record<string, string>Plc_attributes: SerializedFields | undefinedPlc_id: string[]Plc_secrets: __type | undefinedPlc_serializable_keys: string[] | undefinedPtext: string

Methods

M_getType→ MessageTypeM_updateIdMgetType→ MessageTypeMtoDict→ StoredMessageMtoFormattedString→ stringMtoJSON→ SerializedMtoJSONNotImplemented→ SerializedNotImplementedMisInstance→ obj is BaseMessage<T, MessageType> & AIMessage<T>
—

Type guard to check if an object is an AIMessage.

Mlc_name→ string
—

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

Inherited fromSerializable

Properties

Plc_kwargs: SerializedFieldsPlc_namespace: string[]
—

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

Plc_serializable: booleanPlc_aliases: Record<string, string>Plc_attributes: SerializedFields | undefinedPlc_id: string[]Plc_secrets: __type | undefinedPlc_serializable_keys: string[] | undefined

Methods

MtoJSON→ SerializedMtoJSONNotImplemented→ SerializedNotImplementedMlc_name→ string
—

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

View source on GitHub