以编程方式使用文档

LangGraph 提供了两个不同的 API 来构建智能体工作流: **Graph API** 和 **Functional API**。两个 API 共享相同的底层运行时,可以在同一应用程序中一起使用,但它们是为不同的用例和开发偏好而设计的。

本指南将帮助您根据您的具体需求了解何时使用每个 API。

快速决策指南

使用 **Graph API** 当您需要: - **复杂的工作流可视化** 用于调试和文档 - **显式状态管理** 跨多个节点共享数据 - **条件分支** 具有多个决策点 - **并行执行路径** 需要稍后合并 - **团队协作** 视觉表示有助于理解

使用 **Functional API** 当您想要: - **最少的代码改动** 对现有过程式代码 - **标准控制流** (if/else, loops, function calls) - **函数作用域的状态** 无需显式状态管理 - **快速原型开发** 更少的样板代码 - **线性工作流** 配合简单的分支逻辑

详细对比

何时使用图 API

图 API 使用声明式方法,您可以在其中定义节点、边和共享状态来创建可视化图形结构。

1. 复杂的决策树和分支逻辑

当您的工作流有多个依赖于各种条件的决策点时,图 API 使这些分支变得清晰可见,便于可视化。

# Graph API: Clear visualization of decision paths
from langgraph.graph import StateGraph
from typing import TypedDict

class AgentState(TypedDict):
    messages: list
    current_tool: str
    retry_count: int

def should_continue(state):
    if state["retry_count"] > 3:
        return "end"
    elif state["current_tool"] == "search":
        return "process_search"
    else:
        return "call_llm"

workflow = StateGraph(AgentState)
workflow.add_node("call_llm", call_llm_node)
workflow.add_node("process_search", search_node)
workflow.add_conditional_edges("call_llm", should_continue)

2. 跨多个组件的状态管理

当您需要在工作流的不同部分之间共享和协调状态时,图 API 的显式状态管理非常有益。

# Multiple nodes can access and modify shared state
class WorkflowState(TypedDict):
    user_input: str
    search_results: list
    generated_response: str
    validation_status: str

def search_node(state):
    # Access shared state
    results = search(state["user_input"])
    return {"search_results": results}

def validation_node(state):
    # Access results from previous node
    is_valid = validate(state["generated_response"])
    return {"validation_status": "valid" if is_valid else "invalid"}

3. 带同步的并行处理

当您需要并行运行多个操作然后合并其结果时,图 API 可以自然地处理这种情况。

# Parallel processing of multiple data sources
workflow.add_node("fetch_news", fetch_news)
workflow.add_node("fetch_weather", fetch_weather)
workflow.add_node("fetch_stocks", fetch_stocks)
workflow.add_node("combine_data", combine_all_data)

# All fetch operations run in parallel
workflow.add_edge(START, "fetch_news")
workflow.add_edge(START, "fetch_weather")
workflow.add_edge(START, "fetch_stocks")

# Combine waits for all parallel operations to complete
workflow.add_edge("fetch_news", "combine_data")
workflow.add_edge("fetch_weather", "combine_data")
workflow.add_edge("fetch_stocks", "combine_data")

4. 团队协作开发和文档

图 API 的可视化特性使团队更容易理解、记录和维护复杂的工作流。

# Clear separation of concerns - each team member can work on different nodes
workflow.add_node("data_ingestion", data_team_function)
workflow.add_node("ml_processing", ml_team_function)
workflow.add_node("business_logic", product_team_function)
workflow.add_node("output_formatting", frontend_team_function)

何时使用函数式 API

函数式 API 使用命令式方法,将 LangGraph 功能集成到标准过程式代码中。

1. 现有过程式代码

当你拥有使用标准控制流的现有代码,并希望以最少的重构添加 LangGraph 功能时。

# Functional API: Minimal changes to existing code
from langgraph.func import entrypoint, task

@task
def process_user_input(user_input: str) -> dict:
    # Existing function with minimal changes
    return {"processed": user_input.lower().strip()}

@entrypoint(checkpointer=checkpointer)
def workflow(user_input: str) -> str:
    # Standard Python control flow
    processed = process_user_input(user_input).result()

    if "urgent" in processed["processed"]:
        response = handle_urgent_request(processed).result()
    else:
        response = handle_normal_request(processed).result()

    return response

2. 具有简单逻辑的线性工作流

当你的工作流主要是顺序的,具有简单的条件逻辑时。

