Carol

Árvore de páginas

O TOTVS CAROL ASSISTANT

O que é o TOTVS CAROL Assistant?

É uma plataforma de criação de interfaces para usuários conversacionais, que utiliza técnicas e algoritmos de processamento de linguagem natural e machine learning para criar experiências complexas de forma simples e inteligente.

Como o TOTVS CAROL Assistant funciona?

É possível ensinar a TOTVS Carol Assistente a entender quais são as intenções do usuário, que será chamado de cliente. A aplicação vai extrair o máximo de informações úteis da conversa para entender o que o cliente quer e dar a melhor resposta possível. Também pode realizar integrações com os produtos TOTVS Carol, sistemas e APIs externas.

Quais as principais vantagens de utilizar o TOTVS CAROL Assistant?

Por meio da inteligência artificial, sua interação com o usuário será muito mais natural e humanizada. A TOTVS Carol Assistente vai entender o que o cliente precisa e dará respostas claras e eficientes. Além disso, é uma solução omni canal, com uma única configuração pode suportar:

  • Chamadas de API
  • Web Widget
  • Telegram
  • Facebook Messenger
  • WhatsApp
  • Entre outros


O TOTVS CAROL Assistant é um chatbot?

É muito mais que um chatbot! Uma solução de processamento de linguagem natural completa, que integrada a todo o ecossistema TOTVS Carol e com qualquer sistema de mercado, permite integrar dados e fornecer insights que otimizam a experiência de atendimento dos seus clientes.

O Assistant

Habilitar


Para começar a utilizar o Carol Assistant, primeiro é necessário habilitar o sexto botão do menu vertical à esquerda. Ele direciona ao ambiente de criação e manutenção do chatbot.

Para habilitá-lo basta clicar em Enable Carol Assistant. Uma vez habilitado esse passo não será mais necessário e será possível criar o chatbot.



Notação


  • Conversation: uma conversation no Carol Assistant é um agente de atendimento virtual que interage com seus clientes em português brasileiro de maneira eficaz, como um atendimento humano em um contact center. É possível treinar as conversations para responder às mais diversas perguntas que os clientes poderão fazer e com aprendizado de máquina, as conversations aprendem com cada interação.


  • Intents: um intent é a intenção de um cliente para uma tomada de rumo de uma conversa. Quando um cliente inicia uma conversa, ele escreve uma palavra ou frase e o Carol Assistant responde conforme o conteúdo contido em sua intente. Um exemplo: supondo uma pizzaria, onde o cliente deseja fazer um pedido de uma pizza, a conversation tem uma intent que reconhece a intenção do pedido e pode mostrar o cardápio, mostrar as opções de combinações, informar o valor final e até direcionar ao app de cobrança.


  • Secret: responsável por armazenar os dados privados e protegidos no Carol Assistant Secrets


  • Responses: é a resposta enviada ao cliente em uma interação após ele já ter enviado uma mensagem.


  • Contextos: os contextos são assim como na linguagem habitual, o contexto da conversa. Quando o cliente diz "calabresa", a conversation deve entender que é o sabor da pizza, pois ambos devem estar inseridos no mesmo contexto de pedido de pizza.


  • Parameter: é uma informação que pode ser extraída do texto informado pelo cliente em uma interação, o TOTVS CAROL ASSISTANT possui alguns definidos e outros que podem ser criados. Cada parameter possui um nome e tipo.


  • Parameter Types: é o tipo da informação a ser extraída e define minuciosamente a forma de extração, como o exemplo de pizza citado acima. Para essas entradas de entidade, forneça um valor de referência e um ou mais sinônimos.


  • Regex: ou Expressões Regulares são padrões de caracteres que associam sequências de caracteres no texto. Podemos usar expressões regulares para extrair ou substituir porções de texto, bem como, endereço ou link de imagens em uma página HTML, modificar formato de texto ou remover caracteres inválidos.


  • TOTVS CAROL - Carol Assistant - como configurar o fluxo de respostas de uma conversa na Carol Assistant


Conversas



Uma conversation é uma conversa virtual, um chatbot ou uma interação que pode ser treinada semelhante a um atendente humano para responder às principais perguntas do seu produto. A conversation terá a roupagem que for mais adequada ao gosto do construtor podendo ter desde a linguagem mais formal até a mais informal.

Conversations



  1. List of conversations: nesta estão listadas todas as suas conversations e suas informações úteis. É nesta tela também que poderá importar ou criar uma conversation.
  2. Name: nome da conversation
  3. Description; são detalhes da conversa que são informados no momento da criação.
  4. Status: informa o status, ou seja, a situação que a conversation está.
    1. Published (Publicado): neste estado é possível testar o chatbot e interagir nas redes que ele será usado.
    2. Disabled (Desabilitado): neste estado ele não está mais em funcionamento.

    3. Draft (Rascunho): este é o estado que ele fica antes da publicação, não é possível testar a conversation neste estado.


  5. Last Update (Última atualização): informa a data exata incluindo a hora e segundos que a conversation teve uma atualização, é uma informação diferente da Last Deploy, que considera como atualização qualquer modificação ou inserção de intent e será implantada quando for publicado.
  6. Last Deploy (Última implantação): informa a data exata incluindo a hora e segundos.
  7. Import: nele é possível importar conversas ou arquivos.
    1. Import Conversation: importa Conversations Exportadas salvas na sua máquina no formato JSON.

    2. Import Small Talk: importa o modelo pré-definido de conversation de dentro do repositório CAROL. Neste modelo temos algumas intenções de modelo como Cotação do Dólar, Valor de ações na B3 ou ainda algumas interações que tornam a conversa mais humanizada.


  8. Edit: A edição é para desabilitar, ocultar, modificar a descrição e/ou nome da conversation,


  9. Remove: remove a conversation. É feita uma confirmação com o nome da conversation que se deseja excluir. A remoção é definitiva.


  10. Create Conversation:
    1. Conversation Name: É o nome que o desenvolvedor vai dar a sua conversation, todos os caracteres são permitidos, podendo ser alterado posteriormente.
    2. Conversation Description: É a descrição de sua conversation dada pelo desenvolvedor e pode ser alterada posteriormente.
    3. Hide conversation from Helper context?: Quando uma conversation é criada é possível clicar nessa opção o que faz com que conversation, não aparece quando o help é acionado.
    4. Disable conversation: a conversation é desabilitada quando essa opção é acionada.



Parameter types



Ficam listados os parameters, seus valores e outras informações úteis, também é possível criar um parameter novo dando nome e tipo ao mesmo.

  1. List of parameter types: é a lista de parameters com suas informações.
  2. Name: nome do parâmetro, dado pelo usuário no momento que cria o parameter.
  3. Values: informa o que será extraído da informação dada pelo cliente que deve ser identificado conforme Regex.

  4. Status: indica se é um parameter já publicado ou se foi feito um esboço.


  5. Last Update: informa os dados de data e hora da última edição daquele parameter.
  6. Last Deploy: informa os dados de data e hora da última vez que aquele parameter foi publicado.
  7. Error: é onde se pode editar ou remover o parameter. Após editar é necessário publicar novamente o parameter para que ele funcione adequadamente.
  8. Publish: é o botão usado para publicar todos os parameters em um único click, ele fica disponível para ser acionado somente quando ocorre uma criação ou edição de um parameter, ou seja, quando tem parameter disponível para ser publicado.
  9. Create Parameter Type: ao ser acionado este botão tem a possibilidade de criar um parameter, no qual se pode dar o nome, tipo, informar o que será extraído da conversa e como será utilizado.
    1. Parameter Type Name: nome do parameter dado pelo criador.
    2. Auto Expansion: quando ativado ele reconhece valores que não foram informados nitidamente. Como por exemplo: um parameter tipo lista @carol.color, supondo que seja esperado a cor vermelha, mas o cliente digita "Eu quero que seja vermelho", a conversation identifica a cor.
    3. Fuzzy matching: por padrão um embaralhamento das letras para atender todas as possíveis combinações de palavras

    4. Kind: é uma lista de tipos de dados para ser usado na especificação do tipo do seu parameter. Serão apresentados os tipos em "parameter type".


    5. Values: é o valor a ser extraído da interação, ou seja, é o parameters, informado pelo cliente, que deve ser identificado naquela intent pelo assistant.
    6. Synonyms: caso seja um tipo de palavra é o lugar onde se insere os sinônimos.
    7. +Add a value: usado caso seja necessário inserir mais de um valor.

Dashboard

É um registro em tempo real e com histórico que apresenta os dados em números reais e gráficos.

  1. Data relativa: se pode escolher o período que deseja ver. 
  2. Quantidade de usuário: diz a quantidade de clientes que estão acessando o chatbot no último minuto.
  3. Acessos da última hora: diz a quantidade de clientes que estão acessando o chatbot na última hora.
  4. Quantidade de acessos: informa todos os acessos no período selecionado.
  5. Duração média de atendimento: informa a duração média de cada atendimento.
  6. Média de interações: informa a média de interações no período selecionado.
  7. Taxa de rejeição: informa o volume de vezes que o chatbot foi aberto, mas não usado.
  8. Taxa de "Sem resposta": informa a taxa de sessões que o chatbot não obteve sucesso em enviar algum conteúdo após uma pergunta do cliente, seja por falta de conteúdo ou por mau preenchimento.
  9. Engajamento: quantidade de usuários que utilizam a solução mais de uma vez. Em números absolutos, termos percentuais e gráfica.
  10. Acessos diários: gráfico da quantidade de usuários que acessaram no período selecionado.
  11. Acessos por dispositivos: quantidade de acessos por dispositivo (portal, celular, produto), no período selecionado.
  12. Feedbacks: a quantidade de retorno dos clientes no período selecionado.


Visitors


Mostra a lista de usuários que acessaram e o que foi conversado no chat. Para ter acesso ao que foi conversado, a sequência das falas do cliente e o que foi respondido a ele, basta clicar no usuário em que deseja.



  1. List of online visitors: informa a lista de clientes que acessaram.
  2. Refresh: atualiza a lista de clientes que acessaram.
  3. User: informa o cliente que acessou.
  4. Session started: informa os dados do dia e hora que aquele cliente acessou.
  5. User last message: informa a última frase que o cliente digitou.
  6. Assistant message: informa a última mensagem que foi enviada ao cliente.
  7. Last message: informa os dados do dia e hora que foi enviada a última mensagem.


Logs

Apresenta os logs feitos, ou seja, as conversas feitas entre o cliente e o chat bot.



  1. Session Logs: lista os logs.
  2. User message: informa mensagem do cliente que iniciou o log.
  3. Response: informa a mensagem que cliente recebeu.
  4. Conversation / Intent Node: informa o nó/intente que foi utilizado naquele log, ou seja, naquele trecho da conversa.
  5. Date: informa os dados de dia e hora que aquele log foi feito.
  6. Status:
    1. Matched: informa se a resposta que o cliente buscava foi encontrada e respondida.
    2. No matched: informa se a resposta que o cliente buscava não foi encontrada.

Secrets

  1. List of secrets: lista os segredos criados pelo desenvolvedor.

  2. Name: é o nome dado pelo desenvolvedor na criação e ou edição do segredo.
  3. Description: é a descrição dada pelo desenvolvedor na criação e ou edição do segredo.
  4. Created On: informa dia e hora que o segredo foi criado
  5. Last Update: informa a data da última edição.

  6. Create Secret: local onde se cria o segredo.


    1. Secret Name: nome dado pelo desenvolvedor que está criando o chatbot.

    2. Description: descrição pelo desenvolvedor que está criando o chatbot.

    3. Value: valor do segredo que não será re-exibido pelo desenvolvedor que está criando o chatbot..

Tokens

É uma chave conectada de acesso a uma ou mais conversations.



  1. List of tokens: listas os tokens criados.
  2. Name: nome dado pelo desenvolvedor, quando cria o token.
  3. Description: descrição dada pelo desenvolvedor ao token.
  4. Widget demo: Link para testar o assistant.
    1. Development: é o link para a versão de desenvolvimento do Assistant
    2. Production: é o link para a versão publicada do Assistant (somente para ambientes com o controle de versão ativado).

  5. Create Token: é possível criar um token.


    1. Name: nome dado ao token no momento em que é criado, podendo ser alterado posteriormente.
    2. Description: descrição dada ao token no momento em que é criada, podendo ser alterada posteriormente.
    3. Conversations allowed: Seleciona quais as conversas são permitidas para este widget.

  6. Edit: botão utilizado para editar o token e customizar a widget.


    1. Rounded corners: bordas arredondadas
    2. Title: o título que aparece para o seu cliente.
    3. Widget width: largura do widget.

    4. Colors and styles: para estilização do ambiente da conversa.


    5. Icon settings: configurações de ícone


    6. Icon label: rótulo de ícone


    7. Feedback styles heet: folha de estilo de feedback


    8. Zendesk custom Fields: campos personalizados do Zendesk


Version Manage


