AmiVoice API 参考资料

AmiVoice API 是将语音转换为文本的语音识别 Web API。本参考资料说明同步 HTTP 接口、异步 HTTP 接口、WebSocket 接口以及相关 API 的 endpoint、请求参数、响应和协议规格。对于 HTTP API，还提供 OpenAPI 格式的定义。

初次使用时，请先阅读手册中的入门。

接口的类型

语音识别根据用途提供 3 种接口。有关各接口的区别和选择标准，请参阅手册中的接口的类型和用途。

接口	用途
同步 HTTP 接口	通过 HTTP POST 发送短音频文件（16MB 以下），同步接收识别结果。是实现起来最简单的方法。
异步 HTTP 接口	将长时间音频注册为任务，通过轮询获取结果。适用于通话录音和会议录音的批处理。还可以使用说话人区分功能。
WebSocket 接口	在 WebSocket 连接上建立的双向通信协议，可以在发话过程中逐次接收识别的中间结果。适合实时字幕显示和语音对话。

此外，还提供以下与语音识别相关的 API。

API	用途
API Key 发行	使用 serviceId 和 service 密码，发行可设置有效期和连接源 IP 地址限制的 API key。
用户词典注册	导入、导出用于提高识别精度的单词注册（单词强调）。
单词注册类名	获取单词注册中使用的类名列表。
获取情绪参数列表	获取情绪分析结果中包含的参数定义列表。

如果不通过 HTTP 而将其嵌入应用程序，也可以使用各语言通用的客户端库（Hrp/Wrp）。

使用 API 需要认证信息。大多数 API 使用 API key（service 认证 key 字符串）。

HTTP 请求头：除非各 API 的参考页面另有说明，否则请使用以下格式。
```
Authorization: Bearer {API_KEY}
```
语音识别请求: 除了在头中指定外，还可以通过请求参数（同步·异步 HTTP 时为 u 参数，WebSocket 时为 s 命令的 authorization 参数）设置。

详情请参阅手册的API Key 的发行方法。

HTTP API 的参考页面由 OpenAPI 格式的定义文件生成。定义文件（YAML）可从以下链接下载。