LangChain Reference home page

GitHub
Main Docs

LangChain

Browser
Universal
Hub
Node
Load
Serializable
Encoder Backed
File System
In Memory
Tools

LangChain Core

Text Splitters

MCP Adapters

⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

Browser Universal Hub Node Load Serializable Encoder Backed File System In Memory Tools

Agents Caches Base Dispatch Web Manager Promises Chat History Context Base Langsmith Documents Embeddings Errors Example Selectors Indexing Base Chat Models Compat Event Llms Profile Stream Structured Output Load Serializable Memory Messages Tool Output Parsers Openai Functions Openai Tools Outputs Prompt Values Prompts Retrievers Document Compressors Runnables Graph Singletons Stores Structured Query Testing 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 Standard Schema Stream Testing Tiktoken Types Uuid Vectorstores

Language

Theme

JavaScript@langchain/corelanguage_modelsstreamChatModelStream

Class●Since v1.1

ChatModelStream

Copy

class ChatModelStream

Properties

Methods

View source on GitHub

property

output: PromiseLike<AIMessage<MessageStructure<MessageToolSet>>>

property

reasoning: string

The new reasoning text to append.

property

text: string

The new text to append.

property

toolCalls: ToolCallsStream

property

usage: Partial<UsageMetadata>

Final usage snapshot.

[asyncIterator]→ AsyncIterator<ChatModelStreamEvent>

then→ PromiseLike<TResult1 | TResult2>

Attaches callbacks for the resolution and/or rejection of the Promise.

The main stream object returned by chat model streaming.

Implements AsyncIterable<ChatModelStreamEvent> for raw event access and PromiseLike<AIMessage> for simple await usage.