GetSession - Amazon Lex V1
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

如果您使用的是 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

工作階段的使用中前後關聯清單。上下文可以在實現意圖時或通過調用PostContentPostText、或PutSession操作來設置。

您可以使用前後關聯來控制可以跟進意圖的意圖，或修改應用程式的作業。

類型：ActiveContext 物件陣列

陣列成員：項目數下限為 0。項目數上限為 20。

dialogAction

描述機器人目前的狀態。

類型：DialogAction 物件

recentIntentSummaryView

工作階段中使用之意圖的相關資訊陣列。陣列最多可包含三個摘要。如果在工作階段中使用了三個以上的意圖，則recentIntentSummaryView作業會包含有關最後三個使用的意圖的資訊。

如果您在要求中設定checkpointLabelFilter參數，陣列只會包含具有指定標籤的意圖。

類型：IntentSummary 物件陣列

陣列成員：項目數下限為 0。3 個項目的最大數量。

sessionAttributes

表示會話特定上下文信息的鍵/值對的映射。它包含 Amazon Lex 和用戶端應用程式之間傳遞的應用程式資訊。

類型：字串到字串映射

sessionId

工作階段的唯一識別碼。

類型：字串

錯誤

BadRequestException

請求驗證失敗，上下文中沒有可用的消息，或者機器人構建失敗，仍在進行中或包含未構建的更改。

HTTP 狀態碼：400

InternalFailureException

內部服務錯誤。重試通話。

HTTP 狀態碼：500

LimitExceededException

超過限制。

HTTP 狀態碼：429

NotFoundException

找不到所參考的資源 (例如 Amazon Lex 機器人或別名)。

HTTP 狀態碼：404

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：