As versions são versões do chatbot, ao criar uma version (versão) o desenvolvedor atribui a ela as permissões dos chatbots já criados.



  1. List of versions: listas as versions já criadas.
  2. Version: informada pelo próprio sistema, não havendo possibilidade de editar.
  3. Description: a descrição é dada pelo desenvolvedor.
  4. Created On: informa a data e hora que a version foi criada.
  5. Create new version:
    1. Version: apresenta a version a ser criada.
    2. Description: descrição dada pelo desenvolvedor na hora da criação ou edição da version.

    3. Production: não é necessário marcar ela pois é marcada automaticamente na criação da version.

  6. Edit: apenas a description pode ser editada.


  7. Copy to Dev: apresenta as modificações que irão acontecer na edição.



Construindo conversa

Após criar a conversation o construtor clica no nome dela, ou em qualquer um dos itens da conversation e será direcionado ao ambiente de construção da conversa. No ambiente de construção é possível criar e testar o Assistant, onde será criada uma ótima experiência de contato entre seu cliente e seu produto.



No ambiente de construção é o momento de montar o chatbot com a finalidade de otimizar a experiência do cliente. A seguir o passo a passo para criar seu primeiro chatbot.

  1. Adicionar node raiz

    1. Na página inicial da conversa, adicione um novo node (nó).

      Node/Nó: É a intent, ou seja, é o fluxo da conversa dentro do chatbot, cada nova conversa tem que ser composta por no mínimo um ou mais nodes. Estes são os caminhos que o cliente pode percorrer durante a interação dele com a Carol Assist. Por meio da resposta do cliente o caminho será percorrido, pois o cliente é quem define a direção que a conversa irá tomar. Para adicionar um node basta clicar em +Add a new one.

      Após ter adicionado o primeiro node caso deseje adicionar mais intents na mesma conversation é possível de 2 formas, adicionar um novo node raiz, sem ramificação inicial, Add root node, ou adicionar um node partindo de um já existente clicando no sinal de mais localizado abaixo da intente já criada de onde se deseja gerar a ramificação, em seguida no botão Add Custom Node

    2. Dê um nome ao seu node/nó.

      Ao clicar no botão para criar um nó, a página a seguir será exibida e poderá personalizar aquele caminho. O primeiro passo é dar um nome para o trecho em node name, onde o criador do chat deve inserir o nome que dará aquela intente ou nó, como chamaremos a partir de agora.


    3. Crie uma frase de treinamento (Training Phases).


  1. Training Phrases: São as frases que quando o usuário escrever fará ele entrar naquele fluxo de conversa específico, é o gatilho que ativa o node cadastrado. Estas frases serão utilizadas para ensinar os algoritmos do TOTVS Carol Assistant a entender a intenção do cliente e disparar as ações e respostas necessárias para respondê-lo.

    No exemplo a seguir, o gatilho do node é ativado quando o usuário está tentando fazer um pedido de pizza no chatbot. Para cadastrar as frases que ativam o node basta preencher os campos, caso seja desejado adicionar mais frases, clique na opção + Add a training phrase.

    Recomendações de boas práticas de Training Phrases é usar no mínimo 10 frases, completamente diferentes e não genéricas.

    1. Node name: É o nome do nó.


    2. If an user says: em português é "Se um usuário disser", é onde deve ser inserida a frase que o cliente deve usar naquele node que será identificada como gatilho para a interação.


    3. Remove: Remove a frase inserida.
    4. +Add a training phrase: Adiciona uma frase de treinamento, em um node pode ser usado mais de uma frase de treinamento.

    5. Melhores práticas: Ter pelo menos 10 frases de treinamento.



  2. Parameters: Todos os dados podem ser extraídos das mensagens do usuário, identificados por meio do Nome do Parâmetro configurado


    1. + Add a parameter: Em português adicionar parâmetro


      1. Parameter name: Nome do parâmetro

      2. Parameter type: Tipo de parâmetro

        Parameter type map: São informações que fornecem o caminho para os valores de referência para os sinônimos. Toda entrada do mapa possui apenas um valor de referência e uma lista de sinônimos. São do tipo map os seguintes parameters:

        @carol.date-time
        @carol.date
        @carol.date-calendar
        @carol.date-period
        @carol.time
        @carol.time-period

        Parameter type list: São informações inseridas de valor único sem sinônimo nem valor de referência. São do tipo lista os seguintes parameters:

        @carol.color: Corresponde a entradas de cores como o roxo, quando uma cor é inserida o valor dela é extraído.
        @carol.image
        @carol.language

        Parameter type composite: É um tipo de lista que é usada quando se usa um alias. São do tipo composite os seguintes parameters:

        @carol.cardinal
        @carol.ordinal
        @carol.geo-country
        @carol.geo-city
        @carol.geo-state
        @carol.location
        @carol.zip-code
        @carol.geo-capital
        @carol.currency-name
        @carol.unit-area-name
        @carol.unit-length-name
        @carol.unit-speed-name
        @carol.unit-volume-name
        @carol.unit-weigth-name
        @carol.uint-information-name
        @carol.given-name
        @carol.last-name
        @carol.person
        @carol.music-genre
        @carol.email
        @carol.number
        @carol.number-integer
        @carol.number-sequence
        @carol.flight-number
        @carol.unit-area
        @carol.unit-currency
        @carol.unit-length
        @carol.unit-speed
        @carol.unit-volume
        @carol.unit-weight
        @carol.temperature
        @carol.phone-number

        Parameter type regexp: Alguns padrões não possuem padrões específicos, mas sim correspondentes, através deles é possível fornecer uma expressão regular.

        @carol.feedback-stars
        @carol.feedback-thumbs
        @carol.file
        @carol.unit-information
        @carol.any
        @carol.url
      3. Islist?
      4. Required?
      5. Prompts
      6. + Add prompt
      7. Add options?

  3. Responses



    1. Respond with: Responda com
      1. Negrito
      2. Itálico
      3. Sublinhado
      4. Tarjado
      5. Marcadores
      6. Subscrição
      7. Sobrescrição
      8. Tipo de letra
      9. Cor da letra
      10. Marcador
      11. Cor
      12. Alinhamento
      13. Retornar ao normal a letra
      14. Inserir imagens
      15. Inserir link
      16. Inserir vídeo

    2. + Add response: Adicionar uma resposta

    3. End of conversation: ao chegar nesta intent a conversa será encerrada, dependendo do projeto não é indicado uma intent que encerre a conversation.
    4. Additional resources to response: adiciona opções de respostas, fechadas ou abertas.
    5. Jump to another Intent node?: Ao se acionar essa opção o cliente será direcionado a outro nó, ou seja, outro trecho do caminho dependendo da resposta dele.

  4. Named Queries: é possível adicionar queries (consultas estáticas) a uma conversation e configurá-las.


    1. + Add a named query: ao acionar este botão a query é adicionada permitindo nomear e configurar.


    2. Named Query: nome da consulta que pode ser dado, ou escolhido um já existente.
    3. Fields: campos retornados na resposta.
    4. Page size: número de registros a serem obtidos (limitado a 1000).
    5. Sort field: campo para classificar as informações.
    6. Sort order: no caso de Sort field ser usado, a ordem a ser considerada (Valores: ASC ou DESC).
    7. + Add sort field: adiciona mais campos para classificação e ordenação.

  5. Fulfillment



    O mecanismo de fulfillment do Carol Assistant fornece uma plataforma aberta para criar lógica de negócios, integrações com APIs externas ou criar respostas de forma programática. Por enquanto, oferecemos suporte ao Python 3 como linguagem de programação padrão para criar realizações. Para o correto uso deste recurso, é necessário o correto entendimento dos principais conceitos.

    Sua conversation pode ter um fulfillment para cada node de Intenção. O fulfillment do node de intenção será executado quando o node de intenção for ativado por meio de uma mensagem do usuário


    1. Plano de execução do node de Intenção


    2. Criação de um novo Fulfillment

      Para adicionar um fulfillment a um node de intenção, selecione a guia preenchimento no painel detalhe do node de intenção e clique no botão + Add a fulfillment.


      Depois disso, o Carol Assistant adicionará um novo cumprimento ao node de intenção e abrirá o Ambiente de Desenvolvimento de fulfillment.

    3. Ambiente de Desenvolvimento de fulfillment (FDE)

      Com o fulfillment do FDE, os desenvolvedores podem escrever e testar os atendimentos. A partir da versão Carol 3.37, o FDE se parece com a imagem a seguir.



