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

GetBot

Renvoie des informations de métadonnées pour un bot spécifique. Vous devez fournir le nom du bot ainsi que la version ou l'alias du bot.

Cette opération exige des autorisations pour l'action lex:GetBot.

Syntaxe de la demande

GET /bots/name/versions/versionoralias HTTP/1.1

Paramètres de demande URI

La demande utilise les paramètres URI suivants.

name

Le nom du bot. Le nom est sensible à la casse.

Contraintes de longueur : longueur minimale de 2. Longueur maximale de 50.

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

Obligatoire : oui

versionoralias

Version ou alias du bot.

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

{
   "abortStatement": { 
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "checksum": "string",
   "childDirected": boolean,
   "clarificationPrompt": { 
      "maxAttempts": number,
      "messages": [ 
         { 
            "content": "string",
            "contentType": "string",
            "groupNumber": number
         }
      ],
      "responseCard": "string"
   },
   "createdDate": number,
   "description": "string",
   "detectSentiment": boolean,
   "enableModelImprovements": boolean,
   "failureReason": "string",
   "idleSessionTTLInSeconds": number,
   "intents": [ 
      { 
         "intentName": "string",
         "intentVersion": "string"
      }
   ],
   "lastUpdatedDate": number,
   "locale": "string",
   "name": "string",
   "nluIntentConfidenceThreshold": number,
   "status": "string",
   "version": "string",
   "voiceId": "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.

abortStatement

Message renvoyé par Amazon Lex lorsque l'utilisateur choisit de mettre fin à la conversation sans la terminer. Pour de plus amples informations, veuillez consulter PutBot.

Type : objet Statement

checksum

Somme de contrôle du bot utilisée pour identifier une révision spécifique de la $LATEST version du bot.

Type : chaîne

childDirected

Pour chaque bot Amazon Lex créé avec Amazon Lex Model Building Service, vous devez indiquer si votre utilisation d'Amazon Lex est liée à un site Web, à un programme ou à une autre application destiné ou ciblé, en tout ou en partie, aux enfants de moins de 13 ans et soumis à la loi COPPA (Children's Online Privacy Protection Act) en spécifiant true ou false dans le childDirected champ. trueEn spécifiant dans ce childDirected champ, vous confirmez que votre utilisation d'Amazon Lex est liée à un site Web, à un programme ou à une autre application destiné ou ciblé, en tout ou en partie, aux enfants de moins de 13 ans et soumis à la COPPA. falseEn spécifiant dans ce childDirected champ, vous confirmez que votre utilisation d'Amazon Lex n'est pas liée à un site Web, à un programme ou à une autre application destiné ou ciblé, en tout ou en partie, aux enfants de moins de 13 ans et soumis à la COPPA. Vous ne pouvez pas spécifier de valeur par défaut pour le childDirected champ qui ne reflète pas exactement si votre utilisation d'Amazon Lex est liée à un site Web, à un programme ou à une autre application destiné ou ciblé, en tout ou en partie, aux enfants de moins de 13 ans et soumis à la COPPA.

Si votre utilisation d'Amazon Lex concerne un site Web, un programme ou une autre application destinés, en tout ou en partie, à des enfants de moins de 13 ans, vous devez obtenir le consentement parental vérifiable requis en vertu de la COPPA. Pour plus d'informations concernant l'utilisation d'Amazon Lex en relation avec des sites Web, des programmes ou d'autres applications destinés ou ciblés, en tout ou en partie, aux enfants de moins de 13 ans, consultez la FAQ Amazon Lex.

Type : booléen

clarificationPrompt

Le message qu'utilise Amazon Lex lorsqu'il ne comprend pas la demande de l'utilisateur. Pour de plus amples informations, veuillez consulter PutBot.

Type : objet Prompt

createdDate

Date à laquelle le bot a été créé.

Type : Timestamp

description

Description du bot.

Type : chaîne

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

detectSentiment

Indique si les déclarations des utilisateurs doivent être envoyées à Amazon Comprehend pour analyse des sentiments.

Type : booléen

enableModelImprovements

Indique si le bot utilise des améliorations de précision. trueindique que le bot utilise les améliorations, sinon,false.

Type : booléen

failureReason

Dans status l'affirmativeFAILED, Amazon Lex explique pourquoi il n'a pas réussi à créer le bot.

Type : chaîne

idleSessionTTLInSeconds

Durée maximale en secondes pendant laquelle Amazon Lex conserve les données collectées au cours d'une conversation. Pour de plus amples informations, veuillez consulter PutBot.

Type : entier

Plage valide : Valeur minimum de 60. Valeur maximum de 86 400.

intents

Tableau d’objets intent. Pour de plus amples informations, veuillez consulter PutBot.

Type : tableau d’objets Intent

lastUpdatedDate

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

Type : Timestamp

locale

La localisation cible pour le bot.

Type : chaîne

Valeurs valides : de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR

name

Le nom du bot.

Type : chaîne

Contraintes de longueur : longueur minimale de 2. Longueur maximale de 50.

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

nluIntentConfidenceThreshold

Le score qui détermine l'endroit où Amazon Lex insère le AMAZON.FallbackIntent ou les deux lorsqu'il renvoie des intentions alternatives dans une PostTextréponse PostContentou. AMAZON.KendraSearchIntent AMAZON.FallbackIntentest inséré si le score de confiance à toutes fins utiles est inférieur à cette valeur. AMAZON.KendraSearchIntentn'est inséré que s'il est configuré pour le bot.

Type : double

Plage valide : Valeur minimum de 0. Valeur maximale de 1.

status

État du bot.

Lorsque le statut est défini, BUILDING Amazon Lex crée le bot à des fins de test et d'utilisation.

Si le statut du bot estREADY_BASIC_TESTING, vous pouvez le tester en utilisant les énoncés exacts spécifiés dans les intentions du bot. Lorsque le bot est prêt pour un test complet ou pour être exécuté, le statut estREADY.

En cas de problème lors de la création du bot, le statut est le suivant FAILED et le failureReason champ explique pourquoi le bot n'a pas été créé.

Si le bot a été enregistré mais n'a pas été créé, le statut estNOT_BUILT.

Type : chaîne

Valeurs valides : BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

La version du bot. Pour un nouveau bot, la version est toujours$LATEST.

Type : chaîne

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

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

voiceId

L'identifiant vocal Amazon Polly utilisé par Amazon Lex pour l'interaction vocale avec l'utilisateur. Pour de plus amples informations, veuillez consulter PutBot.

Type : chaîne

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 :