LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Graphs
    • Functional API
    • Pregel
    • Checkpointing
    • Storage
    • Caching
    • Types
    • Runtime
    • Config
    • Errors
    • Constants
    • Channels
    • Agents
    LangGraph Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    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 Checkpoint
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    PythonlanggraphpregelremoteRemoteGraphastream_events
    Methodā—Since v0.2

    astream_events

    Copy
    astream_events(
      self,
      input: Any,
      config: RunnableConfig | None = None,
      *
    View source on GitHub
    ,
    version
    :
    Literal
    [
    'v1'
    ,
    'v2'
    ,
    'v3'
    ]
    =
    'v2'
    ,
    interrupt_before
    :
    All
    |
    Sequence
    [
    str
    ]
    |
    None
    =
    None
    ,
    interrupt_after
    :
    All
    |
    Sequence
    [
    str
    ]
    |
    None
    =
    None
    ,
    control
    :
    Any
    =
    None
    ,
    transformers
    :
    Sequence
    [
    Any
    ]
    |
    None
    =
    None
    ,
    headers
    :
    dict
    [
    str
    ,
    str
    ]
    |
    None
    =
    None
    ,
    **
    kwargs
    :
    Any
    =
    {
    }
    )
    ->
    Any

    Async-stream events from this remote graph.

    For version="v3", awaits to an _AsyncRemoteGraphRunStream, matching the local Pregel.astream_events(version="v3") awaitable contract: async with await rg.astream_events(..., version="v3") as run. For version="v1"/"v2", raises NotImplementedError (use astream).