Configurar a Ação TextBotExchange
A ação TextBotExchange envia as mensagens do contato para AI Agents (Cognigy) e recebe as respostas do bot. Ela também fornece variáveis de saída e condições de ramificação que o seu script usa para determinar o que acontece em seguida. Configure as propriedades da ação conforme descrito nesta tarefa.
Permissões necessárias:
-
No Studio script, clique em Actions
no painel direito. -
Expandir a categoria Web editor URL.
-
Arraste a ação TextBotExchange até a área de trabalho do script. Coloque-a após a ação que coleta a entrada do contato.
-
Se o seu script exigir mais de um turno, adicione uma segunda TextBotExchange ação e conecte-a ao loop de conversação. É necessário um mínimo de duas TextBotExchange ações para a maioria das implementações.
-
Antes da primeira TextBotExchange ação, adicione uma Snippet ação e configure-a com o Bot Session State código de snippet. Esse snippet inicializa a variável botSessionState, que mantém o contexto de conversa entre os turnos.
Propriedades de entrada
Selecione a ação TextBotExchange e configure as seguintes propriedades de entrada no painel Propriedades. Use a tabela abaixo para entender cada propriedade:
|
Propriedade |
Valor aceitável ou FORMAT |
Descrição |
|---|---|---|
| Rótulo curto e descritivo. Exemplo: TextBotExchange_CognigyStart | Identifica esta ação específica na tela Studio. O padrão é "TEXTBOT EXCHANGE". Enter uma legenda exclusiva quando seu script contiver mais que uma TextBotExchange ação. | |
| ID do agente virtual | Preenchido automaticamente após você atribuir o bot em Virtual Agent Hub. O valor é igual ao nome do agente virtual (bot) de Virtual Agent Hub. |
Identifica a configuração de Virtual Agent Hub a ser usada. Este campo é preenchido automaticamente quando você atribui o bot à ação em Virtual Agent Hub. Você pode substituir esse valor usando uma variável do Studio, por exemplo, {virtualAgentId}, se precisar selecionar dinamicamente a configuração do bot em tempo de execução. Essa abordagem é comumente usada ao alternar entre múltiplas configurações de bot. |
| Intenção automatizada | String padrão: Bem-vindos. Usado somente no primeiro turno. |
Aciona uma intenção específica em AI Agents (Cognigy) em vez de enviar a entrada digitada do contato. Este campo pode ser usado para invocar intenções predefinidas, como Welcome, ou qualquer outra intenção compatível no bot. Embora seja comumente usado no primeiro turno para acionar uma mensagem de boas-vindas, ele também pode ser usado em turnos subsequentes para invocar outras intenções dinamicamente. Deixe este campo vazio quando quiser passar a mensagem real do contato em vez disso. |
| Entrada do usuário | Studio Variável que armazena a mensagem digitada pelo contato. Exemplo: {customerMessage} | A mensagem de texto digitada pelo contato, passada para AI Agents (Cognigy) para reconhecimento de intenção e geração de resposta. No primeiro turno, esse campo pode estar vazio se AutomatedIntent estiver definido como Welcome. Em cada turno subsequente, esse campo deve conter o enunciado mais recente do contato. |
| Carga útil personalizada | "objeto JSON convertido em string." {customPayload.asJSON()}. Opcional. | Passa dados contextuais personalizados do script Studio para AI Agents (Cognigy). Exemplos incluem nome do contato, ID da conta ou dados de CRM. Você deve definir o objeto de carga útil personalizada em uma ação Snippet. Não use essa propriedade se você precisar processar dados que o agente virtual retorna ao script. Em vez disso, use a variável customPayloadVarName (out). |
| Estado de sessão do bot | Variável preenchida por botSessionStateVarName (out) do turno anterior. Exemplo: {botState} | Mantém o contexto de conversa entre turnos passando um identificador da sessão de volta para AI Agents (Cognigy) a cada solicitação. AI Agents (Cognigy) cria esse identificador no primeiro turno. Em todos os turnos subsequentes, o script deve passar o valor armazenado em Não use esta propriedade se você precisar processar dados que o agente virtual retorna ao script. Em vez disso, use a variável customPayloadVarName (out) de volta neste campo. Se você não configurar isso corretamente, AI Agents (Cognigy) cria uma nova sessão em cada turno e perde o contexto. |
Propriedades de saída
As propriedades de saída a seguir estão disponíveis após a execução da ação TextBotExchange. Faça Referência a essas variáveis em ações subsequentes no seu script.
|
Propriedade |
Valor ou FORMAT aceitável |
|---|---|
| Próximo nome de variável do Prompt (saída) | Mantém as configurações de comportamento que controlam como NiCE CXone solicita o contato no próximo turno de conversação. Essa variável pode ser modificada em uma ação Snippet antes da próxima chamada TextBotExchange para personalizar o comportamento por turno. |
| Nome da var de carga útil personalizada (out) |
Retorna dados JSON personalizados de AI Agents (Cognigy) para o script Studio. Use esta propriedade para processar dados de atendimento ou instruções de roteamento enviadas por AI Agents (Cognigy). Os valores comuns incluem:
Não confunda isso com a propriedade de entrada customPayload. |
| Nome da Var de Detalhes do erro (out) | Contém informações de erro quando o branch OnError é utilizado. Inspecione essa variável no branch OnError para registrar ou tratar o erro. A variável de sistema _ERR também é preenchida com uma descrição condensada do erro. |
| Nome da variável de informações da intenção (out) | Contém detalhes sobre a intenção identificada por AI Agents (Cognigy) para o turno atual. Use essa variável em seu script para registrar dados de intenção ou tomar decisões de roteamento com base na intenção identificada. |
| Nome da variável de estado da sessão do bot (saída) | Contém o identificador de estado da sessão retornado por AI Agents (Cognigy) após cada turno. Você deve passar o valor dessa variável para a propriedade de entrada botSessionState no próximo turno para manter o contexto de conversa. Essa propriedade é obrigatória para o funcionamento correto. |