ジョブの状態の確認、結果の取得
GET/v2/recognitions/:session_id
指定した音声認識ジョブの状態と結果を取得します。
リクエスト
レスポンス
- 200
- 401
- 404
- 500
音声認識リクエストの状態statusと付随する情報を返します。statusは以下の 5 つの値をとります。
| status | 説明 |
|---|---|
| queued | ジョブがキューに登録された状態。 |
| started | ジョブがキューから取り出されて、実行環境を用意している状態。 |
| processing | ジョブが実行されている状態。 |
| completed | 音声認識プロセスから結果が得られた状態。codeが空文字、つまり音声認識に成功した場合、segmentsに結果が含まれます。 |
| error | ジョブを実行しようとしたとき、もしくは、ジョブの実行中に何らかのエラーが発生した状態。error_message にエラーの詳細を保存します。 |
queued、started、processing、completed、error の各状態で含まれる情報について以下の表に整理します。各状態のそれぞれの頭文字の欄（q, s, p, c, e）で、A となっているものは常に含まれます。O となっているものは、その情報があればレスポンスに含まれます。
| キー | q | s | p | c | e | 説明 |
|---|---|---|---|---|---|---|
| status | A | A | A | A | A | ジョブの状態。queued、started、processing、completed、error の状態をとる。 |
| audio_md5 | A | A | O | 受信した音声ファイルの MD5 チェックサムの値。 | ||
| audio_size | A | A | O | 受信した音声ファイルのサイズ。 | ||
| content_id | O | O | O | O | O | ユーザーがリクエスト時に設定した contentId の値。 |
| service_id | A | A | A | A | サービスID。 | |
| segments | A | 発話単位の音声認識結果。 | ||||
| utteranceid | A | 認識結果情報 ID。 | ||||
| text | A | 「発話区間の認識結果」の全てを結合した全体の認識結果テキスト。 | ||||
| code | A | 結果を表す 1 文字のコード。 | ||||
| message | A | エラー内容を表す文字列。 | ||||
| error_message | A | エラー内容を表す文字列 |
status が completed のときには音声認識の結果を JSON 形式で返します。同期 HTTP インタフェースと異なり、認識結果が発話単位でsegmentsの下に配置されます。
認証に失敗した場合に返されます。
| エラーメッセージ | エラーの状況 |
|---|---|
| No authorization header | Authorization ヘッダが設定されていない |
| Invalid authorization header format | Authorization ヘッダのフォーマットが不正 |
| Failed to authorize for the API key | 指定された API キーによる認証が失敗 |
指定された session_id のジョブが見つからない場合に返されます。
| エラーメッセージ | エラーの状況 |
|---|---|
| Specified session_id is not found | 指定された session_id のジョブが見つからない |
正しいsession_idを指定しているにも関わらず、このエラーが起きる場合、以下のようなケースが考えられます。
- データ保存期間を過ぎたとき
- リクエスト時のユーザーと異なったユーザーがジョブの状態や結果を取得しようとしたとき
内部エラーの場合に返されます。
| エラーメッセージ | エラーの状況 |
|---|---|
| - | 内部エラー。こちらにご連絡下さい。 |