自動音声認識(ASR)アノテーションセットのメタデータ取得API



自動音声認識(ASR)アノテーションセットのメタデータ取得API

このAPIを呼び出すと、指定されたアノテーションセットのメタデータを取得できます。

HTTPメソッドとパス

GET v1/skills/{skillId}/asrAnnotationSets/{annotationSetId}
アトリビュート 説明 必須
skillId 文字列 リクエストURIに含むスキルIDです。
annotationSetId 文字列 リクエストURIに含むアノテーションセットIDです。

リクエスト

リクエストヘッダー

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

リクエスト本文

なし

応答

HTTPステータス

HTTP 200 OK

応答ヘッダー

Content-Type: application/json

応答本文

{
    "annotationSets": [
      { 
        "id": string,
        "name": String,
        "annotationCount": integer,
        "lastUpdatedTimestamp": timestamp
      }
    ],
    "paginationContext": {
        "nextToken": string
    }
}
アトリビュート 説明 必須
name 文字列 アノテーションセットの名前です。
annotationCount 整数 アノテーションセット内のアノテーションの数です。
lastUpdatedTimestamp 文字列 アノテーションセットが最後に更新されたタイムスタンプ(ISO 8601形式)です。

エラー応答

このセクションでは、リクエスト固有のエラーについて説明します。すべての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/asrAnnotationSets/1234-1234123-1234 HTTP/1.1 Accept: application/json HTTP 200 OK Content-Type: application/json { "name": "my annotation set", "annotationCount": 12, "lastUpdatedTimestamp": "2019-08-12T18:46:31.674Z" }
GET /v1/skills/1234/asrAnnotationSets/1234-1234123-1234 HTTP/1.1 Accept: application/json
HTTP 404 Not Found Content-Type: application/json { "message": "Resource with identfier \"1234-1234123-1234\" cannot be found", "code": "RESOURCE_NOT_FOUND" }