あなたのAlexaコンソール
?
サポート

対話モデルの操作(スキル管理API)

対話モデルの操作(スキル管理API)

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

関連トピック:Alexa Skills KitコマンドラインインターフェースとAlexaスキル管理APIの概要

GET対話モデル

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

リクエスト

GET /v0/skills/{skillId}/interactionModel/locales/{locale}

パラメーターの説明

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス
locale 取得する対話モデルのロケールです。「en-GB」、「en-US」、「en-IN」、「en-CA」、「de-DE」などがあります。 パス

戻り値の型

InteractionModel

データの例

{
  "languageModel": {
    "invocationName": "string",
    "types": [
      {
        "name": "string",
        "values": [
          "string"
        ]
      }
    ],
    "intents": [
      {
        "name": "string",
        "slots": [
          {
            "name": "string",
            "type": "string",
            "samples": [
              "string"
            ]
          }
        ],
        "samples": [
          "string"
        ]
      }
    ]
  },
  "dialog": {
    "intents": [
      {
        "name": "string",
        "slots": [
          {
            "name": "string",
            "prompts": {
              "elicitation": "string",
              "confirmation": "string"
            },
            "validations": [
              {
                "type": "string",
                "prompt": "string"
              }
            ]
          }
        ]
      }
    ]
  },
  "prompts": [
    {
      "id": "string",
      "variations": [
        {
          "type": "SSML",
          "value": "string"
        }
      ]
    }
  ]
}

応答

HTTP/1.1 200 OK
HTTP/1.1 401 Unauthorized
HTTP/1.1 404

指定したスキルが存在しないか、ロケールにモデルが定義されていません。

リクエスト

HEAD /v0/skills/{skillId}/interactionModel/locales/{locale}

パラメーターの説明

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス
locale 取得する対話モデルのロケールです。 パス

応答

HTTP/1.1 200 OK

ヘッダー

ETag: {eTag}

パラメーターの説明

フィールド 説明 パラメーターの型
eTag APIサービスによって生成された、現行バージョンのモデルのタグです。 応答のヘッダー
HTTP/1.1 401 Unauthorized
HTTP/1.1 404 Not Found

指定したスキルまたはロケールが存在しません。

更新のための対話モデル

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

リクエスト

POST /v0/skills/{skillId}/interactionModel/locales/{locale}

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

パラメーターの説明

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス
locale 取得する対話モデルのロケールです。 パス

リクエスト本文

フィールド 説明 パラメーターの型 必須
interactionModel 対話モデルの名前です 文字列

応答

HTTP/1.1 200 OK

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

HTTP/1.1 401 Unauthorized
HTTP/1.1 400 Bad Request
HTTP/1.1 404 Not Found
HTTP/1.1 409 Conflict

競合のためリクエストを処理できませんでした。たとえば、指定したETagがストアの現在のETagと一致しない、または別のビルドが処理中であるなどの場合が考えられます。

HTTP/1.1 413 Payload Too Large

ペイロードのサイズが制限を超えています。

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

リクエスト

GET /v0/skills/{skillId}/interactionModel/locales/{locale}/status

パラメーターの説明

フィールド 説明 パラメーターの型 必須
skillId 一意のスキルIDです。 パス
locale 取得する対話モデルのロケールです。 パス

戻り値の型

BuildStatus

データの例

Content-Type: application/json
{ }

応答

HTTP/1.1 200 OK
{
    "status": "SUCCESS"
}

その他の有効なstatus値は、FAILEDIN_PROGRESSです。

HTTP/1.1 401 Unauthorized
HTTP/1.1 404 Not Found

指定したスキルが存在しないか、ロケールにモデルが定義されていません。