OpenAI Node 库中结构化输出的注意事项：Zod 模式与 JSON Schema 的兼容性问题

在 OpenAI Node 库中使用结构化输出功能时，开发者经常会选择 Zod 作为模式验证工具。然而，在使用 Zod 的 discriminatedUnion 方法创建模式时，可能会遇到 JSON Schema 兼容性问题，这需要开发者特别注意。

问题背景

当开发者尝试使用 Zod 的 discriminatedUnion 方法创建顶层模式时，生成的 JSON Schema 会包含一个 anyOf 结构。然而，OpenAI API 要求 JSON Schema 的顶层必须是一个对象类型，而不能直接使用 anyOf 作为顶层结构。

技术细节分析

Zod 的 discriminatedUnion 方法会生成一个包含 anyOf 的 JSON Schema，这在技术上是有效的 JSON Schema 语法。但在 OpenAI 的结构化输出实现中，API 要求顶层必须是一个对象类型。这种限制源于 API 设计时对响应格式的严格要求。

解决方案

开发者需要将 discriminatedUnion 嵌套在一个对象类型中，而不是直接将其作为顶层模式使用。例如：

const WrappedSchema = z.object({
  response: z.discriminatedUnion('status', [
    BaseResponseSchema,
    UnsuccessfulResponseSchema,
  ])
});

这种方式确保了生成的 JSON Schema 符合 OpenAI API 的要求，顶层始终是一个对象类型。

最佳实践建议

1. 始终将 discriminatedUnion 嵌套在对象类型中
2. 在使用 Zod 创建复杂模式时，检查生成的 JSON Schema 结构
3. 对于联合类型，考虑使用明确的包装对象
4. 在开发过程中验证生成的 Schema 是否符合 OpenAI API 要求

总结

理解 Zod 模式与 OpenAI API 要求的 JSON Schema 之间的转换规则对于成功实现结构化输出至关重要。通过遵循将 discriminatedUnion 嵌套在对象中的实践，开发者可以避免常见的模式兼容性问题，确保与 OpenAI API 的无缝集成。