首页
/ OpenAI Node.js SDK 文件搜索工具使用问题解析

OpenAI Node.js SDK 文件搜索工具使用问题解析

2025-05-25 12:18:13作者:郁楠烈Hubert

问题背景

在使用OpenAI Node.js SDK创建带有文件搜索(file_search)功能的AI助手时,开发者在上传文件到向量存储(vector store)时遇到了一个常见错误。这个错误表现为当尝试使用fileBatches.uploadAndPoll方法时,系统抛出"TypeError: Cannot read properties of undefined (reading 'length')"异常。

错误原因分析

经过开发者社区和OpenAI团队成员的深入讨论,发现这个问题主要源于两个因素:

  1. 文档示例代码不准确:官方文档中提供的示例代码片段使用了错误的参数传递方式,直接传递了文件流数组,而实际上该方法需要接收一个包含files属性的对象。

  2. 参数类型不匹配uploadAndPoll方法期望接收的参数结构是{ files: Uploadable[]; fileIds?: string[] | undefined; },而文档示例中直接传递了文件流数组。

正确使用方法

要正确实现文件上传到向量存储的功能,开发者应该采用以下两种方式之一:

方法一:使用files.createAndPoll

const fileData = await openai.files.create({
  file: fs.createReadStream("document.pdf"),
  purpose: "fine-tune",
});

let vectorStore = await openai.beta.vectorStores.create({
  name: "文档存储",
});

await openai.beta.vectorStores.files.createAndPoll(
  vectorStore.id,
  {
    file_id: fileData.id,
  }
);

方法二:正确使用fileBatches.uploadAndPoll

const fileStreams = [
  "document1.pdf",
  "document2.pdf"
].map((path) => fs.createReadStream(path));

let vectorStore = await openai.beta.vectorStores.create({
  name: "文档存储",
});

await openai.beta.vectorStores.fileBatches.uploadAndPoll(vectorStore.id, {
  files: fileStreams,
});

最佳实践建议

  1. 类型检查:在TypeScript项目中,可以利用类型系统来避免此类问题,错误的参数传递会在编译时就被发现。

  2. 错误处理:在实际应用中,应该为文件上传操作添加适当的错误处理和重试机制。

  3. 文档验证:虽然官方文档通常是可靠的,但在使用时仍建议结合API定义进行验证。

  4. 替代方案:如果只是上传少量文件,使用files.createAndPoll方法可能更为直接和可靠。

总结

这个问题的出现提醒我们,在使用任何SDK时都应该:

  1. 仔细阅读API定义而不仅仅是示例代码
  2. 理解方法参数的实际结构
  3. 在TypeScript项目中充分利用类型系统
  4. 遇到问题时查阅社区讨论和issue跟踪

OpenAI团队已经确认会在下一个版本中修复文档示例并改进错误提示信息,这将帮助开发者更容易地正确使用文件搜索功能。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511