GetSession - Amazon Lex V1
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Wenn Sie Amazon Lex V2 verwenden, lesen Sie stattdessen das Amazon Lex V2-Handbuch.

 

Wenn Sie Amazon Lex V1 verwenden, empfehlen wir, Ihre Bots auf Amazon Lex V2 zu aktualisieren. Wir fügen V1 keine neuen Funktionen mehr hinzu und empfehlen dringend, V2 für alle neuen Bots zu verwenden.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

GetSession

Gibt Sitzungsinformationen für einen angegebenen Bot, Alias und Benutzer-ID zurück.

Anforderungssyntax

GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

botAlias

Der Alias, der für den Bot verwendet wird, der die Sitzungsdaten enthält.

Erforderlich: Ja

botName

Der Name des Bots, der die Sitzungsdaten enthält.

Erforderlich: Ja

checkpointLabelFilter

Eine Zeichenfolge, mit der die in der recentIntentSummaryView Struktur zurückgegebenen Absichten gefiltert werden.

Wenn Sie einen Filter angeben, werden nur Absichten zurückgegeben, deren checkpointLabel Feld auf diese Zeichenfolge gesetzt ist.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 255 Zeichen.

Pattern: [a-zA-Z0-9-]+

userId

Die ID des Benutzers der Client-Anwendung. Amazon Lex verwendet dies, um die Konversation eines Benutzers mit Ihrem Bot zu identifizieren.

Längenbeschränkungen: Mindestlänge von 2. Maximale Länge beträgt 100 Zeichen.

Pattern: [0-9a-zA-Z._:-]+

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax

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"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

activeContexts

Eine Liste der aktiven Kontexte für die Sitzung. Ein Kontext kann festgelegt werden, wenn eine Absicht erfüllt ist, oder durch Aufrufen der PutSession Operation PostContentPostText, oder.

Sie können einen Kontext verwenden, um die Absichten zu steuern, die einer Absicht folgen können, oder um den Betrieb Ihrer Anwendung zu ändern.

Typ: Array von ActiveContext-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 50 Elemente.

dialogAction

Beschreibt den aktuellen Status des Bots.

Typ: DialogAction Objekt

recentIntentSummaryView

Eine Reihe von Informationen über die in der Sitzung verwendeten Absichten. Das Array kann maximal drei Zusammenfassungen enthalten. Wenn in der Sitzung mehr als drei Absichten verwendet werden, enthält der recentIntentSummaryView Vorgang Informationen über die letzten drei verwendeten Absichten.

Wenn Sie den checkpointLabelFilter Parameter in der Anforderung festlegen, enthält das Array nur die Absichten mit der angegebenen Bezeichnung.

Typ: Array von IntentSummary-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Maximale Anzahl von 3 Elementen.

sessionAttributes

Karte von Schlüssel/Wert-Paaren, die die sitzungsspezifischen Kontextinformationen darstellen. Es enthält Anwendungsinformationen, die zwischen Amazon Lex und einer Client-Anwendung ausgetauscht werden.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

sessionId

Eindeutiger Bezeichner für die Sitzung.

Typ: Zeichenfolge

Fehler

BadRequestException

Die Überprüfung der Anfrage ist fehlgeschlagen, es gibt keine brauchbare Nachricht im Kontext, oder der Bot-Build ist fehlgeschlagen, ist noch in Bearbeitung oder enthält noch nicht erstellte Änderungen.

HTTP Status Code: 400

InternalFailureException

Interner Dienstfehler. Versuchen Sie den Anruf erneut.

HTTP Status Code: 500

LimitExceededException

Ein Limit wurde überschritten.

HTTP-Statuscode: 429

NotFoundException

Die Ressource (z. B. der Amazon Lex Lex-Bot oder ein Alias), auf die verwiesen wird, wurde nicht gefunden.

HTTP Status Code: 404

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: