Functional API 允许你以最小的代码改动,为你的应用程序添加 LangGraph 的关键特性(持久化记忆人机协同流式处理)。 它旨在将这些特性集成到现有代码中,这些代码可能使用标准语言原语进行分支和控制流,例如 if 语句、for 循环和函数调用。与许多需要将代码重构为显式管道或 DAG 的数据编排框架不同,Functional API 允许你在不强制使用刚性执行模型的情况下,集成这些能力。 Functional API 使用两个关键构建块:
  • @entrypoint:将一个函数标记为工作流的起点,封装逻辑并管理执行流程,包括处理长时间运行的任务和中断。
  • @task:表示一个离散的工作单元,例如 API 调用或数据处理步骤,可以在入口点内异步执行。任务返回一个类似 future 的对象,可以同步等待或异步解析。
这为构建具有状态管理和流式处理的工作流提供了一个最小抽象。
有关如何使用 functional API 的信息,请参阅 使用 Functional API

Functional API 与 Graph API

对于喜欢更声明式方法的用户,LangGraph 的 Graph API 允许你使用图范式来定义工作流。两个 API 共享相同的底层运行时,因此你可以在同一个应用程序中一起使用它们。 以下是一些关键区别:
  • 控制流:Functional API 不需要考虑图结构。你可以使用标准的 Python 构造来定义工作流。这通常会减少你需要编写的代码量。
  • 短期记忆Graph API 需要声明一个 State,并且可能需要定义 reducers 来管理图状态的更新。@entrypoint@tasks 不需要显式状态管理,因为它们的状态限定在函数范围内,不会在函数之间共享。
  • 检查点:两个 API 都会生成和使用检查点。在 Graph API 中,每个 超级步骤 之后都会生成新的检查点。在 Functional API 中,当任务执行时,它们的结果会被保存到与给定入口点关联的现有检查点中,而不是创建新的检查点。
  • 可视化:Graph API 可以轻松地将工作流可视化为图,这对于调试、理解工作流以及与他人共享非常有用。Functional API 不支持可视化,因为图是在运行时动态生成的。

示例

下面我们展示一个简单的应用程序,它写一篇文章,并中断以请求人工审阅。
from langgraph.checkpoint.memory import InMemorySaver
from langgraph.func import entrypoint, task
from langgraph.types import interrupt

@task
def write_essay(topic: str) -> str:
    """Write an essay about the given topic."""
    time.sleep(1) # A placeholder for a long-running task.
    return f"An essay about topic: {topic}"

@entrypoint(checkpointer=InMemorySaver())
def workflow(topic: str) -> dict:
    """A simple workflow that writes an essay and asks for a review."""
    essay = write_essay("cat").result()
    is_approved = interrupt({
        # Any json-serializable payload provided to interrupt as argument.
        # It will be surfaced on the client side as an Interrupt when streaming data
        # from the workflow.
        "essay": essay, # The essay we want reviewed.
        # We can add any additional information that we need.
        # For example, introduce a key called "action" with some instructions.
        "action": "Please approve/reject the essay",
    })

    return {
        "essay": essay, # The essay that was generated
        "is_approved": is_approved, # Response from HIL
    }
该工作流将编写一篇关于“cat”主题的文章,然后暂停以获取人工审阅。工作流可以被中断任意长的时间,直到提供审阅。当工作流恢复时,它将从头开始执行,但由于 writeEssay 任务的结果已被保存,任务结果将从检查点加载,而不会重新计算。
import time
from langchain_core.utils.uuid import uuid7
from langgraph.func import entrypoint, task
from langgraph.types import interrupt
from langgraph.checkpoint.memory import InMemorySaver


@task
def write_essay(topic: str) -> str:
    """Write an essay about the given topic."""
    time.sleep(1)  # This is a placeholder for a long-running task.
    return f"An essay about topic: {topic}"

