OpenAI Agents Python项目中Mapping类型输入导致函数工具报错问题解析

问题背景

在OpenAI Agents Python项目的使用过程中，开发者发现当为Agent提供一个输入参数类型为Mapping或dict的function_tool时，运行Agent会返回HTTP 400错误，错误类型为invalid_function_parameters。这个问题的核心在于JSON Schema验证的严格模式下对Mapping类型的处理方式。

问题复现

当开发者尝试定义一个接受Mapping类型参数的函数工具时：

@function_tool
def foo(x: Mapping[str,str]) -> str:
    return 'bar'

foo_agent = Agent(name='Foo Agent', tools=[foo])
await Runner.run(foo_agent, input='foo')

系统会返回如下错误信息：

Error getting response: Error code: 400
{
    'error': {
        'message': "Invalid schema for function 'foo': In context=(), 'required' is required to be supplied and to be an array including every key in properties. Extra required key 'x' supplied.", 
        'type': 'invalid_request_error',
        'param': 'tools[0].parameters',
        'code': 'invalid_function_parameters'
    }
}

技术分析

JSON Schema验证问题

通过检查生成的JSON Schema（通过foo.params_json_schema查看），我们可以看到：

{
    "properties": {
        "x": {
            "additionalProperties": {"type": "string"},
            "title": "X",
            "type": "object"
        }
    },
    "required": ["x"],
    "title": "foo_args",
    "type": "object",
    "additionalProperties": false
}

虽然这个Schema看起来是有效的，但在OpenAI的严格模式验证下会失败。主要原因在于：

1. 结构化输出的限制：OpenAI的结构化输出功能需要保证生成的JSON符合特定的约束条件
2. 无限键值问题：对于Mapping类型，系统无法确定应该生成多少个键值对，导致验证失败

解决方案

开发团队提供了两种解决方案：

1. 使用非严格模式：通过设置strict=False来绕过严格验证

@function_tool(strict=False)
def foo(x: Mapping[str,str]) -> str:
    return 'bar'

2. 使用明确的Pydantic模型：推荐使用定义明确的Pydantic模型替代泛型Mapping

class MyObject(BaseModel):
    parameter_name: str

@function_tool
def foo(x: MyObject) -> str:
    return 'bar'

最佳实践建议

对于需要处理类似字典结构数据的场景，建议：

1. 优先使用明确的Pydantic模型：这能提供更好的类型提示和文档支持
2. 考虑数据结构的实际需求：例如，如果需要处理类似pandas Series的数据，可以定义如下的模型结构：

class DataPoint(BaseModel):
    x: str
    y: float

class DataSeries(BaseModel):
    title: str
    data: list[DataPoint]

3. 仅在必要时使用非严格模式：strict=False虽然能解决问题，但会降低类型安全性

技术背景

这个问题的根源在于OpenAI API对结构化输出的严格要求。结构化输出功能需要确保生成的JSON数据符合可预测的模式，而泛型的Mapping类型无法提供足够的约束信息。Pydantic模型则能明确定义每个字段的类型和约束，因此是更安全的选择。

结论

在OpenAI Agents Python项目中使用函数工具时，开发者应当注意输入参数的类型选择。对于需要字典式输入的场景，推荐使用明确定义的Pydantic模型而非泛型的Mapping类型，这既能保证类型安全，又能获得更好的开发体验。项目团队已经通过添加运行时验证来更早地捕获这类问题，帮助开发者更快地识别和解决问题。