Library with base interfaces for LangGraph checkpoint savers.
Project description
LangGraph Checkpoint
This library defines the base interface for LangGraph checkpointers. Checkpointers provide persistence layer for LangGraph. They allow you to interact with and manage the graph's state. When you use a graph with a checkpointer, the checkpointer saves a checkpoint of the graph state at every superstep, enabling several powerful capabilities like human-in-the-loop, "memory" between interactions and more.
Key concepts
Checkpoint
Checkpoint is a snapshot of the graph state at a given point in time. Checkpoint tuple refers to an object containing checkpoint and the associated config, metadata and pending writes.
Thread
Threads enable the checkpointing of multiple different runs, making them essential for multi-tenant chat applications and other scenarios where maintaining separate states is necessary. A thread is a unique ID assigned to a series of checkpoints saved by a checkpointer. When using a checkpointer, you must specify a thread_id
and optionally checkpoint_id
when running the graph.
thread_id
is simply the ID of a thread. This is always requiredcheckpoint_id
can optionally be passed. This identifier refers to a specific checkpoint within a thread. This can be used to kick of a run of a graph from some point halfway through a thread.
You must pass these when invoking the graph as part of the configurable part of the config, e.g.
{"configurable": {"thread_id": "1"}} # valid config
{"configurable": {"thread_id": "1", "checkpoint_id": "0c62ca34-ac19-445d-bbb0-5b4984975b2a"}} # also valid config
Serde
langgraph_checkpoint
also defines protocol for serialization/deserialization (serde) and provides an default implementation (langgraph.checkpoint.serde.jsonplus.JsonPlusSerializer
) that handles a wide variety of types, including LangChain and LangGraph primitives, datetimes, enums and more.
Pending writes
When a graph node fails mid-execution at a given superstep, LangGraph stores pending checkpoint writes from any other nodes that completed successfully at that superstep, so that whenever we resume graph execution from that superstep we don't re-run the successful nodes.
Interface
Each checkpointer should conform to langgraph.checkpoint.base.BaseCheckpointSaver
interface and must implement the following methods:
.put
- Store a checkpoint with its configuration and metadata..put_writes
- Store intermediate writes linked to a checkpoint (i.e. pending writes)..get_tuple
- Fetch a checkpoint tuple using for a given configuration (thread_id
andthread_ts
)..list
- List checkpoints that match a given configuration and filter criteria.
If the checkpointer will be used with asynchronous graph execution (i.e. executing the graph via .ainvoke
, .astream
, .abatch
), checkpointer must implement asynchronous versions of the above methods (.aput
, .aput_writes
, .aget_tuple
, .alist
).
Usage
from langgraph.checkpoint.memory import MemorySaver
write_config = {"configurable": {"thread_id": "1", "checkpoint_ns": ""}}
read_config = {"configurable": {"thread_id": "1"}}
checkpointer = MemorySaver()
checkpoint = {
"v": 1,
"ts": "2024-07-31T20:14:19.804150+00:00",
"id": "1ef4f797-8335-6428-8001-8a1503f9b875",
"channel_values": {
"my_key": "meow",
"node": "node"
},
"channel_versions": {
"__start__": 2,
"my_key": 3,
"start:node": 3,
"node": 3
},
"versions_seen": {
"__input__": {},
"__start__": {
"__start__": 1
},
"node": {
"start:node": 2
}
},
"pending_sends": [],
}
# store checkpoint
checkpointer.put(write_config, checkpoint, {}, {})
# load checkpoint
checkpointer.get(read_config)
# list checkpoints
list(checkpointer.list(read_config))
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gigagraph_checkpoint-1.0.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 044062801aebb058dd423436dcfcac3e8f0fb8647e6ef8f4caf65913dd654cee |
|
MD5 | c3e4cead9c3a98287213b6abab6ba059 |
|
BLAKE2b-256 | f6c982be8dee92afa535dfba9acd2191d9b8cd693ec7aa9eebd6d7feede11541 |
Hashes for gigagraph_checkpoint-1.0.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bb99ec58ca52b54686c02e9ed51c806dd72f801f9b5ef0d01919fd3ca27c09e |
|
MD5 | f212ae9fb3bd26080e085f69d10d0dfd |
|
BLAKE2b-256 | f13de1bbb381a4073b87efb122b75c562aaed0a20d4bb144980026286c4a8195 |