检查点器¶
CheckpointMetadata
¶
基类:
与检查点关联的元数据。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
source: Literal['input', 'loop', 'update']
instance-attribute
¶
检查点的来源。
- "input": 检查点是从输入创建的,用于调用/流/批处理。
- "loop": 检查点是从 pregel 循环内部创建的。
- "update": 检查点是从手动状态更新创建的。
step: int
instance-attribute
¶
检查点的步骤号。
-1 表示第一个 "input" 检查点。0 表示第一个 "loop" 检查点。... 表示之后的第 n 个检查点。
writes: dict[str, Any]
instance-attribute
¶
在之前的检查点和当前检查点之间所做的写入操作。
从节点名称到该节点发出的写入操作的映射。
parents: dict[str, str]
instance-attribute
¶
父检查点的 ID。
从检查点命名空间到检查点 ID 的映射。
Checkpoint
¶
基类:
在特定时间点的状态快照。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
v: int
instance-attribute
¶
检查点格式的版本。当前为 1。
id: str
instance-attribute
¶
检查点的 ID。它既是唯一的又是单调递增的,因此可以用于对检查点进行排序,从第一个到最后一个。
ts: str
instance-attribute
¶
检查点的 ISO 8601 格式的时间戳。
channel_values: dict[str, Any]
instance-attribute
¶
检查点时通道的值。从通道名称到反序列化的通道快照值的映射。
channel_versions: ChannelVersions
instance-attribute
¶
检查点时通道的版本。键是通道名称,值是每个通道的单调递增版本字符串。
versions_seen: dict[str, ChannelVersions]
instance-attribute
¶
从节点 ID 到从通道名称到已查看版本的映射。这会跟踪每个节点已查看的通道的版本。用于确定接下来要执行哪些节点。
pending_sends: List[SendProtocol]
instance-attribute
¶
推送到节点但尚未处理的输入列表。在下一个检查点被清除。
BaseCheckpointSaver
¶
基类:
用于创建图形检查点器的基类。
检查点器允许 LangGraph 代理在多个交互中以及跨多个交互持久化其状态。
属性
-
(serde
) –SerializerProtocol 用于编码/解码检查点的序列化器。
注意
在创建自定义检查点保存器时,请考虑实现异步版本,以避免阻塞主线程。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
|
config_specs: list[ConfigurableFieldSpec]
property
¶
定义检查点保存器的配置选项。
返回值
-
–list [ConfigurableFieldSpec ]list[ConfigurableFieldSpec]: 配置字段规范的列表。
get(config: RunnableConfig) -> Optional[Checkpoint]
¶
使用给定的配置获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
get_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
¶
使用给定的配置获取检查点元组。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [CheckpointTuple ]Optional[CheckpointTuple]: 请求的检查点元组,如果未找到则为 None。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
list(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> Iterator[CheckpointTuple]
¶
列出符合给定条件的检查点。
参数
-
config
(
) –Optional [RunnableConfig ]用于过滤检查点的基本配置。
-
filter
(
, 默认:Optional [Dict [str ,Any ]]None
) –其他过滤条件。
-
before
(
, 默认:Optional [RunnableConfig ]None
) –列出在此配置之前创建的检查点。
-
limit
(
, 默认:Optional [int ]None
) –要返回的最大检查点数。
返回值
-
–Iterator [CheckpointTuple ]Iterator[CheckpointTuple]: 匹配的检查点元组的迭代器。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
put(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
¶
使用其配置和元数据存储检查点。
参数
-
config
(
) –RunnableConfig 检查点的配置。
-
checkpoint
(
) –Checkpoint 要存储的检查点。
-
metadata
(
) –CheckpointMetadata 检查点的其他元数据。
-
new_versions
(
) –ChannelVersions 截至此次写入的新的通道版本。
返回值
-
RunnableConfig
(
) –RunnableConfig 存储检查点后的更新配置。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
put_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
¶
存储与检查点链接的中间写入内容。
参数
-
config
(
) –RunnableConfig 相关检查点的配置。
-
writes
(
) –List [Tuple [str ,Any ]]要存储的写入内容列表。
-
task_id
(
) –str 创建写入内容的任务标识符。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aget(config: RunnableConfig) -> Optional[Checkpoint]
async
¶
使用给定配置异步获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aget_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
async
¶
使用给定配置异步获取检查点元组。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [CheckpointTuple ]Optional[CheckpointTuple]: 请求的检查点元组,如果未找到则为 None。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
alist(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> AsyncIterator[CheckpointTuple]
async
¶
异步列出符合给定条件的检查点。
参数
-
config
(
) –Optional [RunnableConfig ]用于过滤检查点的基本配置。
-
filter
(
, 默认:Optional [Dict [str ,Any ]]None
) –用于元数据的其他过滤条件。
-
before
(
, 默认:Optional [RunnableConfig ]None
) –列出在此配置之前创建的检查点。
-
limit
(
, 默认:Optional [int ]None
) –要返回的最大检查点数。
返回值
-
–AsyncIterator [CheckpointTuple ]AsyncIterator[CheckpointTuple]: 匹配的检查点元组的异步迭代器。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aput(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
async
¶
异步使用其配置和元数据存储检查点。
参数
-
config
(
) –RunnableConfig 检查点的配置。
-
checkpoint
(
) –Checkpoint 要存储的检查点。
-
metadata
(
) –CheckpointMetadata 检查点的其他元数据。
-
new_versions
(
) –ChannelVersions 截至此次写入的新的通道版本。
返回值
-
RunnableConfig
(
) –RunnableConfig 存储检查点后的更新配置。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aput_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
async
¶
异步存储与检查点链接的中间写入内容。
参数
-
config
(
) –RunnableConfig 相关检查点的配置。
-
writes
(
) –List [Tuple [str ,Any ]]要存储的写入内容列表。
-
task_id
(
) –str 创建写入内容的任务标识符。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
get_next_version(current: Optional[V], channel: ChannelProtocol) -> V
¶
为通道生成下一个版本 ID。
默认使用整数版本,每次递增 1。如果覆盖,可以使用 str/int/float 版本,只要它们是单调递增的即可。
参数
-
current
(
) –Optional [V ]当前版本标识符(int、float 或 str)。
-
channel
(
) –BaseChannel 要进行版本控制的通道。
返回值
-
V
(
) –V 下一个版本标识符,必须递增。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
create_checkpoint(checkpoint: Checkpoint, channels: Optional[Mapping[str, ChannelProtocol]], step: int, *, id: Optional[str] = None) -> Checkpoint
¶
为给定的通道创建检查点。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
SerializerProtocol
¶
基础:
用于对象序列化和反序列化的协议。
dumps
: 将对象序列化为字节。dumps_typed
: 将对象序列化为元组(类型,字节)。loads
: 从字节反序列化对象。loads_typed
: 从元组(类型,字节)反序列化对象。
有效的实现包括 pickle
、json
和 orjson
模块。
源代码位于 libs/checkpoint/langgraph/checkpoint/serde/base.py
中
JsonPlusSerializer
¶
基础:
源代码位于 libs/checkpoint/langgraph/checkpoint/serde/jsonplus.py
中
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
|
MemorySaver
¶
基础:
,
,
内存中的检查点保存器。
此检查点保存器使用 defaultdict 将检查点存储在内存中。
注意
仅将 MemorySaver
用于调试或测试目的。对于生产用例,我们建议安装 langgraph-checkpoint-postgres 并使用 PostgresSaver
/ AsyncPostgresSaver
。
参数
-
serde
(
, 默认:Optional [SerializerProtocol ]None
) –用于序列化和反序列化检查点的序列化程序。默认为 None。
示例
import asyncio
from langgraph.checkpoint.memory import MemorySaver
from langgraph.graph import StateGraph
builder = StateGraph(int)
builder.add_node("add_one", lambda x: x + 1)
builder.set_entry_point("add_one")
builder.set_finish_point("add_one")
memory = MemorySaver()
graph = builder.compile(checkpointer=memory)
coro = graph.ainvoke(1, {"configurable": {"thread_id": "thread-1"}})
asyncio.run(coro) # Output: 2
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
|
config_specs: list[ConfigurableFieldSpec]
属性
¶
定义检查点保存器的配置选项。
返回值
-
–list [ConfigurableFieldSpec ]list[ConfigurableFieldSpec]: 配置字段规范的列表。
get(config: RunnableConfig) -> Optional[Checkpoint]
¶
使用给定的配置获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aget(config: RunnableConfig) -> Optional[Checkpoint]
异步
¶
使用给定配置异步获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
get_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
¶
从内存存储中获取检查点元组。
此方法根据提供的配置从内存存储中检索检查点元组。如果配置包含“checkpoint_id”键,则检索与匹配的线程 ID 和时间戳对应的检查点。否则,将检索给定线程 ID 的最新检查点。
参数
-
config
(
) –RunnableConfig 用于检索检查点的配置。
返回值
-
–Optional [CheckpointTuple ]Optional[CheckpointTuple]: 检索到的检查点元组,如果未找到匹配的检查点,则为 None。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
list(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> Iterator[CheckpointTuple]
¶
列出内存存储中的检查点。
此方法根据提供的条件从内存存储中检索检查点元组列表。
参数
-
config
(
) –Optional [RunnableConfig ]用于过滤检查点的基本配置。
-
filter
(
, 默认:Optional [Dict [str ,Any ]]None
) –用于元数据的其他过滤条件。
-
before
(
, 默认:Optional [RunnableConfig ]None
) –列出在此配置之前创建的检查点。
-
limit
(
, 默认:Optional [int ]None
) –要返回的最大检查点数。
生成
-
–CheckpointTuple Iterator[CheckpointTuple]: 匹配检查点元组的迭代器。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
|
put(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
¶
将检查点保存到内存存储中。
此方法将检查点保存到内存存储中。检查点与提供的配置相关联。
参数
-
config
(
) –RunnableConfig 与检查点关联的配置。
-
checkpoint
(
) –Checkpoint 要保存的检查点。
-
metadata
(
) –CheckpointMetadata 与检查点一起保存的附加元数据。
-
new_versions
(
) –dict 本次写入的新版本
返回值
-
RunnableConfig
(
) –RunnableConfig 包含保存的检查点时间戳的更新配置。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
put_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
¶
将写入列表保存到内存存储中。
此方法将写入列表保存到内存存储中。写入与提供的配置相关联。
参数
-
config
(
) –RunnableConfig 与写入关联的配置。
-
writes
(
) –list [tuple [str ,Any ]]要保存的写入内容。
-
task_id
(
) –str 创建写入内容的任务标识符。
返回值
-
RunnableConfig
(None
) –包含已保存写入内容时间戳的更新配置。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
aget_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
异步
¶
get_tuple 的异步版本。
此方法是 get_tuple 的异步包装器,它使用 asyncio 在单独的线程中运行同步方法。
参数
-
config
(
) –RunnableConfig 用于检索检查点的配置。
返回值
-
–Optional [CheckpointTuple ]Optional[CheckpointTuple]: 检索到的检查点元组,如果未找到匹配的检查点,则为 None。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
alist(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> AsyncIterator[CheckpointTuple]
异步
¶
list 的异步版本。
此方法是 list 的异步包装器,它使用 asyncio 在单独的线程中运行同步方法。
参数
-
config
(
) –RunnableConfig 用于列出检查点的配置。
生成
-
–AsyncIterator [CheckpointTuple ]AsyncIterator[CheckpointTuple]: 检查点元组的异步迭代器。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
aput(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
异步
¶
put 的异步版本。
参数
-
config
(
) –RunnableConfig 与检查点关联的配置。
-
checkpoint
(
) –Checkpoint 要保存的检查点。
-
metadata
(
) –CheckpointMetadata 与检查点一起保存的附加元数据。
-
new_versions
(
) –dict 本次写入的新版本
返回值
-
RunnableConfig
(
) –RunnableConfig 包含保存的检查点时间戳的更新配置。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
aput_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
异步
¶
put_writes 的异步版本。
此方法是 put_writes 的异步包装器,它使用 asyncio 在单独的线程中运行同步方法。
参数
-
config
(
) –RunnableConfig 与写入关联的配置。
-
writes
(
) –List [Tuple [str ,Any ]]要保存的写入内容,每个写入内容都是一个 (channel, value) 对。
-
task_id
(
) –str 创建写入内容的任务标识符。
源代码位于 libs/checkpoint/langgraph/checkpoint/memory/__init__.py
SqliteSaver
¶
基类:
将检查点存储在 SQLite 数据库中的检查点保存器。
注意
此类适用于轻量级、同步用例(演示和小型项目),并且无法扩展到多个线程。对于具有 async
支持的类似 sqlite 保存器,请考虑使用 AsyncSqliteSaver。
参数
-
conn
(
) –Connection SQLite 数据库连接。
-
serde
(
, 默认:Optional [SerializerProtocol ]None
) –用于序列化和反序列化检查点的序列化程序。默认为 JsonPlusSerializerCompat。
示例
>>> import sqlite3
>>> from langgraph.checkpoint.sqlite import SqliteSaver
>>> from langgraph.graph import StateGraph
>>>
>>> builder = StateGraph(int)
>>> builder.add_node("add_one", lambda x: x + 1)
>>> builder.set_entry_point("add_one")
>>> builder.set_finish_point("add_one")
>>> conn = sqlite3.connect("checkpoints.sqlite")
>>> memory = SqliteSaver(conn)
>>> graph = builder.compile(checkpointer=memory)
>>> config = {"configurable": {"thread_id": "1"}}
>>> graph.get_state(config)
>>> result = graph.invoke(3, config)
>>> graph.get_state(config)
StateSnapshot(values=4, next=(), config={'configurable': {'thread_id': '1', 'checkpoint_ns': '', 'checkpoint_id': '0c62ca34-ac19-445d-bbb0-5b4984975b2a'}}, parent_config=None)
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
|
config_specs: list[ConfigurableFieldSpec]
属性
¶
定义检查点保存器的配置选项。
返回值
-
–list [ConfigurableFieldSpec ]list[ConfigurableFieldSpec]: 配置字段规范的列表。
get(config: RunnableConfig) -> Optional[Checkpoint]
¶
使用给定的配置获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aget(config: RunnableConfig) -> Optional[Checkpoint]
异步
¶
使用给定配置异步获取检查点。
参数
-
config
(
) –RunnableConfig 指定要检索的检查点的配置。
返回值
-
–Optional [Checkpoint ]Optional[Checkpoint]: 请求的检查点,如果未找到则为 None。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
aput_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
async
¶
异步存储与检查点链接的中间写入内容。
参数
-
config
(
) –RunnableConfig 相关检查点的配置。
-
writes
(
) –List [Tuple [str ,Any ]]要存储的写入内容列表。
-
task_id
(
) –str 创建写入内容的任务标识符。
引发
-
–NotImplementedError 在您的自定义检查点保存器中实现此方法。
源代码在 libs/checkpoint/langgraph/checkpoint/base/__init__.py
中
from_conn_string(conn_string: str) -> Iterator[SqliteSaver]
classmethod
¶
从连接字符串创建一个新的 SqliteSaver 实例。
参数
-
conn_string
(
) –str SQLite 连接字符串。
生成
-
SqliteSaver
(
) –SqliteSaver 一个新的 SqliteSaver 实例。
示例
In memory:
with SqliteSaver.from_conn_string(":memory:") as memory:
...
To disk:
with SqliteSaver.from_conn_string("checkpoints.sqlite") as memory:
...
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
setup() -> None
¶
设置检查点数据库。
此方法在 SQLite 数据库中创建必要的表,如果它们不存在。它在需要时自动调用,用户不应该直接调用。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
cursor(transaction: bool = True) -> Iterator[sqlite3.Cursor]
¶
获取 SQLite 数据库的游标。
此方法返回 SQLite 数据库的游标。它由 SqliteSaver 内部使用,用户不应该直接调用。
参数
-
transaction
(
, default:bool True
) –是否在游标关闭时提交事务。默认为 True。
生成
-
–Cursor sqlite3.Cursor: SQLite 数据库的游标。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
get_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
¶
从数据库中获取检查点元组。
此方法根据提供的配置从 SQLite 数据库中检索检查点元组。如果配置包含“checkpoint_id”键,则检索与匹配线程 ID 和检查点 ID 相匹配的检查点。否则,检索给定线程 ID 的最新检查点。
参数
-
config
(
) –RunnableConfig 用于检索检查点的配置。
返回值
-
–Optional [CheckpointTuple ]Optional[CheckpointTuple]: 检索到的检查点元组,如果未找到匹配的检查点,则为 None。
示例
Basic:
>>> config = {"configurable": {"thread_id": "1"}}
>>> checkpoint_tuple = memory.get_tuple(config)
>>> print(checkpoint_tuple)
CheckpointTuple(...)
With checkpoint ID:
>>> config = {
... "configurable": {
... "thread_id": "1",
... "checkpoint_ns": "",
... "checkpoint_id": "1ef4f797-8335-6428-8001-8a1503f9b875",
... }
... }
>>> checkpoint_tuple = memory.get_tuple(config)
>>> print(checkpoint_tuple)
CheckpointTuple(...)
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
|
list(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> Iterator[CheckpointTuple]
¶
列出数据库中的检查点。
此方法根据提供的配置从 SQLite 数据库中检索检查点元组列表。检查点按检查点 ID 降序排列(最新的排在最前面)。
参数
-
config
(
) –RunnableConfig 用于列出检查点的配置。
-
filter
(
, 默认:Optional [Dict [str ,Any ]]None
) –元数据的附加过滤条件。默认为 None。
-
before
(
, 默认:Optional [RunnableConfig ]None
) –如果提供,则仅返回指定检查点 ID 之前的检查点。默认为 None。
-
limit
(
, 默认:Optional [int ]None
) –要返回的检查点数的最大值。默认为 None。
生成
-
–CheckpointTuple Iterator[CheckpointTuple]: 检查点元组的迭代器。
示例
>>> from langgraph.checkpoint.sqlite import SqliteSaver
>>> with SqliteSaver.from_conn_string(":memory:") as memory:
... # Run a graph, then list the checkpoints
>>> config = {"configurable": {"thread_id": "1"}}
>>> checkpoints = list(memory.list(config, limit=2))
>>> print(checkpoints)
[CheckpointTuple(...), CheckpointTuple(...)]
>>> config = {"configurable": {"thread_id": "1"}}
>>> before = {"configurable": {"checkpoint_id": "1ef4f797-8335-6428-8001-8a1503f9b875"}}
>>> with SqliteSaver.from_conn_string(":memory:") as memory:
... # Run a graph, then list the checkpoints
>>> checkpoints = list(memory.list(config, before=before))
>>> print(checkpoints)
[CheckpointTuple(...), ...]
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
put(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
¶
将检查点保存到数据库。
此方法将检查点保存到 SQLite 数据库。检查点与提供的配置及其父配置(如果有)相关联。
参数
-
config
(
) –RunnableConfig 与检查点关联的配置。
-
checkpoint
(
) –Checkpoint 要保存的检查点。
-
metadata
(
) –CheckpointMetadata 与检查点一起保存的附加元数据。
-
new_versions
(
) –ChannelVersions 截至此次写入的新的通道版本。
返回值
-
RunnableConfig
(
) –RunnableConfig 存储检查点后的更新配置。
示例
>>> from langgraph.checkpoint.sqlite import SqliteSaver
>>> with SqliteSaver.from_conn_string(":memory:") as memory:
>>> config = {"configurable": {"thread_id": "1", "checkpoint_ns": ""}}
>>> checkpoint = {"ts": "2024-05-04T06:32:42.235444+00:00", "id": "1ef4f797-8335-6428-8001-8a1503f9b875", "data": {"key": "value"}}
>>> saved_config = memory.put(config, checkpoint, {"source": "input", "step": 1, "writes": {"key": "value"}}, {})
>>> print(saved_config)
{'configurable': {'thread_id': '1', 'checkpoint_ns': '', 'checkpoint_id': '1ef4f797-8335-6428-8001-8a1503f9b875'}}
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
put_writes(config: RunnableConfig, writes: Sequence[Tuple[str, Any]], task_id: str) -> None
¶
存储与检查点链接的中间写入内容。
此方法将与检查点相关的中间写入保存到 SQLite 数据库。
参数
-
config
(
) –RunnableConfig 相关检查点的配置。
-
writes
(
) –Sequence [Tuple [str ,Any ]]要存储的写入列表,每个写入都是 (通道,值) 对。
-
task_id
(
) –str 创建写入内容的任务标识符。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
aget_tuple(config: RunnableConfig) -> Optional[CheckpointTuple]
async
¶
异步从数据库中获取检查点元组。
注意
此异步方法不受 SqliteSaver 类支持。使用 get_tuple() 代替,或考虑使用 AsyncSqliteSaver。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
alist(config: Optional[RunnableConfig], *, filter: Optional[Dict[str, Any]] = None, before: Optional[RunnableConfig] = None, limit: Optional[int] = None) -> AsyncIterator[CheckpointTuple]
async
¶
异步列出数据库中的检查点。
注意
此异步方法不受 SqliteSaver 类支持。使用 list() 代替,或考虑使用 AsyncSqliteSaver。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
aput(config: RunnableConfig, checkpoint: Checkpoint, metadata: CheckpointMetadata, new_versions: ChannelVersions) -> RunnableConfig
async
¶
异步将检查点保存到数据库。
注意
此异步方法不受 SqliteSaver 类支持。使用 put() 代替,或考虑使用 AsyncSqliteSaver。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
get_next_version(current: Optional[str], channel: ChannelProtocol) -> str
¶
为通道生成下一个版本 ID。
此方法根据通道的当前版本创建通道的新版本标识符。
参数
-
current
(
) –Optional [str ]通道的当前版本标识符。
-
channel
(
) –BaseChannel 要进行版本控制的通道。
返回值
-
str
(
) –str 下一个版本标识符,保证单调递增。
源代码位于 libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/__init__.py
AsyncSqliteSaver
¶
基类:
一个异步检查点保存器,将检查点存储在 SQLite 数据库中。
此类提供了一个异步接口,用于使用 SQLite 数据库保存和检索检查点。它专为异步环境设计,与同步替代方案相比,在 I/O 绑定操作方面提供了更好的性能。
属性
-
(conn
) –Connection 异步 SQLite 数据库连接。
-
(serde
) –SerializerProtocol 用于对检查点进行编码/解码的序列化器。
提示
需要 aiosqlite 包。使用 pip install aiosqlite
安装它。
警告
虽然此类支持异步检查点,但不建议用于生产工作负载,因为 SQLite 的写入性能有限。对于生产用途,请考虑更强大的数据库,例如 PostgreSQL。
提示
请务必在执行代码后关闭数据库连接,否则您可能会看到图表在执行后“挂起”(因为程序在连接关闭之前不会退出)。
最简单的方法是使用示例中所示的async with
语句。
示例
StateGraph 中的使用
>>> import asyncio
>>>
>>> from langgraph.checkpoint.sqlite.aio import AsyncSqliteSaver
>>> from langgraph.graph import StateGraph
>>>
>>> builder = StateGraph(int)
>>> builder.add_node("add_one", lambda x: x + 1)
>>> builder.set_entry_point("add_one")
>>> builder.set_finish_point("add_one")
>>> async with AsyncSqliteSaver.from_conn_string("checkpoints.db") as memory:
>>> graph = builder.compile(checkpointer=memory)
>>> coro = graph.ainvoke(1, {"configurable": {"thread_id": "thread-1"}})
>>> print(asyncio.run(coro))
Output: 2
>>> import asyncio
>>> import aiosqlite
>>> from langgraph.checkpoint.sqlite.aio import AsyncSqliteSaver
>>>
>>> async def main():
>>> async with aiosqlite.connect("checkpoints.db") as conn:
... saver = AsyncSqliteSaver(conn)
... config = {"configurable": {"thread_id": "1"}}
... checkpoint = {"ts": "2023-05-03T10:00:00Z", "data": {"key": "value"}}
... saved_config = await saver.aput(config, checkpoint, {}, {})
... print(saved_config)
>>> asyncio.run(main())
{"configurable": {"thread_id": "1", "checkpoint_id": "0c62ca34-ac19-445d-bbb0-5b4984975b2a"}}
libs/checkpoint-sqlite/langgraph/checkpoint/sqlite/aio.py
中的源代码
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 |
|