首页
/ Anthropic SDK Python工具调用中InputSchema的$defs字段丢失问题解析

Anthropic SDK Python工具调用中InputSchema的$defs字段丢失问题解析

2025-07-07 18:19:03作者:瞿蔚英Wynne

在Anthropic SDK Python工具调用功能的使用过程中,开发者可能会遇到一个与JSON Schema验证相关的典型问题:当工具参数模式中包含$defs字段时,该字段会在类型验证过程中被意外丢弃,导致后续API调用失败。

问题现象

当开发者使用工具调用功能并传递包含$defs定义的JSON Schema时,如果通过Pydantic的TypeAdapter进行类型验证,Schema中的$defs字段会被静默丢弃。这会导致后续API请求中枚举类型等引用定义无法解析,服务器返回500内部错误。

典型的问题Schema结构如下:

{
  "$defs": {
    "TestAnimalEnum": {
      "enum": ["cat", "dog", "bird"],
      "type": "string"
    }
  },
  "properties": {
    "species": {
      "allOf": [{"$ref": "#/$defs/TestAnimalEnum"}]
    }
  }
}

问题根源

问题的核心在于Anthropic SDK中InputSchema的类型定义方式。在早期版本中,InputSchema被定义为严格的Pydantic模型,当Schema中包含type: "object"时,Pydantic的严格模式会丢弃所有未在模型字段中明确定义的额外字段,包括$defs这种JSON Schema标准字段。

技术背景

JSON Schema中的$defs(原称definitions)是用于定义可重用Schema组件的标准字段。它允许开发者在Schema中定义枚举、复杂类型等,然后通过$ref引用这些定义。这种机制对于保持Schema的DRY原则至关重要。

Pydantic默认会对模型进行严格验证,这意味着任何未在模型字段中定义的属性都会被丢弃。这与JSON Schema的开放性质形成了冲突,因为JSON Schema本身允许任意额外的验证关键字。

解决方案演进

Anthropic SDK团队对此问题进行了两次修复:

  1. 初始修复调整了类型定义,允许保留$defs字段
  2. 后续修复进一步放宽了InputSchema的限制,确保不会因为Schema中包含type: "object"而触发严格模式

最佳实践建议

对于使用Anthropic SDK工具调用功能的开发者,建议:

  1. 确保使用最新版本的SDK(v0.25.9及以上)
  2. 检查工具参数Schema中是否包含必要的$defs定义
  3. 在复杂Schema场景下,验证Schema在发送前的完整性
  4. 对于自定义工具,考虑Schema的兼容性和可移植性

总结

这个问题展示了API客户端开发中类型安全与灵活性之间的平衡挑战。Anthropic SDK通过逐步改进类型定义,既保持了类型安全又支持了JSON Schema的完整功能。开发者在使用类似工具时,应当注意Schema验证环节可能对原始数据结构造成的影响。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8