Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
habib-source opened this issue Jan 13, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@habib-source
Copy link

habib-source commented 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.

@vbarda vbarda added the documentation Improvements or additions to documentation label Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants