Snippet Estado de sessão do bot

Este snippet é para uso com ações que tenham a propriedade botSessionState, como Textbot Exchange e Voicebot Exchange (de agora em diante, ambas as ações são referidas simplesmente como Exchange). A propriedade botSessionState deve ser configurada corretamente para que seus agentes virtuais Um aplicativo de software que interage com os clientes no lugar de um agente humano ao vivo. funcionem conforme esperado.

A propriedade botSessionState deve ser configurada com a variável que contém o identificador exclusivo para a conversa entre o contato e o agente virtual. Ele é 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 fornecedor cria o identificador quando a conversa começa e o passa ao 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 da propriedade botSessionStateVarName (out) do turno anterior para a propriedade botSessionState.

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

Configuração do script

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

• A primeira instância da ação Exchange está localizada logo após a ação Begin no início do script. Configure-a da seguinte forma:
  • botSessionState: deve estar vazio.
  • botSessionStateVarName (out): configure com o nome da variável onde você deseja que o script armazene o identificador.
• A segunda ação Exchange está localizada mais à frente no script. Configure-a da seguinte forma:
  • botSessionState: configure com a variável usada no botSessionStateVarName (out) na primeira instância da ação Exchange. A variável deve conter o identificador do estado da sessão do bot no formato JSON.
  • botSessionStateVarName (out): configure com o nome da variável onde você deseja que o script armazene o identificador.
• A terceira e quaisquer instâncias subsequentes da ação Exchange são opcionais. Se o seu script incluir essas instâncias, configure-as da seguinte forma:
  • botSessionState: configure com a variável usada no botSessionStateVarName (out) na instância anterior da ação Exchange. A variável deve conter o identificador do 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 onde você deseja que o script armazene o identificador.

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

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

Os conteúdos da variável usada na propriedade botSessionStateVarName (out) devem ser convertidos para JSON e passados para a propriedade botSessionState da segunda ação Exchange no seu script. Para fazer isto, você pode incluir código em uma ação Snippet ou configurar a propriedade diretamente. Ambas as abordagens são aceitas. No entanto, a vantagem de criar uma variável em Snippet para conter o objeto convertido é que ela torna mais fácil ver onde a conversão está acontecendo.

Usar uma ação snippet

1. Configure a propriedade botSessionStateVarName (out) da ação Exchange com o nome da variável para conter o identificador de estado da sessão. Por exemplo, botSessionState.

2. Adicione a seguinte linha a um Snippet localizado antes da ação Exchange no 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 usou na instrução ASSIGN. Por exemplo, botSessionStateOut.

Converter na propriedade

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

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