@entrypoint(checkpointer=InMemorySaver())
def workflow(topic: str) -> dict:
    """A simple workflow that writes an essay and asks for a review."""
    essay = write_essay("cat").result()
    is_approved = interrupt(
        {
            # Any json-serializable payload provided to interrupt as argument.
            # It will be surfaced on the client side as an Interrupt when streaming data
            # from the workflow.
            "essay": essay,  # The essay we want reviewed.
            # We can add any additional information that we need.
            # For example, introduce a key called "action" with some instructions.
            "action": "Please approve/reject the essay",
        }
    )
    return {
        "essay": essay,  # The essay that was generated
        "is_approved": is_approved,  # Response from HIL
    }


thread_id = str(uuid7())
config = {"configurable": {"thread_id": thread_id}}
for item in workflow.stream("cat", config):
    print(item)
# > {'write_essay': 'An essay about topic: cat'}
# > {
# >     '__interrupt__': (
# >        Interrupt(
# >            value={
# >                'essay': 'An essay about topic: cat',
# >                'action': 'Please approve/reject the essay'
# >            },
# >            id='b9b2b9d788f482663ced6dc755c9e981'
# >        ),
# >    )
# > }
文章已经写好,可以审阅了。一旦提供审阅,我们就可以恢复工作流:
from langgraph.types import Command

# Get review from a user (e.g., via a UI)
# In this case, we're using a bool, but this can be any json-serializable value.
human_review = True

for item in workflow.stream(Command(resume=human_review), config):
    print(item)
{'workflow': {'essay': 'An essay about topic: cat', 'is_approved': False}}
工作流已完成,审阅已添加到文章中。

Entrypoint

@entrypoint 装饰器可用于从函数创建工作流。它封装工作流逻辑并管理执行流程,包括处理_长时间运行的任务_和中断

定义

一个入口点是通过用 @entrypoint 装饰器装饰一个函数来定义的。 该函数必须接受一个单一的位置参数,该参数作为工作流输入。如果需要传递多个数据,请使用字典作为第一个参数的输入类型。 使用 entrypoint 装饰一个函数会生成一个 Pregel 实例,该实例有助于管理工作流的执行(例如,处理流式传输、恢复和检查点)。 你通常需要将检查点保存器传递给 @entrypoint 装饰器,以启用持久化并使用诸如人机协同之类的特性。
from langgraph.func import entrypoint

@entrypoint(checkpointer=checkpointer)
def my_workflow(some_input: dict) -> int:
    # some logic that may involve long-running tasks like API calls,
    # and may be interrupted for human-in-the-loop.
    ...
    return result
序列化 入口点的输入输出必须是 JSON 可序列化的,以支持检查点。请参阅序列化部分了解更多详细信息。

可注入参数

当声明一个 entrypoint 时,你可以请求访问将在运行时自动注入的额外参数。这些参数包括:
参数描述
previous访问与给定线程的前一个 检查点 关联的状态。参见短期记忆
store[BaseStore][langgraph.store.base.BaseStore] 的实例。用于长期记忆
writer在使用 Async Python < 3.11 时访问 StreamWriter。详见使用 Functional API 进行流式处理
config用于访问运行时配置。有关信息,请参阅 RunnableConfig
使用适当的名称和类型注解声明参数。
from langchain_core.runnables import RunnableConfig
from langgraph.func import entrypoint
from langgraph.store.base import BaseStore
from langgraph.store.memory import InMemoryStore
from langgraph.checkpoint.memory import InMemorySaver
from langgraph.types import StreamWriter

in_memory_checkpointer = InMemorySaver(...)
in_memory_store = InMemoryStore(...)  # An instance of InMemoryStore for long-term memory

@entrypoint(
    checkpointer=in_memory_checkpointer,  # Specify the checkpointer
    store=in_memory_store  # Specify the store
)
def my_workflow(
    some_input: dict,  # The input (e.g., passed via `invoke`)
    *,
    previous: Any = None, # For short-term memory
    store: BaseStore,  # For long-term memory
    writer: StreamWriter,  # For streaming custom data
    config: RunnableConfig  # For accessing the configuration passed to the entrypoint
) -> ...:

执行

使用 @entrypoint 会得到一个 Pregel 对象,可以使用 invokeainvokestreamastream 方法执行它。
config = {
    "configurable": {
        "thread_id": "some_thread_id"
    }
}
my_workflow.invoke(some_input, config)  # Wait for the result synchronously

恢复

