if 语句、for 循环和函数调用。与许多需要将代码重组为显式管道或 DAG 的数据编排框架不同,函数式 API 允许您在不强制执行严格执行模型的情况下合并这些能力。
函数式 API 使用两个关键构建块:
@entrypoint– 将函数标记为工作流程的起点,封装逻辑并管理执行流程,包括处理长时间运行的任务和中断。@task– 表示离散的工作单元,例如 API 调用或数据处理步骤,可以在入口点内异步执行。任务返回类似 future 的对象,可以等待或同步解析。
函数式 API vs. 图 API
对于更喜欢声明式方法的用户,LangGraph 的图 API 允许您使用图范式定义工作流程。两个 API 共享相同的底层运行时,因此您可以在同一应用程序中一起使用它们。 以下是一些关键差异:- 控制流:函数式 API 不需要考虑图结构。您可以使用标准 Python 构造来定义工作流程。这通常会减少您需要编写的代码量。
- 短期记忆:图 API 需要声明状态,可能需要定义归约器来管理图状态的更新。
@entrypoint和@tasks不需要显式状态管理,因为它们的状态范围限定于函数,不在函数之间共享。 - 检查点:两个 API 都生成和使用检查点。在图 API 中,在每个超级步骤之后生成新的检查点。在函数式 API 中,当执行任务时,它们的结果保存到与给定入口点关联的现有检查点,而不是创建新检查点。
- 可视化:图 API 使可视化工作流程作为图变得容易,这对于调试、理解工作流程和与他人共享很有用。函数式 API 不支持可视化,因为图在运行时动态生成。
示例
下面我们演示一个编写论文并中断以请求人工审查的简单应用程序。Detailed Explanation
Detailed Explanation
This workflow will write an essay about the topic “cat” and then pause to get a review from a human. The workflow can be interrupted for an indefinite amount of time until a review is provided.When the workflow is resumed, it executes from the very start, but because the result of the An essay has been written and is ready for review. Once the review is provided, we can resume the workflow:The workflow has been completed and the review has been added to the essay.
writeEssay task was already saved, the task result will be loaded from the checkpoint instead of being recomputed.Entrypoint
@entrypoint 装饰器可用于从函数创建工作流程。它封装工作流程逻辑并管理执行流程,包括处理_长时间运行的任务_和中断。
定义
entrypoint 通过使用@entrypoint 装饰器装饰函数来定义。
函数必须接受单个位置参数,该参数用作工作流程输入。如果您需要传递多个数据,请使用字典作为第一个参数的输入类型。
使用 entrypoint 装饰函数会产生一个 Pregel 实例,该实例有助于管理工作流程的执行(例如,处理流式传输、恢复和检查点)。
您通常希望将检查点器传递给 @entrypoint 装饰器以启用持久化并使用人在回路等功能。
- Sync
- Async
可注入参数
声明entrypoint 时,您可以请求访问将在运行时自动注入的其他参数。这些参数包括:
| Parameter | Description |
|---|---|
| previous | Access the state associated with the previous checkpoint for the given thread. See short-term-memory. |
| store | An instance of [BaseStore][langgraph.store.base.BaseStore]. Useful for long-term memory. |
| writer | Use to access the StreamWriter when working with Async Python < 3.11. See streaming with functional API for details. |
| config | For accessing run time configuration. See RunnableConfig for information. |
Requesting Injectable Parameters
Requesting Injectable Parameters
执行
使用@entrypoint 会产生一个 Pregel 对象,可以使用 invoke、ainvoke、stream 和 astream 方法执行。
- Invoke
- Async Invoke
- Stream
- Async Stream
恢复
在 interrupt 之后恢复执行可以通过将resume值传递给Command 原语来完成。
- Invoke
- Async Invoke
- Stream
- Async Stream
entrypoint with a None and the same thread id (config).
This assumes that the underlying error has been resolved and execution can proceed successfully.
- Invoke
- Async Invoke
- Stream
- Async Stream
Short-term memory
When anentrypoint is defined with a checkpointer, it stores information between successive invocations on the same thread id in checkpoints.
This allows accessing the state from the previous invocation using the previous parameter.
By default, the previous parameter is the return value of the previous invocation.
entrypoint.final
entrypoint.final is a special primitive that can be returned from an entrypoint and allows decoupling the value that is saved in the checkpoint from the return value of the entrypoint.
The first value is the return value of the entrypoint, and the second value is the value that will be saved in the checkpoint. The type annotation is entrypoint.final[return_type, save_type].
Task
A task represents a discrete unit of work, such as an API call or data processing step. It has two key characteristics:- Asynchronous Execution: Tasks are designed to be executed asynchronously, allowing multiple operations to run concurrently without blocking.
- Checkpointing: Task results are saved to a checkpoint, enabling resumption of the workflow from the last saved state. (See persistence for more details).
Definition
Tasks are defined using the@task decorator, which wraps a regular Python function.
Execution
Tasks can only be called from within an entrypoint, another task, or a state graph node. Tasks cannot be called directly from the main application code. When you call a task, it returns immediately with a future object. A future is a placeholder for a result that will be available later. To obtain the result of a task, you can either wait for it synchronously (usingresult()) or await it asynchronously (using await).
- Synchronous Invocation
- Asynchronous Invocation
When to use a task
Tasks are useful in the following scenarios:- Checkpointing: When you need to save the result of a long-running operation to a checkpoint, so you don’t need to recompute it when resuming the workflow.
- Human-in-the-loop: If you’re building a workflow that requires human intervention, you MUST use tasks to encapsulate any randomness (e.g., API calls) to ensure that the workflow can be resumed correctly. See the determinism section for more details.
- Parallel Execution: For I/O-bound tasks, tasks enable parallel execution, allowing multiple operations to run concurrently without blocking (e.g., calling multiple APIs).
- Observability: Wrapping operations in tasks provides a way to track the progress of the workflow and monitor the execution of individual operations using LangSmith.
- Retryable Work: When work needs to be retried to handle failures or inconsistencies, tasks provide a way to encapsulate and manage the retry logic.
Serialization
There are two key aspects to serialization in LangGraph:entrypointinputs and outputs must be JSON-serializable.taskoutputs must be JSON-serializable.
Determinism
To utilize features like human-in-the-loop, any randomness should be encapsulated inside of tasks. This guarantees that when execution is halted (e.g., for human in the loop) and then resumed, it will follow the same sequence of steps, even if task results are non-deterministic. LangGraph achieves this behavior by persisting task and subgraph results as they execute. A well-designed workflow ensures that resuming execution follows the same sequence of steps, allowing previously computed results to be retrieved correctly without having to re-execute them. This is particularly useful for long-running tasks or tasks with non-deterministic results, as it avoids repeating previously done work and allows resuming from essentially the same. While different runs of a workflow can produce different results, resuming a specific run should always follow the same sequence of recorded steps. This allows LangGraph to efficiently look up task and subgraph results that were executed prior to the graph being interrupted and avoid recomputing them.Idempotency
Idempotency ensures that running the same operation multiple times produces the same result. This helps prevent duplicate API calls and redundant processing if a step is rerun due to a failure. Always place API calls inside tasks functions for checkpointing, and design them to be idempotent in case of re-execution. Re-execution can occur if a task starts, but does not complete successfully. Then, if the workflow is resumed, the task will run again. Use idempotency keys or verify existing results to avoid duplication.Common Pitfalls
Handling side effects
Encapsulate side effects (e.g., writing to a file, sending an email) in tasks to ensure they are not executed multiple times when resuming a workflow.- Incorrect
- Correct
In this example, a side effect (writing to a file) is directly included in the workflow, so it will be executed a second time when resuming the workflow.
Non-deterministic control flow
Operations that might give different results each time (like getting current time or random numbers) should be encapsulated in tasks to ensure that on resume, the same result is returned.- In a task: Get random number (5) → interrupt → resume → (returns 5 again) → …
- Not in a task: Get random number (5) → interrupt → resume → get new random number (7) → …
interrupt call may be matched with the wrong resume value, leading to incorrect results.
Please read the section on determinism for more details.
- Incorrect
- Correct
In this example, the workflow uses the current time to determine which task to execute. This is non-deterministic because the result of the workflow depends on the time at which it is executed.