@entrypoint(checkpointer=checkpointer)
def essay_workflow(topic: str) -> dict:
    # Linear flow with simple branching
    outline = create_outline(topic).result()

    if len(outline["points"]) < 3:
        outline = expand_outline(outline).result()

    draft = write_draft(outline).result()

    # Human review checkpoint
    feedback = interrupt({"draft": draft, "action": "Please review"})

    if feedback == "approve":
        final_essay = draft
    else:
        final_essay = revise_essay(draft, feedback).result()

    return {"essay": final_essay}

3. 快速原型开发

当你想快速测试想法,而无需定义状态模式和图结构的开销时。

@entrypoint(checkpointer=checkpointer)
def quick_prototype(data: dict) -> dict:
    # Fast iteration - no state schema needed
    step1_result = process_step1(data).result()
    step2_result = process_step2(step1_result).result()

    return {"final_result": step2_result}

4. 函数作用域状态管理

当你的状态自然地限定在单个函数中,不需要广泛共享时。

@task
def analyze_document(document: str) -> dict:
    # Local state management within function
    sections = extract_sections(document)
    summaries = [summarize(section) for section in sections]
    key_points = extract_key_points(summaries)

    return {
        "sections": len(sections),
        "summaries": summaries,
        "key_points": key_points
    }

@entrypoint(checkpointer=checkpointer)
def document_processor(document: str) -> dict:
    analysis = analyze_document(document).result()
    # State is passed between functions as needed
    return generate_report(analysis).result()

结合使用两种 API

你可以在同一应用中同时使用两种 API。这在系统的不同部分有不同需求时非常有用。

from langgraph.graph import StateGraph
from langgraph.func import entrypoint

# Complex multi-agent coordination using Graph API
coordination_graph = StateGraph(CoordinationState)
coordination_graph.add_node("orchestrator", orchestrator_node)
coordination_graph.add_node("agent_a", agent_a_node)
coordination_graph.add_node("agent_b", agent_b_node)

# Simple data processing using Functional API
@entrypoint()
def data_processor(raw_data: dict) -> dict:
    cleaned = clean_data(raw_data).result()
    transformed = transform_data(cleaned).result()
    return transformed

# Use the functional API result in the graph
def orchestrator_node(state):
    processed_data = data_processor.invoke(state["raw_data"])
    return {"processed_data": processed_data}

API 之间的迁移

从函数式 API 到图 API

当你的函数式工作流变得复杂时,可以迁移到图 API:

# Before: Functional API
@entrypoint(checkpointer=checkpointer)
def complex_workflow(input_data: dict) -> dict:
    step1 = process_step1(input_data).result()

    if step1["needs_analysis"]:
        analysis = analyze_data(step1).result()
        if analysis["confidence"] > 0.8:
            result = high_confidence_path(analysis).result()
        else:
            result = low_confidence_path(analysis).result()
    else:
        result = simple_path(step1).result()

    return result

# After: Graph API
class WorkflowState(TypedDict):
    input_data: dict
    step1_result: dict
    analysis: dict
    final_result: dict

def should_analyze(state):
    return "analyze" if state["step1_result"]["needs_analysis"] else "simple_path"

def confidence_check(state):
    return "high_confidence" if state["analysis"]["confidence"] > 0.8 else "low_confidence"

workflow = StateGraph(WorkflowState)
workflow.add_node("step1", process_step1_node)
workflow.add_conditional_edges("step1", should_analyze)
workflow.add_node("analyze", analyze_data_node)
workflow.add_conditional_edges("analyze", confidence_check)
# ... add remaining nodes and edges

从图 API 到函数式 API

当你的图对于简单的线性流程变得过于复杂时:

# Before: Over-engineered Graph API
class SimpleState(TypedDict):
    input: str
    step1: str
    step2: str
    result: str

# After: Simplified Functional API
@entrypoint(checkpointer=checkpointer)
def simple_workflow(input_data: str) -> str:
    step1 = process_step1(input_data).result()
    step2 = process_step2(step1).result()
    return finalize_result(step2).result()

总结

选择 **图 API** 当你需要对工作流结构、复杂分支、并行处理或团队协作进行显式控制时。

选择 **函数式 API** 当你想以最少的更改向现有代码添加 LangGraph 功能,拥有简单的线性工作流,或需要快速原型开发功能时。

两种 API 都提供相同的核心 LangGraph 功能(持久化、流式处理、人机交互、记忆),但以不同的范式打包它们,以适应不同的开发风格和使用场景。