OpenAI Realtime API Beta 项目使用教程

OpenAI Realtime API Beta 项目使用教程

openai-realtime-api-beta Node.js + JavaScript reference client for the Realtime API (beta) 项目地址: https://gitcode.com/gh_mirrors/op/openai-realtime-api-beta

1. 项目的目录结构及介绍

在OpenAI Realtime API Beta项目中，目录结构清晰，主要包括以下几个部分：

• dist/：编译后的JavaScript文件存放目录。
• examples/：示例代码目录，包含了如何使用该API的实例。
• lib/：项目的核心JavaScript代码库。
• test/：测试代码目录，用于确保API客户端的正常运行。
• .gitignore：Git忽略文件，定义了哪些文件和目录不应该被提交到版本控制系统中。
• LICENSE：项目许可证文件，本项目采用MIT许可。
• README.md：项目的自述文件，包含了项目的基本信息和如何使用。
• index.js：项目的入口文件，包含了Realtime API客户端的初始化和基本使用方法。
• package-lock.json：npm依赖项锁定文件，确保在不同环境中安装的依赖项版本一致。
• package.json：项目配置文件，定义了项目的依赖项、脚本和元数据。
• tsconfig.json：TypeScript配置文件，定义了TypeScript编译器的选项。

2. 项目的启动文件介绍

项目的启动文件是index.js，它是项目的入口点。以下是一个简单的启动文件示例：

import { RealtimeClient } from '@openai/realtime-api-beta';

const client = new RealtimeClient({
  apiKey: process.env.OPENAI_API_KEY
});

// 设置会话参数
client.updateSession({
  instructions: 'You are a great, upbeat friend.',
  voice: 'alloy',
  turn_detection: { type: 'none' },
  input_audio_transcription: { model: 'whisper-1' }
});

// 设置事件处理
client.on('conversation.updated', (event) => {
  const { item, delta } = event;
  // 处理更新事件
});

// 连接到Realtime API
await client.connect();

// 发送用户消息
client.sendUserMessageContent([
  { type: 'input_text', text: 'How are you?' }
]);

在这个文件中，我们首先导入RealtimeClient类，然后创建一个新的实例，并配置API密钥和其他会话参数。接下来，我们设置事件处理函数，最后连接到API并发送一个消息。

3. 项目的配置文件介绍

项目的配置文件是package.json，它包含了项目的元数据、依赖项、脚本等信息。以下是一个package.json文件的示例：

{
  "name": "openai-realtime-api-beta",
  "version": "1.0.0",
  "description": "Reference client for OpenAI's Realtime API (beta)",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  },
  "dependencies": {
    "@openai/realtime-api-beta": "^1.0.0"
  },
  "devDependencies": {
    "jest": "^27.0.0"
  },
  "author": "OpenAI",
  "license": "MIT"
}

在这个文件中，name和version定义了项目的名称和版本。description提供了项目的简短描述。main指定了项目的入口点文件。scripts定义了项目的可执行脚本，例如启动脚本和测试脚本。dependencies列出了项目运行所需的依赖项。devDependencies列出了开发过程中需要的依赖项。最后，author和license提供了关于项目作者和许可证的信息。

openai-realtime-api-beta Node.js + JavaScript reference client for the Realtime API (beta) 项目地址: https://gitcode.com/gh_mirrors/op/openai-realtime-api-beta