自動音声認識(ASR)アノテーションセットのリスト取得API
自動音声認識(ASR)アノテーションセットのリスト取得API
このAPIは、特定のスキルのすべてのアノテーションセットを返します。
HTTPメソッドとパス
GET v1/skills/{skillId}/asrAnnotationSets?nextToken={nextToken}&maxResults={maxResults}
フィールド | 型 | 説明 | 必須 |
---|---|---|---|
skillId |
文字列 | URIパスに含むスキルIDです。 | ◯ |
annotationSetID |
文字列 | URIパスに含むアノテーションセットIDです。 | ◯ |
リクエスト
リクエストヘッダー
Content-Type: application/json
Accept: application/json
リクエスト本文
なし
応答
HTTPステータス
HTTP 200 OK
応答ヘッダー
Content-Type: application/json
応答本文
{
"name": string,
"annotationCount": integer,
"lastUpdatedTimestamp": timestamp
}
アトリビュート | 型 | 説明 | 必須 |
---|---|---|---|
annotationSet[i].id | 文字列 | アノテーションセットID。 | ◯ |
annotationSet[i].name | 文字列 | アノテーションセットの名前です。 | ◯ |
annotationSet[i].annotationCount | 整数 | アノテーションセット内のアノテーションの数です。 | ◯ |
annotationSet[i].lastUpdatedTimestamp | 文字列 | アノテーションセットの最終更新タイムスタンプ。メタデータまたはコンテンツを更新すると、このタイムスタンプ(ISO-8601形式)も更新されます。 | ◯ |
paginationContext | オブジェクト | ページ分割情報を含むオブジェクト。存在する場合、レスポンスには不完全な評価結果が含まれます。存在しない場合、すべての評価結果が既に返されています。 | ✕ |
paginationContext.nextToken | 文字列 | nextTokenの値は、オブジェクトの次のセットのリストを表示する継続トークンとして次のリクエストで使用します。 | ◯ |
エラー応答
このセクションでは、リクエスト固有のエラーについて説明します。すべてのASR APIに適用されるエラーのリファレンスについては、自動音声認識(ASR)APIエラーリファレンスを参照してください。
HTTPステータスコード | エラーコード | シナリオ |
---|---|---|
404 Not Found |
RESOURCE_NOT_FOUND |
指定されたスキルが存在しません。 |
400 Bad Request |
INVALID_REQUEST_PARAMETER |
nextTokenの形式が正しくありません。 |
INAVLID_INTEGER_VALUE |
maxResultsの値が許容範囲外です。 |
|
PARAMETER_EXPIRED |
nextTokenの有効期限が切れています。 |
|
500 Internal Server Error |
INTERNAL_SERVER_ERROR |
内部サーバエラーのため、リクエストが失敗しました。 |
例
サンプルリクエスト | 応答の例 |
---|---|
GET /v1/skills/1234/asrAnnotationSets HTTP/1.1 Accept: application/json
|
HTTP 200 OK Content-Type: application/json { "annotationSets": [ { "id": "amzn1.ask-asr-evaluation.asid.1234-123-1234", "name": "my annotation set", "annotationCount": 10, "lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z" }, { "id": "amzn1.ask-asr-evaluation.asid.1234-123-1235", "name": "my annotation set 2", "annotationCount": 5, "lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z" }, { "id": "amzn1.ask-asr-evaluation.asid.1234-123-1236", "name": "my annotation set 3", "annotationCount": 5, "lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z" }, ] } |
GET /v1/skills/1234/asrAnnotationSets?maxResults=1 HTTP/1.1 Content-Type: application/json Accept: application/json |
HTTP 200 OK Content-Type: application/json { "annotationSets": [ { "id": "amzn1.ask-asr-evaluation.asid.1234-123-1234", "name": "my annotation set 2", "annotationCount": 5, "lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z" } ], "paginationContext": { "nextToken": "ABC123454" } } |
GET /v1/skills/1234/asrAnnotationSets?nextToken=asdfbcd HTTP/1.1 Content-Type: application/json Accept: application/json |
HTTP 400 Bad Request Content-Type: application/json { "message": "Query parameter validations failed", "violations": [{ "message": "Query parameter \"nextToken\" with value\"asdfbcd\" is expired", "code": "PARAMETER_EXPIRED" }] } |