Captain
Por Pranav
Por Pranav
Aprenda a configurar e usar o Captain, o agente de IA do Chatwoot para atendimento ao cliente.
Introdução ao Capitão
Captain é o agente de IA do Chatwoot que ajuda a tornar o suporte ao cliente mais rápido, inteligente e personalizado. Ele vem com ferramentas poderosas para auxiliar tanto seus clientes quanto seus agentes de suporte, garantindo conversas suaves e resoluções rápidas. 🤖 Capitão Assistente – Um assistente inteligente que conversa com seus clientes, aprende com seus documentos de ajuda e conversas passadas, e fornece respostas rápidas e precisas. Quando ativado, o assistente recebe as perguntas iniciais antes de transferir para um agente. Leia mais sobre o assistente aqui. 🧑✈️ Capitão Copiloto – O melhor amigo do agente de suporte! Ajuda a redigir respostas, traduz mensagens e encontra detalhes importantes nas ferramentas conectadas. Além disso, em breve adicionaremos mais integrações para reunir tudo o que você precisa em um só lugar. Leia mais sobre o copiloto aqui. 📚 Capitão FAQs – Identifica perguntas frequentes de clientes que ainda não estão na sua base de conhecimento e te ajuda a preencher essas lacunas, tornando o suporte mais rápido para todos. Leia mais sobre as FAQs aqui. 🧠 Capitão Memórias – Mantém o registro de detalhes importantes das conversas. Se um cliente mencionar um problema mais de uma vez, o Capitão se lembra, para que sua equipe possa fornecer um suporte melhor e mais personalizado. Leia mais sobre as memórias aqui.
Atualizando o robots.txt para Permitir que o Chatwoot Assistant Faça a Varredura do Seu Site
O Chatwoot utiliza o Firecrawl internamente para buscar e indexar o conteúdo do seu site. Isso permite que o Assistente do Chatwoot responda perguntas usando as informações do seu site. No entanto, se o arquivo robots.txt do seu site possuir regras Disallow, o Firecrawl irá respeitá-las e pular o rastreamento dessas páginas. Quando isso acontece: - Nenhum documento do seu site será adicionado ao Chatwoot - O Assistente não receberá contexto adicional - As respostas podem se tornar incompletas ou genéricas Para garantir que o Assistente funcione corretamente, é necessário permitir que o Firecrawl rastreie o seu site. Passo 1: Verifique Seu robots.txt Acesse: https://seudominio.com/robots.txt Procure por entradas Disallow: que possam bloquear agentes de usuário. Passo 2: Adicione uma Regra Allow para o Firecrawl Peça para o administrador ou desenvolvedor do seu site adicionar as seguintes linhas ao arquivo robots.txt: User-agent: FirecrawlAgent Allow: / Isso indica ao Firecrawl que ele tem permissão para rastrear todo o seu site, mesmo que outros bots estejam restritos. Passo 3: Salve e Publique Após atualizar o robots.txt, certifique-se de que o arquivo foi publicado e está acessível publicamente. Você pode verificar acessando: https://seudominio.com/robots.txt e conferindo se as novas regras aparecem.
Como usar o Captain Memories?
Captain Memórias são pedaços de informação salvos a partir de conversas com clientes para fornecer contexto em interações futuras. Essas memórias permitem respostas personalizadas, eficientes e com consciência de contexto. Por exemplo, se um cliente mencionar que tem uma equipe de 18 pessoas ou compartilhar preferências específicas, o Captain armazenará essa informação. Isso permite que sua equipe utilize esses insights em conversas futuras para aprimorar a experiência do cliente. Que Tipo de Informação o Captain Salva? O Captain foi projetado para salvar detalhes compartilhados pelos clientes que sejam relevantes para fornecer um suporte personalizado. Isso pode incluir: • Preferências do cliente (ex: estilo de comunicação preferido ou preferências de produtos). • Dúvidas e questões recorrentes (ex: “Como faço para gerenciar usuários no painel?”). • Necessidades específicas (ex: “Nossa equipe usa o Plano Enterprise e precisa de uma API para integrações.”). • Contexto operacional (ex: “Nossa equipe é composta por 18 membros”). Esses detalhes são automaticamente salvos como anotações no perfil do cliente, tornando-os facilmente acessíveis para consulta futura. Onde Posso Ver uma Memória Gerada pelo Captain? As memórias geradas pelo Captain ficam armazenadas na seção de Notas do painel do cliente, vinculadas diretamente ao cliente relevante. Isso garante que sua equipe possa acessá-las a qualquer momento durante as conversas. Como Visualizar Memórias: 1. Abra o perfil do cliente no painel. 2. Vá para a seção de Notas, onde todas as memórias salvas estão organizadas com marcação de data/hora e contexto para fácil consulta.
Como usar o Captain Copilot?
Captain Copilot foi desenvolvido para ajudar agentes de suporte a trabalharem de forma mais inteligente, fornecendo sugestões e insights úteis diretamente do seu painel. Aqui está um guia para ajudá-lo a tirar o máximo proveito do Captain Copilot. Onde encontrar o Copilot? Para começar, certifique-se de que o Captain Copilot está habilitado na sua caixa de entrada. Abra seu painel e vá para a tela de conversas. No lado direito, você verá a guia Copilot ao lado das opções de contato. Clique na guia Copilot para acessar e começar a usar seus recursos. Como o Copilot funciona? O Copilot é uma ferramenta que pode melhorar a comunicação de várias maneiras. Ele pode analisar a conversa atual e redigir uma resposta apropriada ou até mesmo traduzir uma mensagem para outro idioma, garantindo que o tom e o contexto permaneçam intactos. Além disso, o Copilot pode analisar o tom da conversa, identificar pontos de melhoria e sugerir ajustes para alinhar melhor com a voz e os valores da sua marca. Para aprimorar ainda mais a experiência, o Copilot também pode encontrar artigos ou recursos relevantes relacionados à conversa atual, oferecendo acesso rápido a informações que apoiam suas respostas. Com sua capacidade de reduzir falhas de comunicação, refinar o tom e fornecer insights práticos. Como usar o copilot? Basta digitar seu pedido em linguagem natural, e o Captain irá analisá-lo para fornecer a melhor resposta. Você pode usá-lo para redigir respostas, traduzir mensagens ou melhorar o tom. Para melhores resultados, faça pedidos claros e específicos. Por exemplo, ao invés de dizer, “Ajude com essa resposta,” tente, “Escreva uma resposta educada explicando o atraso e oferecendo um novo prazo.” O Captain usa o conhecimento dos seus documentos para criar respostas precisas e relevantes. Aqui está um exemplo rápido de como redigir uma resposta. Quando o Captain sugerir uma resposta, clique em “Usar esta” para adicioná-la diretamente à sua janela de mensagens. Dicas Adicionais para Uso Eficaz - Sempre revise as sugestões do Copilot antes de enviá-las para garantir que estejam alinhadas com o tom e as diretrizes da sua equipe. - Utilize as recomendações do Copilot para preencher quaisquer lacunas na comunicação com o cliente, como adicionar instruções mais detalhadas ou esclarecer pontos ambíguos. - Incentive sua equipe a explorar e utilizar o Copilot regularmente para uma colaboração mais fluida e interações melhoradas com os clientes.
Como funcionam os Créditos de IA no Captain?
Este guia explica como os créditos de IA são consumidos, como seus créditos são atualizados quando você faz uma recarga, quando ocorre a renovação mensal, o que acontece ao mudar de plano e como funcionam as notificações caso seus créditos acabem. Como os créditos de IA são consumidos? Os créditos de IA são deduzidos sempre que uma ação de IA é realizada. Exemplos incluem: - Respostas do assistente Capitão - Consultas do Copilot - Ações do editor (reformular, resumir, sugerir uma resposta) - Sugestões de etiquetas - Qualquer fluxo de trabalho ou automação que acione uma chamada de modelo - Transcrição de áudio Diferentes modelos consomem créditos em taxas diferentes. No momento, todas as ações consomem 1 crédito por mensagem, já que apenas uma configuração de modelo fixa é suportada. Isso mudará no futuro, conforme mais opções de modelos forem suportadas, momento em que diferentes modelos poderão consumir diferentes quantidades de créditos por ação. Se uma ação não puder ser concluída devido a créditos insuficientes, ocorre uma falha de crédito (explicado mais adiante). Quando o uso é redefinido? O uso é redefinido para 0 apenas durante a renovação mensal. O uso NÃO é redefinido quando: - Você faz recarga de créditos - Muda de plano - Altera a quantidade de usuários Isso significa que você pode fazer recargas a qualquer momento sem perder o acompanhamento do seu ciclo atual de uso. Como os créditos de IA são atualizados? 1. Recarga de créditos Quando você compra créditos adicionais, eles são simplesmente adicionados ao seu saldo existente. Exemplo - Créditos anteriores: 1500 - Recarga: 1000 - Total de créditos novo: 2500 Nenhum outro valor é alterado. 2. Renovação mensal Todo plano inclui uma quantidade mensal de créditos gratuitos. Na renovação, ajustamos o uso e os créditos com base no quanto você consumiu no mês anterior. Caso A: Sem uso Uso: 0 → Seus créditos totais não mudam. Caso B: O uso é menor que seus créditos gratuitos mensais - Créditos anteriores: 1500 - Uso: 200 - Créditos gratuitos mensais: 300 → Nenhuma dedução é aplicada. → Créditos totais permanecem 1500. → Uso é redefinido para 0. Caso C: O uso ultrapassa seus créditos gratuitos mensais - Créditos anteriores: 1500 - Uso: 600 - Créditos gratuitos mensais: 500 Excedente = 600 − 500 = 100 → Deduzir o excedente dos créditos totais. → Novo total de créditos: 1400 → Uso é redefinido para 0. 3. Mudando de plano Ao trocar de plano, a quantidade de créditos gratuitos mensais pode aumentar ou diminuir. Exemplo - Plano Startup: 300 créditos gratuitos - Plano Business: 500 créditos gratuitos - Plano Enterprise: 800 créditos gratuitos Se você trocar de Startups para Business, seus créditos totais aumentariam em 200. Da mesma forma, se você fizer downgrade de Business para Startups, seus créditos totais diminuiriam em 200. Seu uso permanece inalterado. Falha de crédito (Gestão de créditos insuficientes) Uma falha de crédito ocorre quando uma ação de IA é acionada, mas não há créditos suficientes para realizá-la. O que acontece durante uma falha de crédito - A ação não é executada. Quaisquer alternativas disponíveis são executadas — por exemplo, se o assistente não puder responder, a conversa é transferida diretamente para um agente. - Registramos internamente a ação falha para auditoria
Criando uma seção de Perguntas Frequentes com o Captain
FAQs (Perguntas Frequentes) são uma coleção de perguntas comuns e suas respostas, projetadas para fornecer assistência rápida e fácil aos clientes. O Captain utiliza essas FAQs para responder às dúvidas dos clientes de forma eficiente, garantindo que informações precisas e consistentes sejam fornecidas. Como as FAQs são geradas? As FAQs são geradas de duas formas: Automaticamente: O Captain analisa seus artigos do centro de ajuda e conversas resolvidas com clientes para identificar lacunas de conteúdo ou tópicos frequentemente abordados. Com base nessa análise, ele sugere FAQs. Manualmente: Você pode criar FAQs diretamente navegando até a seção de FAQs, clicando em “Adicionar Novo”, inserindo a pergunta e a resposta, e atribuindo ao assistente. Como adicionar uma FAQ manualmente? Vá até a seção de FAQs na barra lateral em Captain. Se FAQs já foram geradas a partir dos seus documentos, você as verá listadas aqui. Caso contrário, a página aparecerá conforme mostrado abaixo. Clique em “Criar nova FAQ” para adicionar uma pergunta e sua respectiva resposta, conforme mostrado abaixo. Selecione o assistente e clique em “Criar.” A FAQ agora estará pronta para uso em conversas. Como verificar as FAQs geradas a partir das conversas? Ao final de cada conversa, o Captain analisa as interações para identificar possíveis lacunas ou perguntas recorrentes que ainda não foram abordadas na sua base de conhecimento. Com base nessa análise, ele sugere novos tópicos como FAQs para ajudar a aprimorar a cobertura do seu conteúdo. Essas FAQs sugeridas são adicionadas à lista “Pendente” na seção de FAQs, onde você pode revisá-las. Para revisar uma FAQ sugerida, acesse a página de FAQs e aplique o filtro "Pendente". Revise atentamente as perguntas sugeridas. Se uma pergunta for relevante e útil, clique no menu de três pontos e selecione a opção para marcá-la como aprovada. Você também pode editar a resposta sugerida para garantir que esteja correta e adequada à sua base de conhecimento antes de aprovar a FAQ. Você também pode visualizar a conversa da qual a pergunta foi gerada. Se você estiver em dúvida sobre a relevância de uma pergunta sugerida, basta clicar no ID da conversa para revisar a interação antes de decidir se aprova ou não a FAQ. Revisar essas sugestões regularmente ajuda a manter sua base de conhecimento precisa, atualizada e alinhada às necessidades em constante evolução dos seus clientes.
Como habilitar o Captain em instalações auto-hospedadas?
O Captain é um assistente de IA que ajuda você a responder mais rápido e com maior precisão. Com o Bring Your Own Key (BYOK), você pode usar sua própria chave de API da OpenAI ou de qualquer serviço de IA compatível. Você controla os dados, os custos e qual modelo é utilizado. Em uma instalação auto-hospedada, o Captain só envia dados para o modelo de IA que você escolher. Este guia vai mostrar como habilitar o Captain na sua Enterprise Edition auto-hospedada, adicionar sua chave de API e configurar um modelo personalizado, se desejar. Pré-requisitos Antes de começar, certifique-se de que você possui: - Chatwoot Enterprise Edition com um plano pago. - Acesso de administrador ao Super Admin Console. - Uma chave de API OpenAI válida. - (Opcional) Um endpoint de API compatível com OpenAI auto-hospedado. - (Opcional) Uma chave de API Firecrawl para uma melhor varredura de documentação. Habilitando o Captain no Super Admin Console Para habilitar o Captain no nível da instalação: Faça login no Super Admin Console. Navegue até Configurações → Captain. Preencha os campos de configuração: 1. Chave de API OpenAI (Obrigatório) – A chave para autenticar solicitações para a OpenAI ou serviço compatível. 2. Modelo OpenAI (Obrigatório) – O padrão é gpt-4o-mini. Você pode escolher outro modelo suportado como gpt-5. 3. Endpoint de API OpenAI (Opcional) – Insira seu endpoint de API personalizado caso esteja usando um modelo auto-hospedado. 4. Chave de API Firecrawl (Opcional) – Recomendado para melhor varredura de sites e documentação. Clique em Enviar para salvar sua configuração. Habilitando o Captain para uma Conta Depois de habilitar o Captain globalmente, ative-o para contas individuais: 1. No Super Admin Console, acesse Contas. 2. Selecione a conta para a qual deseja habilitar o Captain e clique em Editar. 3. Na seção Recursos Premium, ative o Captain. 4. Salve as alterações. Solução de problemas Se o Captain não estiver respondendo conforme o esperado: - Verifique se a chave de API OpenAI está correta e ativa. - Confira se o nome do modelo corresponde a um modelo suportado. - Certifique-se de que sua chave de API Firecrawl é válida caso esteja utilizando a varredura. - Confirme que o Captain está ativado tanto no nível da instalação quanto da conta. Se o Captain ainda não estiver respondendo, revise os logs do servidor Chatwoot tanto dos processos web quanto do worker para identificar quaisquer erros e compartilhe esses detalhes de erro com a equipe de suporte para uma assistência adicional.
O Capitão decide resolver automaticamente ou repassar as conversas
Quando o Captain lida com uma conversa com o cliente, ela não permanece no estado "pendente" para sempre. Após um período de inatividade, o Captain avalia a conversa e decide por um de dois desfechos: resolver (se as necessidades do cliente foram atendidas) ou transferir para um agente humano (se algo ainda está pendente). Este artigo explica como essa decisão funciona e o que você pode esperar. O fluxo de auto-resolução Veja o que acontece depois que o Captain responde a um cliente: 1. A conversa permanece com status Pendente enquanto o Captain está cuidando dela. 2. Se não houver nova atividade por 1 hora, o Captain avalia a conversa. 3. Com base na avaliação, o Captain irá: - Resolver a conversa — envia uma mensagem de resolução e a encerra. - Transferir para um agente humano — reabre a conversa para que sua equipe possa assumi-la. Em ambos os casos, o Captain adiciona uma nota privada explicando por que tomou a decisão. Como o Captain avalia uma conversa O Captain lê toda a conversa e verifica se as necessidades do cliente foram atendidas. A avaliação é intencionalmente conservadora — em caso de dúvida, o Captain mantém a conversa aberta e transfere para um humano. É melhor que um agente encontre uma conversa que talvez não precisasse de atenção do que um cliente tenha sua conversa encerrada enquanto ainda precisa de ajuda. Quando o Captain resolve O Captain resolve uma conversa quando tem confiança de que a dúvida do cliente foi completamente respondida e não resta nada para acompanhar. O cliente não precisa dizer explicitamente "obrigado" ou confirmar — se o Captain deu uma resposta completa e o cliente não fez outra pergunta, isso já é suficiente. Por exemplo, se um cliente perguntar "Quais são o horário de funcionamento?" e o Captain responder com os horários, e o cliente não responder por uma hora — o Captain irá resolver. A resposta era autoexplicativa e completa. O Captain também resolve quando o cliente envia um texto sem sentido ou só palavras soltas sem nenhuma pergunta clara, e o Captain pediu esclarecimento mas não teve resposta. Quando o Captain transfere O Captain transfere para um humano sempre que houver uma chance de que o cliente ainda precise de ajuda. Alguns exemplos comuns: - O Captain sugeriu que o cliente tente algo (como limpar o cache ou atualizar uma configuração) — o cliente pode ainda estar tentando isso. - O Captain apontou o cliente para um link externo ou recurso — ele pode ainda estar consultando. - O cliente pediu algo que o Captain não pôde fazer — mesmo se o Captain explicou o motivo, a necessidade está pendente. - O cliente levantou vários pontos e nem todos foram respondidos. O princípio orientador: se houver qualquer dúvida sobre o cliente ter terminado, o Captain vai preferir manter a conversa aberta para sua equipe. O que o cliente vê Quando o Captain resolve: O cliente recebe uma mensagem de resolução. Você pode personalizar essa mensagem nas configurações do seu assistente Captain — se não configurar, uma mensagem padrão será utilizada. Quando o Captain transfere: Se você definiu uma mensagem de transferência nas configurações do assistente Captain, o cliente verá essa mensagem. O status da conversa muda para Aberta, e sua equipe pode visualizá-la na fila. Se sua equipe estiver fora do horário comercial, o cliente também recebe automaticamente sua mensagem de ausência. Perguntas frequentes O auto-resolve funciona em todos os idiomas? Sim. O Captain avalia as conversas com base no significado e na intenção, independentemente do idioma utilizado. Onde posso ver por que o Captain resolveu ou transferiu uma conversa? Verifique a conversa para uma nota privada do Captain. Ele adiciona uma nota com sua justificativa antes de cada decisão de resolução ou transferência. Não quero que o Captain auto-resolva conversas na minha conta. Entre em contato com nossa equipe de suporte e podemos desativar o auto-resolve para sua conta.
Criando um assistente com o Captain
O Assistente no Captain foi desenvolvido para ajudar a responder perguntas de clientes, fornecer soluções e auxiliar com questões relacionadas ao produto. Ele aprende com os artigos da sua central de ajuda e conversas passadas para fornecer respostas precisas. Quando vinculado a uma caixa de entrada, pode gerenciar conversas diretamente com seus clientes. Como criar um assistente no Captain? Se você possui um plano pago no Chatwoot Cloud, encontrará o menu Captain na barra lateral esquerda. Neste menu, você verá as opções Assistentes, Documentos e FAQs. Clique em Assistentes. Você verá uma página como a mostrada abaixo. Clique no botão Criar um novo Assistente. Aqui estão os campos disponíveis atualmente no formulário para criar um assistente: | Nome do Campo | Descrição | Padrão | Obrigatório | | -- | -- | -- | --| | Nome do Assistente | Este é o nome interno do assistente | -- | Sim | | Descrição | Forneça uma descrição sobre o que o assistente faz. Nota: Isto não é uma instrução para o assistente | -- | Sim| | Nome do Produto | Isto é importante. O assistente é criado em torno do produto, ter o nome do produto ajudará a identificar lacunas de conteúdo e perguntas dos usuários | -- | Sim | | Funcionalidade: Ativar FAQs a partir de conversas resolvidas | Se você ativar esta opção, o Assistente Captain tentará identificar lacunas nos artigos da central de ajuda e sugerirá novas FAQs, consulte o documento de FAQ para mais detalhes | false | Não | | Funcionalidade: Capturar detalhes importantes como memórias das interações com clientes | Se ativado, tentará identificar detalhes importantes das conversas e salvará nas notas | false | Não | Depois de inserir os detalhes, clique em Criar e seu assistente será adicionado à sua conta! Você pode criar múltiplos assistentes para lidar com diferentes casos de uso, se necessário. Como conectar um assistente às caixas de entrada? Adicionar um assistente à sua conta não o conecta automaticamente a todas as caixas de entrada. Você precisará vincular manualmente cada assistente às caixas de entrada relevantes onde ele é necessário. Isso oferece flexibilidade para atribuir assistentes com base em produtos específicos ou segmentos de cliente. Para conectar um assistente, clique no menu de três pontos ao lado dos detalhes do assistente. No menu suspenso, selecione Ver Caixas de Entrada Conectadas. Isso levará você a uma página exibindo todas as caixas de entrada vinculadas ao assistente. A partir daí, você pode gerenciar as conexões. Nota: Cada caixa de entrada pode ser conectada a apenas um assistente por vez. Clique em Conectar uma Nova Caixa de Entrada para ver uma lista de caixas de entrada disponíveis. Selecione uma caixa de entrada da lista e conecte. Pronto! O assistente já está ativo na caixa de entrada. Experimente—envie uma mensagem no chat e veja se ele responde com a saudação inicial. Você pode implantar o assistente em qualquer caixa de entrada disponível, seja chat ao vivo, WhatsApp, Instagram, e-mail ou outros. Pronto! O assistente foi configurado com sucesso. No entanto, neste estágio, ele ainda não possui nenhum conhecimento sobre o seu negócio ou produto. Após a saudação inicial, o assistente tentará transferir a conversa para um agente. Para fornecer contexto sobre seu produto ao assistente, você pode adicionar documentos. Saiba mais sobre documentos neste artigo.
Criando um documento no Captain
Um documento no Captain atua como um recurso de conhecimento para o assistente. Ao vincular seu centro de ajuda ou guias, o Captain pode analisar o conteúdo e auxiliar de forma eficaz nas consultas dos clientes. Atualmente, oferecemos suporte a URLs de sites e arquivos PDF como fontes, mas planejamos expandir para incluir documentos do Notion no futuro. Como criar um documento? No menu lateral, clique na opção Documentos embaixo de Captain. Você verá uma página semelhante à abaixo. Ao clicar em Criar Novo Documento, será exibido um formulário onde você poderá inserir a URL da sua base de conhecimento ou fazer upload de um arquivo PDF. Observe que, no momento, só aceitamos URLs públicas. Depois de inserir a URL da sua base de conhecimento ou centro de ajuda, ou de fazer upload de um documento, clique em Criar para iniciar o processo. O Captain começará a analisar o conteúdo a partir da URL ou documento fornecido, utilizando-o como ponto de partida para reunir informações que podem ajudar a responder perguntas dos clientes de forma eficiente. O Captain irá rastrear sistematicamente todas as páginas vinculadas ao caminho da URL fornecida, buscando artigos, guias e outros recursos associados à URL principal. Por exemplo, se você fornecer uma URL como https://chatwoot.help/user-guide, o Captain analisará todas as URLs que começam com esse caminho. Durante esse processo, ele organiza e indexa as informações, facilitando o acesso ao responder solicitações dos clientes. Esse rastreamento estruturado garante que todo o conhecimento relevante da fonte especificada seja capturado e fique disponível para consulta. Para uploads de PDFs, o Captain irá extrair e analisar o conteúdo de texto do arquivo. Isso é útil para adicionar manuais de produto, guias ou qualquer outra documentação armazenada em PDF à sua base de conhecimento. O documento será gerado, e quaisquer documentos recém-identificados durante o rastreamento também serão adicionados individualmente como documentos separados. Se desejar remover um documento específico que não seja relevante, você pode excluí-lo. Isso também apagará todas as informações associadas que o Captain coletou desse documento, garantindo que ele não seja mais referenciado em nenhuma conversa. Como posso verificar se o conteúdo foi analisado corretamente? Para garantir que o conteúdo foi devidamente analisado, o Captain examina os documentos fornecidos para identificar possíveis perguntas. Em seguida, ele gera uma lista de perguntas frequentes (FAQs) relacionadas ao documento. Ao revisar essas FAQs, você pode verificar se o conteúdo foi processado e interpretado corretamente. Você pode visualizar as FAQs geradas para cada documento. Basta clicar no menu de três pontos do documento e escolher Ver Respostas Relacionadas para acessá-las. Isso exibirá as FAQs relacionadas, conforme mostrado abaixo. Limite de uso Se você não assinou um complemento pago para o Captain, a quantidade de documentos que pode adicionar será limitada. No plano Startups, você pode adicionar até 100 documentos gratuitamente. Para planos superiores, o limite aumenta para 200 documentos gratuitos no plano Business e 300 documentos gratuitos no plano Enterprise.
Como Configurar Ferramentas Personalizadas para o Captain
Custom Tools permitem que o Captain chame suas APIs externas durante conversas — assim ele pode verificar o status do sistema, consultar horários ou buscar dados dos seus próprios serviços sem encaminhar para um agente humano. Quando um cliente faz uma pergunta, o Captain extrai os valores relevantes da conversa, insere-os na requisição à sua API e usa a resposta para formar a sua resposta. Custom Tools está disponível no plano Business e superiores. Criando uma ferramenta Navegue até Captain -> Ferramentas e clique em Criar uma nova ferramenta. Preencha os seguintes campos: Nome da Ferramenta — Um nome curto como "Status do Sistema" ou "Consulta de Horários" (máx. 55 caracteres). Descrição — Indique ao Captain quando usar esta ferramenta. Este é o campo mais importante. Escreva como se estivesse instruindo um agente de suporte: "Verifica o status atual do sistema, incluindo quaisquer incidentes em andamento ou manutenção." Descrições vagas como "API de Status" farão o Captain perder oportunidades de usar a ferramenta. Método — Escolha GET (para buscar dados) ou POST (para enviar dados). URL do Endpoint — A URL da sua API. Use {{ parameter_name }} para inserir valores extraídos da conversa: https://api.yourcompany.com/v1/showtimes?q={{ query }} A URL deve usar HTTPS, ser um hostname (não um endereço IP), e não pode apontar para localhost ou redes privadas. Autenticação — Escolha como sua API autentica as requisições: | Tipo | O que você fornece | |------|-------------------| | Nenhum | Sem autenticação | | Bearer Token | Uma string de token | | Basic Auth | Nome de usuário e senha | | API Key | Um nome de cabeçalho personalizado e valor | As credenciais de autenticação são visíveis apenas para administradores da conta. Parâmetros — Defina o que o Captain deve extrair da mensagem do cliente. Cada parâmetro precisa de um nome, tipo e descrição. Por exemplo: query (String) — "O título do filme ou data que o cliente está perguntando." Template de Requisição (apenas POST) — Um template de corpo JSON usando sintaxe Liquid: { "query": "{{ query }}", "source": "captain" } Template de Resposta — Controla o que o Captain vê da resposta da sua API. Se ficar em branco, o Captain recebe o JSON bruto. Use Liquid para extrair campos relevantes: Status do sistema: {{ response.status }}. {{ response.message }} Use response para acessar o corpo JSON analisado. Templates de resposta ajudam o Captain a focar apenas nos dados relevantes e evitar campos internos como IDs de banco de dados ou informações de debug. Testando sua ferramenta Clique em Testar conexão antes de salvar para verificar se seu endpoint está acessível. O teste mostra o código de status HTTP. Um resultado verde (HTTP 200–299) significa que a conexão e a autenticação estão funcionando. Note que o teste envia a URL sem preencher os valores de parâmetro, então ele apenas verifica se seu endpoint está acessível e se suas credenciais foram aceitas. Se o teste falhar, verifique o seguinte: - 401 Não autorizado — Suas credenciais de autenticação estão incorretas. Verifique o bearer token, chave API ou nome de usuário/senha. - 403 Proibido — Sua API está rejeitando a requisição. Se você exigir verificação de identidade, observe que requisições de teste não incluem cabeçalhos de contato. - 404 Não encontrado — A URL do endpoint está errada. Verifique o caminho e confirme se sua API está em execução. - Timeout — Sua API demorou muito para responder. As ferramentas customizadas têm um timeout de 30 segundos; certifique-se de que seu endpoint responda dentro desse prazo. Contexto enviado em cada chamada de ferramenta Quando o Captain chama sua API, ele inclui cabeçalhos de metadados para que seu backend saiba o contexto: | Cabeçalho | Descrição | |-----------|------------| | X-Chatwoot-Account-Id | O ID da sua conta | | X-Chatwoot-Conversation-Id | O ID da conversa | | X-Chatwoot-Contact-Email | O e-mail do cliente (se disponível) | | X-Chatwoot-Contact-Inbox-Verified | Se a identidade do cliente está verificada por HMAC | Cabeçalhos adicionais incluem X-Chatwoot-Assistant-Id, X-Chatwoot-Tool-Slug, X-Chatwoot-Contact-Id, X-Chatwoot-Contact-Phone e X-Chatwoot-Conversation-Display-Id. Você pode usar esses cabeçalhos para buscar o cliente em seu próprio sistema, registrar quais conversas acionaram chamadas à API e verificar a autenticidade da requisição. Segurança Proteções nativas: - Todos os endpoints devem usar HTTPS - Requisições para faixas de IP privadas, localhost e domínios .local são bloqueadas - Redirecionamentos HTTP não são seguidos - Respostas são limitadas a 1 MB - Credenciais de autenticação são visíveis apenas para administradores Verificação de identidade: Se sua ferramenta retornar dados específicos do cliente (pedidos, faturamento, detalhes de conta), sua API deve verificar o cabeçalho X-Chatwoot-Contact-Inbox-Verified. Sem verificação HMAC ativada no seu inbox, um visitante pode definir qualquer endereço de e-mail no widget de chat. Só retorne dados sensíveis quando este cabeçalho for true. Para ferramentas que retornam dados públicos (horários, status do sistema), essa checagem não é necessária. Prompt injection: Se sua API retornar conteúdo gerado por usuários (avaliações, postagens de fórum), textos maliciosos podem influenciar o comportamento do Captain. Use templates de resposta para extrair apenas campos estruturados, e sanitize conteúdos em sua API. Limites | Limite | Valor | |--------|-------| | Máximo de ferramentas por conta | 15 | | Recomendado | 10 ou menos (um aviso aparece acima de 10) | | Tamanho do nome da ferramenta | 55 caracteres | | Tamanho da resposta | 1 MB máx. | | Timeout da requisição | 30 segundos | Quando usar ferramentas customizadas Ferramentas customizadas são mais indicadas para consultas estruturadas com entradas previsíveis — verificar status do sistema, buscar horários ou consultar registros por ID. Se você já possui uma integração dedicada do Chatwoot para seu caso de uso (ex.: Shopify para e-commerce), use-a em vez disso — integrações dedicadas lidam com buscas, correspondência difusa e sincronização de dados de forma mais confiável do que uma única chamada de API. Exemplos Verificação de Status do Sistema Uma ferramenta simples sem parâmetros — o Captain a aciona quando um cliente pergunta se algo está fora do ar. | Campo | Valor | |-------|-------| | Nome da Ferramenta | Status do Sistema | | Descrição | Verifica o status operacional atual do sistema, incluindo qualquer incidente em andamento ou manutenção programada. Use quando um cliente relatar problemas ou perguntar se o sistema está fora do ar. | | Método | GET | | URL do Endpoint | https://status.yourcompany.com/api/v1/status | | Autenticação | Nenhuma | | Parâmetros | (nenhum) | | Template de Resposta | Status do sistema: {{ response.status }}. {{ response.message }} | Consulta de Sessões / Horários Para empresas que têm horários, tabelas ou listas de eventos — os clientes perguntam o que está disponível e o Captain busca a agenda atual. | Campo | Valor | |-------|-------| | Nome da Ferramenta | Consulta de Horários | | Descrição | Consulta horários de filmes e exibições em cartaz. Use quando um cliente perguntar quais filmes estão passando ou quando um filme específico será exibido. | | Método | GET | | URL do Endpoint | https://api.yourcinema.com/v1/showtimes?q={{ query }} | | Autenticação | Bearer Token | | Parâmetros | query (String, obrigatório) — "O título do filme ou data da sessão que o cliente está perguntando" | | Template de Resposta | {% for show in response.showtimes %}{{ show.title }} — {{ show.date }} às {{ show.time }}{% endfor %} | Ferramentas customizadas funcionam melhor quando as entradas são diretas e a resposta da API é previsível — verificações de status, consultas e outras buscas estruturadas são opções ideais.
Como configurar ferramentas personalizadas para o Captain?
Ferramentas Personalizadas permitem que o Capitão chame suas APIs externas durante conversas — assim ele pode verificar status de garantia, confirmar cobertura de serviço ou buscar dados dos seus próprios serviços sem a necessidade de encaminhar para um atendente humano. Quando um cliente faz uma pergunta, o Capitão extrai os valores relevantes da conversa, insere esses valores na sua requisição de API e usa a resposta para formular a própria resposta. Ferramentas Personalizadas estão disponíveis no plano Business e superiores. Criando uma ferramenta Navegue até Capitão -> Ferramentas e clique em Criar uma nova ferramenta. Preencha os seguintes campos: Nome da ferramenta — Um nome curto como "Consulta de Garantia" ou "Verificação de Área de Atendimento" (máx. 55 caracteres). Descrição — Explique ao Capitão quando usar esta ferramenta. Este é o campo mais importante. Escreva como se estivesse orientando um agente de suporte: "Verifica o status da garantia de um produto pelo número de série." Descrições vagas como "API de Garantia" farão com que o Capitão perca oportunidades de usar a ferramenta. Método — Escolha GET (para buscar dados) ou POST (para enviar dados). URL do endpoint — A URL da sua API. Use {{ parameter_name }} para inserir valores extraídos da conversa: https://api.yourcompany.com/v1/warranty/{{ serial_number }} A URL deve usar HTTPS, deve ser um hostname (não um endereço IP), e não pode apontar para localhost ou redes privadas. Autenticação — Escolha como sua API autentica as requisições: - Nenhuma — Sem autenticação - Token Bearer — Envia seu token no cabeçalho Authorization - Basic Auth — Envia um nome de usuário e senha - API Key — Envia um nome de cabeçalho personalizado e valor (ex: X-API-Key) As credenciais de autenticação são visíveis apenas para administradores da conta. Parâmetros — Defina o que o Capitão deve extrair da mensagem do cliente. Cada parâmetro precisa de um nome, tipo e descrição. Por exemplo: serial_number (String) — "O número de série do produto, localizado na parte de trás do aparelho." Modelo de requisição (apenas POST) — Um template de corpo JSON usando sintaxe Liquid. Modelo de resposta — Controla o que o Capitão verá da resposta da sua API. Se ficar em branco, o Capitão recebe o JSON puro. Use Liquid para extrair campos relevantes, por exemplo: Série {{ response.serial_number }}: {{ response.warranty_status }}. Expira em: {{ response.expiry_date }}. Use response para acessar o corpo JSON já analisado. Modelos de resposta ajudam o Capitão a focar nos dados relevantes e evitar campos internos como IDs de banco de dados ou informações de depuração. Testando sua ferramenta Clique em Testar conexão antes de salvar para verificar se o endpoint está acessível. O teste mostra o código de status HTTP. Um resultado verde (HTTP 200–299) significa que a conexão e autenticação estão funcionando. Note que o teste envia a URL sem preencher os valores dos parâmetros, então só confirma que seu endpoint está acessível e suas credenciais são aceitas. Se o teste falhar, verifique o seguinte: - 401 Não autorizado — Suas credenciais de autenticação estão incorretas. Verifique seu token bearer, chave de API, ou usuário/senha. - 403 Proibido — Sua API está rejeitando a requisição. Se você exige verificação de identidade, note que requisições de teste não incluem cabeçalhos de contato. - 404 Não encontrado — A URL do endpoint está errada. Verifique o caminho e confirme se sua API está em funcionamento. - Timeout — Sua API demorou muito para responder. Ferramentas personalizadas têm um timeout de 30 segundos; certifique-se de que seu endpoint responde dentro desse tempo. Contexto enviado em toda chamada de ferramenta Quando o Capitão chama sua API, ele inclui cabeçalhos de metadados para que seu backend saiba o contexto: - X-Chatwoot-Account-Id — ID da sua conta - X-Chatwoot-Conversation-Id — ID da conversa - X-Chatwoot-Contact-Email — E-mail do cliente (se disponível) - X-Chatwoot-Contact-Inbox-Verified — Se a identidade do cliente tem verificação HMAC - X-Chatwoot-Assistant-Id — O assistente Capitão que está fazendo a chamada - X-Chatwoot-Tool-Slug — O identificador interno da ferramenta - X-Chatwoot-Contact-Id — ID de contato do cliente - X-Chatwoot-Contact-Phone — Telefone do cliente (se disponível) - X-Chatwoot-Conversation-Display-Id — Número de exibição da conversa Você pode usar esses cabeçalhos para localizar o cliente em seu próprio sistema, registrar quais conversas dispararam chamadas de API e verificar a autenticidade das requisições. Segurança Proteções nativas: - Todos os endpoints devem usar HTTPS - Requisições para faixas de IP privadas, localhost e domínios .local são bloqueadas - Redirecionamentos HTTP não são seguidos - Respostas são limitadas a 1 MB - Credenciais de autenticação são visíveis apenas para administradores Verificação de identidade: Se sua ferramenta retorna dados específicos do cliente (pedidos, cobrança, detalhes de conta), sua API deve verificar o cabeçalho X-Chatwoot-Contact-Inbox-Verified. Sem verificação HMAC habilitada na sua caixa de entrada, um visitante poderia definir qualquer e-mail no widget do chat. Só retorne dados sensíveis quando este cabeçalho for true. Para ferramentas que retornam dados públicos esse controle não é necessário. Prompt injection: Se sua API retorna conteúdo gerado por usuários (avaliações, posts de fórum), textos maliciosos podem influenciar o comportamento do Capitão. Use modelos de resposta para extrair apenas campos estruturados, e faça a sanitização do conteúdo na sua API. Limites - Máximo de ferramentas por conta — 15 - Recomendado — 10 ou menos. Um aviso aparece acima de 10; mais ferramentas dificultam a escolha correta pelo Capitão. - Comprimento do nome da ferramenta — 55 caracteres - Tamanho da resposta — 1 MB máx. - Tempo limite da requisição — 30 segundos Quando usar ferramentas personalizadas Ferramentas personalizadas são mais indicadas para consultas estruturadas com entradas previsíveis — verificações de status do sistema, busca de agendas, ou busca de registros por ID. Se você já tem uma integração dedicada do Chatwoot para seu caso de uso (ex: Shopify para e-commerce), dê preferência a ela — integrações dedicadas lidam com buscas, correspondências aproximadas e sincronização de dados com mais confiabilidade do que uma chamada API única. Exemplos Consulta de Garantia Quando um cliente pergunta se o produto ainda está em garantia, o Capitão pode verificar usando o número de série. - Nome da ferramenta: Consulta de Garantia - Descrição: Verifica o status da garantia de um produto pelo número de série. Use quando um cliente perguntar se o produto está coberto, quando expira a garantia ou que tipo de cobertura ele tem. Verificação de Área de Atendimento Para empresas que atuam em regiões específicas — clientes perguntam se o atendimento está disponível no local deles. - Nome da ferramenta: Verificação de Área de Atendimento - Descrição: Verifica se serviço ou entrega está disponível em determinada área usando o CEP ou nome da cidade do cliente. Ferramentas Personalizadas funcionam melhor quando as entradas são diretas e a resposta da API é previsível — verificações de status, consultas e outras buscas estruturadas são ideais para esse recurso.