GetSession - Amazon Lex V1
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Si vous utilisez Amazon Lex V2, consultez plutôt le guide Amazon Lex V2.

 

Si vous utilisez Amazon Lex V1, nous vous recommandons de mettre à niveau vos robots vers Amazon Lex V2. Nous n'ajoutons plus de nouvelles fonctionnalités à la V1 et recommandons vivement d'utiliser la V2 pour tous les nouveaux robots.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

GetSession

Renvoie les informations de session pour un robot, un alias et un ID utilisateur spécifiés.

Syntaxe de la demande

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

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

botAlias

Alias utilisé pour le bot qui contient les données de session.

Obligatoire : oui

botName

Nom du bot qui contient les données de session.

Obligatoire : oui

checkpointLabelFilter

Chaîne utilisée pour filtrer les intentions renvoyées dans la recentIntentSummaryView structure.

Lorsque vous spécifiez un filtre, seules les intentions dont checkpointLabel le champ est défini sur cette chaîne sont renvoyées.

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255.

Modèle : [a-zA-Z0-9-]+

userId

ID de l'utilisateur de l'application cliente. Amazon Lex l'utilise pour identifier la conversation d'un utilisateur avec votre bot.

Contraintes de longueur : longueur minimale de 2. Longueur maximum de 100.

Modèle : [0-9a-zA-Z._:-]+

Obligatoire : oui

Corps de la demande

La demande n’a pas de corps de requête.

Syntaxe de la réponse

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

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

activeContexts

Liste des contextes actifs pour la session. Un contexte peut être défini lorsqu'une intention est satisfaite ou en appelant l'PutSessionopération PostContentPostText, ou.

Vous pouvez utiliser un contexte pour contrôler les intentions qui peuvent suivre une intention ou pour modifier le fonctionnement de votre application.

Type : tableau d’objets ActiveContext

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 20 éléments.

dialogAction

Décrit l'état actuel du bot.

Type : objet DialogAction

recentIntentSummaryView

Un ensemble d'informations sur les intentions utilisées au cours de la session. Le tableau peut contenir au maximum trois résumés. Si plus de trois intentions sont utilisées au cours de la session, l'recentIntentSummaryViewopération contient des informations sur les trois dernières intentions utilisées.

Si vous définissez le checkpointLabelFilter paramètre dans la demande, le tableau contient uniquement les intentions portant l'étiquette spécifiée.

Type : tableau d’objets IntentSummary

Membres du tableau : nombre minimum de 0 élément. Nombre maximum de 3 articles.

sessionAttributes

Carte des paires clé/valeur représentant les informations contextuelles spécifiques à la session. Il contient les informations d'application transmises entre Amazon Lex et une application cliente.

Type : mappage chaîne/chaîne

sessionId

Identifiant unique de la session.

Type : chaîne

Erreurs

BadRequestException

La validation de la demande a échoué, il n'y a aucun message utilisable dans le contexte, ou la création du bot a échoué, est toujours en cours ou contient des modifications non intégrées.

Code d’état HTTP : 400

InternalFailureException

Erreur de service interne. Réessayez l'appel.

Code d’état HTTP : 500

LimitExceededException

Dépassement d'une limite.

Code d’état HTTP : 429

NotFoundException

La ressource (telle que le bot Amazon Lex ou un alias) à laquelle il est fait référence est introuvable.

Code d’état HTTP : 404

consultez aussi

Pour plus d’informations sur l’utilisation de cette API dans l’un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :