Skip to content

docs(langgraph): note private channels are not redacted when streaming#4219

Open
Christian Bromann (christian-bromann) wants to merge 1 commit into
mainfrom
cb/private-state-stream
Open

docs(langgraph): note private channels are not redacted when streaming#4219
Christian Bromann (christian-bromann) wants to merge 1 commit into
mainfrom
cb/private-state-stream

Conversation

@christian-bromann
Copy link
Copy Markdown
Member

Summary

  • Add a Warning callout to the Graph API docs explaining that private state channels are not redacted during streaming.
  • Document that stream_mode="values" / streamMode: "values" defaults to the full set of state channels rather than the output schema, so private channels (e.g. bar) are visible while streaming even though invoke hides them.
  • Show how to restrict streamed values via output_keys (Python) / outputKeys (JS), and note stream_mode="updates" as an alternative for per-node output.
  • Mirror the guidance across both the Python and JS tabs.

Clarify that input/output/private schemas constrain node reads and
invoke returns, but `stream_mode="values"` emits all state channels
including private ones. Show how to scope streamed values with
output_keys (py) / outputKeys (js).
@github-actions github-actions Bot added langgraph For docs changes to LangGraph oss labels May 29, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Thanks for opening a docs PR, Christian Bromann (@christian-bromann)! When it's ready for review, please add the relevant reviewers:

  • @npentrel or @lnhsingh (LangGraph)

@github-actions
Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-cbpriv-1780098138-8a5fd76

Site preview: https://langchain-5e9cc07a-preview-cbpriv-1780098138-8a5fd76.mintlify.app

Preview links may take a few minutes to start working while the deployment finishes.

Changed documentation pages (preview deep links):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal langgraph For docs changes to LangGraph oss

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant