Search…
⌃K
Links

Functions

Realize integrações dos bots com os sistemas dos clientes diminuindo o tempo de programação.
Com a Functions você consegue processar os dados mais pesados do seu bot, como uma lista de endereços, e exibi-lo no seu chatbot sem a necessidade de utilizar uma API externa.
Ao criar uma ação ou nó no Builder, é possível personalizar uma lista dinâmica e tratar o seu retorno, diminuindo o tempo de programação e melhorando a agilidade no fluxo.

Acesso

Para acessar a Functions, clique em BUILD no menu lateral da esquerda e, em seguida, em Functions.

Estrutura

A partir de agora, conheça toda a estrutura da Functions que possibilitará você realizar as integrações que deseja.

Criar Function

Para criar uma nova function, basta localizar o sinal de + e criar um Novo arquivo. O nome que você escolher não pode conter caracteres especiais nem números.
Feito isso, clique em Criar novo arquivo e a function estará na lista lateral à esquerda.
Veja o gif de exemplo:

Inserir logs na Function

Para inserir logs nas functions e consultá-los posteriormente, basta configurar um console.log() na sua function. Por exemplo:

Visualizar Function

No menu lateral à esquerda, selecione uma function para visualizá-la e, em seguida, a tela de edição será exibida.
Se você clicar em mais de uma Functions na edição, elas ficarão separadas por abas, como mostra a imagem abaixo:

Salvar ou Desfazer Function

Para salvar a sua edição, basta clicar na opção Salvar alterações. Caso queira desfazê-la, clique na opção Desfazer:
Lembre-se sempre de salvar, pois as alterações não serão salvas automaticamente.

Testar Function

Os parâmetros setados para o teste poderão ser utilizados pela função através da variável "params". Essa opção ficará disponível na aba Código.
  • Parâmetros de teste: editor onde os parâmetros devem ser setados no formato JSON;
  • Resultado do teste: campo de leitura contendo o resultado da ação programada utilizando os parâmetros de teste.
A área de teste fica logo ao lado da opção Publicar. Para utilizá-la, clique no botão Exibir Área de Testes e, em seguida, em Testar. Para retirar a visualização, clique em Ocultar Área de Testes.
Caso você visualize, no momento da sua edição, que existe outro usuário também editando, você não poderá fazer nada além de visualizar.

Atributos

A estrutura do retorno de uma ação é a seguinte:
{
"code":"200/404/500",
"result":"retorno programado da ação"
}
Atributos de um evento:
Atributo
descrição
code
Código de execução da ação:
  • 200 - Em caso de sucesso
  • 404 - Caso a ação não seja encontrada (por erro de escrita ou por não estar publicada, por exemplo)
  • 500 - Caso ocorra erros inesperados de execução.
result
Retorno da função criada. retornará exatamente o que foi programado pelo ser criador no altu
Para uso no builder, acessar através da result_variable da ação (result_variable.code ou result_variable.result), como no exemplo abaixo:

Modelo de homologação e produção

Todas as alterações feitas nas Functions só terão reflexos em versões de produção caso a respectiva function seja publicada.
Dessa forma, temos um ambiente de homologação melhor definido para testar bastante as suas functions.
No ambiente de desenvolvimento, as Functions serão executadas com todas as mudanças feitas antes mesmo de publicar.
Caso deseje publicar a sua Function, clique na opção Publicar.
Ao publicar uma versão no builder, as functions não serão também publicadas. Isso deve ser feito separadamente.

Aplicar no Assistente

Para aplicar a Function no seu assistente, siga as instruções abaixo dentro da plataforma do Zenvia NLU:
  1. 1.
    Clique no nó que deseja adicionar a functions ou crie um novo;
  2. 2.
    Escolha o componente de Ações </>;
  3. 3.
    Acesse o Helper;
  4. 4.
    Busque por Functions;
  5. 5.
    Mantenha o prefixo "custom" e a partir dele haverá um autocomplete para selecionar a function que deseja utilizar.

Versões

Na aba de Versões, é possível visualizar todas as versões existentes com suas respectivas datas e responsáveis pela criação.
Na tela principal, você verá todas as versões presentes e diferentes da Function, separadas por linhas.
Perceba que, em cada linha, há dois botões:
  • Comparar: ao clicar nessa opção, você poderá comparar um código com o outro. A ferramenta exibirá, lado a lado, as versões.
  • Enviar para desenvolvimento: ao clicar nessa opção, a versão selecionada da Functions será enviada para a tela de edição, ou seja, para aba de código. Assim, é possível que você crie uma nova versão editada da que acabou de restaurar. Essa funcionalidade é como um backup de versões, por onde poderá recuperá-lo e editá-lo.
Para salvar uma nova versão, basta preencher com um nome no campo Digite um título para a versão e, em seguida, clicar em + Salvar nova versão.
Só é possível manter 20 versões. Logo, a partir da vigésima primeira, apaga-se, automaticamente, a mais antiga.

Logs

Na aba de Logs, é possível rastrear todos os registros e informações diversas das requisições de uma API.
Nela, você poderá pesquisar por palavras-chaves no conteúdo dos logs e seu respectivo período.

Estrutura

  • Componentes: neste filtro, você poderá buscar por duas opções que melhor atenda sua necessidade. São elas:
  1. 1.
    Http_request: opção mais utilizada para chamar API's diretamente pelo builder, essa busca trará os logs que são gerados a partir das ações http_resquest.
  2. 2.
    Functions: filtre por uma ou todas as Functions criadas. Mas atenção: é preciso configurar um console.log na Function para gerar logs.
  • Período: você poderá filtrar até 7 dias, podendo personalizar o período desejado através do calendário exibido nesta opção.
  • Assistente: nesse filtro, você poderá buscar por um ou todos os assistentes.
  • Atendimento: utilize o ID do atendimento para filtrar.
  • Conteúdo do log: nesse filtro, busque dentro do conteúdo do log um termo existente para filtrar mais rápido.

Lista de Logs

Após realizar os filtros conforme desejado, uma lista de logs será exibida com as seguintes informações:
  • Atendimento: link para o atendimento que ocorreu a execução da function;
  • Timestamp: data de execução da function/log;
  • Assistente: link para o assistente que ocorreu a execução da function.
Com isso, sempre que clicar no item escolhido da lista, uma barra lateral à direita será exibida contendo todo o conteúdo do log.