Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetSession
指定されたボット、エイリアス、ユーザー ID のセッション情報を返します。
リクエストの構文
GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- botAlias
-
セッションデータを含むボットに使用されるエイリアス。
必須: はい
- botName
-
セッションデータを含むボットの名前。
必須: はい
- checkpointLabelFilter
-
recentIntentSummaryView構造体で返されるインテントをフィルタリングするための文字列。フィルターを指定すると、
checkpointLabelフィールドにその文字列が設定されているインテントのみが返されます。長さの制限：最小長は 1 です。最大長は 255 です。
パターン:
[a-zA-Z0-9-]+ - userId
-
クライアントアプリケーションユーザーの ID。Amazon Lex は、ユーザーとボットとの会話を識別するために使用します。
長さの制限: 最小長は 2 です。最大長は 100 です。
パターン:
[0-9a-zA-Z._:-]+必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"activeContexts": [
{
"name": "string",
"parameters": {
"string" : "string"
},
"timeToLive": {
"timeToLiveInSeconds": number,
"turnsToLive": number
}
}
],
"dialogAction": {
"fulfillmentState": "string",
"intentName": "string",
"message": "string",
"messageFormat": "string",
"slots": {
"string" : "string"
},
"slotToElicit": "string",
"type": "string"
},
"recentIntentSummaryView": [
{
"checkpointLabel": "string",
"confirmationStatus": "string",
"dialogActionType": "string",
"fulfillmentState": "string",
"intentName": "string",
"slots": {
"string" : "string"
},
"slotToElicit": "string"
}
],
"sessionAttributes": {
"string" : "string"
},
"sessionId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- activeContexts
-
セッションのアクティブコンテキストのリスト。コンテキストは、インテントが達成されたとき、または
PostContent、PostText、PutSessionのオペレーションを呼び出したときに設定できます。コンテキストを使用して、あるインテントをフォローできるインテントを制御したり、アプリケーションの動作を変更したりすることができます。
型: ActiveContext オブジェクトの配列
配列メンバー：最小数は 0 項目です。最大数は 20 項目です。
- dialogAction
-
ボットの現在の状態を示します。
型: DialogAction オブジェクト
- recentIntentSummaryView
-
セッションで使用されるインテントに関する情報の配列。配列には最大 3 つのサマリーを含めることができます。セッションで 3 つ以上のインテントが使用されている場合、
recentIntentSummaryViewオペレーションには最後に使用された 3 つのインテントに関する情報が含まれています。リクエストに
checkpointLabelFilterパラメータを設定した場合、配列には、指定されたラベルを持つインテントのみが含まれます。型: IntentSummary オブジェクトの配列
配列メンバー：最小数は 0 項目です。最大数は 3 項目です。
- sessionAttributes
-
セッション固有のコンテキスト情報を表すキーバリューのペアのマップ。Amazon Lex とクライアントアプリケーションの間で渡されるアプリケーション情報を含みます。
型: 文字列間のマッピング
- sessionId
-
セッションの一意の識別子。
型: 文字列
エラー
- BadRequestException
-
リクエストの検証に失敗したか、コンテキストに使用可能なメッセージがないか、ボットの構築が失敗もしくは進行中であるか、または構築されていない変更が含まれています。
HTTP ステータスコード：400
- InternalFailureException
-
内部サービスエラー。呼び出しを再試行します。
HTTP ステータスコード：500
- LimitExceededException
-
制限を超えました。
HTTP ステータスコード: 429
- NotFoundException
-
参照するリソース (Amazon Lex bot やエイリアスなど) が見つかりません。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。
