Qual é o meu plano?
Suite, todas as versões Team, Growth, Professional, Enterprise ou Enterprise Plus
Support Team, Professional ou Enterprise

No criador de integrações, os parâmetros de solicitação permitem extrair dados (parâmetros de conversa) das conversas com os agentes de IA e enviá-los para pontos de extremidade externos. Em alguns casos, pode ser necessário transformar ou reformatar esses dados antes de enviá-los em uma solicitação de API, seja como uma consulta na URL ou no corpo da solicitação. Para isso, você pode usar JSONata, uma poderosa linguagem de consulta e transformação.

Este artigo contém os seguintes tópicos:

  • Reformatação do valor de um parâmetro de solicitação
  • Exemplos comuns de casos de uso para reformatação de valores

Artigos relacionados:

  • Recursos do criador de integrações

Reformatação do valor de um parâmetro de solicitação

Você pode reformatar o valor de um parâmetro de solicitação usando JSONata.

Como reformatar o valor de um parâmetro de solicitação

  1. No canto superior direito do espaço de trabalho dos agentes de IA, use o campo de lista suspensa para selecionar o agente de IA.
  2. No menu principal à esquerda, clique em Integrações de API.
  3. Selecione ou crie uma integração.
  4. Na página Parâmetros da solicitação, selecione ou crie o parâmetro de solicitação cujo valor você quer reformatar.
  5. No campo Testar valor, selecione o ícone Reformatar valor ().
  6. Na caixa de diálogo Reformatar valor, no campo Reformatação do JSONata, use JSONata para transformar ou reformatar o valor associado à chave do parâmetro de solicitação selecionado.
    Na consulta JSONata, use '$' para representar a chave cujo valor você está reformatando.
    O campo Testar visualização do valor permite que você verifique os resultados da consulta em tempo real.
  7. Clique em Concluído.
  8. (Opcional) Se você estiver adicionando o parâmetro de solicitação ao corpo de uma solicitação de API:
    1. No cabeçalho Ambiente, à esquerda, selecione o ambiente adequado.
    2. Selecione a aba Corpo.
    3. Insira o objeto JSON, utilizando o parâmetro de solicitação como valor entre chaves duplas.

Casos de uso comuns para reformatação de valores

No criador de integrações, é possível definir parâmetros de solicitação atribuindo-os a chaves específicas. Embora esses valores possam funcionar como estão, há situações em que precisam ser transformados ou reformatados para atender aos requisitos do sistema externo.

Por exemplo, talvez você deseje:

  • Reformatar datas: altere o formato de uma data de MM/DD/AAAA para AAAA-MM-DD ou ISO 8601, de modo a atender aos requisitos da API.
  • Fazer operações com cadeias de caracteres: manipule cadeias de caracteres, como adicionar ou remover caracteres, combinar vários campos ou transformar cadeias de caracteres para que contenham HTML.
  • Aplicar lógica condicional: aplique condições, como verificar se um campo está vazio ou atribuir um valor padrão, se necessário.

Esta seção contém os exemplos a seguir:

  • Situação: reformatação de datas
  • Situação: reformatação de URLs para tornar os links clicáveis
  • Situação: reformatação de uma transcrição de chat para torná-la mais legível

Situação: reformatação de datas

Neste cenário, o ponto de extremidade precisa verificar uma data no formato AAAA-MM-DD ou no formato ISO 8601. No entanto, para sua conversa, você quer que as datas sejam exibidas em um formato mais intuitivo, como DD/MM/AAAA.

Aqui está a consulta JSONata que você usaria nessa situação:

$substring($, 6, 10) & "-" & $substring($, 3, 2) & "-" & $substring($, 0, 2)

Situação: reformatação de URLs para tornar os links clicáveis

Neste cenário, você quer converter URLs em links clicáveis, procurando por texto (uma subcadeia) que comece com http:// ou https://, seguido por uma série de caracteres que não sejam espaços em branco. Em seguida, você quer substituir essa subcadeia usando a função $replace do JSONata por uma cadeia de caracteres que envolva a URL correspondente em uma tag HTML <a>, criando um link clicável.

Aqui está a consulta JSONata que você usaria nessa situação:

(
$text := "Chat transcript unavailable. Here is a link:https://www.zendesk.com. Here is another link: https://www.w3schools.com.";

$replace($text, /(https?:\/\/[^\s]+)/, '<a href="$1">$1</a>'
)

Situação: reformatação de uma transcrição de chat para torná-la mais legível

Neste cenário, você quer adicionar uma transcrição de chat a um ticket. No entanto, em sua forma padrão, a transcrição do chat não é muito legível:

  • Transcrição do chat - 2024-10-12 (13:04:10) Agente de IA: Boas-vindas ao agente de IA do criador de integrações! (13:04:10) Agente de IA: Escolha qual integração você quer testar: (13:04:10) Visitante: teste c.id: d501304d-da09-4485-a4c7-1c708ec0005d Todos os horários estão em UTC

Você quer transformar isso em um formato mais fácil de ler, colocando cada mensagem em uma nova linha. Como cada nova mensagem começa com um parêntese aberto ( ( ), você pode usar o JSONata para substituir cada ocorrência de ( por uma quebra de linha seguida do (.

A conversa reformatada ficaria assim:

  • Transcrição do chat - 2024-10-12
    (13:04:10) Agente de IA: Boas-vindas ao agente de IA do criador de integrações!
    (13:04:10) Agente de IA: Escolha qual integração você quer testar:
    (13:04:10) Visitante: teste c.id: d501304d-da09-4485-a4c7-1c708ec0005d Todos os horários estão em UTC

Aqui está a consulta JSONata que você usaria nessa situação:

$replace($, “(“, “\n(“)

Além disso, você precisaria adicionar este parâmetro à seção de corpo no seu ambiente para que seja enviado junto com a solicitação:

{
"chatTranscript": "{{chatTranscript}}"
}

 

Powered by Zendesk