Documentazione API di Vulgate
Benvenuto nella documentazione API di Vulgate. Vulgate è una piattaforma di intelligenza documentale che ti permette di ingerire, cercare e interagire con le tue librerie di documenti attraverso una potente API.
Carica e processa documenti di qualsiasi formato — PDF, immagini, audio e altro — poi interrogali con ricerca semantica o per parole chiave, oppure conduci conversazioni basate sull’IA fondate sui tuoi contenuti con citazioni complete delle fonti.
L’API è progettata per essere compatibile con OpenAI, così puoi integrarla con qualsiasi SDK esistente che supporti l’interfaccia Chat Completions.
Autenticazione
Tutti gli endpoint API richiedono l’autenticazione tramite un token Bearer nell’intestazione Authorization:
Authorization: Bearer <la-tua-chiave-api>Configurazione della chiave API
Configura la tua chiave API come variabile d’ambiente. Questo approccio semplifica l’utilizzo dell’API eliminando la necessità di includere la chiave in ogni richiesta. Inoltre, migliora la sicurezza riducendo al minimo il rischio di includere inavvertitamente la chiave nel tuo codice.
Nel terminale di tua scelta:
export VULGATE_API_KEY=<la-tua-chiave-api>Oppure, nel file .env del tuo progetto:
VULGATE_API_KEY=<la-tua-chiave-api>Sostituisci <la-tua-chiave-api> con la tua chiave API effettiva, che puoi generare nella dashboard del tuo team andando su Impostazioni > API. Consulta la Console API per i dettagli completi sulla gestione delle chiavi.
Sezioni
- Console API - Gestisci le tue chiavi API e monitora l’utilizzo.
- API di Ingestione - Scopri come caricare e ingerire documenti.
- API di Ricerca - Ricerca semantica e per parole chiave nelle tue librerie di documenti.
- API di Chat - Conversazioni basate sull’IA e fondate sui tuoi documenti.