RAG Search

RAG Search è il servizio API basato sulla tecnologia Retrieval-Augmented Generation (RAG) che consente di effettuare ricerche intelligenti all’interno dei tuoi dati e documenti, individuando le informazioni più rilevanti in tempo reale e a partire da una query. Grazie a un sistema avanzato potenziato dall’intelligenza artificiale, il servizio restituisce uno o più estratti di testo rilevanti, garantendo risposte pertinenti e sicure, senza alcun rischio di fuga di dati sensibili.

La tecnologia RAG-as-a-Service di Openapi permette quindi alle aziende di accedere, elaborare e generare risposte accurate basate sui propri dati proprietari. Il nostro servizio colma il divario tra i Large Language Model (LLM) e la conoscenza specifica dell’organizzazione, eliminando le “allucinazioni” e garantendo risposte affidabili, coerenti e sempre contestualizzate.

Con RAG-as-a-Service puoi integrare in modo semplice e scalabile le funzionalità di RAG nelle tue applicazioni, senza dover gestire infrastrutture complesse o pipeline di dati. Il servizio consente di aggiungere e indicizzare automaticamente i tuoi dati strutturati, permettendo al modello LLM di accedere in tempo reale a informazioni aggiornate e pertinenti. In questo modo, Openapi combina la potenza dei modelli linguistici avanzati con la ricerca contestuale sui dati aziendali, offrendo risposte precise, aggiornate e realmente basate sulla tua conoscenza proprietaria.

Oltre a RAG Search, Openapi dispone di altri due servizi per la ricerca dei documenti: Search with Answer (che consente di ottenere una risposta in linguaggio naturale generata dall’AI) e Conversation (che permette di avviare nuove conversazioni, con risposte contestualizzate, a partire da conversazioni precedenti). Tutti e tre sono validi a livello globale.

Perché il servizio RAG Search funzioni correttamente e la risposta generata sia il quanto più possibile pertinente e coerente con la richiesta, è necessario seguire tre passaggi:

Con indicizzazione si intende il processo che consente di recuperare rapidamente le informazioni più rilevanti in risposta a una query. Se si vogliono ottenere risposte contestuali e accurate, è fondamentale avviare l’indicizzazione ogni volta che si effettua una modifica al RAG (caricamento o eliminazione di un documento).

Crea un nuovo RAG

Il primo passo, come accennato, presuppone la creazione di un nuovo RAG, vuoto, all’interno del quale si potrà poi procedere al caricamento di uno o più documenti. Questo è possibile attraverso l’endpoint POST /rag.

ESEMPIO RICHIESTA

Nella richiesta vanno indicati:

{
  "name": "RAGTest",
  "options": {
    "ocr": false,
    "autoIndexingIntervalHours": 0
  },
  "callback": {
    "method": "POST",
    "field": "string",
    "url": "https://www.mysite.it/callback.php",
    "data": {}
  }
}

ESEMPIO RISPOSTA

La risposta restituisce dettagli del RAG, come ID e nome, stato, opzioni, impostazioni (es. OCR disattivato), numero di documenti totali e indicizzati, date di creazione, aggiornamento, ultima indicizzazione.

{
  "data": {
    "id": "68947e1e0dab7e743108abfb",
    "name": "RAGTest",
    "state": "ready",
    "options": {
      "ocr": false,
      "autoIndexingIntervalHours": 0
    },
    "totalDocuments": 0,
    "totalIndexedDocuments": 0,
    "sizeMegaByte": 0,
    "createdAt": "2025-09-04T10:45:42.036Z",
    "updatedAt": "2025-09-04T10:45:42.036Z",
    "indexedAt": "2025-09-04T10:45:42.036Z",
    "indexingRunAt": "2025-09-04T10:45:42.036Z",
    "callback": {
      "method": "POST",
      "field": "string",
      "url": "https://www.mysite.it/callback.php",
      "data": {}
    }
  },
  "success": true,
  "message": "",
  "error": null
}

In qualsiasi momento è possibile recuperare la lista di tutti i RAG o i dettagli di un singolo RAG con gli endpoint GET /rag e GET /rag/{id}.

Carica un documento

Una volta creato il RAG, si può proseguire con l’inserimento di un documento al suo interno attraverso l’endpoint POST /rag/{id}/documents.

ESEMPIO RICHIESTA

In fase di richiesta va specificato come parametro l’ID del RAG in cui verrà caricato il documento.

Nel payload è necessario indicare:

{
  "fileName": "documentTest",
  "fileContent": "string",
  "metadata": {
    "custom_key_str": "string",
    "custom_key_date": "2025-09-04T10:51:06.259Z",
    "custom_key_int": 0,
    "custom_key_geo_latitude": 0,
    "custom_key_geo_longitude": 0,
    "custom_key_bool": true
  }
}

ESEMPIO RISPOSTA

