自動音声認識(ASR)評価の実行API



自動音声認識(ASR)評価の実行API

このAPIを呼び出すと、既存のアノテーションセットに対してASR評価を実行できます。

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

HTTPメソッドとパス

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

リクエスト

リクエストヘッダー

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

リクエスト本文

{
   "skill": {
      "stage": enum["development", "live"],
      "locale": string
   },
   "annotationSetId": string
}
アトリビュート 説明 必須
skill オブジェクト 評価で使用されたスキルに関する情報を含むオブジェクト。
skill.stage 列挙 指定されたスキルステージで結果をフィルタリングします。有効な値はdevelopmentまたはliveです。省略すると、ステージに関係なくすべての評価が応答に含まれます。
skill.locale 文字列 スキルのロケール(bcp 47形式)。
annotationSetId 文字列 アノテーションセットのIDです。

応答

HTTPステータス

HTTP 200 Ok

応答ヘッダー

Content-Type: application/json
Location: v1/skills/{skillId}/asrEvaluations/{evaluationId}/status
アトリビュート 説明 必須
skillId 文字列 スキルID。Locationヘッダーの一部です。
evaluationId 文字列 評価ID。Locationヘッダーの一部です。

応答本文

{
   "id": string
}
アトリビュート 説明 必須
id 文字列 評価の実行に関連付けられている評価ID。このIDは'amzn1.ask.asr-evaluaiton.{UUID}'の形式です。

エラー応答

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

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

404 Not Found

RESOURCE_NOT_FOUND

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

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

指定されたアノテーションセットが存在しません。

400 Bad Request

INVALID_REQUEST_PARAMETER

アノテーションセットIDの形式が正しくありません。

MISSING_REQUIRED_PROPERTY

リクエスト本文に必須フィールドがありません。

CONTENT_PARSE_FAILURE

リクエスト本文の形式が正しくありません。

PRECONDITION_NOT_MET アノテーションセットが空です。
指定されたロケールのスキル対話モデルが存在しません。

409 Conflict

CONFLICTING_INSTANCES

評価リクエストが、同じスキルの進行中の評価と競合しています。指定のスキルIDに対する評価は1つのみ実行可能であり、同時進行の評価リクエストはできません。

500 Internal Server Error

INTERNAL_SERVER_ERROR

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

サンプルリクエスト 応答の例
POST /v1/skills/1234/asrEvaluations HTTP/1.1 Content-Type: application/json Accept: application/json { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "amzn1.ask.asr-annotation-set.1234-1234-12341234" } HTTP 200 OK Content-Type: application/json Location: /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status { "id": "amzn1.ask.asr-evaluation.1234-1234-1234-12341234" }
POST /v1/skills/1234/asrEvaluations HTTP/1.1 Content-Type: application/json Accept: application/json { "skill": { "stage": "development", "locale": "en-US" }, "annotationSetId": "amzn1.ask.asr-annotation-set.1234-1234-12341234" }
HTTP 400 Bad Request Content-Type: application/json Location: /v1/skills/1234/asrEvaluations/1234-1234-1234-12341234/status { "message": "Skill does not have en-US internal model", "violations": [{ "message": "The skill does not have \"en-US\" interaction model", "code": "PRECONDITION_NOT_MET" }] }