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 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
    Pythonlanggraphpregel_readChannelRead
    Class●Since v0.6

    ChannelRead

    Copy
    ChannelRead(
      self,
      channel: str | list[str],
      *,
      fresh: bool

    Bases

    RunnableCallable

    Constructors

    Attributes

    Methods

    Inherited fromRunnableCallable

    Attributes

    AnameAfunc: funcAafunc: afuncAtags: tagsA
    View source on GitHub
    =
    False
    ,
    mapper
    :
    Callable
    [
    [
    Any
    ]
    ,
    Any
    ]
    |
    None
    =
    None
    ,
    tags
    :
    list
    [
    str
    ]
    |
    None
    =
    None
    )
    kwargs
    : kwargs
    Atrace: trace
    Arecurse: recurse
    Aexplode_args: explode_args
    Afunc_accepts: dict[str, tuple[str, Any]]

    Methods

    MinvokeMainvoke

    Inherited fromRunnable(langchain_core)

    Attributes

    AnameAInputTypeAOutputTypeAinput_schemaAoutput_schemaAconfig_specs

    Methods

    Mget_input_schemaMget_input_jsonschemaMget_output_schemaMget_output_jsonschemaMconfig_schemaMget_config_jsonschema
    constructor
    __init__
    NameType
    channelstr | list[str]
    freshbool
    mapperCallable[[Any], Any] | None
    tagslist[str] | None
    attribute
    channel: str | list[str]
    attribute
    fresh: bool
    attribute
    mapper: Callable[[Any], Any] | None
    method
    get_name
    method
    do_read

    Implements the logic for reading state from CONFIG_KEY_READ. Usable both as a runnable as well as a static method to call imperatively.

    Mget_graph
    Mget_prompts
    Mpipe
    Mpick
    Massign
    Minvoke
    Mainvoke
    Mbatch
    Mbatch_as_completed
    Mabatch
    Mabatch_as_completed
    Mstream
    Mastream
    Mastream_log
    Mastream_events
    Mtransform
    Matransform
    Mbind
    Mwith_config
    Mwith_listeners
    Mwith_alisteners
    Mwith_types
    Mwith_retry
    Mmap
    Mwith_fallbacks
    Mas_tool