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 seguir el estado de procesamiento de su contenido.

La Base de Conocimiento se nutre de los Artículos que creas, importas de sitios web o subes como archivos. No hay paso de reentrenamiento: cada artículo que creas, actualizas o eliminas se procesa automáticamente en segundo plano y surte efecto en las conversaciones en cuanto termina.

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"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

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
pending_embed_count integer	Artículos que aún se están procesando. 0 significa que todo lo que has enviado está en vivo
failed_embed_count integer	Artículos cuyo procesamiento falló. Reintenta con Retry Failed Articles

Esperar a que el contenido entre en vigor

Consulta este endpoint después de una escritura y espera a que pending_embed_count llegue a 0. El estado por artículo también está disponible en el campo embed_state de Articles.

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).

Retry Failed Articles

Vuelve a procesar todos los artículos cuyo procesamiento falló. Los artículos que ya están en vivo o todavía en curso no se tocan, y la llamada se puede repetir sin problema.

Los artículos fallidos también se reintentan automáticamente, así que este endpoint solo hace falta cuando no quieres esperar a que ocurra.

Scope: write_all

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

Shell

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

Python

import requests

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

Response 200 OK

{
  "retried": 2
}

Field	Description
retried integer	Cuántos artículos fallidos se pusieron en cola para volver a procesarse

Retrain Knowledge Base Deprecated

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

El reentrenamiento ya no existe: los cambios en los artículos se procesan automáticamente. Este endpoint se mantiene solo para que las integraciones existentes sigan funcionando: acepta la petición, no hace nada y devuelve 200 OK.

Puedes eliminar la llamada de tu integración. Si consultabas hasta que terminara el reentrenamiento, espera en su lugar a que pending_embed_count llegue a 0 en Get Settings.

---