Compartilhar via

Usar variáveis para transportar conteúdo entre tópicos

  • Artigo

Variáveis armazenam as respostas dos seus clientes às perguntas do seu agente. Por exemplo, você pode salvar o nome de um cliente em uma variável chamada UserName. O agente pode então se dirigir ao cliente pelo nome enquanto a conversa continua.

Por padrão, o valor de uma variável só pode ser usado no tópico em que ela é criada. No entanto, é possível reutilizar o mesmo valor entre tópicos. Por exemplo, um tópico Bem-vindo solicita o nome e o email do cliente. No agendamento de consultas tópico, você quer que o agente se lembre do que o cliente digitou e não pergunte novamente.

Uma maneira de reutilizar uma variável é transmitir a variável entre os tópicos. A outra maneira é tornar a variável global no escopo, e é isso que este artigo cobre. Variáveis globais são chamadas assim porque estão disponíveis em todos os tópicos do agente.

As variáveis agente são aplicadas durante uma única sessão de usuário. Você especifica quais variáveis devem ser tratadas como variáveis agente para distingui-las das variáveis de nível de tópico.

Criar uma variável global

Você cria uma variável global ao alterar o escopo de uma variável temática.

  1. Crie uma variável ou use o painel Variáveis para abrir uma variável existente.

  2. No painel Propriedades da variável, selecione Global (acessível por qualquer tópico).

    O nome da variável receberá o prefixo Global. para diferenciá-lo das variáveis no nível do tópico. Por exemplo, a variável UserName é exibida como Global.UserName.

    Captura de tela mostrando o painel Propriedades da Variável, com Configuração global realçado.

  3. Salve o tópico.

    O nome de uma variável global deve ser exclusivo em todos os tópicos. No caso de um conflito, você precisará renomear a variável antes de salvar sua alteração.

Usar variáveis globais

Ao compor uma mensagem agente em um nó de mensagem ou um nó de pergunta, Select o ícone {x} para visualizar as variáveis que estão disponíveis para o tópico. As variáveis globais são listadas na guia Personalizado, juntamente com quaisquer variáveis de tópico. As variáveis são classificadas em ordem alfabética.

Captura de tela mostrando a seleção de uma variável global.

Encontre todos os tópicos usando uma variável global

Você pode encontrar onde uma variável global é definida e que outros tópicos a estão usando. Isso pode ser útil se você estiver trabalhando em um novo agente ou se tiver várias variáveis e ramificações complexas de tópico.

  1. Selecione uma variável global na tela de criação ou abra o painel Variáveis e selecione uma variável global.

  2. No painel Propriedades da variável, na seção Referência, selecione qualquer um dos tópicos em que a variável é usada para ir diretamente para esse tópico e nó.

    Captura de tela mostrando a lista de tópicos usados por uma variável no painel Propriedades da Variável.

Ciclo de vida de variáveis globais

Por padrão, o valor de uma variável global persiste até a sessão terminar. O nó Desmarcar valores de variáveis redefine os valores de variáveis globais e é usado no tópico do sistema Redefinir conversa. Esse tópico pode ser acionado por redirecionamento ou quando o usuário digita uma frase de gatilho como "Começar de novo". Nesse caso, todas as variáveis globais são redefinidas.

Definir o valor de uma variável global de origens externas

Se você quiser ter certeza de que agente inicia uma conversa com algum contexto, você pode inicializar uma variável global com uma fonte externa. Digamos que seu site exija que os usuários façam login. Como seu agente já sabe o nome do usuário, ele pode cumprimentá-lo pelo nome antes que ele comece a digitar a primeira pergunta.

  1. Selecione uma variável global.

  2. No painel Propriedades de variável, selecione Fontes externas podem definir valores.

Defina variáveis globais em um agente incorporado

Se você estiver incorporando seu agente em uma página da web simples, você pode anexar variáveis e suas definições ao URL do agente. Ou, se quiser um pouco mais de controle, você pode usar um bloco de código <script> para chamar e usar variáveis de forma programada.

O nome da variável na cadeia de consulta do URL deve corresponder ao nome da variável global sem o prefixo Global.. Por exemplo, uma variável global Global.UserName seria referida como UserName na consulta.

Os exemplos que se seguem fornecem uma declaração simples para as variáveis. Em um cenário de produção, é possível passar outra variável que já armazenou o nome do usuário como o parâmetro de consulta ou a definição de variável (por exemplo, se você tiver o nome de usuário em um script de entrada).

Anexe as variáveis e suas definições à URL do agente como parâmetros de string de consulta no formato botURL?variableName1=variableDefinition1&variableName2=variableDefinition2.

Por exemplo:

O nome do parâmetro não faz distinção entre maiúsculas e minúsculas. username=Renata também funcionará neste exemplo.

Adicionar variáveis globais a uma tela personalizada

Você também pode adicionar a variável a uma tela personalizada.

  1. Na seção <script> da página onde você tem seu agente, defina as variáveis da seguinte forma, substituindo variableName1 pelo nome da variável sem o Global. prefixo e variableDefinition1 pela definição. Separe as muitas variáveis com vírgulas (,).

       const store = WebChat.createStore({}, ({ dispatch }) => next => action => {
     if (action.type === 'DIRECT_LINE/CONNECT_FULFILLED') {
       dispatch({
          type: "WEB_CHAT/SEND_EVENT",
          payload: {
            name: "pvaSetContext",
            value: {
               "variableName1": "variableDefinition1",
               "variableName2": "variableDefinition2"
            }
          },
        });
      }
        return next(action);
    });

  2. Na sua <script> seção, chame o store quando você incorporar seu agente, como no exemplo a seguir, onde store é chamado logo acima de onde styleOptions é chamado (você precisará substituir o BOT_ID pelo ID do seu agente):

    const BOT_ID = "12345-5678";
const theURL = "https://powerva.microsoft.com/api/botmanagement/v1/directline/directlinetoken?botId=" + BOT_ID;

fetch(theURL)
    .then(response => response.json())
    .then(conversationInfo => {
        window.WebChat.renderWebChat(
            {
                directLine: window.WebChat.createDirectLine({
                    token: conversationInfo.token,
                }),
                store,
                styleOptions
            },
            document.getElementById('webchat')
        );
    })
    .catch(err => console.error("An error occurred: " + err));

Conteúdo relacionado