TypeBox项目中处理OpenAI兼容的递归JSON Schema方案

在TypeBox项目中，开发者们经常需要处理复杂的JSON Schema定义，特别是当这些Schema需要与OpenAI的API兼容时，会遇到一些特殊挑战。本文将深入探讨如何优雅地解决这些问题。

问题背景

OpenAI API对JSON Schema有两个主要限制：

1. 不允许在根级别使用anyOf
2. 不支持命名/相对引用，必须通过根级别的$defs来实现

这些限制使得在使用TypeBox定义递归结构时，需要采用特殊的技术手段来确保生成的Schema与OpenAI兼容。

递归结构的传统定义方式

在TypeBox中，我们通常使用Type.Recursive来定义递归结构。例如：

const Element = <Node extends TSchema>(Node: Node) => Type.Object({
  type: Type.Literal('Element'),
  children: Type.Array(Node)
})

const Carousel = <Node extends TSchema>(Node: Node) => Type.Object({
  type: Type.Literal('Carousel'),
  include_arrows: Type.Boolean(),
  min_width: Type.String(),
  children: Type.Array(Node)
})

export const Node = Type.Recursive(Node => Type.Union([
  Element(Node),
  Carousel(Node)
]), {
  discriminantKey: 'type'
})

这种方式生成的Schema虽然有效，但不完全符合OpenAI的要求，因为它不使用$defs结构。

使用Module原型实现$defs结构

TypeBox提供了一个实验性的Module原型，可以创建符合OpenAI要求的$defs结构：

import { Module, ModuleRef } from './prototypes/module'

const Types = Module({
  Element: Type.Object({
    type: Type.Literal('Element'),
    children: Type.Array(ModuleRef('Node'))
  }),
  
  Carousel: Type.Object({
    type: Type.Literal('Carousel'),
    include_arrows: Type.Boolean(),
    min_width: Type.String(),
    children: Type.Array(ModuleRef('Node'))
  }),
  
  Node: Type.Union([
    ModuleRef('Element'),
    ModuleRef('Carousel')
  ], {
    discriminantKey: 'type'
  })
})

const Element = Types.Import('Element')
const Carousel = Types.Import('Carousel')
const Node = Types.Import('Node')

Module原型的工作原理是：

1. 创建一个包含多个相关类型的模块
2. 使用ModuleRef实现类型间的相互引用
3. 通过Import方法生成最终的Schema，其中包含$defs结构

自定义转换工具

如果不想使用实验性的Module原型，开发者也可以创建自定义转换工具，将TypeBox类型转换为OpenAI兼容的JSON Schema：

function ToRootDefs<T extends TSchema>(schema: T): T {
  const defs: Record<string, TSchema> = {}
  const newSchema = replace_refs(schema, defs)
  return {
    ...newSchema,
    $defs: defs,
  } as unknown as T & { $defs: Record<string, TSchema> }
}

这个工具会：

1. 遍历Schema中的所有递归引用
2. 将递归结构提取到$defs中
3. 将引用替换为#/$defs/[recursive_schema_id]格式

实际应用示例

在实际应用中，我们可以这样使用转换后的Schema与OpenAI API交互：

const res = await open_ai_client.chat.completions.create({
    model,
    messages: [...],
    response_format: {
        type: "json_schema",
        json_schema: ToRootDefs(Node)
    }
})

总结

TypeBox提供了多种方式来处理复杂的递归结构定义，特别是针对OpenAI API的特殊要求。开发者可以根据项目需求选择：

1. 使用标准的Type.Recursive（简单但不完全兼容）
2. 采用实验性的Module原型（完全兼容但可能有功能限制）
3. 实现自定义转换工具（灵活但需要额外开发）

随着TypeBox的发展，未来版本可能会原生支持$defs结构，进一步简化这一过程。目前，开发者可以根据项目实际情况选择最适合的方案。