自動音声認識(ASR)評価ステータスの取得API



自動音声認識(ASR)評価ステータスの取得API

このAPIを呼び出すと、指定された自動音声認識(ASR)評価の実行に関する概略を返します。このAPIでは、詳細な評価結果は得られません。より詳細な評価結果を表示するには、 ASR評価結果の取得APIを呼び出します。

実行内容は、ASR評価結果の取得APIとは異なります。ASR評価結果の取得APIは、詳細なデータを返し、ASR評価ステータスの取得APIはより大まかな情報を返します。

ASR評価のAPI実行手順の詳細については、APIフローを参照してください。

HTTPメソッドとパス

GET v1/skills/{skillId}/asrEvaluations/{evaluationId}/status HTTP/1.1 
アトリビュート 説明 必須
skillId 文字列 リクエストURIに含むスキルIDです。
evaluationId 文字列 URIパスに含む評価IDです。

リクエスト

リクエストヘッダー

  Accept: application/json

リクエスト本文

なし

応答

HTTPステータス

HTTP 200 OK

応答ヘッダー

Content-Type: application/json

応答本文

{
   "status": enum["IN_PROGRESS", "COMPLETED", "FAILED"],
   "totalEvaluationCount": integer,
   "completedEvaluationCount": integer,
   "startTimestamp": string,
   "request": {
       "skill": {
          "stage": enum["development", "live"],
          "locale": string
       },
       "annotationSetId": string
   },
   "result": {
      "status": enum["PASSED", "FAILED"],
      "metrics": {
          "overallErrorRate": double
      }
   },
   "error": {
      "message": string,
      "code": string
   }
}
アトリビュート 説明 必須
status 列挙 評価ジョブのステータスを示す列挙型。値は次のいずれかです。
IN_PROGRESS: 評価が進行中であることを示します。
FAILED: 入力検証に関係のない要因で、評価を開始できないことを示します。
COMPLETED: 評価が完了したことを示します。
request オブジェクト 評価の実行をトリガーするリクエスト。構造は、ASR評価の実行APIのペイロードと同一です。
totalEvaluationCount 整数 評価リクエストで実行される評価の合計数。
completedEvaluationCount 整数 完了した評価の数。
startTimestamp 文字列 ASR評価ジョブの開始タイムスタンプ(ISO-8601形式)。
result オブジェクト 評価結果に関する情報を含むオブジェクト。 ステータスがCOMPLETEDの場合は、それ以外は
result.metrics オブジェクト 生成されたメトリクスに関する情報を含むオブジェクト。 結果が存在する場合は、存在しない場合は
result.metrics.overallErrorRate Double ASR評価の実行における全体的なエラー率。すべての評価タスクが完了している場合のみ返されます。 結果が存在する場合は、存在しない場合は
result.status 列挙 評価結果のステータスを示す列挙型。指定できる値はPASSEDまたはFAILEDです。 結果が存在する場合は、存在しない場合は
error オブジェクト エラーに関する情報。このフィールドは、内部サーバエラーにより評価が終了した場合、応答本文に含まれます。
error.message 文字列 評価の実行が失敗した理由の詳細な説明。 実行エラーの場合は、そうでない場合は
error.code 文字列 エラーコード 。 実行エラーの場合は、そうでない場合は

エラー応答

このセクションでは、リクエスト固有のエラーについて説明します。すべてのASR APIに適用されるエラーのリファレンスについては、自動音声認識(ASR)APIエラーリファレンスを参照してください。

HTTPステータスコード エラーコード シナリオ

404 Not Found

RESOURCE_NOT_FOUND

指定されたスキルが存在しません。

指定された評価が存在しません。

400 Bad Request

INVALID_REQUEST_PARAMETER

評価IDの形式が正しくありません。

500 Internal Server Error

INTERNAL_SERVER_ERROR

内部サーバエラーのため、リクエストが失敗しました。

サンプルリクエスト 応答の例
GET /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status HTTP/1.1 Accept: application/json HTTP 200 OK Content-Type: application/json { "id": "1234-1234-1234-12341234", "status": "COMPLETED", "totalEvaluationCount": 2, "completedEvaluation": 2, "startTimestamp": "2018-10-25T08:25:04.679Z", "request": { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "1234-1234-12341234" }, "result": { "status": "PASSED", "metrics": { "overallErrorRate": 0.5 } } }
GET /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "id": "1234-1234-1234-12341234", "status": "IN_PROGRESS", "totalEvaluationCount": 2, "completedEvaluationCount": 1, "startTimestamp": "2018-10-25T08:25:04.679Z", "request": { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "1234-1234-12341234" } }
GET /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "id": "1234-1234-1234-12341234", "status": "COMPLETED", "totalEvaluationCount": 2, "completedEvaluationCount": 2, "startTimestamp": "2018-10-25T08:25:04.679Z", "request": { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "1234-1234-12341234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.4 } } }
GET /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "id": "1234-1234-1234-12341234", "status": "FAILED", "totalEvaluationCount": 2, "completedEvaluationCount": 2, "startTimestamp": "2018-10-25T08:25:04.679Z", "request": { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "1234-1234-12341234" }, "error": { "message": "An unexpected error occurred during evaluation run", "code": "INTERNAL_SERVER_ERROR" } }
GET /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status HTTP/1.1 Accept: application/json
HTTP 404 NOT FOUND Content-Type: application/json { "message": "Evaluation with identifier \"1234-1234-1234-12341234\" cannot be found", "code": "RESOURCE_NOT_FOUND" }