自動音声認識(ASR)アノテーションセットの作成API
自動音声認識(ASR)アノテーションセットの作成API
このAPIは、ASR評価用の空のアノテーションセットを作成します。アノテーションセットの作成後に音声ファイルのアノテーションを追加するには、アノテーションセットのアノテーション更新APIを呼び出します。
ASR評価のAPI実行手順の詳細については、APIフローを参照してください。
HTTPメソッドとパス
POST v1/skills/{skillId}/asrAnnotationSets
フィールド | 型 | 説明 | 必須 |
---|---|---|---|
skillId | 文字列 | URIパスに含むスキルIDです。 | ◯ |
リクエスト
リクエストヘッダー
Content-Type: application/json
Accept: application/json
リクエスト本文
{
"name": string
}
アトリビュート | 型 | 説明 | 必須 |
---|---|---|---|
name | 文字列 | アノテーションセットの名前(最大170文字)。 | ◯ |
応答
HTTPステータス
HTTP 200 OK
応答ヘッダー
Content-Type: application/json
Location: v1/skills/{skillId}/asrAnnotationSets/{annotationSetId}
アトリビュート | 型 | 説明 | 必須 |
---|---|---|---|
skillId | 文字列 | Location ヘッダーのURIに含まれるスキルIDです。 |
◯ |
annotationSetId | 文字列 | Location ヘッダーのURIに含まれるアノテーションセットIDです。 |
◯ |
応答本文
{
"id": string
}
アトリビュート | 型 | 説明 | 必須 |
---|---|---|---|
id | 文字列 | 新規作成されたアノテーションセットのID。'amzn1.ask.asr-annotation-set.{UUID}'の形式です。例:amzn1.ask.asr-annotation-set.524575b7-d845-4b61-a472-ce6e1fe4210a | ◯ |
エラー応答
このセクションでは、リクエスト固有のエラーについて説明します。すべてのASR APIに適用されるエラーのリファレンスについては、自動音声認識(ASR)APIエラーリファレンスを参照してください。
HTTPステータスコード | エラーコード | シナリオ |
---|---|---|
400 Bad Request |
MISSING_REQUIRED_PROPERTY | リクエスト本文に必須フィールドがありません。 |
CONTENT_PARSE_FAILURE |
リクエスト本文の形式が正しくありません。 |
|
INVALID_STRING_LENGTH |
nameフィールドの長さが許容範囲外です。 |
|
INVALID_REQUEST_PARAMETER |
nameフィールドに無効な文字が含まれています。 |
|
404 Not Found |
RESOURCE_NOT_FOUND |
指定されたスキルが存在しません。 |
500 Internal Server Error |
INTERNAL_SERVER_ERROR |
内部サーバエラーのため、リクエストが失敗しました。 |
例
サンプルリクエスト | 応答の例 |
---|---|
POST /v1/skills/1234/asrAnnotationSets HTTP/1.1 Content-Type: application/json Accept: application/json { "name": "my annotation set name" }
|
HTTP 200 OK Content-Type: application/json Location: /v1/skills/1234/asrAnnotationSets/amzn1.ask-asr-evaluation.asid.524575b7-d845-4b61-a472-ce6e1fe4210a { "id": "amzn1.ask.asr-evaluation.524575b7-d845-4b61-a472-ce6e1fe4210a" } |
POST /v1/skills/1234/asrAnnotationSets HTTP/1.1 Content-Type: application/json Accept: application/json { "name": "" } |
HTTP 400 Bad Request Content-Type: application/json { "message": "Payload validations failed", "violations": [{ "message": "The \"name\" property at property path \"$.name\" is outside the allowed range.Actual length: 0, Minimum length: 1", "code": "INVALID_STRING_LENGTH" }] } |
POST /v1/skills/1234/asrAnnotationSets HTTP/1.1 Content-Type: application/json Accept: application/json {} |
HTTP 400 Bad Request Content-Type: application/json { "message": "Payload validations failed", "violations": [{ "message": "Object at property path \"$\" has missing required property \"name\"" "code": "MISSING_REQUIRED_PROPERTY" }] } |