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.
GetIntent
Devuelve información sobre una intención. Además del nombre de la intención, debe especificar la versión de la intención.
Esto operación requiere permisos para realizar la acción lex:GetIntent.
Sintaxis de la solicitud
GET /intents/name/versions/version HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- name
-
El nombre de la intención. El nombre distingue entre mayúsculas y minúsculas.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 100 caracteres.
Patrón:
^([A-Za-z]_?)+$Obligatorio: sí
- version
-
La versión de la intención.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón:
\$LATEST|[0-9]+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
{
"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"
}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.
- checksum
-
La suma de comprobación de la intención.
Tipo: cadena
- conclusionStatement
-
Una vez que la función de Lambda especificada en el elemento
fulfillmentActivitycumple con la intención, Amazon Lex transmite esta afirmación al usuario.Tipo: objeto Statement
- confirmationPrompt
-
Si se define en el bot, la solicitud que Amazon Lex utiliza para confirmar la intención del usuario antes de cumplirla. Para obtener más información, consulte PutIntent.
Tipo: objeto Prompt
- createdDate
-
La fecha en que se creó la intención.
Tipo: marca temporal
- description
-
Una descripción de la intención.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 200 caracteres.
- dialogCodeHook
-
Si se define en el bot, Amazon Lex invoca esta función de Lambda para cada entrada del usuario. Para obtener más información, consulte PutIntent.
Tipo: objeto CodeHook
- followUpPrompt
-
Si se define en el bot, Amazon Lex utiliza esta solicitud para solicitar actividad adicional del usuario una vez que se ha cumplido con la intención. Para obtener más información, consulte PutIntent.
Tipo: objeto FollowUpPrompt
- fulfillmentActivity
-
Describe cómo se cumple con la intención. Para obtener más información, consulte PutIntent.
Tipo: objeto FulfillmentActivity
- inputContexts
-
Una matriz de objetos
InputContextque enumera los contextos que deben estar activos para que Amazon Lex elija la intención en una conversación con el usuario.Tipo: matriz de objetos InputContext
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 5 artículos.
- kendraConfiguration
-
Información sobre la configuración necesaria, si procede, para conectar un índice de Amazon Kendra con la intención
AMAZON.KendraSearchIntent.Tipo: objeto KendraConfiguration
- lastUpdatedDate
-
La fecha de actualización de la intención. Al crear un recurso, la fecha de creación y la fecha de la última actualización son la misma.
Tipo: marca temporal
- name
-
El nombre de la intención.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 100 caracteres.
Patrón:
^([A-Za-z]_?)+$ - outputContexts
-
Una matriz de objetos
OutputContextque enumera los contextos en los que la intención se activa cuando esta se cumple.Tipo: matriz de objetos OutputContext
Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 10 artículos.
- parentIntentSignature
-
Un identificador único para una intención integrada.
Tipo: cadena
- rejectionStatement
-
Si el usuario responde “no” a la pregunta definida en
confirmationPrompt, Amazon Lex responde con esta afirmación para confirmar que la intención se ha cancelado.Tipo: objeto Statement
- sampleUtterances
-
Una matriz de ejemplos de enunciados configurados para la intención.
Tipo: matriz de cadenas
Miembros de la matriz: número mínimo de 0 artículos. La cantidad máxima es de 1500 elementos.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.
- slots
-
Una matriz de ranuras de intención configuradas para la intención.
Tipo: matriz de objetos Slot
Miembros de la matriz: número mínimo de 0 artículos. Número máximo de 100 artículos.
- version
-
La versión de la intención.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón:
\$LATEST|[0-9]+
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:
