PutSlotType - Amazon Lex V1

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

 

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

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

PutSlotType

カスタムスロットタイプを作成するか、既存のカスタムスロットタイプを置き換えます。

カスタムスロットタイプを作成するには、スロットタイプの名前と、このタイプのスロットが引き受けることができる値の列挙値のセットを指定します。詳細については、「Amazon Lex: 仕組み」を参照してください。

既存のスロットタイプの名前を指定した場合、リクエストのフィールドはそのスロットタイプの $LATEST バージョンの既存の値を置き換えます。Amazon Lex は、リクエストで指定していないフィールドを削除します。必須フィールドに値を指定しない場合、Amazon Lex は例外をスローします。$LATEST バージョンのスロットタイプを更新すると、ボットがそのスロットタイプを含む $LATEST バージョンインテントを使用している場合、ボットの status フィールドが NOT_BUILT に設定されます。

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

リクエストの構文

PUT /slottypes/name/versions/$LATEST HTTP/1.1 Content-type: application/json { "checksum": "string", "createVersion": boolean, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string" }

URI リクエストパラメータ

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

name

スロットタイプの名前。キースペース名では、大文字と小文字は区別されません

組み込みインテントネームと一致しないか、組み込みのインテントネームに「AMAZON」が含まれています。削除済み。例えば、AMAZON.DATE というスロットタイプが組み込まれているので、DATE というカスタムスロットタイプを作ることはできません。

組み込みスロットタイプの一覧については、「Alexa Skills Kit」「Slot Type Reference」(スロットタイプリファレンス) を参照してください。

長さの制限:最小長は 1 です。最大長は 100 です。

パターン: ^([A-Za-z]_?)+$

必須: はい

リクエストボディ

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

checksum

$LATEST バージョンの特定のリビジョンを識別します。

新しいスロットタイプを作成する場合は、checksum フィールドを空白にします。チェックサムを指定した場合、BadRequestException の例外が発生します。

スロットタイプを更新する場合は、checksum フィールドに $LATEST バージョンの最新リビジョンのチェックサムを設定します。 checksum フィールドを指定しない場合や、チェックサムが $LATEST バージョンと一致しない場合は、PreconditionFailedException 例外が発生します。

タイプ: 文字列

必須: いいえ

createVersion

true に設定すると、新しく採番されたバージョンのスロットタイプが作成されます。これは、CreateSlotTypeVersion のオペレーションを呼び出すのと同じです。createVersion を指定していない場合、デフォルトは false です。

型: ブール値

必須: いいえ

description

スロットタイプの説明。

型: 文字列

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

必須: いいえ

enumerationValues

スロットタイプが取得できる値を定義する EnumerationValue オブジェクトのリスト。各値は、機械学習モデルがスロットを解決する値を学習するための追加の値である synonyms のリストを持つことができます。

正規表現スロットタイプは、列挙値を必要としません。他のすべてのスロットタイプには、列挙値のリストが必要です。

Amazon Lexは、スロットの値を解決する際に、最大 5 つの可能な値を含む解決リストを生成します。Lambda 関数を使用している場合は、この解決リストが関数に渡されます。Lambda 関数を使用していない場合は、ユーザーが入力した値を返すか、解決リストの最初の値をスロット値として返すかを選択できます。valueSelectionStrategy フィールドには、使用するオプションが表示されます。

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

配列メンバー:最小数は 0 項目です。最大数は 10000 項目です。

必須: いいえ

parentSlotTypeSignature

スロットタイプの親として使用される組み込みスロットタイプです。親スロットタイプを定義すると、新しいスロットタイプには親と同じ設定が適応されます。

AMAZON.AlphaNumeric のみサポートされています。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 100 です。

Pattern: ^((AMAZON\.)_?|[A-Za-z]_?)+

必須: いいえ

slotTypeConfigurations

親組み込みスロットタイプを拡張する構成情報。構成は、親スロットタイプの設定に追加されます。

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

の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。

必須: いいえ

valueSelectionStrategy

Amazon Lex がスロットタイプの値を返す際に使用するスロット解決方法を決定します。フィールドの値は次のいずれかになります。

  • ORIGINAL_VALUE - ユーザー値がスロット値と似ている場合、ユーザーが入力した値を返します。

  • TOP_RESOLUTION - スロットの解像度リストがある場合、解像度リストの最初の値をスロットタイプの値として返します。解像度リストがない場合、null が返されます。

valueSelectionStrategy を指定しなかった場合、デフォルトは ORIGINAL_VALUE です。

型: 文字列

有効な値:ORIGINAL_VALUE | TOP_RESOLUTION

必須:いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "checksum": "string", "createdDate": number, "createVersion": boolean, "description": "string", "enumerationValues": [ { "synonyms": [ "string" ], "value": "string" } ], "lastUpdatedDate": number, "name": "string", "parentSlotTypeSignature": "string", "slotTypeConfigurations": [ { "regexConfiguration": { "pattern": "string" } } ], "valueSelectionStrategy": "string", "version": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

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

checksum

スロットタイプの $LATEST バージョンのチェックサム。

型: 文字列

createdDate

スロットタイプが作成された日付。

型: タイムスタンプ

createVersion

新しいバージョンのスロットタイプが作成された場合の True。リクエストで createVersion フィールドが指定されていない場合は、レスポンスで createVersion フィールドが false に設定されます。

型: ブール値

description

スロットタイプの説明。

型: 文字列

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

enumerationValues

スロットタイプが取得できる値を定義する EnumerationValue オブジェクトのリスト。

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

配列メンバー:最小数は 0 項目です。最大数は 10000 項目です。

lastUpdatedDate

スロットタイプが更新された日付。スロットタイプを作成する場合、作成日と最終更新日は同じです。

型: タイムスタンプ

name

スロットタイプの名前。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 100 です。

パターン: ^([A-Za-z]_?)+$

parentSlotTypeSignature

スロットタイプの親として使用される組み込みスロットタイプです。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 100 です。

パターン: ^((AMAZON\.)_?|[A-Za-z]_?)+

slotTypeConfigurations

親組み込みスロットタイプを拡張する構成情報。

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

の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。

valueSelectionStrategy

Amazon Lex がスロットの値を決定するために使用するスロット解決ストラテジー。詳細については、「PutSlotType」を参照してください。

型: 文字列

有効な値:ORIGINAL_VALUE | TOP_RESOLUTION

version

スロットタイプのバージョン。新しいスロットタイプの場合、バージョンは常に $LATEST となります。

型: 文字列

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

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

エラー

BadRequestException

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

HTTP ステータスコード:400

ConflictException

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

HTTP ステータスコード: 409

InternalFailureException

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

HTTP ステータスコード:500

LimitExceededException

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

HTTP ステータスコード: 429

PreconditionFailedException

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

HTTP ステータスコード: 412

その他の参照資料

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