WebHooks

Outra forma de permitir a execução de codigo fonte customizado é utilizando webhooks. Webhook é um método de ampliar ou alterar o comportamento de uma aplicação utilizando callbacks (ligações de retorno) personalizados com contratos, autenticação e padrões pré-estabelicidos. O TOTVS Carol Assistente permite que antes de cada envio de resposta ao usuário da conversa, uma chamada autenticada a um endpoint externo sejá realizada com o conteúdo do contexto da conversa e aguarde uma nova resposta a ser enviada para a conversa com o usuário.



Configuração do WebHook

Para configurar o webhook no nó de intenção, na aba fulfillment, selecione o fulfillment type Webhook. 

Agora você pode adicionar a URL do endpoint que irá receber a chamada do webhook. Caso necessário pode-se informar diferentes endpoints para ambientes de desenvolvimento e produção, para isso basta desmarcar o checkbox Use the same URL for Production and Development?


Chamadas e payloads

Quando configurado, o TOTVS Carol Assistente, sempre que o nó de intenção for ativado durante uma conversa, irá fazer uma chamada HTTP usando o comando POST para a URL do endpoint configurada. Além dos cabeçalhos http habituais, será enviado um cabeçado específico para a autenticação com o token mostrado na configuração do fulfillment, o que deverá ser validado na ponta que receberá a chamada. Os cabeçalhos da chamada são:

