Knowledge Base

La Base de Conocimiento es el núcleo de la pericia de tu Agente de IA: contiene toda la información que tu IA usa para responder preguntas. Estos endpoints te permiten gestionar la configuración de la Base de Conocimiento y disparar el reentrenamiento tras cambios de contenido.

La Base de Conocimiento se nutre de los Artículos que creas, importas de sitios web o subes como archivos. Después de hacer cambios en los artículos, necesitas reentrenar la Base de Conocimiento para que las actualizaciones surtan efecto en las conversaciones.

Get Settings

Recupera la configuración de tu Base de Conocimiento.

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	Nombre del Agente de IA. Dashboard: Identity > Profile > AI Agent Name
short_description string	System prompt / descripción del Agente de IA. Dashboard: Identity > Profile > AI Agent Description
ai_commands array of strings	Directrices de comportamiento. Dashboard: Identity > Conversation Style > AI Guidelines
retrain_state string or null	Estado actual del entrenamiento: null (actualizado o nunca entrenado), "to_be_retrained", "in_progress", "up_to_date" o "failed"

Nota

Estos tres campos (one_word_description, short_description, ai_commands) se comparten con Chatbot Settings. Actualizar mediante cualquiera de los dos endpoints modifica los mismos datos subyacentes.

Update Settings

Scope: write_all

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

Request Body

Parameter	Description
one_word_description string	Nombre del Agente de IA
short_description string	System prompt / descripción del 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 — Devuelve la configuración de la Base de Conocimiento actualizada (mismo esquema que Get Settings).

Retrain Knowledge Base

Dispara un reentrenamiento asíncrono de la Base de Conocimiento.

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

El reentrenamiento es necesario después de publicar cambios en los artículos para garantizar que el Agente de IA use el contenido más reciente. Puedes monitorizar el progreso mediante el campo retrain_state en Get Settings: cambia de "to_be_retrained" a "in_progress" y luego a "up_to_date".

---