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

安装语音 SDK

  • 项目

参考文档包 (NuGet)GitHub 上的其他示例

本指南介绍如何安装用于 C# 的语音 SDK。

文档中的代码示例以 C# 8 编写，并在 .NET standard 2.0 上运行。

平台要求

适用于 C# 的语音 SDK 与 Windows、Linux 和 macOS 兼容。

在 Windows 上，你必须使用 64 位目标体系结构。 需要 Windows 10 或更高版本。

必须安装适用于你的平台的 Microsoft Visual C++ Redistributable for Visual Studio 2015、2017、2019 或 2022。 首次安装此包时，可能需要重启。

安装适用于 C# 的语音 SDK

适用于 C# 的语音 SDK 以 NuGet 包的形式提供并实现了 .NET Standard 2.0。 有关详细信息，请参阅 Microsoft.CognitiveServices.Speech。

可以使用以下 dotnet add 命令从 .NET CLI 安装适用于 C# 的语音 SDK：

dotnet add package Microsoft.CognitiveServices.Speech

可以使用以下 Install-Package 命令安装适用于 C# 的语音 SDK：

Install-Package Microsoft.CognitiveServices.Speech

可以按照下面的指南获取其他选项。

选择目标环境

本指南介绍如何安装用于 .NET Framework (Windows) 控制台应用的语音 SDK。

先决条件

本指南需要：

创建 Visual Studio 项目并安装语音 SDK

需安装语音 SDK NuGet 包，以便在代码中引用它。 为此，可能首先需要创建 helloworld 项目。 如果已经有一个可以使用“.NET 桌面开发”工作负荷的项目，则可使用该项目并跳到使用 NuGet 包管理器安装语音 SDK。

创建 helloworld 项目

  1. 打开 Visual Studio 2019。

  2. 在“开始”窗口中，选择“创建新项目”。

  3. 在“创建新项目”窗口中，选择“控制台应用(.NET Framework)”，然后选择“下一步”。

  4. 在“配置新项目”窗口中的“项目名称”内输入 helloworld，在“位置”中选择或创建目录路径，然后选择“创建”。

  5. 从 Visual Studio 菜单栏中，选择“工具”>“获取工具和功能”。 此步骤会打开 Visual Studio 安装程序并显示“修改”对话框。

  6. 检查“.NET 桌面开发”工作负荷是否可用。 如果尚未安装该工作负荷，请选中它旁边的复选框，然后选择“修改”以启动安装。 下载和安装过程可能需要几分钟。

    如果已选中“.NET 桌面开发”旁边的复选框，请选择“关闭”关闭该对话框。

    屏幕截图显示如何启用 .NET 桌面开发。

  7. 关闭 Visual Studio 安装程序。

使用 NuGet 包管理器安装语音 SDK

  1. 在解决方案资源管理器中右键单击“helloworld”项目，然后选择“管理 NuGet 包”以显示 NuGet 包管理器。

  2. 在右上角找到“包源”下拉框，并确保选择了 nuget.org。

    屏幕截图显示 NuGet 包管理器。

  3. 在左上角，选择“浏览”。

  4. 在搜索框中，键入 Microsoft.CognitiveServices.Speech 并按 Enter。

  5. 在搜索结果中选择“Microsoft.CognitiveServices.Speech”包，然后选择“安装”以安装最新稳定版本。

    屏幕截图显示如何安装 Microsoft.CognitiveServices.Speech NuGet 包。

  6. 接受所有协议和许可证，开始安装。

    安装此包后，“包管理器控制台”窗口中将显示一条确认消息。

选择目标体系结构

若要生成并运行控制台应用程序，请创建与计算机体系结构匹配的平台配置。

  1. 在菜单栏中，选择“生成”>“配置管理器” 。 此时将显示“配置管理器”对话框。

  2. 在“活动解决方案平台”下拉框中，选择“新建” 。 此时将显示“新建解决方案平台”对话框。

    屏幕截图显示“配置管理器”对话框。

  3. 在“键入或选择新平台”下拉框中：

    • 如果运行的是 64 位 Windows，请选择 x64。
    • 如果运行的是 32 位 Windows，请选择 x86。

  4. 选择“确定”，然后选择“关闭”。

