GetBot - Amazon Lex V1
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Si utiliza Amazon Lex V2, consulte la guía de Amazon Lex V2.

 

Si utiliza Amazon Lex V1, le recomendamos que actualice los bots a Amazon Lex V2. Hemos dejado de agregar nuevas características a V1, por lo que recomendamos encarecidamente utilizar V2 para todos los nuevos bots.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetBot

Devuelve información sobre los metadatos de un bot específico. Debe proporcionar el nombre del bot y la versión del bot o el alias.

Esta operación necesita permisos para la acción lex:GetBot.

Sintaxis de la solicitud

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

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

name

El nombre del bot. El nombre distingue entre mayúsculas y minúsculas.

Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 50 caracteres.

Patrón: ^([A-Za-z]_?)+$

Obligatorio: sí

versionoralias

La versión o el alias del bot.

Obligatorio: sí

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

abortStatement

El mensaje que Amazon Lex devuelve cuando el usuario elige acabar con la conversación sin completarla. Para obtener más información, consulte PutBot.

Tipo: objeto Statement

checksum

La suma de comprobación del bot que se utiliza para identificar una revisión específica de la versión $LATEST del bot.

Tipo: cadena

childDirected

Para cada bot de Amazon Lex creado con el Servicio de creación de modelos de Amazon Lex, debe especificar si el uso de Amazon Lex está relacionado con un sitio web, un programa u otro tipo de aplicación que esté dirigido, total o parcialmente, a niños menores de 13 años y esté sujeto a la Ley de protección de la privacidad infantil en línea (COPPA, por sus siglas en inglés). Para ello, especifique true o false en el campo childDirected. Al especificar true en el campo childDirected, confirma que el uso de Amazon Lex está relacionado con un sitio web, un programa u otro tipo de aplicación que está dirigido, total o parcialmente, a niños menores de 13 años y está sujeto a la COPPA. Al especificar false en el campo childDirected, confirma que el uso de Amazon Lex no está relacionado con un sitio web, un programa u otro tipo de aplicación que está dirigido, total o parcialmente, a niños menores de 13 años y está sujeto a la COPPA. No puede especificar un valor predeterminado en el campo childDirected que no indique de forma precisa si el uso de Amazon Lex está relacionado o no con un sitio web, un programa u otro tipo de aplicación que está dirigido, total o parcialmente, a niños menores de 13 años y está sujeto a la COPPA.

Si el uso de Amazon Lex está relacionado con un sitio web, un programa u otro tipo de aplicación que está dirigido, total o parcialmente, a niños menores de 13 años, debe obtener un consentimiento parental verificable, obligatorio en virtud de la COPPA. Para obtener información acerca del uso de Amazon Lex con relación a sitios web, programas u otras aplicaciones dirigidos, total o parcialmente, a niños menores de 13 años, consulte las Preguntas frecuentes de Amazon Lex.

Tipo: Booleano

clarificationPrompt

El mensaje que utiliza Amazon Lex cuando no entiende la solicitud del usuario. Para obtener más información, consulte PutBot.

Tipo: objeto Prompt

createdDate

La fecha de creación del bot.

Tipo: marca temporal

description

La descripción del bot.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 200 caracteres.

detectSentiment

Indica si los enunciados del usuario deben enviarse a Amazon Comprehend con fines de análisis de opiniones.

Tipo: Booleano

enableModelImprovements

Indica si el bot utiliza mejoras en la precisión. true indica que el bot utiliza las mejoras y false, lo contrario.

Tipo: Booleano

failureReason

Si status es FAILED, Amazon Lex explica por qué no se ha podido crear el bot.

Tipo: cadena

idleSessionTTLInSeconds

El tiempo máximo que Amazon Lex retiene los datos recopilados en una conversación, en segundos. Para obtener más información, consulte PutBot.

Tipo: entero

Rango válido: valor mínimo de 60. Valor máximo de 86 400.

intents

Una matriz de objetos intent. Para obtener más información, consulte PutBot.

Tipo: matriz de objetos Intent

lastUpdatedDate

La fecha de actualización del bot. Cuando se crea un recurso, la fecha de creación y la fecha de la última actualización son la misma.

Tipo: marca temporal

locale

La configuración regional de destino para el bot.

Tipo: cadena

Valores válidos: 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

El nombre del bot.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 2. La longitud máxima es de 50 caracteres.

Patrón: ^([A-Za-z]_?)+$

nluIntentConfidenceThreshold

La puntuación que determina dónde inserta Amazon Lex AMAZON.FallbackIntentAMAZON.KendraSearchIntent, o ambas, al devolver intenciones alternativas en una PostTextrespuesta PostContento. AMAZON.FallbackIntentse inserta si la puntuación de confianza de todos los intentos está por debajo de este valor. AMAZON.KendraSearchIntentsolo se inserta si está configurado para el bot.

Tipo: Doble

Rango válido: valor mínimo de 0. El valor máximo es de 1.

status

El estado del bot.

Cuando el estado es BUILDING, Amazon Lex está creando el bot para probarlo y usarlo.

Si el estado del bot es READY_BASIC_TESTING, puede probar el bot con los enunciados exactos que se especifican en las intenciones del bot. Cuando el bot está listo para probarse definitivamente o para ejecutarse, el estado es READY.

Si ha habido un problema al crear el bot, el estado es FAILED y en el campo failureReason se explica por qué no se ha compilado el bot.

Si el bot se ha guardado sin compilar, el estado es NOT_BUILT.

Tipo: cadena

Valores válidos: BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

La versión del bot. En el caso de un bot nuevo, la versión es siempre $LATEST.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.

Patrón: \$LATEST|[0-9]+

voiceId

El ID de voz de Amazon Polly que Amazon Lex utiliza para la interacción de voz con el usuario. Para obtener más información, consulte PutBot.

Tipo: cadena

Errores

BadRequestException

La solicitud no está bien formulada. Es posible que un valor no sea válido o que falte un campo obligatorio. Revise los valores del campo e inténtelo de nuevo.

Código de estado HTTP: 400

InternalFailureException

Se ha producido un error interno de Amazon Lex. Intente volver a realizar la solicitud.

Código de estado HTTP: 500

LimitExceededException

La solicitud ha superado un límite. Intente volver a realizar la solicitud.

Código de estado HTTP: 429

NotFoundException

No se ha encontrado el recurso especificado en la solicitud. Compruebe si el recurso existe e inténtelo de nuevo.

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: