リクエストの構文 URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。

Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateBotVersion

指定されたボットの $LATEST バージョンに基づいて新しいバージョンを作成します。このリソースの $LATEST バージョンが、最後のバージョンを作成してから変更されていない場合、Amazon Lex は新しいバージョンを作成しません。最後に作成したバージョンを返します。

注記

ボットのバージョンで更新できるのは $LATEST バージョンのみです。CreateBotVersion オペレーションを使用して作成した番号付きのバージョンを更新することはできません。

ボットの最初のバージョンを作成すると、Amazon Lex はバージョンを 1 に設定します。それ以降のバージョンは 1 ずつ増えます。詳細については、「バージョニング」を参照してください。

このオペレーションには lex:CreateBotVersion アクションに対するアクセス許可が必要です。

リクエストの構文


POST /bots/name/versions HTTP/1.1
Content-type: application/json

{
   "checksum": "string"
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

name

作成する新しいバージョンのボットの名前。名前は、大文字と小文字が区別されます。

長さの制限: 最小長は 2 です。最大長は 50 です。

Pattern: ^([A-Za-z]_?)+$

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

checksum

ボットの $LATEST バージョンの特定のリビジョンを識別します。チェックサムを指定しても、$LATEST バージョンのボットのチェックサムが異なる場合は、PreconditionFailedException 例外が返され、Amazon Lexは新しいバージョンを公開しません。チェックサムを指定しない場合、Amazon Lex は $LATEST バージョンを公開します。

タイプ: 文字列

必須: いいえ

レスポンスの構文


HTTP/1.1 201
Content-type: application/json

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "status": "string",
   "version": "string",
   "voiceId": "string"
}

レスポンス要素

アクションが成功すると、HTTP 201 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。

abortStatement

Amazon Lex が会話をキャンセルするために使用するメッセージ。詳細については、「PutBot」を参照してください。

型: Statement オブジェクト

checksum

作成されたボットのバージョンを識別するチェックサム。

型: 文字列

childDirected

Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、childDirected フィールドに true または false を指定する必要があります。childDirected フィールドに true を指定することで、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA の対象になることに同意します。childDirected フィールドに false を指定することで、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しておらず、COPPA の対象にならないことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、childDirected フィールドにデフォルト値を指定することはできません。

Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、「Amazon Lex FAQ」を参照してください。

型: ブール値

clarificationPrompt

Amazon Lex がユーザーのリクエストを理解できない場合に使用するメッセージ。詳細については、「PutBot」を参照してください。

型: Prompt オブジェクト

createdDate

ボットバージョンの作成日｡

型: タイムスタンプ

description

ボットの説明。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 200 です。

detectSentiment

ユーザーが入力した発話を Amazon Comprehend に送信してセンチメント分析を行うかどうかを示します。

型: ブール値

enableModelImprovements

ボットが精度向上を使用しているかどうかを示します。true はボットが精度向上を使用していることを示し、それ以外は false となります。

型: ブール値

failureReason

status が FAILED の場合、Amazon Lex はボットの構築に失敗した理由を提示します。

型: 文字列

idleSessionTTLInSeconds

Amazon Lex が会話で収集したデータを保持する最大時間 (秒) です。詳細については、「PutBot」を参照してください。

型: 整数

値の範囲: 最小値は 60 です。最大値は 86400 です。

intents

Intent オブジェクトの配列。詳細については、「PutBot」を参照してください。

型: Intent オブジェクトの配列

lastUpdatedDate

このボットの $LATEST バージョンが更新された日。

型: タイムスタンプ

locale

ボットのターゲットロケールを指定します。

型: 文字列

name

ボットの名前。

型: 文字列

長さの制限: 最小長は 2 です。最大長は 50 です。

Pattern: ^([A-Za-z]_?)+$

status

ボットの作成や更新のリクエストを送信すると、Amazon Lex は status レスポンス要素を BUILDING に設定します。Amazon Lex がボットを構築した後、status を READY に設定します。Amazon Lex がボットをビルドできない場合、status を FAILED に設定します。Amazon Lex は、failureReason レスポンス要素に失敗の理由を返します。

型: 文字列

有効な値：BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

取得するボットのバージョンです。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: \$LATEST|[0-9]+

voiceId

Amazon Lex がユーザーとの音声対話に使用する Amazon Polly 音声 ID です。

型: 文字列

エラー

BadRequestException

リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。

HTTP ステータスコード：400

ConflictException

リクエストの処理中に競合が発生しました。リクエストを再試行してください。

HTTP ステータスコード: 409

InternalFailureException

Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。

HTTP ステータスコード：500

LimitExceededException

リクエストが制限を超えました。リクエストを再試行してください。

HTTP ステータスコード: 429

NotFoundException

リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。

HTTP ステータスコード: 404

PreconditionFailedException

変更しようとしているリソースのチェックサムがリクエストのチェックサムと一致しません。リソースのチェックサムを確認して、もう一度お試しください。

HTTP ステータスコード: 412

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Amazon Lex Model Building Service

CreateIntentVersion