参考文档包 (NuGet)GitHub 上的其他示例

本指南介绍如何安装用于 C++ 的语音 SDK。

平台要求

适用于 C++ 的语音 SDK 与 Windows、Linux 和 macOS 兼容。

在 Windows 上，你必须使用 64 位目标体系结构。 需要 Windows 10 或更高版本。

必须安装适用于你的平台的 Microsoft Visual C++ Redistributable for Visual Studio 2015、2017、2019 或 2022。 首次安装此包时，可能需要重启。

安装适用于 C++ 的语音 SDK

适用于 C++ 的语音 SDK 以 NuGet 包的形式提供。 有关详细信息，请参阅 Microsoft.CognitiveServices.Speech。

可以使用以下 dotnet add 命令从 .NET Core CLI 安装适用于 C++ 的语音 SDK：

dotnet add package Microsoft.CognitiveServices.Speech

可以使用以下 Install-Package 命令安装适用于 C# 的语音 SDK：

Install-Package Microsoft.CognitiveServices.Speech

可以按照下面的指南获取其他选项。

选择目标环境

本指南介绍如何安装用于 Linux 的语音 SDK。

使用以下过程下载并安装 SDK。 这些步骤包括从 https://aka.ms/csspeech/linuxbinary 以 .tar 文件格式下载必需的库和头文件。

  1. 选择应将语音 SDK 文件提取到的目录，然后将 SPEECHSDK_ROOT 环境变量设置为指向该目录。 使用此变量，在将来的命令中可以轻松引用目录。

    例如，如果要使用主目录中的 speechsdk 目录，请使用如下所示的命令：

    export SPEECHSDK_ROOT="$HOME/speechsdk"

  2. 如果该目录尚不存在，则创建该目录：

    mkdir -p "$SPEECHSDK_ROOT"

  3. 下载并提取包含语音 SDK 二进制文件的 .tar.gz 存档：

    wget -O SpeechSDK-Linux.tar.gz https://aka.ms/csspeech/linuxbinary
tar --strip 1 -xzf SpeechSDK-Linux.tar.gz -C "$SPEECHSDK_ROOT"

  4. 验证所提取的程序包的顶级目录的内容：

    ls -l "$SPEECHSDK_ROOT"

    目录列表应包含第三方声明和许可证文件。 该列表还应包含容纳头文件 (.h) 的 include 目录和容纳 arm32、arm64、x64 和 x86 库的 lib 目录。

    路径 说明
    license.md 许可
    ThirdPartyNotices.md 第三方声明
    REDIST.txt 再分发声明
    include C++ 所需的头文件
    lib/arm32 ARM32 必需的用来链接应用程序的本机库
    lib/arm64 ARM64 必需的用来链接应用程序的本机库
    lib/x64 x64 必需的用来链接应用程序的本机库
    lib/x86 x86 必需的用来链接应用程序的本机库

参考文档包 (Go)GitHub 上的其他示例

本指南介绍如何安装用于 Go 的语音 SDK。

平台要求

适用于 Go 的语音 SDK 在 Linux 上使用时，仅支持 x64 体系结构上的 Ubuntu 18.04/20.04/22.04、Debian 9/10/11、Red Hat Enterprise Linux (RHEL) 8 和 CentOS 8。

重要

使用 Linux 分发版的最新 LTS 版本。 例如，如果使用 Ubuntu 20.04 LTS，请使用最新版本的 Ubuntu 20.04.X。

语音 SDK 依赖于以下 Linux 系统库：

  • GNU C 库的共享库（包括 POSIX 线程编程库 libpthreads）
  • OpenSSL 库 (libssl) 版本 1.x 和证书 (ca-certificates)
  • ALSA 应用程序的共享库 (libasound)
  • 还应安装 ca-certificates 以建立安全的 Websocket 并避免此 WS_OPEN_ERROR_UNDERLYING_IO_OPEN_FAILED 错误。