CabeçalhoDescrição
X-Assistant-Signature-TokenContém o Webhook token gerado aleatóriamente no momento da configuração do webhook do nó de intenção.
Content-Type

Tipo de conteúdo do payload. Sempre será 'application/json'

O payload da chamada do webhook contém as seguintes propriedades:

ParâmetroTipoDescrição
intent_nameStrNome do nó ativado
parametersDictTodos os parametros desse contexto de conversa
sessionLogListLista de ID de sessões até esse ponto da conversa
namedQueriesDictResultados da Named Query (se houver) (a ser descontinuado)
queryStringQuery executada (se houver) (a ser descontinuado)
languageStringIdioma da conversa
carolOrganizationStringNome da Organização
carolEnvironmentStringNome do Ambiente
carolOrganizationIdStringId da Organização
carolEnvironmentIdStringId do Ambiente
sessionIdStringId da sessão da conversa atual
isProductionBooleanInforma se a convesa está acontecendo em Produção ou Desenvolvimento
channelNameStringNome do canal por onde a mensagem chegou

Retorno:

Para retornar dados pelo WebHook, o TOTVS Carol Assistente espera que os dados estejam em um formado pré definido. O retorno deverá ser um objeto JSON com as seguintes propriedades: 

ParâmetroObrigatório?TipoDescrição
messageSimStringMensagem que será retornada na conversa
short_messageNãoStringMensagem curta de retorno
jump_toNãoStringNome do nó para o qual a conversa será direcionada
optionsNãoArray[Str]Lista de opções pré-definidas que aparecerão como botões na resposta
logoutNãoBooleanDestrói a sessão de usuário na conversa
parametersNãoObjectParametros que serão adicionados no contexto da conversa

Canais de conversação

Canal Telegram


