Azure OpenAI 实时音频SDK安装与配置指南

1. 项目基础介绍

本项目是Azure OpenAI实时音频SDK的样例代码库，主要用于演示如何使用Azure OpenAI的/realtime API进行实时音频交互。该SDK适用于需要实时语音输入输出的场景，如聊天机器人、语音助手、实时翻译等。项目主要使用Python编程语言。

2. 关键技术与框架

• WebSocket: 实现实时通信的关键技术。
• Azure OpenAI API: 利用Azure OpenAI的/realtime API进行实时音频处理。
• Python: 项目主要编程语言，用于编写与Azure OpenAI API交互的客户端代码。
• Flask: 一个轻量级的Web应用框架，用于创建中间件服务。

3. 安装和配置

准备工作

在开始安装之前，请确保您的系统中已安装以下软件：

• Python 3.x
• pip（Python包管理工具）
• Flask（可选，如果需要运行示例Web应用）

安装步骤

1. 克隆项目

   打开命令行，执行以下命令以克隆项目仓库：

   git clone https://github.com/Azure-Samples/aoai-realtime-audio-sdk.git
   cd aoai-realtime-audio-sdk
   

2. 安装Python依赖

   在项目根目录下，运行以下命令安装项目所需的Python包：

   pip install -r requirements.txt
   

3. 配置Azure OpenAI资源

   在Azure门户中创建一个OpenAI资源，并获取资源终结点、API版本和部署名称。确保资源位于支持/realtime API的区域内（如eastus2或swedencentral）。

4. 修改配置文件

   打开项目中的配置文件（如.env或config.py），填入您的Azure OpenAI资源信息：

   AZURE_OPENAI_ENDPOINT="wss://<your-aoai-resource>.openai.azure.com"
   API_VERSION="2024-10-01-preview"
   DEPLOYMENT_NAME="gpt-4o-realtime-preview-1001"
   

   请将<your-aoai-resource>替换为您在Azure中创建的资源名称。

5. 运行示例代码

   修改完配置后，可以运行项目中的示例代码以测试与Azure OpenAI的实时音频交互。

   如果项目包含示例Web应用，可以在项目根目录下运行：

   flask run
   

   然后在浏览器中访问http://127.0.0.1:5000/来查看示例应用。

按照以上步骤操作，您应该能够成功安装并配置Azure OpenAI实时音频SDK，开始构建实时音频交互的应用程序。