sudo apt-get update
sudo apt-get install build-essential libssl-dev ca-certificates libasound2 wget

重要

语音 SDK 不支持 OpenSSL 3.0（Ubuntu 22.04 中的默认版本）。

仅在 Ubuntu 22.04 上，安装最新的 libssl1.1 作为二进制包，或通过从源编译它来安装。

必须安装 Go 二进制版本 1.13 或更高版本。

安装适用于 Go 的语音 SDK

使用以下过程下载并安装 SDK。 这些步骤包括从 https://aka.ms/csspeech/linuxbinary 以 .tar 文件格式下载必需的库和头文件。

  1. 选择应将语音 SDK 文件提取到的目录，然后将 SPEECHSDK_ROOT 环境变量设置为指向该目录。 使用此变量，在将来的命令中可以轻松引用目录。

    例如，如果要使用主目录中的 speechsdk 目录，请使用如下所示的命令：

    export SPEECHSDK_ROOT="$HOME/speechsdk"

  2. 如果该目录尚不存在，则创建该目录：

    mkdir -p "$SPEECHSDK_ROOT"

  3. 下载并提取包含语音 SDK 二进制文件的 .tar.gz 存档：

    wget -O SpeechSDK-Linux.tar.gz https://aka.ms/csspeech/linuxbinary
tar --strip 1 -xzf SpeechSDK-Linux.tar.gz -C "$SPEECHSDK_ROOT"

  4. 验证所提取的程序包的顶级目录的内容：

    ls -l "$SPEECHSDK_ROOT"

    目录列表应包含第三方声明和许可证文件。 该列表还应包含容纳头文件 (.h) 的 include 目录和容纳 arm32、arm64、x64 和 x86 库的 lib 目录。

    路径 说明
    license.md 许可
    ThirdPartyNotices.md 第三方声明
    REDIST.txt 再分发声明
    include C++ 所需的头文件
    lib/arm32 ARM32 必需的用来链接应用程序的本机库
    lib/arm64 ARM64 必需的用来链接应用程序的本机库
    lib/x64 x64 必需的用来链接应用程序的本机库
    lib/x86 x86 必需的用来链接应用程序的本机库

配置 Go 环境

通过以下步骤可使 Go 环境能够查找语音 SDK。 在两个步骤中，将 <architecture> 替换为 CPU 的处理器体系结构。 即为 x86、x64、arm32 或 arm64。

  1. 由于绑定依赖于 cgo，因此需要设置环境变量，以便 Go 可以找到 SDK。

    export CGO_CFLAGS="-I$SPEECHSDK_ROOT/include/c_api"
export CGO_LDFLAGS="-L$SPEECHSDK_ROOT/lib/<architecture> -lMicrosoft.CognitiveServices.Speech.core"

  2. 若要运行应用程序和 SDK，需要告知操作系统可在何处可以找到库。

    export LD_LIBRARY_PATH="$SPEECHSDK_ROOT/lib/<architecture>:$LD_LIBRARY_PATH"

参考文档 | GitHub 上的其他示例

本指南介绍如何安装用于 Java 的语音 SDK。

平台要求

选择目标环境

适用于 Java 的语音 SDK 与 Windows、Linux 和 macOS 兼容。

在 Windows 上，你必须使用 64 位目标体系结构。 需要 Windows 10 或更高版本。

必须安装适用于你的平台的 Microsoft Visual C++ Redistributable for Visual Studio 2015、2017、2019 或 2022。 首次安装此包时，可能需要重启。

适用于 Java 的语音 SDK 不支持 ARM64 上的 Windows。

必须安装 Java 开发工具包，例如 Azul Zulu OpenJDK。 Microsoft Build of OpenJDK 或你喜欢的 JDK 应该也能正常工作。

安装适用于 Java 的语音 SDK

某些说明使用特定的 SDK 版本，例如 1.24.2。 可以通过搜索我们的 GitHub 存储库查看最新版本。

选择目标环境

本指南介绍如何在 Java 运行时上安装用于 Java 的语音 SDK。

