Aviso de fim do suporte: em 15 de setembro de 2025, o suporte para o Amazon Lex V1 AWS será interrompido. Depois de 15 de setembro de 2025, você não poderá mais acessar o console do Amazon Lex V1 ou os recursos do Amazon Lex V1. Se você estiver usando o Amazon Lex V2, consulte o guia do Amazon Lex V2 em vez disso.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Retorna informações sobre uma intenção. Além do nome da intenção, você deve especificar a versão da intenção.
Essa operação exige permissões para executar a ação lex:GetIntent.
Sintaxe da Solicitação
GET /intents/name/versions/version HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- name
-
O nome da intenção. O nome diferencia maiúsculas e minúsculas.
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão:
^([A-Za-z]_?)+$Exigido: Sim
- version
-
A versão da intenção.
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 64.
Padrão:
\$LATEST|[0-9]+Exigido: Sim
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
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 Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- checksum
-
A soma de verificação da intenção.
Tipo: String
- conclusionStatement
-
Depois que a função do Lambda especificada no elemento
fulfillmentActivitycumpre a intenção, o Amazon Lex transmite essa declaração ao usuário.Tipo: objeto Statement
- confirmationPrompt
-
Se definido no bot, o prompt que o Amazon Lex usa para confirmar a intenção do usuário antes de atendê-la. Para obter mais informações, consulte PutIntent.
Tipo: objeto Prompt
- createdDate
-
A data em que a intenção foi criada.
Tipo: Timestamp
- description
-
Uma descrição da intenção.
Tipo: String
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.
- dialogCodeHook
-
Se definido no bot, o Amazon Lex invoca essa função do Lambda para cada entrada do usuário. Para obter mais informações, consulte PutIntent.
Tipo: objeto CodeHook
- followUpPrompt
-
Se definido no bot, o Amazon Lex usa esse prompt para solicitar atividades adicionais do usuário depois que a intenção for atendida. Para obter mais informações, consulte PutIntent.
Tipo: objeto FollowUpPrompt
- fulfillmentActivity
-
Descreve como a intenção é atendida. Para obter mais informações, consulte PutIntent.
Tipo: objeto FulfillmentActivity
- inputContexts
-
Uma matriz de objetos
InputContextque lista os contextos que devem estar ativos para que o Amazon Lex escolha a intenção em uma conversa com o usuário.Tipo: matriz de InputContext objetos
Membros da Matriz: número mínimo de 0 itens. Número máximo de 5 itens.
- kendraConfiguration
-
Informações de configuração, se houver, para conectar um índice do Amazon Kendra com a intenção
AMAZON.KendraSearchIntent.Tipo: objeto KendraConfiguration
- lastUpdatedDate
-
A data em que a intenção foi atualizada. Quando você cria um recurso, a data de criação e a data da última atualização são as mesmas.
Tipo: Timestamp
- name
-
O nome da intenção.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão:
^([A-Za-z]_?)+$ - outputContexts
-
Uma matriz de objetos
OutputContextque lista os contextos que a intenção ativa quando a intenção é atendida.Tipo: matriz de objetos OutputContext
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.
- parentIntentSignature
-
Um identificador exclusivo de uma intenção integrada.
Tipo: String
- rejectionStatement
-
Quando o usuário responde “não” à pergunta definida em
confirmationPrompt, o Amazon Lex responde com essa mensagem para confirmar que a intenção foi cancelada.Tipo: objeto Statement
- sampleUtterances
-
Uma matriz de amostra de declarações configurada para a intenção.
Tipo: matriz de strings
Membros da Matriz: número mínimo de 0 itens. Número máximo de 1.500 itens.
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 200.
- slots
-
Uma matriz de slots de intenção configurados para a intenção.
Tipo: matriz de objetos Slot
Membros da Matriz: número mínimo de 0 itens. Número máximo de 100 itens.
- version
-
A versão da intenção.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.
Padrão:
\$LATEST|[0-9]+
Erros
- BadRequestException
-
A solicitação não está bem formada. Por exemplo, um valor é inválido ou um campo obrigatório está faltando. Verifique os valores dos campos e tente novamente.
Código de status HTTP: 400
- InternalFailureException
-
Ocorreu um erro interno do Amazon Lex. Tente sua solicitação novamente.
Código de status HTTP: 500
- LimitExceededException
-
A solicitação excedeu um limite. Tente sua solicitação novamente.
Código de status HTTP: 429
- NotFoundException
-
O recurso especificado na solicitação não foi encontrado. Verifique o recurso e tente novamente.
Código de status HTTP: 404
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
