你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

快速入门：使用 Azure OpenAI 耳语模型将语音转换为文本

项目
11/01/2024

本快速入门介绍了如何使用 Azure OpenAI Whisper 模型将语音转换为文本。 Whisper 模型可以转录多种语言的人类语音，还可以将其他语言翻译成英语。

Whisper 模型的文件大小限制为 25 MB。如果需要听录大于 25 MB 的文件，可以使用 Azure AI 语音批量听录 API。

先决条件

Azure 订阅 - 免费创建订阅。
通过支持的模型在支持的区域中部署的 Azure OpenAI 资源。
请确保至少为 Azure OpenAI 资源分配了认知服务参与者角色。
如果你没有自己的数据，请从 GitHub 下载示例数据。

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到服务终结点。或者，也可以通过 Azure AI Foundry 门户中的“部署”页找到该终结点。示例终结点为：`https://docs-test-001.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

在 Azure 门户中转到你的资源。可以在“资源管理”部分找到“终结点和密钥”。复制终结点和访问密钥，因为在对 API 调用进行身份验证时需要这两项。可以使用 KEY1 或 KEY2。始终准备好两个密钥可以安全地轮换和重新生成密钥，而不会导致服务中断。

环境变量

为密钥和终结点创建和分配持久环境变量。

重要

如果使用 API 密钥，请将其安全地存储在某个其他位置，例如 Azure Key Vault 中。请不要直接在代码中包含 API 密钥，并且切勿公开发布该密钥。

有关 Azure AI 服务安全性的详细信息，请参阅对 Azure AI 服务的请求进行身份验证。

setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE"

setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')

echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment

echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment

创建 REST API 请求和响应

在 bash shell 中运行以下命令：需要将 YourDeploymentName 替换为你在部署耳语模型时选择的部署名称。部署名称不一定与模型名称相同。输入模型名称将会导致错误，除非所选部署名称与基础模型名称相同。

curl $AZURE_OPENAI_ENDPOINT/openai/deployments/YourDeploymentName/audio/transcriptions?api-version=2024-02-01 \
 -H "api-key: $AZURE_OPENAI_API_KEY" \
 -H "Content-Type: multipart/form-data" \
 -F file="@./wikipediaOcelot.wav"

上面的命令的第一行的格式及示例终结点如下所示：

curl https://aoai-docs.openai.azure.com/openai/deployments/{YourDeploymentName}/audio/transcriptions?api-version=2024-02-01 \

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

重要

对于生产环境来说，请使用安全的方法（例如 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

输出

{"text":"The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, Mexico, and Central and South America. This medium-sized cat is characterized by solid black spots and streaks on its coat, round ears, and white neck and undersides. It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters 16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758. Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing, leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum, and lagomorphs."}

先决条件

Azure 订阅。可以免费创建一个帐户。
在受支持区域中部署的具有 Whisper 模型的 Azure OpenAI 资源。有关详细信息，请参阅使用 Azure OpenAI 创建资源和部署模型。
Python 3.8 或更高版本
以下 Python 库：os

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到服务终结点。或者，也可以通过 Azure AI Foundry 门户中的“部署”页找到该终结点。示例终结点为：`https://docs-test-001.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

环境变量

为密钥和终结点创建和分配持久环境变量。

重要

如果使用 API 密钥，请将其安全地存储在某个其他位置，例如 Azure Key Vault 中。请不要直接在代码中包含 API 密钥，并且切勿公开发布该密钥。

有关 Azure AI 服务安全性的详细信息，请参阅对 Azure AI 服务的请求进行身份验证。

setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE"

setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')

echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment

echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment

建议使用无密码身份验证

对于无密码身份验证，需要

使用@azure/identity包。
将Cognitive Services User角色分配给用户帐户。这可以在 Azure 门户的访问控制 (IAM)>添加角色分配下完成。
使用 Azure CLI（例如，az login）登录。

创建 Python 环境

使用以下项安装 OpenAI Python 客户端库：

OpenAI Python 1.x
OpenAI Python 0.28.1

pip install openai

注意

OpenAI Python 库版本 0.28.1 已弃用。我们建议使用 1.x。有关如何从 0.28.1 迁移到 1.x 的信息，请参阅我们的迁移指南。

pip install openai==0.28.1

创建 Python 应用

创建名为 quickstart.py 的新 Python 文件。然后在你偏好的编辑器或 IDE 中打开该文件。
将 quickstart.py 的内容替换为以下代码。修改代码以添加你的部署名称：

OpenAI Python 1.x
OpenAI Python 0.28.1

    import os
    from openai import AzureOpenAI
        
    client = AzureOpenAI(
        api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
        api_version="2024-02-01",
        azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
    )
    
    deployment_id = "YOUR-DEPLOYMENT-NAME-HERE" #This will correspond to the custom name you chose for your deployment when you deployed a model."
    audio_test_file = "./wikipediaOcelot.wav"
    
    result = client.audio.transcriptions.create(
        file=open(audio_test_file, "rb"),            
        model=deployment_id
    )
    
    print(result)

    import openai
    import time
    import os
    
    openai.api_key = os.getenv("AZURE_OPENAI_API_KEY")
    openai.api_base = os.getenv("AZURE_OPENAI_ENDPOINT")  # your endpoint should look like the following https://YOUR_RESOURCE_NAME.openai.azure.com/
    openai.api_type = "azure"
    openai.api_version = "2024-02-01"
    
    model_name = "whisper"
    deployment_id = "YOUR-DEPLOYMENT-NAME-HERE" #This will correspond to the custom name you chose for your deployment when you deployed a model."
    audio_language="en"
    
    audio_test_file = "./wikipediaOcelot.wav"
    
    result = openai.Audio.transcribe(
                file=open(audio_test_file, "rb"),            
                model=model_name,
                deployment_id=deployment_id
            )
    
    print(result)

使用快速入门文件中的 python 命令运行应用程序：

python quickstart.py

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

重要

对于生产环境来说，请使用安全的方法（例如 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

输出

{"text":"The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, Mexico, and Central and South America. This medium-sized cat is characterized by solid black spots and streaks on its coat, round ears, and white neck and undersides. It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters 16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758. Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing, leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum, and lagomorphs."}

先决条件

Azure 订阅。可以免费创建一个帐户。
在受支持区域中部署的具有 Whisper 模型的 Azure OpenAI 资源。有关详细信息，请参阅使用 Azure OpenAI 创建资源和部署模型。
The .NET 8.0 SDK

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到服务终结点。或者，也可以通过 Azure AI Foundry 门户中的“部署”页找到该终结点。示例终结点为：`https://docs-test-001.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

创建 .NET 应用

使用 dotnet new 命令创建 .NET 应用：
```
dotnet new console -n OpenAIWhisper
```
更改为新应用的目录：
```
cd OpenAIWhisper
```
安装 Azure.OpenAI 客户端库：
```
dotnet add package Azure.AI.OpenAI
```

建议使用无密码身份验证

无密码身份验证比基于密钥的替代方法更安全，建议使用它连接到 Azure 服务。如果选择使用无密码身份验证，则需要完成以下操作：

添加 Azure.Identity 程序包。
```
dotnet add package Azure.Identity
```
将Cognitive Services User角色分配给用户帐户。这可以在 Azure 门户中你的 OpenAI 资源内的“访问控制(IAM)”>“添加角色分配”下完成。
通过 az login 使用 Visual Studio 或 Azure CLI 登录到 Azure。

更新应用代码

将 program.cs 的内容替换为以下代码，并将占位符值更新为你自己的值。

注意

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

using Azure;
using Azure.AI.OpenAI;
using Azure.Identity; // Required for Passwordless auth

var endpoint = new Uri("YOUR_OPENAI_ENDPOINT");
var credentials = new AzureKeyCredential("YOUR_OPENAI_KEY");
// var credentials = new DefaultAzureCredential(); // Use this line for Passwordless auth
var deploymentName = "whisper"; // Default deployment name, update with your own if necessary
var audioFilePath = "YOUR_AUDIO_FILE_PATH";

var openAIClient = new AzureOpenAIClient(endpoint, credentials);

var audioClient = openAIClient.GetAudioClient(deploymentName);

var result = await audioClient.TranscribeAudioAsync(audioFilePath);

Console.WriteLine("Transcribed text:");
foreach (var item in result.Value.Text)
{
    Console.Write(item);
}

重要

对于生产环境来说，请使用安全的方法（例如 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

使用 dotnet run 命令或 Visual Studio 顶部的运行按钮运行应用程序：

dotnet run

如果使用示例音频文件，应会看到控制台中输出的以下文本：

The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, 
Mexico, and Central and South America. This medium-sized cat is characterized by solid 
black spots and streaks on its coat, round ears...

源代码 | 包 (npm) | 示例

先决条件

Azure 订阅 - 免费创建订阅
LTS 版本的 Node.js
Azure CLI用于本地开发环境中的无密码身份验证，请使用 Azure CLI 登录以创建必要的上下文。
在受支持的区域中创建的 Azure OpenAI 资源（请参阅区域可用性）。有关详细信息，请参阅使用 Azure OpenAI 创建资源和部署模型。

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到服务终结点。或者，也可以通过 Azure AI Foundry 门户中的“部署”页找到该终结点。示例终结点为：`https://docs-test-001.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

环境变量

为密钥和终结点创建和分配持久环境变量。

重要

如果使用 API 密钥，请将其安全地存储在某个其他位置，例如 Azure Key Vault 中。请不要直接在代码中包含 API 密钥，并且切勿公开发布该密钥。

有关 Azure AI 服务安全性的详细信息，请参阅对 Azure AI 服务的请求进行身份验证。

setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE"

setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')

echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment

echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment

建议使用 Microsoft Entra ID 身份验证

对于无密码身份验证，需要

使用@azure/identity包。
将Cognitive Services User角色分配给用户帐户。这可以在 Azure 门户的访问控制 (IAM)>添加角色分配下完成。
使用 Azure CLI（例如，az login）登录。

创建 Node 应用程序

在控制台窗口（例如 cmd、PowerShell 或 Bash）中，为应用创建一个新目录并导航到该目录。然后运行 npm init 命令以使用 package.json 文件创建一个 node 应用程序。

npm init

安装客户端库

使用以下命令安装客户端库：

npm install openai @azure/identity

你的应用的 package.json 文件将随依赖项进行更新。

创建一个名为 Whisper.js 的新文件，然后在首选代码编辑器中打开它。将以下代码复制到“Whisper.js”文件中：

const { createReadStream } = require("fs");
const { AzureOpenAI } = require("openai");
const { DefaultAzureCredential, getBearerTokenProvider } = require("@azure/identity");

// You will need to set these environment variables or edit the following values
const audioFilePath = "<audio file path>";
const endpoint = process.env["AZURE_OPENAI_ENDPOINT"] || "<endpoint>";

// Required Azure OpenAI deployment name and API version
const apiVersion = "2024-08-01-preview";
const deploymentName = "whisper";

// keyless authentication    
const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const azureADTokenProvider = getBearerTokenProvider(credential, scope);

function getClient() {
  return new AzureOpenAI({
    endpoint,
    azureADTokenProvider,
    apiVersion,
    deployment: deploymentName,
  });
}

export async function main() {
  console.log("== Transcribe Audio Sample ==");

  const client = getClient();
  const result = await client.audio.transcriptions.create({
    model: "",
    file: createReadStream(audioFilePath),
  });

  console.log(`Transcription: ${result.text}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

使用以下命令运行该脚本：
```
node Whisper.js
```

创建一个名为 Whisper.js 的新文件，然后在首选代码编辑器中打开它。将以下代码复制到“Whisper.js”文件中：

import { createReadStream } from "fs";
import { AzureOpenAI } from "openai";

// You will need to set these environment variables or edit the following values
const audioFilePath = "<audio file path>";
const endpoint = process.env["AZURE_OPENAI_ENDPOINT"] || "<endpoint>";
const apiKey = process.env["AZURE_OPENAI_API_KEY"] || "<api key>";

// Required Azure OpenAI deployment name and API version
const apiVersion = "2024-08-01-preview";
const deploymentName = "whisper";

function getClient(): AzureOpenAI {
  return new AzureOpenAI({
    endpoint,
    apiKey,
    apiVersion,
    deployment: deploymentName,
  });
}

export async function main() {
  console.log("== Transcribe Audio Sample ==");

  const client = getClient();
  const result = await client.audio.transcriptions.create({
    model: "",
    file: createReadStream(audioFilePath),
  });

  console.log(`Transcription: ${result.text}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

使用以下命令生成应用程序：
```
tsc
```
使用以下命令运行应用程序：
```
node Whisper.js
```

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

重要

对于生产环境来说，请使用安全的方法（例如 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

输出

{"text":"The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, Mexico, and Central and South America. This medium-sized cat is characterized by solid black spots and streaks on its coat, round ears, and white neck and undersides. It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters 16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758. Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing, leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum, and lagomorphs."}

源代码 | 包 (npm) | 示例

先决条件

Azure 订阅 - 免费创建订阅
LTS 版本的 Node.js
TypeScript
Azure CLI用于本地开发环境中的无密码身份验证，请使用 Azure CLI 登录以创建必要的上下文。
在受支持的区域中创建的 Azure OpenAI 资源（请参阅区域可用性）。有关详细信息，请参阅使用 Azure OpenAI 创建资源和部署模型。

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。或者，可以在“Azure OpenAI Studio”>“操场”>“代码视图”中找到该值。示例终结点为：`https://aoai-docs.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

环境变量

为密钥和终结点创建和分配持久环境变量。

重要

如果使用 API 密钥，请将其安全地存储在某个其他位置，例如 Azure Key Vault 中。请不要直接在代码中包含 API 密钥，并且切勿公开发布该密钥。

有关 Azure AI 服务安全性的详细信息，请参阅对 Azure AI 服务的请求进行身份验证。

setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE"

setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')

echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment

echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment

建议使用 Microsoft Entra ID 身份验证

对于无密码身份验证，需要

使用@azure/identity包。
将Cognitive Services User角色分配给用户帐户。这可以在 Azure 门户的访问控制 (IAM)>添加角色分配下完成。
使用 Azure CLI（例如，az login）登录。

创建 Node 应用程序

npm init

安装客户端库

使用以下命令安装客户端库：

npm install openai @azure/identity

你的应用的 package.json 文件将随依赖项进行更新。

创建一个简单的应用程序

Microsoft Entra ID
API 密钥

创建一个名为 Whisper.ts 的新文件，然后在首选代码编辑器中打开它。将以下代码复制到 Whisper.ts 文件中：

import { createReadStream } from "fs";
import { AzureOpenAI } from "openai";
import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";

// You will need to set these environment variables or edit the following values
const audioFilePath = "<audio file path>";
const endpoint = process.env["AZURE_OPENAI_ENDPOINT"] || "<endpoint>";

// Required Azure OpenAI deployment name and API version
const apiVersion = "2024-08-01-preview";
const deploymentName = "whisper";

// keyless authentication    
const credential = new DefaultAzureCredential();
const scope = "https://cognitiveservices.azure.com/.default";
const azureADTokenProvider = getBearerTokenProvider(credential, scope);

function getClient(): AzureOpenAI {
  return new AzureOpenAI({
    endpoint,
    azureADTokenProvider,
    apiVersion,
    deployment: deploymentName,
  });
}

export async function main() {
  console.log("== Transcribe Audio Sample ==");

  const client = getClient();
  const result = await client.audio.transcriptions.create({
    model: "",
    file: createReadStream(audioFilePath),
  });

  console.log(`Transcription: ${result.text}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

使用以下命令生成应用程序：
```
tsc
```
使用以下命令运行应用程序：
```
node Whisper.js
```

创建一个名为 Whisper.ts 的新文件，然后在首选代码编辑器中打开它。将以下代码复制到 Whisper.ts 文件中：

import { createReadStream } from "fs";
import { AzureOpenAI } from "openai";

// You will need to set these environment variables or edit the following values
const audioFilePath = "<audio file path>";
const endpoint = process.env["AZURE_OPENAI_ENDPOINT"] || "<endpoint>";
const apiKey = process.env["AZURE_OPENAI_API_KEY"] || "<api key>";

// Required Azure OpenAI deployment name and API version
const apiVersion = "2024-08-01-preview";
const deploymentName = "whisper";

function getClient(): AzureOpenAI {
  return new AzureOpenAI({
    endpoint,
    apiKey,
    apiVersion,
    deployment: deploymentName,
  });
}

export async function main() {
  console.log("== Transcribe Audio Sample ==");

  const client = getClient();
  const result = await client.audio.transcriptions.create({
    model: "",
    file: createReadStream(audioFilePath),
  });

  console.log(`Transcription: ${result.text}`);
}

main().catch((err) => {
  console.error("The sample encountered an error:", err);
});

使用以下命令生成应用程序：
```
tsc
```
使用以下命令运行应用程序：
```
node Whisper.js
```

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

重要

对于生产环境来说，请使用安全的方法（例如 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

输出

{"text":"The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, Mexico, and Central and South America. This medium-sized cat is characterized by solid black spots and streaks on its coat, round ears, and white neck and undersides. It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters 16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758. Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing, leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum, and lagomorphs."}

先决条件

Azure 订阅 - 免费创建订阅
可以使用最新版本（即 PowerShell 7），也可以使用 Windows PowerShell 5.1。
已部署模型的 Azure OpenAI 服务资源。有关模型部署的详细信息，请参阅资源部署指南。
部署了 gpt-35-turbo 或 gpt-4 模型的 Azure OpenAI 服务资源。有关模型部署的详细信息，请参阅资源部署指南。

设置

检索密钥和终结点

若要成功对 Azure OpenAI 发出调用，需要一个终结点和一个密钥。

变量名称	值
`AZURE_OPENAI_ENDPOINT`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到服务终结点。或者，也可以通过 Azure AI Foundry 门户中的“部署”页找到该终结点。示例终结点为：`https://docs-test-001.openai.azure.com/`。
`AZURE_OPENAI_API_KEY`	从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。可以使用 `KEY1` 或 `KEY2`。

环境变量

为密钥和终结点创建和分配持久环境变量。

重要

如果使用 API 密钥，请将其安全地存储在某个其他位置，例如 Azure Key Vault 中。请不要直接在代码中包含 API 密钥，并且切勿公开发布该密钥。

有关 Azure AI 服务安全性的详细信息，请参阅对 Azure AI 服务的请求进行身份验证。

setx AZURE_OPENAI_API_KEY "REPLACE_WITH_YOUR_KEY_VALUE_HERE"

setx AZURE_OPENAI_ENDPOINT "REPLACE_WITH_YOUR_ENDPOINT_HERE"

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_API_KEY', 'REPLACE_WITH_YOUR_KEY_VALUE_HERE', 'User')

[System.Environment]::SetEnvironmentVariable('AZURE_OPENAI_ENDPOINT', 'REPLACE_WITH_YOUR_ENDPOINT_HERE', 'User')

echo export AZURE_OPENAI_API_KEY="REPLACE_WITH_YOUR_KEY_VALUE_HERE" >> /etc/environment && source /etc/environment

echo export AZURE_OPENAI_ENDPOINT="REPLACE_WITH_YOUR_ENDPOINT_HERE" >> /etc/environment && source /etc/environment

创建 PowerShell 应用

运行以下命令。需要将 YourDeploymentName 替换为你在部署耳语模型时选择的部署名称。部署名称不一定与模型名称相同。输入模型名称将会导致错误，除非所选部署名称与基础模型名称相同。

# Azure OpenAI metadata variables
$openai = @{
    api_key     = $Env:AZURE_OPENAI_API_KEY
    api_base    = $Env:AZURE_OPENAI_ENDPOINT # your endpoint should look like the following https://YOUR_RESOURCE_NAME.openai.azure.com/
    api_version = '2024-02-01' # this may change in the future
    name        = 'YourDeploymentName' #This will correspond to the custom name you chose for your deployment when you deployed a model.
}

# Header for authentication
$headers = [ordered]@{
    'api-key' = $openai.api_key
}

$form = @{ file = get-item -path './wikipediaOcelot.wav' }

# Send a completion call to generate an answer
$url = "$($openai.api_base)/openai/deployments/$($openai.name)/audio/transcriptions?api-version=$($openai.api_version)"

$response = Invoke-RestMethod -Uri $url -Headers $headers -Form $form -Method Post -ContentType 'multipart/form-data'
return $response.text

可以从 GitHub 上的 Azure AI 语音 SDK 存储库获取示例音频文件，例如 wikipediaOcelot.wav。

重要

对于生产环境来说，请使用安全的方法（例如 PowerShell 机密管理和 Azure Key Vault）来存储和访问你的凭据。有关凭据安全性的详细信息，请参阅 Azure AI 服务安全性。

输出

The ocelot, Lepardus paradalis, is a small wild cat native to the southwestern United States, Mexico, and Central and South America. This medium-sized cat is characterized by solid black spots and streaks on its coat, round ears, and white neck and undersides. It weighs between 8 and 15.5 kilograms, 18 and 34 pounds, and reaches 40 to 50 centimeters 16 to 20 inches at the shoulders. It was first described by Carl Linnaeus in 1758. Two subspecies are recognized, L. p. paradalis and L. p. mitis. Typically active during twilight and at night, the ocelot tends to be solitary and territorial. It is efficient at climbing, leaping, and swimming. It preys on small terrestrial mammals such as armadillo, opossum, and lagomorphs.

清理资源

如果你想要清理和移除 Azure OpenAI 资源，可以删除该资源。在删除资源之前，必须先删除所有已部署的模型。

后续步骤

若要了解如何批量将音频数据转换为文本，请参阅创建批量听录。
有关更多示例，请查看 Azure OpenAI 示例 GitHub 存储库。

通过

快速入门：使用 Azure OpenAI 耳语模型将语音转换为文本

先决条件

设置

检索密钥和终结点

环境变量

创建 REST API 请求和响应

输出

先决条件

设置

检索密钥和终结点

环境变量

建议使用无密码身份验证

创建 Python 环境

创建 Python 应用

输出

先决条件

设置

检索密钥和终结点

创建 .NET 应用

建议使用无密码身份验证

更新应用代码

先决条件

设置

检索密钥和终结点

环境变量

建议使用 Microsoft Entra ID 身份验证

创建 Node 应用程序

安装客户端库

创建一个简单的应用程序

输出

先决条件

设置

检索密钥和终结点

环境变量

建议使用 Microsoft Entra ID 身份验证

创建 Node 应用程序

安装客户端库

创建一个简单的应用程序

输出

先决条件

设置

检索密钥和终结点

环境变量

创建 PowerShell 应用

输出

清理资源

后续步骤

反馈

其他资源