支持的操作系统

用于 Java 包的语音 SDK 适用于以下操作系统：

按照以下步骤使用 Apache Maven 安装适用于 Java 的语音 SDK：

  1. 安装 Apache Maven。
  2. 在需要新项目的地方打开命令提示符，并创建一个新的 pom.xml 文件。
  3. 将以下 XML 内容复制到 pom.xml 中：
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.microsoft.cognitiveservices.speech.samples</groupId>
    <artifactId>quickstart-eclipse</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <build>
        <sourceDirectory>src</sourceDirectory>
        <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.7.0</version>
            <configuration>
            <source>1.8</source>
            <target>1.8</target>
            </configuration>
        </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
        <groupId>com.microsoft.cognitiveservices.speech</groupId>
        <artifactId>client-sdk</artifactId>
        <version>1.28.0</version>
        </dependency>
    </dependencies>
</project>
  4. 若要安装语音 SDK 和依赖项，请运行以下 Maven 命令。 
    mvn clean dependency:copy-dependencies

参考文档包 (npm)GitHub 上的其他示例库源代码

本指南介绍如何安装用于 JavaScript 的语音 SDK。

适用于 JavaScript 的语音 SDK 以 npm 包的形式提供。 请参阅 microsoft-cognitiveservices-speech-sdk 及其配套的 GitHub 存储库 cognitive-services-speech-sdk-js。

平台要求

请务必考虑 Node.js 和客户端 Web 浏览器之间的各种体系结构影响。 例如，文档对象模型 (DOM) 不可用于服务器端应用程序，就像 Node.js 文件系统不可用于客户端应用程序一样。

安装适用于 JavaScript 的语音 SDK

请根据目标环境使用以下指南之一：

选择目标环境

本指南介绍如何安装可以在 Node.js 中使用的 JavaScript 版语音 SDK。 如果你只是需要包名称以便自行开始操作，请从现有项目运行 npm install microsoft-cognitiveservices-speech-sdk。

先决条件

本快速入门需要 Node.js。

创建 npm 项目

创建一个新目录，运行 npm init 并浏览其提示。

添加语音 SDK 包

运行 npm install microsoft-cognitiveservices-speech-sdk。

本指南介绍如何安装可以在 Node.js 中使用的 JavaScript 版语音 SDK。

  1. 安装 Node.js。

  2. 创建一个新目录，运行 npm init 并浏览其提示。

  3. 若要安装适用于 JavaScript 的语音 SDK，请运行以下 npm install 命令：

    npm install microsoft-cognitiveservices-speech-sdk

有关详细信息，请参阅 Node.js 示例。

使用语音 SDK

添加以下 import 语句以在 JavaScript 项目中使用语音 SDK：

import * as sdk from "microsoft-cognitiveservices-speech-sdk";

有关 import 的详细信息，请参阅 JavaScript 网站上的导出和导入。

或者，可以使用 require 语句：

const sdk = require("microsoft-cognitiveservices-speech-sdk");

参考文档包（下载）GitHub 上的其他示例

本指南介绍如何安装用于 Objective-C 的语音 SDK。

提示

有关使用适用于 Swift 的语音 SDK 的详细信息，请参阅将 Objective-C 导入 Swift 。

安装适用于 Objective-C 的语音 SDK

用于 Objective-C 的语音 SDK 以 CocoaPod 包的形式本机提供，适用于 Mac x64 和基于 ARM 的芯片。

Mac 的系统需求：

  • macOS 版本 10.14 或更高版本

macOS CocoaPod 包可供下载并在 Xcode 9.4.1（或更高版本）集成开发环境 (IDE) 中使用。

  1. 转到 .xcodeproj 项目文件所在的 Xcode 目录。

  2. 运行 pod init 以创建一个名为 Podfile 的 Pod 文件。

  3. 将 Podfile 的内容替换为以下内容。 将 target 名称从“AppName”更新为应用的名称。 根据需要更新平台或 Pod 版本。

    platform :osx, 10.14
use_frameworks!