Antes de configurar o canal Carol Assistant Telegram, é preciso criar seu novo bot usando o BotFather do Telegram. Verifique a documentação do Telegram Bot sobre como criar um Telegram Bot em<{+}https://core.telegram.org/bots+>


  1. Limitações










    O canal Carol Assistant Telegram não suporta [modo em linha] (https://core.telegram.org/bots#inline-mode) e recursos avançados do Telegram como: pagamentos, jogos, teclados embutidos, retornos de chamada e comandos (o desenvolvedor pode treinar uma intenção node para oferecer suporte a um comando de barra, adicionando um comando de barra nas frases de treinamento do node de intenção).
    Ao formatar as respostas, lembre-se de que o Telegram aceita apenas um subconjunto de tags de formatação HTML (o Carol Assistant removerá todas as tags não suportadas antes de enviar mensagens para a API do Telegram:










  2. Check-list

    • Crie um novo bot com @botfather
    • Obtenha o token da API do Telegram Bot em @botfather
    • Defina o secret TELEGRAM_TOKEN no Carol Assistant Secrets
    • Adicionar /start como frase de treinamento para o node de intenção de boas-vindas padrão



  3. Configurar

    1. Adicionar token de API do Telegram Bot ao Carol Assistant

      Com o seu novo Telegram Bot pronto e o token da API do Telegram Bot recuperado, agora o desenvolvedor pode configurar o Carol Assistant para responder às consultas do Telegram.

      Primeiro, adicione seu token de API do Telegram Bot como um novo secret do Carol Assistant. Clique no botão Criar secret e preencha todas as informações necessárias.

      Depois de inserir as informações do token, clique em Salvar.


      IMPORTANTE:

      o nome do secret não pode ser alterado. Padronizamos *TELEGRAM_TOKEN* como o nome do token e usamos internamente na integração do canal

    2. Configure o ponto de extremidade do webhook na configuração do Telegram Bot

      Depois de configurar o token da API do Telegram Bot no Carol Assistant, precisamos informar a API do Telegram para onde enviar mensagens do usuário do Telegram para a API do Carol Assistant.

      Para ajudar a concluir esta etapa, fornecemos um endpoint:

      {+}https://telegram-assistantbackend.apps.carol.ai/setup+

      Este ponto de extremidade aceita apenas o método POST HTTP.


Canal WhatsApp

Existem algumas etapas para habilitar o canal WhatsApp para um ambiente Carol Assistant, são elas:

  • Defina a API Carol Assistant no Twilio
  • Defina o número Twilio

  • Definir sid e token da conta Twilio como secret


  1. Definir API Carol Assistant no Twilio
    1. Obtenha o seguinte URL:
      https://twilio-assistantbackend.apps.carol.ai/incoming_channel_message/\{organization}/{tenant}/{organization_id}/{tenant_id}/{token}

    2. Substitua os seguintes valores:

      * organization * - exemplo: Totvs

      * tenant * - exemplo: Dev

      * organization_id * - ID exclusivo da organização

      * tenant_id * - ID exclusivo do locatário / ambiente

      * token *: - Token do assistente que pode ser encontrado na página do token, conforme mostrado abaixo:


      Defina a API no lado do Twilio como um ponto de extremidade HTTP Post. 




  2. Defina o número Twilio

    • Obtenha o número que foi configurado no Twilio e adicione-o ao Carol Assistant:

    • Obtenha nas configurações do Twilio:

    • Adicionar ao token Carol Assistant



  3. Definir conta Twilio e token como secret

    • Obtenha a conta e o token do Twilio:

    • Adicione estes dois secrets dentro do Carol Assistant, com base no token Twilio e na conta, respectivamente:

Canal Microsoft Teams


O Microsoft Teams é uma ferramenta de comunicação e armazenamento de arquivos utilizada pelo mundo acadêmico e corporativo, onde a comunicação pode ser escrita, áudio ou vídeo.

  1. Configurar

    1. Abra o "App Studio" dentro do Microsoft Teams:

    • Crie um novo aplicativo do zero
    • Defina o nome abreviado pelo qual deseja que o seu assistente seja identificado.
    • Defina um nome completo para o aplicativo e também uma descrição que será mostrada aos usuários.
    • Defina a versão do aplicativo, por exemplo: 1.0.0
    • Defina o nome da sua empresa
    • Definir o site da empresa
    • Defina uma página "Declaração de privacidade" e "Termos de uso".
    • Defina a marca do seu Assistente
    • Abra a página Bots e configure



    • Defina o nome do bot pelo qual você deseja que seu assistente seja identificado. Será o nome que os usuários irão visualizar e mencionar como Assistente.
    • Também é hora de escolher como seu Assistente será usado. Existem algumas possibilidades:
      • Pessoal
      • Equipe
      • Conversa em grupo
    • E então crie o bot


    Após a configuração do bot, você verá uma página como esta:

    • Copie o ID acima do nome do bot e cole-o em ** MSTEAM_APP_ID **
    • Clique no botão ** Gerar nova senha **, copie a senha e cole no campo ** MSTEAM_TOKEN **.
    • Obtenha o URL do Webhook na página do Carol Assistant e cole no campo ** Endpoint de mensagens **


    Vá para a página ** Testar e Distribuir **

    • Clique em ** Publicar **
    • Envie o aplicativo para o catálogo da sua organização.

    CUIDADO:

    Certifique-se de não enviar o aplicativo para os aplicativos globais. Nesse caso, qualquer organização pode usar seu bot.










    Navegue até [Centro de administração do Microsoft Teams] (https://admin.teams.microsoft.com/)> Aplicativos do Teams> Gerenciar aplicativos.











    • Pesquise o nome do aplicativo que você acabou de enviar
    • Clique e publique.



  2. Instalando o App / Bot
  • Selecione sua equipe
  • Clique em Gerenciar equipe


  • Clique em Mais Aplicativos


  • Pesquise e instale o seu aplicativo