LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Graphs
  • Functional API
  • Pregel
  • Checkpointing
  • Storage
  • Caching
  • Types
  • Runtime
  • Config
  • Errors
  • Constants
  • Channels
  • Agents
LangGraph CLI
LangGraph SDK
LangGraph Supervisor
LangGraph Swarm
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewGraphsFunctional APIPregelCheckpointingStorageCachingTypesRuntimeConfigErrorsConstantsChannelsAgents
LangGraph CLI
LangGraph SDK
LangGraph Supervisor
LangGraph Swarm
Language
Theme
Pythonlanggraphpregelremote
Module●Since v0.2

remote

Attributes

attribute
CONF
attribute
CONFIG_KEY_CHECKPOINT_ID
attribute
CONFIG_KEY_CHECKPOINT_MAP
attribute
CONFIG_KEY_CHECKPOINT_NS
attribute
CONFIG_KEY_STREAM
attribute
CONFIG_KEY_TASK_ID
attribute
INTERRUPT
attribute
NS_SEP
attribute
All: Literal['*']

Special value to indicate that graph should interrupt on all nodes.

attribute
StreamMode: Literal['values', 'updates', 'checkpoints', 'tasks', 'debug', 'messages', 'custom']

How the stream method should emit outputs.

  • "values": Emit all values in the state after each step, including interrupts. When used with functional API, values are emitted once at the end of the workflow.
  • "updates": Emit only the node or task names and updates returned by the nodes or tasks after each step. If multiple updates are made in the same step (e.g. multiple nodes are run) then those updates are emitted separately.
  • "custom": Emit custom data using from inside nodes or tasks using StreamWriter.
  • "messages": Emit LLM messages token-by-token together with metadata for any LLM invocations inside nodes or tasks.
  • "checkpoints": Emit an event when a checkpoint is created, in the same format as returned by get_state().
  • "tasks": Emit events when tasks start and finish, including their results and errors.
  • "debug": Emit "checkpoints" and "tasks" events for debugging purposes.
attribute
logger

Functions

function
merge_configs

Merge multiple configs into one.

Classes

class
GraphInterrupt

Raised when a subgraph is interrupted, suppressed by the root graph. Never raised directly, or surfaced to the user.

class
ParentCommand
class
PregelProtocol
class
StreamProtocol
class
Command

One or more commands to update the graph's state and send messages to nodes.

class
Interrupt

Information about an interrupt that occurred in a node.

Changed in version v0.4.0
  • interrupt_id was introduced as a property
Changed in version v0.6.0

The following attributes have been removed:

  • ns
  • when
  • resumable
  • interrupt_id, deprecated in favor of id
class
PregelTask

A Pregel task.

class
StateSnapshot

Snapshot of the state of the graph at the beginning of a step.

class
RemoteException

Exception raised when an error occurs in the remote graph.

class
RemoteGraph

The RemoteGraph class is a client implementation for calling remote APIs that implement the LangGraph Server API specification.

For example, the RemoteGraph class can be used to call APIs from deployments on LangSmith Deployment.

RemoteGraph behaves the same way as a Graph and can be used directly as a node in another Graph.

View source on GitHub