Assistente

Ajude seus usuários a ter sucesso com seu produto e a encontrar respostas mais rapidamente

O Assistente é ativado automaticamente nos planos Pro e Custom.

Sobre o Assistente

O Assistente responde a perguntas sobre sua documentação por meio de consultas em linguagem natural. Ele é incorporado diretamente ao seu site de documentação, oferecendo aos usuários acesso imediato a ajuda contextual.

O Assistente usa RAG agentic (geração aumentada por recuperação) com chamadas de ferramentas, alimentado pelo Claude Sonnet 4. Quando os usuários fazem perguntas, o Assistente:

• Pesquisa e recupera conteúdo relevante da sua documentação para fornecer respostas precisas.
• Cita fontes e oferece links navegáveis que levam os usuários diretamente às páginas referenciadas.
• Gera exemplos de código copiáveis para ajudar os usuários a implementar soluções a partir da sua documentação.

Cada mensagem enviada ao Assistente conta para a cota de mensagens do seu plano. Se você exceder essa cota, mensagens adicionais gerarão cobranças excedentes. Você pode definir limites de gastos ou desativar o Assistente ao atingir sua cota de mensagens.

Você pode visualizar o uso do Assistente no seu painel para entender o comportamento dos usuários e a eficácia da documentação. Exporte e analise os dados de consultas para ajudar a identificar:

• Perguntas frequentes que podem precisar de melhor cobertura.
• Lacunas de conteúdo em que os usuários têm dificuldade em encontrar respostas.
• Tópicos populares que podem se beneficiar de conteúdo adicional.

Configurando o Assistente

O Assistente vem ativado por padrão nos planos Pro e Custom. Você pode gerenciá-lo no seu dashboard, incluindo ativá-lo ou desativá-lo, configurar o tratamento das respostas e definir um limite de gastos.

Status do Assistente

Alterne o status para ativar ou desativar o Assistente no seu site de documentação.

Desvio do Assistente

Permita que o assistente encaminhe perguntas sem resposta para sua equipe de suporte. Forneça um endereço de e-mail que o assistente informará aos usuários que fizerem perguntas às quais não conseguir responder.

Pesquisar sites

A pesquisa no site está em beta. Para habilitá-la no seu site de documentação, entre em contato com nossa equipe de vendas.

Configure os sites que o Assistente pode consultar para obter contexto adicional ao responder perguntas.

• Os sites devem ser publicamente acessíveis.
• Sites que exigem JavaScript para carregar não são compatíveis.

Você pode usar a seguinte sintaxe de filtragem ao configurar sites externos:

• Filtragem por domínio
  • example.com: Pesquisar apenas o domínio example.com
  • docs.example.com: Pesquisar apenas o subdomínio docs.example.com
  • *.example.com: Pesquisar todos os subdomínios de example.com
• Filtragem por caminho
  • docs.example.com/api: Pesquisar todas as páginas no subcaminho /api
• Vários padrões
  • Adicione várias entradas para segmentar diferentes seções dos sites

Limite de gastos

Defina um limite de gastos para controlar o que acontece se você atingir sua franquia de mensagens. Por padrão, o Assistente continuará respondendo às perguntas dos usuários após você atingir sua franquia de mensagens, o que gera cobranças excedentes.

Na aba Billing da página Assistant Configurations, você pode definir um limite de gastos para mensagens do Assistente além da sua franquia. Quando você atinge seu limite de gastos, o Assistente é desativado até que sua franquia de mensagens seja redefinida.

Você também pode configurar alertas de uso para receber um e-mail quando atingir uma determinada porcentagem do seu limite de gastos.

Usando o Assistente

Os usuários podem acessar o Assistente de três maneiras:

• Atalhos de teclado: ? ou Command + I (Ctrl + I no Windows)
• Botão do Assistente ao lado da barra de pesquisa
• URLs com ?assistant=open anexado abrirão o Assistente quando a página carregar. Por exemplo, https://mintlify.com/docs?assistant=open.

Todos os métodos abrem um painel de chat no lado direito da sua documentação. Os usuários podem fazer qualquer pergunta e o Assistente buscará uma resposta na sua documentação. Se nenhuma informação relevante for encontrada, o Assistente informará que não pode responder à pergunta.

Tornando o conteúdo adequado para ingestão por IA

Estruture sua documentação para ajudar o Assistente a fornecer respostas precisas e relevantes. Uma organização clara e um contexto abrangente beneficiam tanto os leitores humanos quanto a compreensão da IA.

Estrutura e organização

• Use marcação semântica.
• Escreva títulos descritivos para as seções.
• Crie uma hierarquia lógica de informações.
• Use formatação consistente em toda a documentação.
• Inclua metadados completos no frontmatter da página.
• Divida blocos longos de texto em parágrafos mais curtos.

Contexto

• Defina termos e siglas específicas quando forem apresentadas pela primeira vez.
• Forneça conteúdo conceitual suficiente sobre recursos e procedimentos.
• Inclua exemplos e casos de uso.
• Faça referências cruzadas a tópicos relacionados.
• Adicione Páginas ocultas com contexto adicional que os usuários não precisam, mas que o Assistente pode consultar.

Exportando e analisando consultas

Revise e exporte consultas do seu painel para entender como as pessoas interagem com sua documentação e identificar oportunidades de melhoria. Algumas formas de como a análise de consultas pode ajudar você a aprimorar sua documentação:

• Identifique lacunas de conteúdo em que consultas frequentes recebem respostas insuficientes.
• Descubra padrões de comportamento dos usuários e necessidades de informação comuns a partir de temas e tendências nas consultas.
• Priorize páginas com alto tráfego para melhorar precisão e qualidade.

Você pode explorar consultas no seu painel, mas, para obter insights mais robustos, recomendamos exportar um arquivo CSV com suas consultas, respostas e fontes para analisar com sua ferramenta de IA preferida.

1. Acesse a página do Assistente no seu painel.
2. Selecione Export to CSV.
3. Analise os dados exportados usando sua ferramenta preferida.

Exemplos de prompts para análise

• Resuma os temas mais comuns das consultas.
• Liste as consultas que não tiveram fontes citadas.
• Encontre padrões em interações malsucedidas.