GetIntent - 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.

GetIntent

Renvoie des informations relatives à une intention. Outre le nom de l'intention, vous devez spécifier la version de l'intention.

Cette opération exige des autorisations pour exécuter l'action lex:GetIntent.

Syntaxe de la demande

GET /intents/name/versions/version HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

name

Nom de l'intention. Le nom est sensible à la casse.

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 100.

Modèle : ^([A-Za-z]_?)+$

Obligatoire : oui

version

Version de l'intention.

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

Modèle : \$LATEST|[0-9]+

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

{
   "checksum": "string",
   "conclusionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "confirmationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "dialogCodeHook": { 
      "messageVersion": "string",
      "uri": "string"
   },
   "followUpPrompt": { 
      "prompt": { 
         "maxAttempts": number,
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      },
      "rejectionStatement": { 
         "messages": [ 
            { 
               "content": "string",
               "contentType": "string",
               "groupNumber": number
            }
         ],
         "responseCard": "string"
      }
   },
   "fulfillmentActivity": { 
      "codeHook": { 
         "messageVersion": "string",
         "uri": "string"
      },
      "type": "string"
   },
   "inputContexts": [ 
      { 
         "name": "string"
      }
   ],
   "kendraConfiguration": { 
      "kendraIndex": "string",
      "queryFilterString": "string",
      "role": "string"
   },
   "lastUpdatedDate": number,
   "name": "string",
   "outputContexts": [ 
      { 
         "name": "string",
         "timeToLiveInSeconds": number,
         "turnsToLive": number
      }
   ],
   "parentIntentSignature": "string",
   "rejectionStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "sampleUtterances": [ "string" ],
   "slots": [ 
      { 
         "defaultValueSpec": { 
            "defaultValueList": [ 
               { 
                  "defaultValue": "string"
               }
            ]
         },
         "description": "string",
         "name": "string",
         "obfuscationSetting": "string",
         "priority": number,
         "responseCard": "string",
         "sampleUtterances": [ "string" ],
         "slotConstraint": "string",
         "slotType": "string",
         "slotTypeVersion": "string",
         "valueElicitationPrompt": { 
            "maxAttempts": number,
            "messages": [ 
               { 
                  "content": "string",
                  "contentType": "string",
                  "groupNumber": number
               }
            ],
            "responseCard": "string"
         }
      }
   ],
   "version": "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.

checksum

Somme de contrôle de l'intention.

Type : chaîne

conclusionStatement

Une fois que la fonction Lambda spécifiée dans l'fulfillmentActivityélément répond à l'intention, Amazon Lex transmet cette déclaration à l'utilisateur.

Type : objet Statement

confirmationPrompt

Si cela est défini dans le bot, Amazon Lex utilise une invite pour confirmer l'intention avant de répondre à la demande de l'utilisateur. Pour de plus amples informations, veuillez consulter PutIntent.

Type : objet Prompt

createdDate

Date à laquelle l'intention a été créée.

Type : Timestamp

description

Une description de l'intention.

Type : chaîne

Contraintes de longueur : longueur minimum de 0. Longueur maximum de 200.

dialogCodeHook

Si elle est définie dans le bot, Amazon Amazon Lex invoque cette fonction Lambda pour chaque entrée utilisateur. Pour de plus amples informations, veuillez consulter PutIntent.

Type : objet CodeHook

followUpPrompt

Si elle est définie dans le bot, Amazon Lex utilise cette invite pour solliciter une activité supplémentaire de l'utilisateur une fois que l'intention a été remplie. Pour de plus amples informations, veuillez consulter PutIntent.

Type : objet FollowUpPrompt

fulfillmentActivity

Décrit comment l'intention est atteinte. Pour de plus amples informations, veuillez consulter PutIntent.

Type : objet FulfillmentActivity

inputContexts

Tableau d'InputContextobjets répertoriant les contextes qui doivent être actifs pour qu'Amazon Lex puisse choisir l'intention d'une conversation avec l'utilisateur.

Type : tableau d’objets InputContext

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

kendraConfiguration

Informations de configuration, le cas échéant, pour se connecter à un index Amazon Kendra dans le AMAZON.KendraSearchIntent but recherché.

Type : objet KendraConfiguration

lastUpdatedDate

Date à laquelle l'intention a été mise à jour. Lorsque vous créez une ressource, la date de création et la date de dernière mise à jour sont identiques.

Type : Timestamp

name

Nom de l'intention.

Type : chaîne

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 100.

Modèle : ^([A-Za-z]_?)+$

outputContexts

Tableau d'OutputContextobjets répertoriant les contextes que l'intention active lorsque l'intention est atteinte.

Type : tableau d’objets OutputContext

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

parentIntentSignature

Identifiant unique pour une intention intégrée.

Type : chaîne

rejectionStatement

Si l'utilisateur répond « non » à la question définie dansconfirmationPrompt, Amazon Lex répond par cette déclaration pour reconnaître que l'intention a été annulée.

Type : objet Statement

sampleUtterances

Un ensemble d'exemples d'énoncés configurés en fonction de l'intention.

Type : tableau de chaînes

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

Contraintes de longueur : longueur minimale de 1. Longueur maximum de 200.

slots

Un ensemble de créneaux d'intention configurés pour l'intention.

Type : tableau d’objets Slot

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 100 éléments.

version

Version de l'intention.

Type : chaîne

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

Modèle : \$LATEST|[0-9]+

Erreurs

BadRequestException

La demande n'est pas bien formulée. Par exemple, une valeur n'est pas valide ou un champ obligatoire est manquant. Vérifiez les valeurs des champs, puis réessayez.

Code d’état HTTP : 400

InternalFailureException

Une erreur interne Amazon Lex s'est produite. Réessayez votre demande.

Code d’état HTTP : 500

LimitExceededException

La demande a dépassé une limite. Réessayez votre demande.

Code d’état HTTP : 429

NotFoundException

La ressource spécifiée dans la demande est introuvable. Vérifiez la ressource et réessayez.

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 :