Voltar ao Painel

Documentação

Aprenda a usar o Asyntai

Integração com o Wagtail

Um assistente de IA que responde a perguntas no seu site Wagtail

Ir para o painel

Visão Geral

O pacote do Wagtail coloca um assistente de IA no seu site. Um botão de chat fica no canto de cada página, os visitantes fazem a pergunta com as suas próprias palavras, e a resposta vem do seu próprio conteúdo: o seu site, os seus documentos enviados e os seus artigos de ajuda.

Aviso sobre a IA: As respostas no seu site são geradas por IA. Por vezes podem estar erradas ou incompletas. Verifique-as antes de confiar nelas, sobretudo em decisões importantes.

Como funciona

O pacote junta um middleware que coloca um pequeno script mesmo antes da etiqueta de fecho body de cada página. Esse script espera a página acabar de carregar e depois busca o widget de chat no Asyntai, por isso o seu site é desenhado primeiro e a velocidade da página não muda. O seu servidor nunca fala com o Asyntai; só o navegador do visitante fala.

Não muda nada nos seus modelos. O middleware deixa a administração do Wagtail em paz, e deixa em paz tudo o que não seja uma página HTML.

Requisitos

  • Uma conta Asyntai. O plano gratuito chega para começar.
  • Um site Wagtail, versão 5.2 ou mais recente, com Django 4.2 ou mais recente e Python 3.9 ou mais recente.
  • Acesso ao código desse site, porque instala um pacote Python.

Instalação

Siga estes passos para adicionar o Asyntai ao seu site Wagtail:

1

Instale o pacote

Instale-o a partir do Python Package Index, no mesmo ambiente do seu site:

pip install wagtail-ai-chatbot
2

Junte-o às suas definições

Junte a aplicação e o módulo de definições do Wagtail a INSTALLED_APPS, e o middleware no topo de MIDDLEWARE:

INSTALLED_APPS = ["wagtail_asyntai", "wagtail.contrib.settings", ...]
MIDDLEWARE = ["wagtail_asyntai.middleware.AsyntaiWidgetMiddleware", ...]
3

Corra a migração

Isto cria a tabela que guarda as suas definições:

python manage.py migrate wagtail_asyntai
4

Cole o ID do seu widget

In the Wagtail admin, open Settings and then Asyntai chat assistant. Paste your widget ID and select Save. You find the ID in your Asyntai Dashboard under Setup & Integration. You can paste the whole snippet; the package keeps only the ID.

Dica: Acrescente os seus documentos, as suas perguntas e respostas e as suas instruções no painel Asyntai antes de publicar, para que o assistente responda bem logo ao primeiro visitante.

Configurações

  • ID do widget: o chat está ligado enquanto este campo tiver um ID válido, e desligado quando está vazio.
  • Mostrar o chat só a visitantes sem sessão: os utilizadores com sessão iniciada nunca veem o chat. Útil quando o assistente está lá para responder a quem ainda não se registou.
  • Endereço do script do widget: deixe este valor como está, a não ser que o apoio do Asyntai lhe peça para o mudar.

As definições são por site, por isso um projeto que serve vários sites a partir de uma instalação Wagtail pode dar a cada site o seu próprio assistente.

Definições no seu ficheiro de definições

Um projeto que guarda a configuração em variáveis de ambiente pode saltar a administração e pôr os valores no código. Se ambos estiverem preenchidos, ganha a administração.

ASYNTAI_WIDGET_ID = "asyntai_ab12cd34"

Há mais três valores opcionais: ASYNTAI_SHOW_TO_ANONYMOUS_ONLY, ASYNTAI_SCRIPT_URL e ASYNTAI_SKIP_PREFIXES. O último nomeia os caminhos que o widget nunca toca, e precisa dele quando a sua administração não está em /admin/.

Colocar o widget à mão

Se preferir escolher o sítio, deixe o middleware de fora e ponha a etiqueta no seu modelo base. A etiqueta e o middleware nunca disparam os dois, por isso pode ficar com ambos.

{% load asyntai %} ... {% asyntai_widget %}

O que o assistente consegue fazer

  • Responder às perguntas dos visitantes de imediato, 24 horas por dia, em cada página
  • Responder em mais de 80 idiomas, detetados automaticamente a partir da pergunta
  • Ficar aberto enquanto o visitante passa de página em página
  • Usar os seus próprios documentos, perguntas frequentes e instruções para dar respostas precisas

Planos e preços

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

Desinstalação

Apague o campo do ID do widget para desligar o chat. Para remover o pacote, tire o middleware e a aplicação das suas definições e desinstale-o com o pip.

Código-fonte

The package is free and open source, under the MIT licence. You can read every line on GitHub.

Precisa de Ajuda?

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