La risposta fornisce specifiche sul documento, tra cui ID, nome, stato, metadati, dimensione, tipo di file, data di creazione e aggiornamento.

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "state": "string",
      "metadata": {
        "custom_key_str": "string",
        "custom_key_date": "2025-09-04T10:51:06.260Z",
        "custom_key_int": 0,
        "custom_key_geo_latitude": 0,
        "custom_key_geo_longitude": 0,
        "custom_key_bool": true
      },
      "sizeMegaByte": 0,
      "mimeType": "string",
      "createdAt": "2025-09-04T10:51:06.260Z",
      "updatedAt": "2025-09-04T10:51:06.260Z",
      "paymentDueDate": "2025-09-04T10:51:06.260Z"
    }
  ],
  "success": true,
  "message": "",
  "error": null
}

In qualsiasi momento è possibile recuperare la lista dei documenti all’interno di un RAG attraverso l’endpoint GET /rag/{id}/documents.

Avvia processo di indicizzazione

Come anticipato sopra, per ottenere risposte contestuali e accurate, è indispensabile avviare l’indicizzazione ogni volta che si effettua una modifica al RAG (quindi se viene caricato o eliminato un documento). Se non si esegue questo passaggio, il sistema continuerà a basarsi solo sui dati precedenti e non su quelli aggiornati.

L’indicizzazione può essere avviata manualmente tramite PATCH/rag/{id}; in alternativa è possibile impostare l’indicizzazione automatica, che si avvia ogni tot ore (stabilite dall’utente). Quest’ultima va impostata nel momento in cui si crea il RAG, quindi attraverso l’endpoint POST /rag. Per l'indicizzazione, sia essa automatica o manuale, non sono previsti costi aggiuntivi.

ESEMPIO RICHIESTA

In fase di richiesta va specificato come parametro l’ID del RAG per il quale viene avviato il processo di indicizzazione manuale.

Nel payload della richiesta è necessario includere il parametro startIndexing impostato su true per avviare il processo di indicizzazione:

"startIndexing": true

ESEMPIO RISPOSTA

La risposta restituisce dettagli sul nome del RAG, lo stato (es. ready, indexing), le impostazioni (es. OCR sì/no, indicizzazione automatica sì/no), il numero di documenti presenti e indicizzati, la dimensione attuale del RAG in mb, le date di creazione e aggiornamento.

{
  "data": {
    "id": "68947e1e0dab7e743108abfb",
    "name": "RAGTest",
    "state": "indexing",
    "options": {
      "ocr": false,
      "autoIndexingIntervalHours": 0
    },
    "totalDocuments": 0,
    "totalIndexedDocuments": 0,
    "sizeMegaByte": 0,
    "createdAt": "2025-09-04T10:55:37.306Z",
    "updatedAt": "2025-09-04T10:55:37.306Z",
    "callback": {
      "method": "POST",
      "field": "string",
      "url": "https://www.mysite.it/callback.php",
      "data": {}
    }
  },
  "success": true,
  "message": "",
  "error": null
}

RAG SEARCH

Dopo aver effettuato i tre step sopra menzionati, si può quindi passare alla ricerca vera e propria, attraverso l’endpoint POST /rag/search.

Come specificato all’inizio, RAG Search ti consente - tramite API e in tempo reale - di trovare il documento o l’informazione che ti serve all’interno di tutti i tuoi file, grazie a un motore di ricerca potenziato dall’AI e a partire da una query. Tutto questo in totale sicurezza e senza rischio di fuga di dati sensibili.

ESEMPIO RICHIESTA

Nella richiesta vanno indicati:

{
  "ragId": "688b2ab3bccc6a603202f87c",
  "query": "che servizi ci sono?",
  "max_len": 5,
  "metadata_filter": "(custom_key_int<175 AND custom_key_bool = \"true\") OR (custom_key_int<125 AND custom_key_bool = \"false\")",
  "settings": {
    "prompt_style": "basic"
  }
}

ESEMPIO RISPOSTA

RAG Search ti restituisce informazioni sui documenti più rilevanti per la tua ricerca, inclusi estratti di testo, che possono aiutarti a trovare rapidamente i dati che cerchi.

Nello specifico, il payload della risposta fornisce:

{
  "data": [
    [
      {
        "snippets": [
          "string"
        ],
        "id": "689c70313f292734010a7dda",
        "ragId": "689c6ed7b283ac0aa40c1555",
        "name": "documentTest",
        "state": "indexing",
        "metadata": {
          "custom_key_str": "string",
          "custom_key_date": "2025-09-04T13:32:33.635Z",
          "custom_key_int": 0,
          "custom_key_geo_latitude": 0,
          "custom_key_geo_longitude": 0,
          "custom_key_bool": true
        }
      }
    ]
  ],
  "success": true,
  "message": "",
  "error": null
}

Grazie a RAG Search, è quindi possibile interrogare i propri documenti rapidamente, con la garanzia che il sistema restituisca risposte quanto più accurate possibili e estragga le informazioni solo dai dati effettivamente caricati e indicizzati. In questo modo le proprie informazioni vengono mantenute completamente al sicuro.

Il servizio è pensato in particolare per aziende che gestiscono grandi quantità di documenti (contratti, report, manuali), ad es.:

In generale, RAG Search è ideale per tutte le organizzazioni o professionisti che devono accedere rapidamente a informazioni precise e aggiornate all’interno dei propri documenti, ottimizzando tempi di ricerca e affidabilità dei risultati.