通过将恢复值传递给 Command 原语,可以在 interrupt 之后恢复执行。
from langgraph.types import Command

config = {
    "configurable": {
        "thread_id": "some_thread_id"
    }
}

my_workflow.invoke(Command(resume=some_resume_value), config)
错误后恢复 要在错误后恢复,请使用 None 和相同的线程 id(配置)运行 entrypoint 这假设底层的错误已解决,并且可以继续成功执行。

config = {
    "configurable": {
        "thread_id": "some_thread_id"
    }
}

my_workflow.invoke(None, config)

短期记忆

当使用 checkpointer 定义一个 entrypoint 时,它会在同一个线程 id 的连续调用之间,将信息存储在检查点中。 这允许使用 previous 参数访问上一次调用的状态。 默认情况下,previous 参数是上一次调用的返回值。
@entrypoint(checkpointer=checkpointer)
def my_workflow(number: int, *, previous: Any = None) -> int:
    previous = previous or 0
    return number + previous

config = {
    "configurable": {
        "thread_id": "some_thread_id"
    }
}

my_workflow.invoke(1, config)  # 1 (previous was None)
my_workflow.invoke(2, config)  # 3 (previous was 1 from the previous invocation)

entrypoint.final

entrypoint.final 是一个特殊原语,可以从入口点返回,并允许将保存在检查点中的值入口点的返回值解耦。 第一个值是入口点的返回值,第二个值是将保存在检查点中的值。类型注解为 entrypoint.final[return_type, save_type]
@entrypoint(checkpointer=checkpointer)
def my_workflow(number: int, *, previous: Any = None) -> entrypoint.final[int, int]:
    previous = previous or 0
    # This will return the previous value to the caller, saving
    # 2 * number to the checkpoint, which will be used in the next invocation
    # for the `previous` parameter.
    return entrypoint.final(value=previous, save=2 * number)

config = {
    "configurable": {
        "thread_id": "1"
    }
}

my_workflow.invoke(3, config)  # 0 (previous was None)
my_workflow.invoke(1, config)  # 6 (previous was 3 * 2 from the previous invocation)

任务

一个任务表示一个离散的工作单元,例如 API 调用或数据处理步骤。它有两个关键特性:
  • 异步执行:任务设计为异步执行,允许多个操作并发运行而不会阻塞。
  • 检查点:任务结果被保存到检查点,使工作流能够从最后保存的状态恢复。(更多细节请参见持久化)。

定义

任务使用 @task 装饰器定义,该装饰器包装一个普通的 Python 函数。
from langgraph.func import task

@task()
def slow_computation(input_value):
    # Simulate a long-running operation
    ...
    return result
序列化 任务的输出必须是 JSON 可序列化的,以支持检查点。

执行

任务只能在入口点、另一个任务状态图节点内部调用。任务_不能_直接从主应用程序代码调用。 当你调用一个任务时,它会立即返回一个 future 对象。future 是稍后可用的结果的占位符。 要获取任务的结果,你可以同步等待(使用 result()),也可以异步等待(使用 await)。
@entrypoint(checkpointer=checkpointer)
def my_workflow(some_input: int) -> int:
    future = slow_computation(some_input)
    return future.result()  # Wait for the result synchronously

何时使用任务

任务在以下场景中很有用:
  • 检查点:当你需要将长时间运行的操作的结果保存到检查点,以便在恢复工作流时无需重新计算。
  • 人机协同:如果你正在构建需要人工干预的工作流,你必须使用任务来封装任何随机性(例如,API 调用),以确保工作流能够正确恢复。更多细节请参阅确定性部分。
  • 并行执行:对于 I/O 密集型任务,任务支持并行执行,允许多个操作并发运行而不会阻塞(例如,调用多个 API)。
  • 可观测性:将操作包装在任务中,提供了一种使用 LangSmith 跟踪工作流进度并监控单个操作执行情况的方法。
  • 可重试的工作:当需要重试工作以处理失败或不一致时,任务提供了一种封装和管理重试逻辑的方法。

序列化

在 LangGraph 中,序列化有两个关键方面:
  1. entrypoint 的输入和输出必须是 JSON 可序列化的。
  2. task 的输出必须是 JSON 可序列化的。
