メインコンテンツまでスキップ

AmiVoice API リファレンス

AmiVoice API は、音声をテキストに変換する音声認識の Web API です。 このリファレンスでは、各インタフェースと関連 API のエンドポイント、リクエスト、レスポンスなどを説明します。 HTTP API については、OpenAPI 形式の定義もあわせて提供します。

はじめて利用する場合は、マニュアルのはじめにからお読みください。

インタフェースの種類​

音声認識には、用途に応じて 3 つのインタフェースがあります。それぞれの違いや使い分けの基準は、マニュアルのインタフェースの種類と使い方を参照してください。

インタフェース
用途
同期 HTTP インタフェース短い音声ファイル（16MB 以下）を HTTP POST で送信し、認識結果を同期的に受け取ります。実装が最も簡単な方法です。
非同期 HTTP インタフェース長時間の音声をジョブとして登録し、ポーリングで結果を取得します。通話録音や会議録音のバッチ処理を想定しています。話者ダイアライゼーションも利用できます。
WebSocket インタフェースWebSocket 接続上の双方向通信プロトコルで、発話中の認識途中結果を逐次受け取れます。リアルタイムの字幕表示や音声対話に向いています。

また、音声認識に付随する以下の API を提供しています。

API
用途
API キー発行サービス ID とサービスパスワードから、有効期限や接続元 IP アドレス制限を設定した API キーを発行します。
ユーザー辞書登録認識精度を高めるための単語登録（単語強調）のインポート・エクスポートを行います。
単語登録クラス名単語登録で用いられるクラス名の一覧を取得します。
感情パラメータ一覧の取得感情分析結果に含まれるパラメータの定義一覧を取得します。

HTTP を使わずにアプリケーションへ組み込む場合は、各言語共通のクライアントライブラリ（Hrp/Wrp）も利用できます。

認証​

API の利用には認証情報が必要です。多くの API では、API キー（サービス認証キー文字列）を使用します。

APIキーの指定方法​

  • HTTP リクエストヘッダー: 各 API のリファレンスに別の案内がない場合は、次の書式を使用します。 
    Authorization: Bearer {APIキー}
  • 音声認識リクエスト: ヘッダーでの指定に加え、リクエストパラメータ（同期・非同期HTTPの場合は u パラメータ、WebSocketの場合は s コマンドの authorization パラメータ）での設定も可能です。

APIキーの取得・確認手順​

詳細はマニュアルのAPI キーの発行方法を参照してください。

OpenAPI 定義​

HTTP API のリファレンスは OpenAPI 形式の定義ファイルから生成されています。定義ファイル（YAML）は以下からダウンロードできます。

関連情報​