Lex V2 ボットのリクエスト属性の設定

リクエスト属性は、リクエスト固有の情報を示し、現在のリクエストにのみ適用されます。クライアントアプリケーションは、この情報を Amazon Lex に送信します。セッション全体を通しては保持する必要がない情報は、リクエスト属性を使用して渡します。リクエスト属性は、独自に作成することも、事前定義されたものを使用することもできます。リクエスト属性を送信するには、 の x-amz-lex-request-attributesヘッダーRecognizeUtteranceまたは RecognizeText リクエストの requestAttributesフィールドを使用します。セッション属性とは異なり、リクエスト属性は複数のリクエストにわたって保持されないため、RecognizeUtterance レスポンスや RecognizeText レスポンスで返されることはありません。

注記

複数のリクエストにわたって保持される情報を送信するには、セッション属性を使用します。

Lex V2 ボットリクエストごとにユーザー定義のリクエスト属性を設定する

ユーザー定義のリクエスト属性は各リクエストでボットに送信するデータです。この情報を送信するには、RecognizeUtterance リクエストの amz-lex-request-attributes ヘッダーを使用するか、RecognizeText リクエストの requestAttributes フィールドを使用します。

Amazon Lex にリクエスト属性を送信するには、属性の string-to-string マップを作成します。リクエスト属性のマッピング方法を以下に示します。

{
   "attributeName": "attributeValue",
   "attributeName": "attributeValue"
}

PostText オペレーションの場合は、次に示すように、[requestAttributes] フィールドを使用してリクエストの本文にマップを挿入します。

"requestAttributes": {
   "attributeName": "attributeValue",
   "attributeName": "attributeValue"
}

PostContent オペレーションの場合は、マップを base64 エンコードし、それを x-amz-lex-request-attributes ヘッダーとして送信します。

バイナリまたは構造化されたデータをリクエスト属性で送信する場合は、最初にデータを単純な文字列に変換する必要があります。詳細については、「Lex V2 ボットでの複雑な属性の設定」を参照してください。