这些要求对于启用检查点和工作流恢复是必需的。使用 Python 原语,如字典、列表、字符串、数字和布尔值,以确保你的输入和输出是可序列化的。 序列化确保工作流状态(如任务结果和中间值)能够可靠地保存和恢复。这对于启用人机协同交互、容错和并行执行至关重要。当工作流配置了检查点保存器时,提供不可序列化的输入或输出将导致运行时错误。

确定性

当你恢复一个工作流运行时,代码不会从执行停止的同一行代码处恢复。执行会返回到检查点边界,工作流会重放直到再次到达暂停点。 对于 Functional API,重放从入口点的开头开始,而 LangGraph 会从检查点保存器恢复已完成的任务子图结果,而不是重新计算它们。这保留了暂停之间步骤的记录顺序,包括长时间运行或非确定性的任务输出。 要使用人机协同等特性,你必须将非确定性工作(例如随机值)和副作用(例如文件写入或 API 调用)放在任务中。 不同运行的工作流可能会产生不同的结果,但恢复一个特定的线程应该重放相同的持久化任务子图结果。 为确保你的工作流是确定性的并且能够一致地重放,请遵循以下准则:
  • 避免重复工作:在入口点中,如果你链式调用多个副作用(例如,日志记录、文件写入或网络调用),为每个副作用赋予自己的任务,这样恢复时就可以从检查点保存器恢复其输出,而不是再次运行它们。
  • 封装非确定性操作:将可能在尝试之间发生变化的值(例如,随机数或墙上时钟读数)保留在任务内部,以便重放与检查点记录的内容一致。
  • 使用幂等操作:对于部分任务失败和重试,请参见幂等性

幂等性

幂等性确保多次运行相同的操作会产生相同的结果。这有助于防止在某个步骤因故障而重新运行时出现重复的 API 调用和冗余处理。始终将 API 调用放在任务函数中进行检查点,并将它们设计为幂等的,以防重新执行。 这对于导致数据写入的操作尤其重要。 当工作流恢复时,LangGraph 从检查点重放已完成的任务结果。一个已开始但未完成的任务可能会在该次恢复时再次运行,因此请将副作用设计为幂等的。使用幂等键或验证现有结果以避免意外的重复。

常见陷阱

处理副作用

将副作用(例如,写入文件、发送电子邮件)封装在任务中,以确保在恢复工作流时它们不会多次执行。
在此示例中,副作用(写入文件)直接包含在工作流中,因此在恢复工作流时会再次执行。
@entrypoint(checkpointer=checkpointer)
def my_workflow(inputs: dict) -> int:
    # This code will be executed a second time when resuming the workflow.
    # Which is likely not what you want.
    with open("output.txt", "w") as f:
        f.write("Side effect executed")
    value = interrupt("question")
    return value

非确定性控制流

每次可能给出不同结果的操作(例如获取当前时间或随机数)应封装在任务中,以确保在恢复时返回相同的结果。
  • 在任务中:获取随机数 (5) → 中断 → 恢复 → (再次返回 5) → …
  • 不在任务中:获取随机数 (5) → 中断 → 恢复 → 获取新的随机数 (7) → …
这在具有多个中断调用的人机协同工作流中尤其重要。LangGraph 为每个任务/入口点维护一个恢复值列表。当遇到中断时,它将与相应的恢复值匹配。此匹配严格基于索引,因此恢复值的顺序应与中断的顺序匹配。如果在恢复时未保持执行顺序,则一个 interrupt 调用可能会与错误的 resume 值匹配,导致不正确的结果。 请阅读确定性部分了解更多详细信息。
在此示例中,工作流使用当前时间来决定执行哪个任务。这是非确定性的,因为工作流的结果取决于其执行的时间。
from langgraph.func import entrypoint

@entrypoint(checkpointer=checkpointer)
def my_workflow(inputs: dict) -> int:
    t0 = inputs["t0"]
    t1 = time.time()

    delta_t = t1 - t0

    if delta_t > 1:
        result = slow_task(1).result()
        value = interrupt("question")
    else:
        result = slow_task(2).result()
        value = interrupt("question")

    return {
        "result": result,
        "value": value
    }

了解更多