自動音声認識（ASR）評価のリスト取得API

自動音声認識（ASR）評価のリスト取得API

このAPIを呼び出すと、自動音声認識（ASR）評価の履歴を取得できます。返される結果では、最新の評価実行が最初に表示されます。

HTTPメソッドとパス

GET /v1/skills/{skillId}/asrEvaluations?locale={locale}&annotationSetId={annotationSetId}&stage={stage}&nextToken={nextToken}&maxResults={maxResults} HTTP/1.1
アトリビュート 型 説明 必須
skillId 文字列 スキルIDです。 ◯
annotationSetId 文字列 指定したアノテーションセットIDで結果をフィルタリングします。省略すると、評価に使用されたアノテーションセットに関係なく、すべての評価が応答に含まれます。 ✕
locale 文字列 bcp 47形式のロケール。指定したロケールで結果をフィルタリングします。省略すると、ロケールに関係なくすべての評価が応答に含まれます。 ✕
stage 列挙 指定されたスキルステージで結果をフィルタリングします。有効な値はdevelopmentまたはliveです。省略すると、ステージに関係なくすべての評価が応答に含まれます。 ✕
nextToken 文字列 文字列です。前回のリスト取得応答で、responseオブジェクトで返された継続トークンです。 ✕
maxResults 整数 整数です。表示するテスト項目の結果の最大数。値は1〜1000の間で指定します。デフォルトは1000です。 ✕

リクエスト

リクエストヘッダー

Content-Type: application/json
Accept: application/json

リクエスト本文

なし

応答

HTTPステータス

HTTP 200 OK

応答ヘッダー

Content-Type: application/json

応答本文

{
    "paginationContext": {
        "nextToken": string
    },
    "evaluations": [
        {
            "id": string,
            "status": enum["IN_PROGRESS", "COMPLETED", "FAILED"],
            "totalEvaluationCount": integer,
            "completedEvaluationCount": integer,
            "startTimestamp": string,
            "request": {
                "skill": {
                    "stage": string,
                    "locale": string
                },
                "annotationSetId": "id": string
           },
           "result": {
               "status": enum["PASSED", "FAILED"],
               "metrics": {
                   "overallErrorRate": double
               }
           },
           "error": {
               "message": string,
               "code": string
           }
       }
    ]
}
アトリビュート 型 説明 必須
evaluations 配列 リクエストで定義されたフィルタ条件に基づく、これまで実行したすべての評価を含む配列。 ◯
evaluations[i] オブジェクト 評価に関する大まかな情報。構造は、ASR評価ステータス取得APIの応答と同じです。 ◯
paginationContext オブジェクト ページ分割情報を含むオブジェクト。これが存在する場合、応答のアノテーションセットは不完全です。存在しない場合、すべてのアノテーションセットが既に返されています。 ✕
paginationContext.nextToken 文字列 nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用します。 ◯

エラー応答

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

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

404 Not Found

RESOURCE_NOT_FOUND

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

400 Bad Request

INVALID_REQUEST_PARAMETER

ロケールの形式が正しくありません。

ステージの形式が正しくありません。

nextTokenの形式が正しくありません。

PARAMTER_EXPIRED

nextTokenの有効期限が切れています。

INAVLID_INTEGER_VALUE

maxResultsの値が許容範囲外です。

500 Internal Server Error

INTERNAL_SERVER_ERROR

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

例

サンプルリクエスト 応答の例
GET /v1/skills/{skillId}/asrEvaluations HTTP/1.1 Accept: application/json HTTP 200 OK Content-Type: application/json { "evaluations": [ { "id": "1234-1234-54321", "status": "COMPLETED", "startTimestamp": "2018-10-25T08:25:04.679Z", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "request": { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "PASSED", "metrics": { "overallErrorRate": 0.5 } } }, { "id": "1234-1234-54325", "status": "COMPLETED", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "startTimestamp": "2018-10-24T08:25:04.679Z" "request": { "skill": { "stage": "live", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.5 } } }, { "id": "1234-1234-54322", "status": "COMPLETED", "startTimestamp": "2018-10-24T08:25:04.679Z", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "request": { "skill": { "stage": "development", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.5 } } }, { "id": "1234-1234-54323", "status": "FAILED", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "startTimestamp": "2018-10-24T08:25:04.679Z" "request": { "skill": { "stage": "development", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "error": { "message": "An unexpected error occurred", "code": "INTERNAL_SERVER_ERROR" } } ] }

GET /v1/skills/{skillId}/asrEvaluations HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "paginationContext": { "nextToken": "12341234" }, "evaluations": [ { "id": "1234-1234-54325", "status": "COMPLETED", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "startTimestamp": "2018-10-24T08:25:04.679Z" "request": { "skill": { "stage": "live", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.5 } } } ] }
GET /v1/skills/{skillId}/asrEvaluations HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "evaluations": [ { "id": "1234-1234-54322", "status": "COMPLETED", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "startTimestamp": "2018-10-24T08:25:04.679Z" "request": { "skill": { "stage": "development", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.5 } } } ] }
GET /v1/skills/{skillId}/asrEvaluations HTTP/1.1 Accept: application/json
HTTP 200 OK Content-Type: application/json { "evaluations": [ { "id": "1234-1234-54325", "status": "COMPLETED", "totalEvaluationCount": 10, "completedEvaluationCount": 10, "startTimestamp": "2018-10-24T08:25:04.679Z" "request": { "skill": { "stage": "live", "locale": "en-GB" }, "annotationSetId": "1234-1234-1234" }, "result": { "status": "FAILED", "metrics": { "overallErrorRate": 0.5 } } } ] }
GET /v1/skills/{skillId}/asrEvaluations HTTP/1.1 Accept: application/json
HTTP 400 Bad Request Content-Type: application/json { "message": "Request validations failed", "violations": [{ "message": "Query parameter \"nextToken\" with value \"12341234\" is expired.", "code": "PARAMETER_EXPIRED" }] }