O Criador de integrações é uma ferramenta poderosa sem código que permite que você conecte seu agente de IA a qualquer API ou fonte de dados sem precisar de habilidades técnicas ou de programação. Este artigo aborda as perguntas frequentes (FAQs) 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 em conversas de agente de IA começa com a captura automática de metadados do usuário quando a sessão começa e continua durante a interação com o agente de IA, onde entradas, respostas e entidades de conteúdo podem ser capturadas.
Quando uma sessão de chat é iniciada, especialmente se o usuário estiver conectado, determinados metadados são coletados automaticamente. Esses metadados normalmente incluem detalhes específicos do usuário, que podem incluir o ID do usuário ou informações da conta, ID da sessão, localização, carimbos de data/hora e mais. Esses dados podem ser salvos como uma ação de conversa.
Durante a conversa, você pode optar por capturar determinadas respostas (escritas como texto livre ou enviadas com botões) do usuário. Você pode fazer isso assim:
- Um parâmetro usando a configuração Coletar parâmetro em um bloco condicional
- Uma Entidade de conteúdo
Esses parâmetros podem ser passados para a integração e usados como parâmetros de solicitação no ponto de extremidade da URL ou no corpo da solicitação.
O que é um parâmetro de URL e como posso usar um?
Um parâmetro de URL é um parâmetro dinâmico na URL que muda com base nas informações passadas para a integração nos parâmetros de solicitação provenientes da conversa.
Aqui está um exemplo de um ID de usuário usada como parâmetro:
https://{{zendesk_subdomain}}.zendesk.com/api/v2/users/{{user_id}}
Entre chaves duplas, o parâmetro user_id é adicionado à URL.
Como posso acessar os dados da conversa para usar na API?
Para usar os dados da conversa, eles devem ser salvos na sessão como um parâmetro, conforme descrito acima, 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 se forem provenientes da conversa ou como dados/metadados da sessão a serem enviados para a API. Você também pode enviar dinamicamente esse parâmetro no corpo da solicitação.
Como posso acessar os parâmetros ou dados da resposta da API para usar na conversa?
Para usar 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 sucesso). Depois de salvo e quando a API chega a um determinado cenário, você pode acessar e usar o parâmetro de sessão para usar em uma mensagem de agente de IA ou como parâmetro para um bloco condicional:
- Em uma mensagem de agente de IA , ela é acessada como {{parameterName}}.
- Em um bloco condicional, ele é acessado com o nome do parâmetro.
Como envio parâmetros de solicitação no corpo?
Para enviar um parâmetro de solicitação no corpo, você deve 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 de sua solicitação. Ao testar, reformate o valor com a função JSONata $eval($). A função eval analisa e avalia uma cadeia de caracteres contendo uma expressão JSON ou uma expressão JSONata como se fosse JSON.
Neste 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 é ao enviar uma matriz de pedidos.
Ao testar, por que não estou recebendo parâmetros de solicitação ou parâmetros incorretos?
Para fins de teste, você deve usar um valor de teste que corresponda aos dados reais em seu ponto de extremidade para o parâmetro de solicitação no Criador de integrações. No entanto, em uma conversa em tempo real, o valor desse parâmetro vem da conversa. Se você não conseguir ver 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 na caixa de diálogo.
Lembre-se de que os dados da sessão limpos não serão exibidos nos registros de conversas. Nesse caso, talvez você precise registrá-las temporariamente em uma mensagem de agente de IA para depurar.
Por que estou vendo [Objeto, objeto]?
Ver [Objeto, objeto] significa que você está tentando gerar um objeto, mas o sistema não tem uma maneira estruturada de exibi-lo. Para resolver isso, você precisa converter o objeto em um formato de cadeia de caracteres.
Você registra chamadas bem-sucedidas?
Não, por motivos de IIP e RGPD , não registramos chamadas de dados bem-sucedidas. Registramos chamadas malsucedidas para que possamos fornecer mais informações sobre o que deu errado durante a solução de problemas, se necessário.
Perguntas frequentes sobre ambientes
Por que posso precisar de ambientes diferentes?
Ao testar sua integração, talvez você não queira usar dados reais ou em tempo real. Se você tiver acesso a um ambiente de sandbox, de teste ou de desenvolvimento (sugerimos que você consulte sua equipe técnica ou a documentação da API), poderá configurar isso no Criador de integrações.
Os ambientes compartilham saídas e parâmetros de solicitação. No entanto, eles diferem em pontos de extremidade e detalhes de autenticação. No criador de diálogos, você pode alternar facilmente entre ambientes no nó da API. Isso significa que você só precisa criar um diálogo durante o teste e, em seguida, pode mudar para um ambiente de produção quando estiver pronto para implementar 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 8 cartões com um cartão fallback. Um cartão de fallback dá ao usuário uma saída do carrossel (por exemplo, se ele não vir o item).
Preciso exibir imagens em cartões em um carrossel?
Sim, a imagem é um campo de dados obrigatório. Você pode preencher o campo de imagem com um link de imagem genérico se não precisar 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 validade
- Autenticação básica
- OAuth 2.0
- Listas de autorização de IP
Para começar com a autenticação do Criador de integrações, consulte Requisitos técnicos de integração.
Posso criar uma integração com um ponto de extremidade na Lista de autorização?
Sim. Para fazer isso, você deve adicionar nossos endereços IP à sua lista de autorização. Para obter uma lista de endereços IP, consulte Permitir que os IPs conectem agentes avançados de IA ao seu CRM.
O que é uma integração apenas de autenticação e quando preciso dela?
Para saber mais sobre integrações apenas de autenticação, consulte Uso de autorização personalizada com o criador de integrações.
Posso implementar a limitação e a otimização de taxa?
Não impomos limitação de taxa e estrangulamento diretamente. A limitação de taxa normalmente é aplicada pelos sistemas ou APIs com os quais nos integramos, como seu sistema de back-end. Esses limites dependem da configuração do seu back-end.
O que acontece se minha API demorar mais de 9 segundos para responder?
O complemento Agentes de IA - Avançado aplica um tempo limite de 9 segundos para as respostas da API. Se sua API não fornecer uma resposta dentro desse período, a solicitação expirará e retornará o erro ECONNABORTED. Além disso, tempos de resposta mais longos podem afetar negativamente a experiência do usuário, pois os usuários podem achar frustrante esperar por informações.
Para resolver isso, se você antecipar que determinadas respostas da API demorarão mais de 9 segundos, recomendamos fazer 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 prontos quando necessário, evitando atrasos durante o fluxo da conversa.