结构化输出 - Docs by LangChain

结构化输出允许代理以特定、可预测的格式返回数据。无需解析自然语言响应，您可以直接获得JSON对象、Pydantic模型或数据类形式的结构化数据，供应用程序直接使用。

本页介绍使用 create_agent 的代理的结构化输出。要直接在模型上使用结构化输出（在代理之外），请参阅模型 - 结构化输出。

LangChain的 create_agent 会自动处理结构化输出。用户设置其期望的结构化输出模式，当模型生成结构化数据时，该数据会被捕获、验证，并在代理状态的 'structured_response' 键中返回。

def create_agent(
    ...
    response_format: Union[
        ToolStrategy[StructuredResponseT],
        ProviderStrategy[StructuredResponseT],
        type[StructuredResponseT],
        None,
    ]

响应格式

使用 response_format 来控制代理如何返回结构化数据：

ToolStrategy[StructuredResponseT]：使用工具调用实现结构化输出
ProviderStrategy[StructuredResponseT]：使用提供商原生结构化输出
type[StructuredResponseT]：模式类型 - 根据模型能力自动选择最佳策略
None：未明确请求结构化输出

当直接提供模式类型时，LangChain会自动选择：

如果所选模型和提供商支持原生结构化输出（例如 OpenAI、Anthropic (Claude) 或 xAI (Grok)），则使用 ProviderStrategy。
对于所有其他模型，使用 ToolStrategy。

如果使用 langchain>=1.1，对原生结构化输出功能的支持会从模型的配置数据中动态读取。如果数据不可用，请使用其他条件或手动指定：

custom_profile = {
    "structured_output": True,
    # ...
}
model = init_chat_model("...", profile=custom_profile)

如果指定了工具，模型必须支持同时使用工具和结构化输出。

结构化响应在代理最终状态的 structured_response 键中返回。

提供商策略

一些模型提供商通过其API原生支持结构化输出（例如 OpenAI、xAI (Grok)、Gemini、Anthropic (Claude)）。当可用时，这是最可靠的方法。要使用此策略，请配置 ProviderStrategy：

class ProviderStrategy(Generic[SchemaT]):
    schema: type[SchemaT]
    strict: bool | None = None

strict 参数需要 langchain>=1.2。

schema

required

定义结构化输出格式的模式。支持：

Pydantic模型：带有字段验证的 BaseModel 子类。返回已验证的Pydantic实例。
数据类：带有类型注解的Python数据类。返回字典。
TypedDict：类型化字典类。返回字典。
JSON模式：包含JSON模式规范的字典。返回字典。

strict

可选的布尔参数，用于启用严格的模式遵循。某些提供商支持（例如 OpenAI 和 xAI）。默认为 None（禁用）。

当您直接将模式类型传递给 create_agent.response_format 且模型支持原生结构化输出时，LangChain会自动使用 ProviderStrategy：

from pydantic import BaseModel, Field
from langchain.agents import create_agent


class ContactInfo(BaseModel):
    """联系人信息。"""
    name: str = Field(description="人员姓名")
    email: str = Field(description="人员的电子邮件地址")
    phone: str = Field(description="人员的电话号码")

agent = create_agent(
    model="gpt-5.4",
    response_format=ContactInfo  # 自动选择ProviderStrategy
)

result = agent.invoke({
    "messages": [{"role": "user", "content": "从以下内容提取联系信息：John Doe, john@example.com, (555) 123-4567"}]
})

print(result["structured_response"])
# ContactInfo(name='John Doe', email='john@example.com', phone='(555) 123-4567')

提供商原生结构化输出提供高可靠性和严格验证，因为模型提供商会强制执行模式。当可用时请使用它。

如果提供商原生支持您所选模型的结构化输出，那么编写 response_format=ProductReview 与 response_format=ProviderStrategy(ProductReview) 在功能上是等效的。在任何一种情况下，如果结构化输出不受支持，代理将回退到工具调用策略。

工具调用策略

对于不支持原生结构化输出的模型，LangChain使用工具调用来实现相同的结果。这适用于所有支持工具调用的模型（大多数现代模型）。要使用此策略，请配置 ToolStrategy：

class ToolStrategy(Generic[SchemaT]):
    schema: type[SchemaT]
    tool_message_content: str | None
    handle_errors: Union[
        bool,
        str,
        type[Exception],
        tuple[type[Exception], ...],
        Callable[[Exception], str],
    ]

schema

required

定义结构化输出格式的模式。支持：

Pydantic模型：带有字段验证的 BaseModel 子类。返回已验证的Pydantic实例。
数据类：带有类型注解的Python数据类。返回字典。
TypedDict：类型化字典类。返回字典。
JSON模式：包含JSON模式规范的字典。返回字典。
联合类型：多个模式选项。模型将根据上下文选择最合适的模式。

tool_message_content

生成结构化输出时返回的工具消息的自定义内容。如果未提供，则默认为显示结构化响应数据的消息。

handle_errors

结构化输出验证失败时的错误处理策略。默认为 True。

True：使用默认错误模板捕获所有错误
str：使用此自定义消息捕获所有错误
type[Exception]：仅使用默认消息捕获此异常类型
tuple[type[Exception], ...]：仅使用默认消息捕获这些异常类型
Callable[[Exception], str]：返回错误消息的自定义函数
False：不重试，让异常传播

from pydantic import BaseModel, Field
from typing import Literal
from langchain.agents import create_agent
from langchain.agents.structured_output import ToolStrategy


class ProductReview(BaseModel):
    """产品评论分析。"""
    rating: int | None = Field(description="产品评分", ge=1, le=5)
    sentiment: Literal["positive", "negative"] = Field(description="评论的情感倾向")
    key_points: list[str] = Field(description="评论的关键点。小写，每个1-3个词。")

agent = create_agent(
    model="gpt-5.4",
    tools=tools,
    response_format=ToolStrategy(ProductReview)
)

result = agent.invoke({
    "messages": [{"role": "user", "content": "分析此评论：'优秀的产品：5星。发货快，但价格贵'"}]
})
result["structured_response"]
# ProductReview(rating=5, sentiment='positive', key_points=['fast shipping', 'expensive'])

自定义工具消息内容

tool_message_content 参数允许您自定义生成结构化输出时出现在对话历史中的消息：

from pydantic import BaseModel, Field
from typing import Literal
from langchain.agents import create_agent
from langchain.agents.structured_output import ToolStrategy


class MeetingAction(BaseModel):
    """从会议记录中提取的行动项。"""
    task: str = Field(description="需要完成的具体任务")
    assignee: str = Field(description="负责该任务的人员")
    priority: Literal["low", "medium", "high"] = Field(description="优先级")

agent = create_agent(
    model="gpt-5.4",
    tools=[],
    response_format=ToolStrategy(
        schema=MeetingAction,
        tool_message_content="行动项已捕获并添加到会议记录中！"
    )
)

agent.invoke({
    "messages": [{"role": "user", "content": "根据我们的会议：Sarah需要尽快更新项目时间表"}]
})

================================ Human Message =================================

根据我们的会议：Sarah需要尽快更新项目时间表
================================== Ai Message ==================================
Tool Calls:
  MeetingAction (call_1)
 Call ID: call_1
  Args:
    task: 更新项目时间表
    assignee: Sarah
    priority: high
================================= Tool Message =================================
Name: MeetingAction

行动项已捕获并添加到会议记录中！

如果没有 tool_message_content，我们最终的 ToolMessage 将是：

================================= Tool Message =================================
Name: MeetingAction

返回结构化响应：{'task': 'update the project timeline', 'assignee': 'Sarah', 'priority': 'high'}

错误处理

模型在通过工具调用生成结构化输出时可能会出错。LangChain提供智能重试机制来自动处理这些错误。

多个结构化输出错误

当模型错误地调用多个结构化输出工具时，代理会在 ToolMessage 中提供错误反馈，并提示模型重试：

from pydantic import BaseModel, Field
from typing import Union
from langchain.agents import create_agent
from langchain.agents.structured_output import ToolStrategy


class ContactInfo(BaseModel):
    name: str = Field(description="人员姓名")
    email: str = Field(description="电子邮件地址")

class EventDetails(BaseModel):
    event_name: str = Field(description="活动名称")
    date: str = Field(description="活动日期")

agent = create_agent(
    model="gpt-5.4",
    tools=[],
    response_format=ToolStrategy(Union[ContactInfo, EventDetails])  # 默认：handle_errors=True
)

agent.invoke({
    "messages": [{"role": "user", "content": "提取信息：John Doe (john@email.com) 将于3月15日组织技术会议"}]
})

================================ Human Message =================================

提取信息：John Doe (john@email.com) 将于3月15日组织技术会议
None
================================== Ai Message ==================================
Tool Calls:
  ContactInfo (call_1)
 Call ID: call_1
  Args:
    name: John Doe
    email: john@email.com
  EventDetails (call_2)
 Call ID: call_2
  Args:
    event_name: Tech Conference
    date: March 15th
================================= Tool Message =================================
Name: ContactInfo

错误：模型错误地返回了多个结构化响应（ContactInfo, EventDetails），而预期只有一个。
 请修正您的错误。
================================= Tool Message =================================
Name: EventDetails

错误：模型错误地返回了多个结构化响应（ContactInfo, EventDetails），而预期只有一个。
 请修正您的错误。
================================== Ai Message ==================================
Tool Calls:
  ContactInfo (call_3)
 Call ID: call_3
  Args:
    name: John Doe
    email: john@email.com
================================= Tool Message =================================
Name: ContactInfo

返回结构化响应：{'name': 'John Doe', 'email': 'john@email.com'}

模式验证错误

当结构化输出与预期模式不匹配时，代理会提供具体的错误反馈：

from pydantic import BaseModel, Field
from langchain.agents import create_agent
from langchain.agents.structured_output import ToolStrategy


class ProductRating(BaseModel):
    rating: int | None = Field(description="1-5的评分", ge=1, le=5)
    comment: str = Field(description="评论内容")

agent = create_agent(
    model="gpt-5.4",
    tools=[],
    response_format=ToolStrategy(ProductRating),  # 默认：handle_errors=True
    system_prompt="您是一个解析产品评论的有用助手。不要编造任何字段或值。"
)

agent.invoke({
    "messages": [{"role": "user", "content": "解析此内容：惊人的产品，10/10！"}]
})

================================ Human Message =================================

解析此内容：惊人的产品，10/10！
================================== Ai Message ==================================
Tool Calls:
  ProductRating (call_1)
 Call ID: call_1
  Args:
    rating: 10
    comment: Amazing product
================================= Tool Message =================================
Name: ProductRating

错误：解析工具 'ProductRating' 的结构化输出失败：ProductRating.rating 有1个验证错误
  输入应小于或等于5 [type=less_than_equal, input_value=10, input_type=int]。
 请修正您的错误。
================================== Ai Message ==================================
Tool Calls:
  ProductRating (call_2)
 Call ID: call_2
  Args:
    rating: 5
    comment: Amazing product
================================= Tool Message =================================
Name: ProductRating

返回结构化响应：{'rating': 5, 'comment': 'Amazing product'}

错误处理策略

您可以使用 handle_errors 参数自定义错误处理方式： 自定义错误消息：

ToolStrategy(
    schema=ProductRating,
    handle_errors="请提供1-5之间的有效评分并包含评论。"
)

如果 handle_errors 是一个字符串，代理将始终使用固定的工具消息提示模型重试：

================================= Tool Message =================================
Name: ProductRating

请提供1-5之间的有效评分并包含评论。

仅处理特定异常：

ToolStrategy(
    schema=ProductRating,
    handle_errors=ValueError  # 仅在ValueError时重试，其他异常抛出
)

如果 handle_errors 是一个异常类型，代理仅在引发的异常是指定类型时重试（使用默认错误消息）。在所有其他情况下，异常将被抛出。 处理多种异常类型：

ToolStrategy(
    schema=ProductRating,
    handle_errors=(ValueError, TypeError)  # 在ValueError和TypeError时重试
)

如果 handle_errors 是一个异常元组，代理仅在引发的异常是其中一种指定类型时重试（使用默认错误消息）。在所有其他情况下，异常将被抛出。 自定义错误处理函数：

from langchain.agents.structured_output import StructuredOutputValidationError
from langchain.agents.structured_output import MultipleStructuredOutputsError

def custom_error_handler(error: Exception) -> str:
    if isinstance(error, StructuredOutputValidationError):
        return "格式存在问题。请重试。"
    elif isinstance(error, MultipleStructuredOutputsError):
        return "返回了多个结构化输出。请选择最相关的一个。"
    else:
        return f"错误：{str(error)}"


agent = create_agent(
    model="gpt-5.4",
    tools=[],
    response_format=ToolStrategy(
                        schema=Union[ContactInfo, EventDetails],
                        handle_errors=custom_error_handler
                    )  # 默认：handle_errors=True
)

result = agent.invoke({
    "messages": [{"role": "user", "content": "提取信息：John Doe (john@email.com) 将于3月15日组织技术会议"}]
})

for msg in result['messages']:
    # 如果消息实际上是ToolMessage对象（不是字典），检查其类名
    if type(msg).__name__ == "ToolMessage":
        print(msg.content)
    # 如果消息是字典或您想要回退
    elif isinstance(msg, dict) and msg.get('tool_call_id'):
        print(msg['content'])

在 StructuredOutputValidationError 时：

================================= Tool Message =================================
Name: ToolStrategy

格式存在问题。请重试。

在 MultipleStructuredOutputsError 时：

================================= Tool Message =================================
Name: ToolStrategy

返回了多个结构化输出。请选择最相关的一个。

在其他错误时：

================================= Tool Message =================================
Name: ToolStrategy

错误：<错误消息>

无错误处理：

response_format = ToolStrategy(
    schema=ProductRating,
    handle_errors=False  # 所有错误都抛出
)

将这些文档通过MCP连接到Claude、VSCode等，以获取实时答案。

在GitHub上编辑此页面或提交问题。

​响应格式

​提供商策略

​工具调用策略

​自定义工具消息内容

​错误处理

​多个结构化输出错误

​模式验证错误

​错误处理策略

响应格式

提供商策略

工具调用策略

自定义工具消息内容

错误处理

多个结构化输出错误

模式验证错误

错误处理策略