WEBDIENSTE/langgraph
1
0
Fork 0
mirror of https://github.com/langchain-ai/langgraph.git synced 2026-09-08 02:37:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): enhance return type documentation for graph run method

Browse Source
This commit is contained in:
Mason Daugherty
2025-11-07 20:48:20 -05:00
parent 218c60717e
commit 45613ddc8f
1 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libs/langgraph/langgraph/pregel/main.py
+22 -2
View File
@@ -3038,7 +3038,17 @@ class Pregel(
**kwargs: Additional keyword arguments to pass to the graph run.
Returns:
The output of the graph run. If `stream_mode` is `"values"`, it returns the latest output.
The output of the graph run. Common return types include:
- Single channel: `AIMessage`, `list[AnyMessage]`, or any channel value
- Multiple channels: `dict[str, Any]` mapping channel names to values
- Non-values mode: `list` of output chunks
For message-based graphs, typically returns:
`{"messages": [HumanMessage, AIMessage, ...]}`
If `stream_mode` is `"values"`, it returns the latest output.
If `stream_mode` is not `"values"`, it returns a list of output chunks.
"""
output_keys = output_keys if output_keys is not None else self.output_channels
@@ -3125,7 +3135,17 @@ class Pregel(
**kwargs: Additional keyword arguments to pass to the graph run.
Returns:
The output of the graph run. If `stream_mode` is `"values"`, it returns the latest output.
The output of the graph run. Common return types include:
- Single channel: `AIMessage`, `list[AnyMessage]`, or any channel value
- Multiple channels: `dict[str, Any]` mapping channel names to values
- Non-values mode: `list` of output chunks
For message-based graphs, typically returns:
`{"messages": [HumanMessage, AIMessage, ...]}`
If `stream_mode` is `"values"`, it returns the latest output.
If `stream_mode` is not `"values"`, it returns a list of output chunks.
"""
output_keys = output_keys if output_keys is not None else self.output_channels