使用场景
开发者可以使用该API客户端在Node.js环境中创建一个实时语音聊天应用。
在浏览器中,开发者可以利用该客户端实现一个语音识别和生成的交互界面。
通过中继服务器,开发者可以在不支持直接API调用的环境中,如某些受限的浏览器或移动应用中,使用OpenAI的实时语音功能。
产品特色
支持Node.js、浏览器、Deno、Bun、CF workers等多种环境。
提供了一个简单的中继服务器,方便在不支持直接API调用的环境中使用。
包含了Node.js CLI示例,便于本地测试。
支持所有事件的完全类型化,提高代码的可读性和可维护性。
修复了多个小错误和不一致性,提升了API的稳定性和可靠性。
提供了一个OpenAI实时控制台演示,展示了该包的功能。
允许自定义事件处理,提供了更灵活的API使用方式。
使用教程
1. 克隆该项目到本地环境。
2. 安装依赖项,使用命令 `pnpm install`。
3. 设置 `.env` 文件,填入你的 `OPENAI_API_KEY`。
4. 根据需要运行不同的示例,例如使用命令 `npx tsx examples/node/basic.ts` 运行基本的Node.js示例。
5. 如果需要在浏览器中使用,可以创建一个指向中继服务器的 `RealtimeClient` 实例。
6. 如果需要在Node.js环境中直接使用API密钥,可以在创建 `RealtimeClient` 实例时传入 `apiKey` 和 `dangerouslyAllowAPIKeyInBrowser: true`。
7. 参考官方文档和示例代码,根据项目需求进行相应的API调用和事件处理。