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

GetSession

Retorna informações de sessão para um bot, alias e ID de usuário especificado.

Sintaxe da Solicitação

GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1

Parâmetros da Solicitação de URI

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

botAlias

O alias em uso para o bot que contém os dados da sessão.

Obrigatório: Sim

botName

O nome do bot que contém os dados da sessão.

Obrigatório: Sim

checkpointLabelFilter

Uma string usada para filtrar as intenções retornadas na estrutura recentIntentSummaryView.

Quando você especifica um filtro, somente as intenções com o campo checkpointLabel definido para essa string são retornadas.

Restrições de tamanho: o tamanho mínimo é 1. Comprimento máximo de 255.

Padrão: [a-zA-Z0-9-]+

userId

O ID do usuário do aplicativo cliente. O Amazon Lex usa isso para identificar a conversa de um usuário com seu bot.

Restrições de tamanho: tamanho mínimo 2. Comprimento máximo de 100.

Padrão: [0-9a-zA-Z._:-]+

Exigido: Sim

Corpo da Solicitação

Essa solicitação não tem corpo.

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "dialogAction": { 
      "fulfillmentState": "string",
      "intentName": "string",
      "message": "string",
      "messageFormat": "string",
      "slots": { 
         "string" : "string" 
      },
      "slotToElicit": "string",
      "type": "string"
   },
   "recentIntentSummaryView": [ 
      { 
         "checkpointLabel": "string",
         "confirmationStatus": "string",
         "dialogActionType": "string",
         "fulfillmentState": "string",
         "intentName": "string",
         "slots": { 
            "string" : "string" 
         },
         "slotToElicit": "string"
      }
   ],
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "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.

activeContexts

Uma lista de contextos ativos para a sessão. Um contexto pode ser definido quando uma intenção é cumprida ou chamando a operação PostContent, PostText ou PutSession.

Você pode usar um contexto para controlar as intenções que podem acompanhar uma intenção ou para modificar a operação do seu aplicativo.

Tipo: matriz de objetos ActiveContext

Membros da Matriz: número mínimo de 0 itens. Número máximo de 20 itens.

dialogAction

Descreve o estado atual do bot.

Tipo: objeto DialogAction

recentIntentSummaryView

Uma matriz de informações sobre as intenções usadas na sessão. A matriz pode conter no máximo três resumos. Se mais de três intenções forem usadas na sessão, a operação recentIntentSummaryView conterá informações sobre as últimas três intenções usadas.

Se você definir o parâmetro checkpointLabelFilter na solicitação, a matriz conterá somente as intenções com o rótulo especificado.

Tipo: matriz de objetos IntentSummary

Membros da Matriz: número mínimo de 0 itens. Número máximo de 3 itens.

sessionAttributes

Mapa de pares de chaves/valores que representam as informações de contexto específicas da sessão. Ele contém informações do aplicativo passadas entre o Amazon Lex e um aplicativo cliente.

Tipo: mapa de string para string

sessionId

Um identificador exclusivo da sessão.

Tipo: string

Erros

BadRequestException

A validação da solicitação falhou, não há mensagem utilizável no contexto ou a compilação do bot falhou, ainda está em andamento ou contém alterações não criadas.

Código de Status HTTP: 400

InternalFailureException

Erro de serviço interno. Tente a chamada novamente.

Código de Status HTTP: 500

LimitExceededException

Excedeu um limite.

Código de Status HTTP: 429

NotFoundException

O atributo (como o bot Amazon Lex ou um alias) mencionado não foi encontrado.

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: