RAG Search with Answer

RAG Search with Answer è il servizio che sfrutta la potenza della tecnologia Retrieval-Augmented Generation (RAG) per permetterti di effettuare ricerche intelligenti all'interno dei tuoi documenti. Il servizio combina ricerca semantica e generazione di output in linguaggio naturale e restituisce in tempo reale una singola risposta pertinente, a partire da una query. Il tutto in maniera affidabile e sicura, senza fughe di dati.

Come accennato, alla base di tutto c'è la tecnologia RAG-as-a-Service di Openapi, che consente alle aziende di interrogare i propri dati proprietari e ottenere risposte affidabili e contestualizzate. Il sistema riduce il rischio di “allucinazioni” tipico dei Large Language Model (LLM), offrendo risposte coerenti e pertinenti rispetto alla conoscenza specifica dell’organizzazione.

Grazie a RAG-as-a-Service, puoi integrare facilmente funzionalità avanzate di RAG nelle tue applicazioni, senza la complessità di infrastrutture dedicate o pipeline di dati. I tuoi dati vengono indicizzati automaticamente, consentendo al modello di accedere in tempo reale a informazioni aggiornate. In questo modo, Openapi unisce la potenza dei LLM alla ricerca contestuale sui dati aziendali, offrendo risposte precise e basate esclusivamente sulla tua conoscenza proprietaria.

Oltre a Search with Answer, Openapi offre anche altri due servizi RAG per la ricerca documentale: Search, che restituisce uno o più estratti di testo rilevanti, e Conversation, che consente di avviare conversazioni contestualizzate a partire da interazioni precedenti. Tutti e tre sono validi a livello globale.

Per ottenere risultati coerenti e pertinenti con RAG Search with Answer, occorre seguire tre passaggi principali:

L’indicizzazione permette di recuperare rapidamente le informazioni più rilevanti in risposta a una query. Ogni volta che si modifica il RAG (caricamento o rimozione di documenti), è fondamentale riavviare l’indicizzazione per assicurare risposte aggiornate e accurate.

Crea un nuovo RAG

Il primo passo consiste nel creare un RAG vuoto tramite l’endpoint POST /rag, in cui inserire successivamente i documenti.

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 contiene dettagli del RAG (es. ID e nome, stato, opzioni, impostazioni come OCR, 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 WITH ANSWER

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

Come specificato all’inizio, RAG Search with Answer 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, a partire da una query, e di ottenere risposte contestuali, in linguaggio naturale. 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 with Answer 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": [
    {
      "answer": "string",
      "search_result": [
        {
          "index": 0,
          "snippets": [
            "string"
          ],
          "id": "689c70313f292734010a7dda",
          "ragId": "689c6ed7b283ac0aa40c1555",
          "name": "documentTest",
          "state": "indexing",
          "metadata": {
            "custom_key_str": "string",
            "custom_key_date": "2025-09-25T10:34:00.005Z",
            "custom_key_int": 0,
            "custom_key_geo_latitude": 0,
            "custom_key_geo_longitude": 0,
            "custom_key_bool": true
          }
        }
      ]
    }
  ],
  "success": true,
  "message": "",
  "error": null
}

Con RAG Search with Answer puoi quindi interrogare rapidamente i tuoi documenti, ottenendo risposte precise e affidabili e accedendo solo ai dati effettivamente caricati e indicizzati. In questo modo, le tue informazioni restano completamente protette.

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

In generale, RAG Search with Answer supporta tutte le organizzazioni o professionisti che necessitano di accedere rapidamente a informazioni affidabili, ottimizzando tempi e precisione nella gestione dei documenti.