Documentazione di riferimento completa per tutte le API della piattaforma Knowledge Base.
Utilizza il riferimento API quando conosci l'operazione che desideri implementare e hai bisogno dell'endpoint corrente, dei parametri, degli schemi di richiesta e risposta e delle informazioni di stato.
Apri il riferimento API
Utilizza il riferimento Swagger come fonte autorevole per le definizioni degli endpoint correnti e i dettagli di implementazione.
Cosa puoi trovare nel riferimento API
Il riferimento API fornisce dettagli di implementazione per le operazioni disponibili, inclusi:
- Metodi HTTP e percorsi degli endpoint.
- Parametri di richiesta.
- Schemi di richiesta e risposta.
- Informazioni di risposta e stato.
Le API disponibili coprono aree funzionali come:
- Raccolte e accesso alle raccolte.
- Documenti e elaborazione documenti.
- Inferenza IA.
- Allegati.
- Tag dei documenti.
- Utenti e organizzazioni.
- feedback.
- Impostazioni.
- Analytics e reportistica.
- Integrazioni bot.
Utilizza Introduzione all'API Knowledge Base se hai bisogno di un'introduzione al modello di risorsa API, al ciclo di vita dell'elaborazione dei documenti, al comportamento di inferenza o al flusso di richieste tipico.
Risoluzione dei problemi delle richieste API
Le risposte API includono un'intestazione di risposta X-Request-ID che identifica la richiesta nei servizi Knowledge Base.
Acquisisci l'X-Request-ID quando risolvi problemi di una richiesta non riuscita o contatti l'assistenza.Inoltre, mantieni lo stato HTTP, i dettagli della risposta, l'endpoint e l'orario approssimativo della richiesta.
