GetBot - Amazon Lex V1
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

Se você estiver usando o Amazon Lex V2, consulte o Guia do Amazon Lex V2.

 

Se você estiver usando o Amazon Lex V1, recomendamos atualizar seus bots para o Amazon Lex V2. Não estamos mais adicionando novos atributos à V1 e recomendamos o uso da V2 para todos os novos bots.

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

GetBot

Retorna informações de metatados para um bot específico. Você deve fornecer o nome do bot e a versão ou o alias do bot.

Essa operação exige permissões para a ação lex:GetBot.

Sintaxe da Solicitação

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

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

name

O nome do bot. O nome diferencia maiúsculas e minúsculas.

Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.

Padrão: ^([A-Za-z]_?)+$

Exigido: Sim

versionoralias

A versão do alias do bot.

Obrigatório: Sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

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 Resposta

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

abortStatement

A mensagem que o Amazon Lex retorna quando o usuário decide encerrar a conversa sem concluí-la. Para ter mais informações, consulte PutBot.

Tipo: objeto Statement

checksum

Soma de verificação do bot usada para identificar uma revisão específica da versão $LATEST do bot.

Tipo: String

childDirected

Para cada bot do Amazon Lex criado com o Serviço de criação de modelo do Amazon Lex, você deve especificar se o uso do Amazon Lex está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à Lei de Proteção à Privacidade Online Infantil (COPPA), especificando true ou false no childDirected campo. Ao especificar true no campo childDirected, você confirma que seu uso do Amazon Lex está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA. Ao especificar false no campo childDirected, você confirma que seu uso do Amazon Lex não está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA. Você não pode especificar um valor padrão para o campo childDirected que não reflita com precisão se o uso do Amazon Lex está relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos e sujeito à COPPA.

Se o uso do Amazon Lex estiver relacionado a um site, programa ou outro aplicativo direcionado, total ou parcialmente, a crianças menores de 13 anos, você deverá obter qualquer consentimento parental verificável exigido pela COPPA. Para obter informações sobre o uso do Amazon Lex em conexão com sites, programas ou outros aplicativos direcionados, total ou parcialmente, a crianças menores de 13 anos, consulte as perguntas frequentes do Amazon Lex.

Tipo: booliano

clarificationPrompt

A mensagem que o Amazon Lex usa quando não entende a solicitação do usuário. Para ter mais informações, consulte PutBot.

Tipo: objeto Prompt

createdDate

A data e a hora em que o bot foi criado.

Tipo: Timestamp

description

Uma descrição do bot.

Tipo: String

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 200.

detectSentiment

Indica se as declarações inseridas pelo usuário devem ser enviadas ao Amazon Comprehend para análise de sentimento.

Tipo: booliano

enableModelImprovements

Indica se o bot usa melhorias de precisão. true indica que o bot está usando as melhorias, caso contrário, é false.

Tipo: booliano

failureReason

Se status for FAILED, o Amazon Lex explica por que não conseguiu criar o bot.

Tipo: String

idleSessionTTLInSeconds

O tempo máximo em segundos que o Amazon Lex retém os dados coletados em uma conversa. Para ter mais informações, consulte PutBot.

Tipo: inteiro

Faixa válida: valor mínimo de 60. Valor máximo de 86.400.

intents

Uma matriz de objetos intent. Para ter mais informações, consulte PutBot.

Tipo: matriz de objetos Intent

lastUpdatedDate

A data em que o bot foi atualizado. Quando você cria um atributo, a data de criação e a data da última atualização são as mesmas.

Tipo: Timestamp

locale

O local de destino deste bot.

Tipo: String

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

O nome do bot.

Tipo: String

Restrições de tamanho: tamanho mínimo 2. Tamanho máximo de 50.

Padrão: ^([A-Za-z]_?)+$

nluIntentConfidenceThreshold

A pontuação que determina onde o Amazon Lex insere oAMAZON.FallbackIntent,AMAZON.KendraSearchIntent, ou ambos ao retornar intenções alternativas em uma resposta PostContent. PostText AMAZON.FallbackIntentserá inserido se a pontuação de confiança para todas as intenções estiver abaixo desse valor. AMAZON.KendraSearchIntentsó é inserido se estiver configurado para o bot.

Tipo: duplo

Intervalo válido: valor mínimo de 0. Valor máximo de 1.

status

O status do bot.

Quando o status é BUILDING, o Amazon Lex está criando o bot para teste e uso.

Se o status do bot for READY_BASIC_TESTING, você poderá testar o bot usando as declarações exatas especificadas nas intenções do bot. Quando o bot estiver pronto para o teste completo ou para ser executado, o status será READY.

Se houve um problema com a criação do bot, o status será FAILED e o campo failureReason explica por que o bot não foi criado.

Se o bot tiver sido salvo, mas não criado, o status será NOT_BUILT.

Tipo: String

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

version

A versão do bot. Para um novo bot, a versão é sempre $LATEST.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: \$LATEST|[0-9]+

voiceId

O ID de voz do Amazon Polly que o Amazon Lex usa para a interação de voz com o usuário. Para ter mais informações, consulte PutBot.

Tipo: string

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 atributo especificado na solicitação não foi encontrado. Verifique o atributo e tente novamente.

Código de Status HTTP: 404

Consulte Também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: