春哥的Agent通关秘籍：知识篇输出格式详解

在AI Agent开发中，规范化AI输出格式是至关重要的一步。如何让AI按照我们期望的格式输出结果，是每个开发者dou需要面对的问题。本文将深入探讨如何利用JSONSchema和Pydantic来实现结构化的输出。

为什么需要结构化输出？

在与AI交互时我们通常希望得到结构化的数据，以便于后续处理。然而AI的自然语言输出往往难以直接满足这一需求。

例如当我们询问AI天气情况时它可Neng会回复：“你好，北京今天天气不错...”。这样的回复虽然友好，但对于程序来说却是难以解析的。

JSONSchema：描述JSON结构的语法

JSONSchema是一种用来描述JSON结构的语法。它Ke以清晰地定义一个JSON对象应该包含哪些字段，每个字段是什么类型，以及其他约束条件。

{ "type": "object", "properties": { "name": { "type": "string", "description": "用户全名" }, "age": { "type": "integer", "description": "用户年龄", "minimum": 0, "maximum": 150 } }, "required": } Pydantic：Python的数据验证库

Pydantic是一个Python的数据验证库，它Ke以帮助我们定义数据模型，并自动生成对应的JSONSchema。

通过Pydantic，我们Ke以轻松地定义一个数据模型，并利用其model_json_schema方法生成对应的JSONSchema。

from pydantic import BaseModel, Field class UserInfo: name: str = Field age: int = Field schemastr = json.dumps, ensureascii=False) 如何实现结构化输出？

要实现结构化输出，我们需要结合使用JSONSchema和Pydantic。

定义数据模型：使用Pydantic定义数据模型，并生成对应的JSONSchema。

设置System Prompt：在System Prompt中指定AI必须按照给定的JSONSchema输出数据。

调用API：在调用API时将生成的JSONSchema传递给AI，并设置response_format={"type": "json_object"}以强制AI输出JSON格式的数据。

实战示例

from openai import OpenAI from pydantic import BaseModel, Field # 定义数据模型 class UserInfo: name: str = Field age: int = Field # 生成JSONSchema schemastr = json.dumps, ensureascii=False) # 设置System Prompt systemprompt = f"""你是一个专业的数据提取助手。必须严格按照以下 JSON Schema 格式输出 JSON 数据，不要包含任何其他解释性文字： {schemastr} """ # 初始化客户端 client = OpenAI # 调用API response = client.chat.completions.create( model="deepseek-chat", messages=, responseformat={"type": "json_object"} ) # 获取响应结果 text = response.choices.message.content print

通过本文的介绍，我们了解了如何利用JSONSchema和Pydantic实现AI的结构化输出。这一技术对于构建高效、可靠的AI应用具有重要意义。希望本文Neng够帮助开发者geng好地掌握这一技Neng，并在实际项目中加以应用。

春哥的Agent通关秘籍系列文章推荐：

春哥的Agent通关秘籍01：什么是Agent开发？了解Agent开发的基础概念和重要性。

春哥的Agent通关秘籍02：搭建环境及语言选择。学习如何搭建开发环境并选择合适的编程语言进行Agent开发。

春哥的Agent通关秘籍03：格式化输出。深入探讨如何实现AI的结构化输出，包括使用JSONSchema和Pydantic等技术。

春哥的Agent通关秘籍04：智Neng记账，还Neng安慰你的小秘书。通过实战案例学习如何开发具备记账功Neng和情感反馈的AI助理系统。

春哥的Agent通关秘籍05：工具调用 Function Calling。探索如何利用Function Calling技术增强AI的Neng力，使其Neng够执行geng复杂的任务。

"双管齐下",即同时使用Pydantic + JSON Schema ,以及Open AI API的参数"response_format",来确保大模型的稳定格式化

. 同时也对 System Prompt和 User Prompt进行了详细对比分析。 这些知识点将在后续系列文章中继续深入探讨，以便于读者全面掌握 Agent 开发的核心技Neng。。

---