O criador de integrações é uma poderosa ferramenta sem código que permite conectar o agente de IA a qualquer API ou fonte de dados sem grandes habilidades técnicas ou de programação. Este artigo aborda as perguntas mais frequentes sobre o criador de integrações.
Este artigo contém os seguintes tópicos:
- Perguntas frequentes sobre parâmetros e dados
- Perguntas frequentes sobre ambientes
- Perguntas frequentes sobre cartões e carrosséis
- Perguntas frequentes sobre autenticação
Artigos relacionados:
Perguntas frequentes sobre parâmetros e dados
Como os dados da sessão da conversa são coletados?
A coleta de dados da sessão nas conversas com agentes de IA começa com a captura automática dos metadados do usuário no início da sessão e continua ao longo da interação com o agente de IA, durante a qual podem ser capturadas entradas, respostas e entidades.
Quando uma sessão de chat é iniciada, especialmente se o usuário estiver conectado, certos metadados são coletados automaticamente. Esses metadados geralmente incluem detalhes específicos do usuário, como ID do usuário ou informações da conta, ID da sessão, localização, carimbos de data e hora e outros. Esses dados podem então ser salvos como uma ação de conversa.
Durante a conversa, você pode optar por capturar determinadas respostas (sejam elas escritas como texto livre ou enviadas por meio de botões) do usuário. Você pode fazer isso das seguintes maneiras:
- Um parâmetro que utiliza a configuração “Coletar parâmetro” em um bloco condicional
- Uma entidade
Esses parâmetros podem então ser passados para a integração e utilizados como parâmetros de solicitação na URL do ponto de extremidade ou no corpo da solicitação.
O que é um parâmetro de URL e como posso usá-lo?
Um parâmetro de URL é um parâmetro dinâmico na URL que muda de acordo com as informações passadas para a integração nos parâmetros da solicitação provenientes da conversa.
Aqui está um exemplo de um ID de usuário usado como parâmetro:
https://{{zendesk_subdomain}}.zendesk.com/api/v2/users/{{user_id}}Entre as chaves duplas, o parâmetro user_id é adicionado à URL.
Como posso acessar os dados da conversa para utilizá-los na API?
Para utilizar os dados da conversa, é necessário salvá-los na sessão como um parâmetro, conforme descrito anteriormente, seja coletando o parâmetro ou salvando os metadados em um parâmetro nos dados da sessão. Os dados devem ser salvos como um parâmetro de solicitação no criador de integrações, caso sejam provenientes da conversa, ou como dados/metadados da sessão a serem enviados para a API. Em seguida, você também pode enviar esse parâmetro dinamicamente no corpo da solicitação.
Como posso acessar os parâmetros ou dados da resposta da API para utilizá-los na conversa?
Para utilizar parâmetros ou dados da resposta da API, eles devem ser salvos como um parâmetro de sessão no ambiente (na maioria dos casos, o cenário de êxito). Depois de salvar e assim que a API for aplicada a um determinado cenário, você poderá acessar e usar o parâmetro de sessão em uma mensagem do agente de IA ou como parâmetro de um bloco condicional:
- Na mensagem de um agente de IA, ele é acessado como {{parameterName}}.
- Em um bloco condicional, ele é acessado pelo nome do parâmetro.
Como faço para enviar parâmetros de solicitação no corpo?
Para enviar um parâmetro de solicitação no corpo, é necessário incluí-lo entre chaves duplas, assim:
{{exampleParameter}}Posso enviar uma matriz no corpo da solicitação?
Sim, você pode selecionar o tipo de dados como uma matriz ao definir os parâmetros da solicitação. Ao fazer os testes, certifique-se de reformatar o valor com a função JSONata $eval($). A função "eval" analisa e avalia uma cadeia de caracteres que contenha uma expressão JSON ou uma expressão JSONata como se fosse JSON.
Nesse caso, estamos pegando uma cadeia de caracteres incluída em uma matriz e usando $eval() para analisá-la como uma matriz. O caso de uso mais comum para isso é ao enviar uma matriz de pedidos.
Ao fazer testes, por que não estou recebendo nenhum parâmetro de solicitação ou estou recebendo parâmetros incorretos?
Para fins de teste, você deve usar um valor de teste que corresponda aos dados reais do seu ponto de extremidade para o parâmetro de solicitação no criador de integrações No entanto, em uma conversa ao vivo, o valor desse parâmetro vem da própria conversa. Se você não conseguir visualizar o parâmetro e o valor nos dados da sessão durante o teste, verifique se está capturando e salvando-os como o parâmetro correto no diálogo.
Lembre-se de que os dados da sessão sanitizados não aparecerão nos registros das conversas. Nesse caso, talvez seja necessário registrá-los temporariamente em uma mensagem do agente de IA para fins de depuração.
Por que estou vendo [Object, object]?
Ver [Object, object] significa que você está tentando ter um objeto como saída, mas o sistema não tem uma maneira estruturada de exibi-lo. Para resolver isso, é necessário converter o objeto para o formato de cadeia de caracteres.
As chamadas bem-sucedidas são registradas?
Não, por motivos relacionados a IIP e ao RGPD, as chamadas de dados bem-sucedidas não são registradas. As chamadas malsucedidas são registradas para que possamos fornecer mais informações sobre o que deu errado durante a solução de problemas, caso seja necessário.
Perguntas frequentes sobre ambientes
Por que eu precisaria de ambientes diferentes?
Ao testar sua integração, talvez você não queira usar dados reais ou em tempo real. Se você tem acesso a um ambiente de sandbox, staging ou desenvolvimento (recomendamos consultar sua equipe técnica ou a documentação da API), pode configurar isso no criador de integrações.
Os ambientes compartilham parâmetros de solicitação e saídas. No entanto, eles diferem nos pontos de extremidade e nos detalhes de autenticação. No criador de diálogos, é possível alternar facilmente entre ambientes no nó da API. Isso significa que você só precisa criar um diálogo durante os testes e, depois, pode migrar para o ambiente de produção quando estiver com tudo pronto para ativar a integração.
Perguntas frequentes sobre cartões e carrosséis
Preciso definir um número máximo de cartões?
Para a integração do Sunshine Conversations, há um máximo de 10 cartões.
Sugerimos limitar o número de cartões em um carrossel a 9 cartões, ou a 8 cartões com um cartão de fallback. Um cartão de fallback oferece ao usuário uma maneira de sair do carrossel (por exemplo, caso não encontre o que procura).
Preciso exibir imagens nos cartões em um carrossel?
Sim, a imagem é um campo de dados obrigatório. Você pode preencher o campo de imagem com um link para uma imagem genérica, caso não precise de imagens dinâmicas (por exemplo, uma imagem por produto).
Perguntas frequentes sobre autenticação
Quais métodos de autenticação posso usar?
Você pode usar os seguintes métodos de autenticação:
- Chave da API
- Token do portador
- Token de expiração
- Autenticação básica
- OAuth 2.0
- Listas de autorização de IP
Para começar a usar a autenticação no criador de integrações, consulte Requisitos técnicos da integração.
Posso criar uma integração com um ponto de extremidade incluído na lista de autorização?
Sim. Para isso, você deve adicionar nossos endereços IP à lista de autorização. Para obter uma lista de endereços IP, consulte Permissão para que IPs conectem agentes de IA ao CRM.
O que é uma integração apenas de autenticação e quando preciso dela?
Para saber mais sobre integrações apenas de autorização, consulte Uso de autorização personalizada com o criador de integrações.
Posso implementar limites de taxa e restrições de tráfego?
Não aplicamos limites de taxa nem restrições de tráfego diretamente. Os limites de taxa costumam ser aplicados pelos sistemas ou APIs com os quais nos integramos, como o seu sistema de back-end. Esses limites dependem da configuração do back-end.
O que acontece se minha API demorar mais de 9 segundos para responder?
O espaço de trabalho dos agentes de IA impõe um tempo limite de 9 segundos para respostas da API. Se a API não fornecer uma resposta dentro desse prazo, a solicitação expirará e retornará o erro ECONNABORTED. Além disso, tempos de reação mais longos podem afetar negativamente a experiência do usuário, já que os usuários podem achar frustrante ter que esperar pelas informações.
Para resolver isso, se você prevê que certas respostas da API levarão mais de 9 segundos, recomendamos realizar as chamadas de API necessárias no início da conversa, se possível (por exemplo, no evento Chat iniciado) e armazenar as informações relevantes na sessão. Isso garante que os dados estejam disponíveis quando necessário, evitando atrasos durante o fluxo da conversa.