docs · setup para júnior

Se você tem o código do bot em mãos, siga isso.

Seis passos, um de cada vez, sem assumir que você é sênior. Antes de começar, você precisa de: Python instalado, acesso à pasta do projeto do bot, e permissão pra instalar pacote (pip install).

  1. 1Crie sua chave de conexão

    Entre no aferiq → menu Conectar → o guia cria a chave e oferece "Baixar .env". Baixe — o arquivo já vem com a linha AFERIQ_DSN pronta. A parte secreta da chave só aparece uma vez.

  2. 2Coloque o .env na raiz do projeto do bot

    A raiz é a pasta onde você roda o comando que inicia o bot. Se já existe um .env lá, copie só a linha AFERIQ_DSN pra dentro dele (não substitua o arquivo).

    # o arquivo .env deve conter uma linha assim:
    AFERIQ_DSN=https://rg_pk_live_SUACHAVE@www.aferiq.com.br/api/v1/traces
  3. 3Instale o pacote

    No terminal, dentro da pasta do projeto (se o projeto usa venv/poetry, ative antes):

    pip install aferiq-eval
  4. 4Cole 3 linhas no arquivo que inicia o bot

    Procure o arquivo principal (geralmente main.py, app.py ou bot.py) e cole no TOPO, junto dos outros imports. A ordem importa: o import do openai/anthropic vem ANTES do aferiq.start().

    import openai          # ou anthropic — antes do start()
    import aferiq
    aferiq.start()         # lê o AFERIQ_DSN do .env automaticamente
  5. 5Rode o bot e faça uma pergunta

    Inicie o bot do jeito que você sempre inicia e mande uma mensagem de verdade pra ele responder. Cada resposta vira uma "conversa registrada" no aferiq.

  6. 6Veja a caixa verde no painel

    Abra o dashboard do aferiq → Conversas. A primeira conversa aparece em até ~30 segundos e o painel confirma "Conversas fluindo". Pronto — seu bot está monitorado.

Se deu erro: as 5 causas mais comuns

Nada aparece no painel

Causa provável: O .env não está na pasta certa, ou o bot não recarrega o .env. Como resolver: Confirme que o .env está na MESMA pasta de onde você roda o bot e reinicie o processo.

Erro 401 ao enviar

Causa provável: A chave foi colada com pedaço faltando (ela é longa). Como resolver: Baixe o .env de novo em API keys — não digite a chave na mão.

ModuleNotFoundError: aferiq

Causa provável: O pip instalou em outro Python (sem venv ativado). Como resolver: Ative o ambiente do projeto (source venv/bin/activate ou poetry shell) e rode o pip install de novo.

start() roda mas nada é capturado

Causa provável: O import openai veio DEPOIS do aferiq.start(). Como resolver: Mova o import openai/anthropic pra ANTES da linha aferiq.start().

Não sei se deu certo

Causa provável: Falta um diagnóstico. Como resolver: Rode `aferiq doctor` no terminal — ele confere chave, endpoint e conexão e diz exatamente o que falta.

Travou mesmo assim? hi@aferiq.com.br — manda o output do aferiq doctor que a gente destrava junto.