入门

AmiVoice API 是一个将语音转换为文本的语音识别 API。当您发送语音时，它会返回将语音内容转换为文本的结果。您可以创建支持语音的应用程序，如会议记录或语音对话系统。

图. AmiVoice API 概述

文档结构

请参阅"引入和运营指南"部分了解引入前的安全和运营信息，"开发指南"部分了解实施详情，"参考"部分确认 API 规格，如遇困难请参阅"帮助"部分。

📄️ 引入和运营指南

汇总了安全、合规和运营所需的信息。

📄️ 开发指南

解释根据目的使用 API 的方法、请求、响应等开发所需的详细信息。

📄️ 参考

API 参考

📄️ 帮助

故障排除和咨询方法

快速入门

获取 APPKEY

从用户注册页面注册，并记下在我的页面的[连接信息]中显示的 APPKEY。使用以下命令将其设置为环境变量。

macOS / Linux
Windows (PowerShell)
Windows (命令提示符)

export APPKEY=your_appkey_here

$env:APPKEY = "your_appkey_here"

set APPKEY=your_appkey_here

提示

AmiVoice Tech Blog 提供了从用户注册到使用 AmiVoice API 将音频文件转换为文本的逐步说明，请参考以下链接：

Let's try using the speech recognition API "AmiVoice API"

准备音频文件

准备要转录的音频文件。您可以直接使用以下示例音频（test.wav）。

关于支持的音频文件格式，请参阅关于音频格式。

执行语音识别

请执行以下操作。将 test.wav 替换为您要使用的音频文件的路径。

curl (macOS / Linux)
curl (Windows PowerShell)
curl (Windows 命令提示符)
Python

curl https://acp-api.amivoice.com/v1/recognize \
     -F d=-a-general \
     -F u=$APPKEY \
     -F a=@test.wav | jq

备注

如果未安装 curl 命令，请从 https://curl.se/ 下载适用于您的操作系统的软件包，或使用软件包管理器安装 curl。
结果文本是 Unicode 转义的。上述命令使用 jq 来格式化响应，使其更易读。如果未安装 jq，请尝试删除 | jq 部分执行。您可以从 https://stedolan.github.io/jq/ 下载适用于您的操作系统的软件包，或使用软件包管理器安装 jq 命令。

curl.exe https://acp-api.amivoice.com/v1/recognize `
     -F d=-a-general `
     -F u=$env:APPKEY `
     -F a=@test.wav | jq

备注

在 PowerShell 中，curl 是 Invoke-WebRequest 的别名，因此请明确使用 curl.exe。Windows 10 版本 1803 及更高版本默认包含 curl.exe。如果没有包含，请从 https://curl.se/ 安装。
结果文本是 Unicode 转义的。上述命令使用 jq 来格式化响应，使其更易读。如果未安装 jq，请尝试删除 | jq 部分执行。您可以从 https://stedolan.github.io/jq/ 下载适用于您的操作系统的软件包，或使用软件包管理器安装 jq 命令。

curl https://acp-api.amivoice.com/v1/recognize ^
     -F d=-a-general ^
     -F u=%APPKEY% ^
     -F a=@test.wav

备注

Windows 10 版本 1803 及更高版本默认包含 curl。如果没有包含，请从 https://curl.se/ 安装。
结果文本是 Unicode 转义的。上述命令使用 jq 来格式化响应，使其更易读。如果未安装 jq，请尝试删除 | jq 部分执行。您可以从 https://stedolan.github.io/jq/ 下载适用于您的操作系统的软件包，或使用软件包管理器安装 jq 命令。

import os
import requests

with open("test.wav", "rb") as f:
    response = requests.post(
        "https://acp-api.amivoice.com/v1/recognize",
        data={"d": "-a-general", "u": os.environ["APPKEY"]},
        files={"a": f}
    )
    data = response.json()  # JSON 解析器会自动将 Unicode 转义转换为中文
    print(data)

确认结果

成功时会返回如下 JSON。转录结果包含在 text 字段中。

{
  "results": [
    {
      "tokens": [ ... ],
      "confidence": 0.998,
      "starttime": 250,
      "endtime": 8794,
      "text": "アドバンスト・メディアは、人と機械との自然なコミュニケーションを実現し、豊かな未来を創造していくことを目指します。"
    }
  ],
  "utteranceid": "20220602/14/018122d637320a301bc194c9_20220602_141433",
  "text": "アドバンスト・メディアは、人と機械との自然なコミュニケーションを実現し、豊かな未来を創造していくことを目指します。",
  "code": "",
  "message": ""
}