[PR #4219] [MERGED] docs(langgraph): note private channels are not redacted when streaming #4206

Closed
opened 2026-06-05 19:13:08 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/langchain-ai/docs/pull/4219
Author: @christian-bromann
Created: 5/29/2026
Status: Merged
Merged: 6/3/2026
Merged by: @christian-bromann

Base: mainHead: cb/private-state-stream


📝 Commits (2)

  • d95d97f docs(langgraph): note private channels are not redacted when streaming
  • 35eb963 cr

📊 Changes

1 file changed (+70 additions, -0 deletions)

View changed files

📝 src/oss/langgraph/graph-api.mdx (+70 -0)

📄 Description

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.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/langchain-ai/docs/pull/4219 **Author:** [@christian-bromann](https://github.com/christian-bromann) **Created:** 5/29/2026 **Status:** ✅ Merged **Merged:** 6/3/2026 **Merged by:** [@christian-bromann](https://github.com/christian-bromann) **Base:** `main` ← **Head:** `cb/private-state-stream` --- ### 📝 Commits (2) - [`d95d97f`](https://github.com/langchain-ai/docs/commit/d95d97f33bcd5a702fbffb874232cd3ab9ec4ae8) docs(langgraph): note private channels are not redacted when streaming - [`35eb963`](https://github.com/langchain-ai/docs/commit/35eb96301da8a70e6d47af4e5b3672d017527ea3) cr ### 📊 Changes **1 file changed** (+70 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `src/oss/langgraph/graph-api.mdx` (+70 -0) </details> ### 📄 Description ## 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 19:13:08 -04:00
yindo closed this issue 2026-06-05 19:13:08 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#4206