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
    Pythonlanggraphpregel_checkpointcreate_checkpoint_plan_for_update_state_api
    Functionā—Since v1.2

    create_checkpoint_plan_for_update_state_api

    Copy
    create_checkpoint_plan_for_update_state_api(
      channels: Mapping[str, BaseChannel],
      updated_channels: set[str
    View source on GitHub
    ]
    ,
    *
    ,
    step
    :
    int
    ,
    parents
    :
    dict
    [
    str
    ,
    Any
    ]
    ,
    saved_metadata
    :
    Mapping
    [
    str
    ,
    Any
    ]
    |
    None
    ,
    is_fresh_thread
    :
    bool
    )
    ->
    tuple
    [
    set
    [
    str
    ]
    ,
    dict
    [
    str
    ,
    Any
    ]
    ]

    Return (channels_to_snapshot, metadata) for an update_state head.