Voltar ao Painel

Documentação

Aprenda a usar o Asyntai

Integração com o GitBook

Deixe o seu assistente de IA responder a partir da sua documentação do GitBook

Ir para o painel

Visão Geral

A integração com o GitBook transforma a sua documentação em conhecimento para o seu assistente de IA. Você instala o Asyntai num espaço do GitBook e as páginas desse espaço passam a ser o material com que o seu assistente responde: no seu site, no seu centro de ajuda e em todos os outros canais que utiliza.

O GitBook é uma fonte de conhecimento, não um canal. Você não conversa com o assistente dentro do GitBook. A sua documentação torna-se o material com que o assistente responde em todos os outros lugares.

Como funciona

O Asyntai corre dentro do GitBook como uma integração instalada. Lê as páginas do espaço onde o instalou, incluindo as páginas aninhadas dentro de grupos, e envia o texto para a sua base de conhecimento. Apenas lê. Nunca edita, cria nem elimina nada no GitBook.

Requisitos

  • Uma conta Asyntai. O plano gratuito chega para começar.
  • Uma organização do GitBook com pelo menos um espaço que tenha texto real.
  • Permissão para instalar uma integração nessa organização.

Instalação

Siga estes passos para ligar a sua documentação do GitBook:

1

Encontrar o Asyntai no GitBook

No GitBook, abra Integrações e escolha Asyntai. Selecione Instalar.

2

Escolher os seus espaços

Instale-o em todos os espaços, ou escolha os espaços que o assistente deve usar. Só os espaços que escolher são lidos.

3

Autorize a conexão

Selecione Autorizar. Você entra no Asyntai e escolhe a qual dos seus sites pertencem as páginas. Isto só tem de ser feito uma vez.

4

Aguardar a importação

O Asyntai lê as páginas e adiciona-as à sua base de conhecimento. Isto demora alguns segundos num espaço pequeno e alguns minutos num grande. O seu assistente responde com elas assim que terminar.

Dica: Instale-o nos espaços sobre os quais os seus clientes mais perguntam: a documentação de produto, o centro de ajuda e as perguntas frequentes. Pode adicionar outras fontes a qualquer momento no seu painel do Asyntai.

O que é importado

  • O título e o texto de cada página nos espaços que escolheu
  • Títulos, parágrafos, listas, citações e blocos de código, pela ordem em que aparecem
  • As páginas aninhadas dentro de grupos, por mais fundo que estejam
  • Até 1.000 páginas por espaço

O que fica de fora

  • Qualquer espaço onde não instalou a integração
  • Os próprios grupos, que são pastas e não têm texto próprio
  • As ligações para outros sites, que são referências e não conteúdo
  • As páginas quase vazias, porque não acrescentam nada a uma resposta

Manter atualizado

Não tem de fazer nada. Sempre que edita o conteúdo de um espaço ou junta um pedido de alteração, o Asyntai atualiza as páginas afetadas no lugar. Nada fica duplicado, e uma página que elimine no GitBook desaparece também da sua base de conhecimento.

Exemplos de Casos de Uso

  • Documentação de produto: os visitantes fazem uma pergunta em vez de lerem o manual
  • Centro de ajuda: as respostas que escreveu uma vez servem cada visitante, na sua própria língua
  • Referência da API: os programadores perguntam como se comporta um ponto final e obtêm a resposta a partir da sua própria referência
  • Manual interno: a sua equipa faz uma pergunta em vez de procurar em páginas aninhadas

Privacidade

O Asyntai pede ao GitBook apenas acesso de leitura, e só aos espaços onde o instalou. Nunca escreve na sua documentação. Pode terminar a ligação a qualquer momento desinstalando a integração no GitBook, ou desligando-a no seu painel do Asyntai, o que para de imediato o envio das páginas.

Planos e preços

A integração com o GitBook está disponível em todos os planos do Asyntai, incluindo o gratuito. Cada plano inclui um limite mensal de mensagens partilhado por todos os seus canais e integrações. Ver preços.

Desinstalação

Abra Integrações no GitBook e desinstale o Asyntai. As páginas deixam de ser enviadas de imediato. Também pode desligá-la no seu painel do Asyntai, o que corta a ligação do nosso lado.

Precisa de Ajuda?

If you have any questions or run into issues, contact us at [email protected].