Knowledge Base

A Base de Conhecimento é o núcleo da expertise do seu Agente de IA — ela contém todas as informações que sua IA usa para responder perguntas. Estes endpoints permitem gerenciar a configuração da Base de Conhecimento e disparar o retreinamento após mudanças de conteúdo.

A Base de Conhecimento se baseia nos Articles que você cria, importa de sites ou envia como arquivos. Após fazer alterações nos artigos, você precisa retreinar a Base de Conhecimento para que as atualizações tenham efeito nas conversas.

Get Settings

Recupere a configuração da sua Base de Conhecimento.

Scope: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/

Shell

curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

Response 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "retrain_state": null
}

Field	Description
one_word_description string	Nome do Agente de IA. Dashboard: Identity > Profile > AI Agent Name
short_description string	System prompt / descrição do Agente de IA. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Diretrizes de comportamento. Dashboard: Identity > Conversation Style > AI Guidelines
retrain_state string or null	Status de treinamento atual: null (atualizado ou nunca treinado), "to_be_retrained", "in_progress", "up_to_date" ou "failed"

Nota

Esses três campos (one_word_description, short_description, ai_commands) são compartilhados com Chatbot Settings. Atualizar por qualquer um dos endpoints modifica os mesmos dados subjacentes.

Update Settings

Scope: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

Request Body

Parameter	Description
one_word_description string	Nome do Agente de IA
short_description string	System prompt / descrição do Agente de IA
ai_commands array of strings	AI Guidelines

Shell

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

Python

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

Response 200 OK — Retorna as configurações da Base de Conhecimento atualizadas (mesmo schema de Get Settings).

Retrain Knowledge Base

Dispara um retreinamento assíncrono da Base de Conhecimento.

Scope: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retrain/ \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retrain/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

Response 202 Accepted

Nota

O retreinamento é necessário após publicar alterações em artigos para garantir que o Agente de IA use o conteúdo mais recente. Você pode acompanhar o progresso pelo campo retrain_state em Get Settings — ele muda de "to_be_retrained" para "in_progress" e depois para "up_to_date".

---