Base di conoscenza

La base di conoscenza è il nucleo delle competenze dell’agente AI: contiene tutte le informazioni che l’AI usa per rispondere alle domande. Questi endpoint permettono di gestirne la configurazione e monitorare lo stato di elaborazione dei contenuti.

La base di conoscenza attinge agli Articoli che crei, importi dai siti web o carichi come file. Non è necessario riaddestrare: ogni articolo creato, aggiornato o eliminato viene elaborato automaticamente in background e diventa effettivo nelle conversazioni appena l’elaborazione termina.

Recuperare le impostazioni

Recupera la configurazione della base di conoscenza.

Ambito: 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()

Risposta 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
}

Campo	Descrizione
one_word_description stringa	Nome dell’agente AI. Dashboard: Identità > Personalità AI > Nome
short_description stringa	Prompt di sistema / Prompt principale. Dashboard: Identità > Personalità AI > Prompt principale
ai_commands array di stringhe	Linee guida comportamentali, una per elemento dell’array. Dashboard: Identità > Personalità AI > Linee guida. Fino a 250 elementi, 5.000 caratteri per elemento e 10.000 caratteri complessivi.
pending_embed_count intero	Articoli ancora in elaborazione. 0 indica che tutto ciò che hai inviato è disponibile
failed_embed_count intero	Articoli la cui elaborazione non è riuscita. Riprova con Riprovare gli articoli non elaborati

Attendere la disponibilità dei contenuti

Interroga periodicamente questo endpoint dopo una scrittura e attendi che pending_embed_count raggiunga 0. Lo stato di ogni articolo è disponibile anche nel campo embed_state degli Articoli.

Nota

Questi tre campi (one_word_description, short_description, ai_commands) sono condivisi con Impostazioni del chatbot. Un aggiornamento tramite uno qualsiasi dei due endpoint modifica gli stessi dati sottostanti.

Aggiornare le impostazioni

Ambito: write_all

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

Corpo della richiesta

Parametro	Descrizione
one_word_description stringa	Nome dell’agente AI
short_description stringa	Prompt di sistema / Descrizione dell’agente AI. L’API accetta fino a 25.000 caratteri in ogni piano; l’editor nell’app applica il limite del piano, che parte da 15.000. Un valore troppo lungo restituisce 422.
ai_commands array di stringhe	Linee guida AI, una per elemento dell’array. Fino a 250 elementi, 5.000 caratteri per elemento e 10.000 caratteri complessivi. Un valore troppo lungo restituisce 422.

Come vengono salvate le linee guida

Ogni elemento dell’array è una linea guida, salvata esattamente come la invii. La punteggiatura, inclusi i punti e virgola, viene preservata. In precedenza una linea guida contenente ; veniva restituita come due linee guida separate: se evitavi i punti e virgola per aggirare il problema, non è più necessario.

In precedenza questo endpoint accettava linee guida di qualsiasi lunghezza. I limiti indicati sopra vengono ora applicati anche qui e coincidono esattamente con quelli delle Impostazioni del chatbot.

Ometti ai_commands oppure invia null per lasciare invariate le linee guida. Invia [] per cancellarle.

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

Risposta 200 OK: restituisce le impostazioni aggiornate della base di conoscenza, con lo stesso schema di Recuperare le impostazioni.

Riprovare gli articoli non elaborati

Rielabora ogni articolo la cui elaborazione non è riuscita. Gli articoli già disponibili o ancora in elaborazione non vengono modificati; la chiamata può essere ripetuta in sicurezza.

Gli articoli non elaborati vengono ritentati anche automaticamente, quindi questo endpoint serve solo quando non vuoi attendere.

Ambito: 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>"},
)

Risposta 200 OK

{
  "retried": 2
}

Campo	Descrizione
retried intero	Numero di articoli non elaborati inseriti in coda per una nuova elaborazione

Riaddestrare la base di conoscenza Deprecato

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

Il riaddestramento non esiste più: le modifiche agli articoli vengono elaborate automaticamente. Questo endpoint viene mantenuto solo per far funzionare le integrazioni esistenti: accetta la richiesta, non esegue operazioni e restituisce 200 OK.

Puoi rimuovere la chiamata dalla tua integrazione. Se interrogavi periodicamente lo stato fino al termine del riaddestramento, attendi invece che pending_embed_count raggiunga 0 in Recuperare le impostazioni.

---