Google Gemini Cookbook 项目中的 JSON 响应模式问题解析

问题背景

在使用 Google Gemini API 进行 JSON 格式输出时，开发者遇到了两个典型问题。第一个问题是当尝试使用 TypedDict 定义响应模式时出现的 KeyError 异常，第二个问题是 JSON 响应中字段缺失的情况。

技术细节分析

KeyError 异常问题

这个问题的根源在于 Pydantic 版本兼容性。当开发者使用 TypedDict 定义响应模式时，系统内部会尝试将其转换为 Pydantic 模型。在 Pydantic v1 环境下，这个转换过程会出现 KeyError 异常，具体表现为无法正确解析类型定义中的引用。

解决方案相对简单：升级到 Pydantic v2 即可解决。测试表明，将 Pydantic 从 1.10.14 升级到 2.8.2，同时将 pydantic_core 从 2.14.6 升级到 2.20.1 后，问题得到解决。

JSON 响应字段缺失问题

另一个常见问题是 JSON 响应中只包含部分字段。例如，当定义一个包含 index 和 content 两个字段的 TypedDict 时，API 可能只返回 index 字段。这个问题在官方文档示例中也存在，表明这可能是 API 的一个已知限制。

最佳实践建议

1. 版本管理：确保使用 Pydantic v2 及以上版本，这是与 Gemini API 配合使用的基础要求。

2. 简单数据结构：在设计响应模式时，尽量使用简单的数据结构。复杂嵌套类型可能会引发解析问题。

3. 逐步验证：在实现复杂功能前，先用简单示例验证 API 的基本功能是否正常。

4. 错误处理：在代码中加入适当的错误处理逻辑，特别是对 API 返回的数据进行完整性检查。

技术实现示例

以下是一个经过验证可用的代码示例：

from google import generativeai as genai
from typing import TypedDict

class Character(TypedDict):
    name: str
    description: str

class SummaryResponse(TypedDict):
    synopsis: str
    characters: list[Character]

model = genai.GenerativeModel(
    model_name="gemini-1.5-pro-latest",
    generation_config={
        "response_mime_type": "application/json",
        "response_schema": SummaryResponse
    }
)

总结

Google Gemini API 的 JSON 输出功能虽然强大，但在使用过程中需要注意版本兼容性和数据结构设计。通过遵循上述建议，开发者可以更有效地利用这一功能，构建稳定的应用程序。对于更复杂的需求，建议分阶段实现，并充分测试每个阶段的输出结果。