DOC: API reference doesn't mention the “messages” stream mode in stream_mode definition. #399

Closed
opened 2026-02-20 17:39:54 -05:00 by yindo · 1 comment
Owner

Originally created by @habib-source on GitHub (Jan 13, 2025).

Issue with current documentation:

stream_mode (Optional[Union[StreamMode, list[StreamMode]]], default: None ) – The mode to stream output, defaults to self.stream_mode. Options are 'values', 'updates', and 'debug'. values: Emit the current values of the state for each step. updates: Emit only the updates to the state for each step. Output is a dict with the node name as key and the updated values as value. debug: Emit debug events for each step.

For example, this is the definition of stream_mode in the async meth under the CompiledStateGraph url with mention for 'values', 'updates', and 'debug' but no 'messages'. I thought it was deprecated or something. But I tried it out and it works.

Idea or request for content:

add the 'messages' stream mode and it's definition to the stream_mode definition.

Originally created by @habib-source on GitHub (Jan 13, 2025). ### Issue with current documentation: stream_mode (Optional[Union[StreamMode, list[StreamMode]]], default: None ) – The mode to stream output, defaults to self.stream_mode. Options are 'values', 'updates', and 'debug'. values: Emit the current values of the state for each step. updates: Emit only the updates to the state for each step. Output is a dict with the node name as key and the updated values as value. debug: Emit debug events for each step. For example, this is the definition of stream_mode in the async meth under the CompiledStateGraph [url](https://langchain-ai.github.io/langgraph/reference/graphs/#langgraph.graph.state.CompiledStateGraph.astream) with mention for 'values', 'updates', and 'debug' but no 'messages'. I thought it was deprecated or something. But I tried it out and it works. ### Idea or request for content: add the 'messages' stream mode and it's definition to the stream_mode definition.
yindo added the documentation label 2026-02-20 17:39:54 -05:00
yindo closed this issue 2026-02-20 17:39:54 -05:00
Author
Owner

@dhruv1710 commented on GitHub (Mar 11, 2025):

I think it is solved

Image
@dhruv1710 commented on GitHub (Mar 11, 2025): I think it is solved <img width="717" alt="Image" src="https://github.com/user-attachments/assets/7cbea8fd-c3e4-4099-bb46-e2fecfeb1b29" />
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/langgraph#399