target 'AppName' do
  pod 'MicrosoftCognitiveServicesSpeech-macOS', '~> 1.28.0'
end

  4. 运行 pod install 以安装语音 SDK。

或者，可以下载二进制 CocoaPod 并解压缩以提取其内容。 在 Xcode 项目中，添加对提取的“MicrosoftCognitiveServicesSpeech.xcframework”文件夹及其内容的引用。

注意

.NET 开发人员可以使用 Xamarin.Mac 应用程序框架生成本机 macOS 应用程序。 有关详细信息，请参阅 Xamarin.Mac。

参考文档包（下载）GitHub 上的其他示例

本指南介绍如何安装用于 Swift 的语音 SDK。

提示

有关使用适用于 Swift 的语音 SDK 的详细信息，请参阅将 Objective-C 导入 Swift 。

安装适用于 Swift 的语音 SDK

用于 Swift 的语音 SDK 以 CocoaPod 包的形式本机提供，适用于 Mac x64 和基于 ARM 的芯片。

Mac 的系统需求：

  • macOS 版本 10.14 或更高版本

macOS CocoaPod 包可供下载并在 Xcode 9.4.1（或更高版本）集成开发环境 (IDE) 中使用。

  1. 转到 .xcodeproj 项目文件所在的 Xcode 目录。

  2. 运行 pod init 以创建一个名为 Podfile 的 Pod 文件。

  3. 将 Podfile 的内容替换为以下内容。 将 target 名称从“AppName”更新为应用的名称。 根据需要更新平台或 Pod 版本。

    platform :osx, 10.14
use_frameworks!

target 'AppName' do
  pod 'MicrosoftCognitiveServicesSpeech-macOS', '~> 1.28.0'
end

  4. 运行 pod install 以安装语音 SDK。

或者，可以下载二进制 CocoaPod 并解压缩以提取其内容。 在 Xcode 项目中，添加对提取的“MicrosoftCognitiveServicesSpeech.xcframework”文件夹及其内容的引用。

注意

.NET 开发人员可以使用 Xamarin.Mac 应用程序框架生成本机 macOS 应用程序。 有关详细信息，请参阅 Xamarin.Mac。

参考文档包 (PyPi)GitHub 上的其他示例

本指南介绍如何安装用于 Python 的语音 SDK。

平台要求

适用于 Python 的语音 SDK 与 Windows、Linux 和 macOS 兼容。

在 Windows 上，你必须使用 64 位目标体系结构。 需要 Windows 10 或更高版本。

必须安装适用于你的平台的 Microsoft Visual C++ Redistributable for Visual Studio 2015、2017、2019 或 2022。 首次安装此包时，可能需要重启。

重要

确保安装了相同目标体系结构的包。 例如，如果安装 x64 可再发行包，则需要安装适用于 Python 的 x64 包。

安装从 3.7 开始或更高版本的 Python。

若要检查安装情况，请打开终端并运行命令 python --version。 如果安装正确，你将会收到像“Python 3.8.10”这样的响应。 如果你使用的是 macOS 或 Linux，可能需要改为运行命令 python3 --version。 若要启用 python 而不是 python3，请运行 alias python='python3' 以设置别名。 语音 SDK 快速入门示例指定了 python 用法。

安装适用于 Python 的语音 SDK

安装适用于 Python 的语音 SDK 之前，请确保满足平台先决条件。

选择工具或 IDE

从 PyPI 安装

若要安装适用于 Python 的语音 SDK，请在终端中运行此命令。

pip install azure-cognitiveservices-speech

升级到最新的语音 SDK 版本

若要升级到最新的语音 SDK，请在终端中运行以下命令：

pip install --upgrade azure-cognitiveservices-speech

可以通过查看 azure.cognitiveservices.speech.__version__ 变量来检查当前安装的适用于 Python 的语音 SDK 版本。 例如，在终端中运行以下命令：

pip list

使用语音 SDK

添加以下 import 语句以在 Python 项目中使用语音 SDK：

import azure.cognitiveservices.speech as speechsdk

后续步骤