Snippet Estado de sessão do bot

As informações desta página de ajuda se aplicam tanto a Studio quanto a Desktop Studio.

O snippet Bot Session State é necessário em seu script quando são utilizadas ações que possuem a propriedade botSessionState. Isso inclui ações como Textbot Exchange e Voicebot Exchange (a partir daqui, ambas as ações serão referidas simplesmente como Exchange). A propriedade botSessionState deve ser configurada corretamente para que seus agentes virtuaisClosed Um aplicativo de software que gerencia as interações com clientes no lugar de um agente humano ao vivo. funcionem conforme esperado. Para isso, você deve criar este snippet em seu script e configurar as ações corretamente, conforme mostrado nas seções a seguir.

A propriedade botSessionState deve ser configurada com a variável que contém o exclusivo identificador para a conversa entre o contato e o agente virtual. É atribuído automaticamente pelo provedor do agente virtual. O identificador evita que uma nova sessão seja criada a cada turno da conversa e ajuda o agente virtual a manter o contexto entre os turnos.

O provedor cria o identificador quando a conversa começa e o passa para o script com a primeira resposta. O script armazena o identificador na variável nomeada na propriedade botSessionStateVarName (out) da ação Exchange. Por fim, o script passa o identificador do turno anterior da propriedade botSessionStateVarName (out) para a propriedade botSessionState.

Seus Scripts nunca devem gravar nesta propriedade ou em sua variável. Seu script deve ser configurado corretamente para usar o identificador de estado da sessão do bot.

Este snippet é obrigatório, a menos que você use Google Dialogflow CX, em que é possível definir uma identificação de conversa personalizada no Carga útil personalizada snippet que atende à mesma finalidade que o snippet Bot Session State. Uma identificação de conversa personalizada é usada ao transferir contatos de uma instância do CX Dialogflow para outra. Se você não usar nenhuma das identificações, uma nova identificação de sessão será gerada para cada turno da conversa, e seu agente virtual não manterá o contexto da conversa. Se isso ocorrer, nenhum erro será gerado, mas o sistema não funcionará conforme o esperado.

Configuração de script

Quando você usa uma ação Exchange, um mínimo de duas instâncias da ação são necessárias em seu script. A propriedade botSessionState em cada uma das ações Exchange deve ser configurada de forma diferente:

  • The first instance of the Exchange action is located right after the Begin action at the start of the script. Configure it as follows: 
    • botSessionState: Isso deve estar vazio.
    • botSessionStateVarName (out): Configure com o nome da variável em que deseja que o script armazene o identificador.
  • The second Exchange action is located later in the script. Configure it as follows: 
    • botSessionState: Configure com a variável usada em botSessionStateVarName (out) na primeira instância da ação Exchange. A variável deve conter o identificador de estado de sessão do bot em formato JSON.
    • botSessionStateVarName (out): Configure com o nome da variável em que você deseja que o script armazene o identificador.
  • The third and any subsequent instances of the Exchange action are optional. If your script includes these instances, configure them as follows: 
    • botSessionState: Configure com a variável usada em botSessionStateVarName (out) na instância anterior da ação Exchange. A variável deve conter o identificador de estado da sessão do bot no formato JSON. O identificador de estado da sessão do bot normalmente não muda entre os turnos. No entanto, caso ele seja alterado, a ação deverá ser configurada para capturar a alteração.
    • botSessionStateVarName (out): Configure com o nome da variável em que você deseja que o script armazene o identificador.

Esta configuração é necessária apenas para todos os agentes virtuais.

Verifique se a propriedade botSessionState está configurada corretamente

Você pode usar um script trace para confirmar se essa propriedade está configurada corretamente.

  1. Execute um rastreamento de script em uma interação entre o agente virtual e um contato. Você pode usar um rastreamento ou capturar um rastreamento de um ANI ou DNIS específico (somente para interações de voz).
  2. Na janela de rastreamento, clique na linha que corresponde à primeira ação Virtual Agent Hub (Voicebot Exchange ou Textbot Exchange).
  3. Na lista Variáveis, marque a Variável botSessionState. O valor dela deve ser nulo (vazio).
  4. Na janela de rastreamento, clique na próxima linha do rastreamento após a primeira ação Virtual Agent Hub.
  5. Observe o valor da variável botSessionState.
  6. Na janela de rastreamento, clique na linha do rastreamento que corresponde a qualquer ação subsequente de Virtual Agent Hub.
  7. Verifique o valor da variável botSessionState. Ele deve ser o mesmo da etapa 5.

Converter o identificador de estado da sessão do bot para JSON

O conteúdo da variável usada na propriedade botSessionStateVarName (out) deve ser convertido em JSON e passado para a propriedade botSessionState da segunda ação Exchange no seu script. Para fazer isso, você pode incluir código em uma ação Snippet ou pode configurar a propriedade diretamente. Both approaches are acceptable. However, the benefit of creating a variable in a Snippet to hold the converted object is that it makes it easier to see where the conversion is happening.

Usar uma Ação de Snippet

  1. Configure a propriedade botSessionStateVarName (out) da ação Exchange com o nome da variável que manterá o identificador do estado da sessão. Por exemplo, botSessionState.
  2. Adicione a seguinte linha a um Snippet localizado antes da ação Exchangeno seu script:

    ASSIGN botSessionStateOut = botSessionStateOut.asJSON()

    Use o nome da variável que você usa no seu script.

  3. Configure a propriedade botSessionState na ação Exchange com o nome da variável que você usou na instrução ASSIGN. Por exemplo, botSessionStateOut.

Converter na propriedade

Se você converter a variável na propriedade botSessionState, use a variável botSessionStateVarName (out) com a asJSON()função. Por exemplo:

  • botSessionStateVarName (out): botSessionState
  • botSessionState: botSessionState.asJSON()

Transferência de contatos de um Agente virtual para outro

Para configurar a transferência de contatos entre agentes virtuais, você precisa configurar corretamente os ids do estado da sessão do bot. Cada agente virtual deve ter seu próprio id do estado da sessão do bot exclusivo. Isso ajuda os agentes virtuais individuais a manter o contexto da conversa da qual participam.

  • Agente virtual 1: Configure as variáveis de estado da sessão do bot conforme descrito anteriormente nesta página.

  • Agente virtual 2: configurado da mesma forma, usando uma variável diferente em botSessionStateVarName (out) para armazenar o id do estado da sessão do bot. Certifique-se de que, na primeira chamada a este agente virtual, a propriedade botSessionState esteja vazia. O primeiro turno na conversa retorna um id exclusivo do estado da sessão do bot para a variável em botSessionStateVarName (out).
  • Todos os agentes virtuais subsequentes: Configure da mesma forma que o agente virtual 2, usando uma variável exclusiva para o id do estado da sessão do bot.

Este método funciona para todos os provedores de agentes virtuais compatíveis, a menos que você esteja transferindo entre dois agentes virtuais Google Dialogflow CX. Nesse caso, é necessário um método diferente.