対話モデルの管理



対話モデルの管理

このドキュメントでは、対話モデルリソースに関連するすべてのAPI操作について説明します。このAPIのエンドポイントは、https://api.amazonalexa.comです。すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値はLogin with Amazonから取得したアクセストークンでなければなりません。

GET対話モデル

指定したスキルの対話モデルを取得します。

リクエスト

GET /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯
stage スキルのステージです。有効な値は、developmentとlive（大文字小文字の区別あり）です。 パス ◯
locale 取得する対話モデルのロケールです。de-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT, ja-JP、pt-BRなどです。 パス ◯

応答

HTTP/1.1 200 OK

ヘッダー

ETag: <etag_value>

本文

フィールド 説明 型
version 対話モデルのバージョンです。 文字列
description 対話モデルの説明です。 文字列
interactionModel 対話モデルオブジェクトです。 オブジェクト

例外

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 429 Too Many Requests

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

HEAD対話モデル

指定したスキルに対話モデルが存在するかどうかを確認します。

リクエスト

HEAD /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯
stage スキルのステージです。有効な値は、developmentとlive（大文字小文字の区別あり）です。 パス ◯
locale 取得する対話モデルのロケールです。 パス ◯

応答

HTTP/1.1 204 NoContent

ヘッダー

ETag: {eTag}

例外

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 429 Too Many Requests

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

更新のための対話モデル

指定したスキルの対話モデルの更新に使用します。

リクエスト

PUT /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}

スキルのInteractionModelを作成します。

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯
stage スキルのステージです。有効な値は、development（大文字小文字の区別あり）です。 パス ◯
locale 更新する対話モデルのロケールです。 パス ◯
interactionModel 対話モデルです。詳しくは、 対話モデルのスキーマを参照してください。 本文（オブジェクト） ◯
description 対話モデルのこのバージョンの説明です。 本文（文字列） ✕

ヘッダー

If-Match: <etag_value>

応答

HTTP/1.1 202 Accepted

成功すると、開発ステータスの場所のリンクが返されます。

ヘッダー

ETag: <etag>
Location: <Returns a relative URL to track the status>

例外

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 412 Precondition Failed

HTTP/1.1 429 Too Many Requests

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

対話モデルのバージョンのリスト

指定したスキルの対話モデルで、使用可能なバージョンの一覧を取得します。対話モデルのバージョンが取得できるのは、ビルドが正常に完了した後のみです。

リクエスト

GET /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}/versions

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯
stage スキルのステージです。有効な値は、development（大文字小文字の区別あり）のみです。 パス ◯
locale 取得する対話モデルのロケールです。de-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT, ja-JP、pt-BRなどです。 パス ◯
nextToken 結果が省略されている応答を受け取った後、さらに多くのバージョンを取得するには、このパラメーターを使用します。受け取った省略された応答からnextTokenの値に設定します。 クエリ ✕
maxResults 応答で返すバージョンの最大数です。このパラメーターを含めない場合は、デフォルトの最大値は10です。このパラメーターを含める場合は、応答には指定した値よりも小さい数の項目しかない場合もありますが、これを超える数の項目は含まれません。50を超える値を指定することはできません。 クエリ ✕
sortDirection 応答で返すバージョンの並び順を設定します。有効な値は、ascとdescです。ascに設定すると、そのバージョンは昇順で返され、descに設定すると、降順で返されます。 クエリ ✕
sortField 並び替えが適用されるフィールドを設定します。有効な値はversionのみです。 クエリ ✕

応答

HTTP/1.1 200 OK

本文

{
  "_links": {
    "self": {
      "href": "string"
    },
    "next": {
      "href": "string"
    }
  },
  "skillModelVersions": [
    {
      "version": "string",
      "creationTime": "string",
      "description": "string",
      "_links": {
        "self": {
          "href": "string"
        }
      }
    }
  ],
  "isTruncated": true,
  "nextToken": "string"
}
フィールド 説明 型
_links APIナビゲーションのリンクです。このフィールドの構造は、JSON Hypertext Application Languageの仕様（英語）で定義されています。 _linksオブジェクト （仕様（英語））
skillModelVersions 使用できる対話モデルのバージョンの一覧（配列）を含みます。各バージョンには、バージョンID、作成時間、説明、_linksオブジェクトが含まれます。 オブジェクト
isTruncated 応答で返された項目よりも多くの使用できるバージョンがリストに存在するかどうかを示すフラグです。この値がtrueであれば、この応答のリストは省略されます。さらに多くの項目を取得するには、この応答のnextTokenフィールドの値を、次のリクエストのnextTokenパラメーターに渡します。 ブール値
nextToken isTruncatedがtrueの場合、このフィールドには次のリクエストのnextTokenパラメーターに使用する値が含まれます。 文字列

例外

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 429 Too Many Requests

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

GET対話モデルのバージョン

指定したスキルの対話モデルの指定されたバージョンを取得します。

リクエスト

GET /v1/skills/{skillId}/stages/{stage}/interactionModel/locales/{locale}/versions/{version}

パラメーター

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス ◯
stage スキルのステージです。有効な値は、developmentとlive（大文字小文字の区別あり）です。 パス ◯
locale 取得する対話モデルのロケールです。de-DE、en-AU、en-CA、en-GB、en-IN、en-US、es-ES、es-MX、es-US、fr-CA、fr-FR、hi-IN、it-IT, ja-JP、pt-BRなどです。 パス ◯
version 取得する対話モデルのバージョンです。たとえば、1、2、3、4などです。現在のバージョンを取得するには、~currentを使用します。 パス ◯

応答

HTTP/1.1 200 OK

本文

フィールド 説明 型
version 対話モデルのバージョンです。 文字列
description 対話モデルのバージョンの説明です。 文字列
interactionModel 対話モデルオブジェクトです。 オブジェクト

例外

HTTP/1.1 400 Bad Request

HTTP/1.1 401 Unauthorized

HTTP/1.1 403 Forbidden

HTTP/1.1 404 Not Found

HTTP/1.1 429 Too Many Requests

HTTP/1.1 500 Internal Server Error

HTTP/1.1 503 Service Unavailable

対話モデルの開発ステータスを取得する

対話モデルの開発ステータスを取得するには、スキルステータスの取得を使用します。