RAG Search with Answer

RAG Search with Answer ist der Dienst, der die Leistungsfähigkeit der Retrieval-Augmented Generation (RAG)-Technologie nutzt, um intelligente Suchen in Ihren Dokumenten zu ermöglichen. Der Dienst kombiniert semantische Suche und Ausgabe in natürlicher Sprache und liefert in Echtzeit eine einzige relevante Antwort basierend auf einer Abfrage. Dies geschieht zuverlässig und sicher, ohne Datenlecks.

Wie erwähnt, steht im Kern die RAG-as-a-Service-Technologie von Openapi, die es Unternehmen ermöglicht, ihre proprietären Daten abzufragen und zuverlässige, kontextbezogene Antworten zu erhalten. Das System reduziert das Risiko von „Halluzinationen“, das bei großen Sprachmodellen (LLMs) typisch ist, und liefert Antworten, die konsistent und relevant für das spezifische Wissen der Organisation sind.

Dank RAG-as-a-Service können Sie fortschrittliche RAG-Funktionen einfach in Ihre Anwendungen integrieren, ohne die Komplexität von dedizierter Infrastruktur oder Datenpipelines. Ihre Daten werden automatisch indexiert, wodurch das Modell in Echtzeit auf aktuelle Informationen zugreifen kann. Openapi vereint so die Leistung der LLMs mit der kontextuellen Suche in Unternehmensdaten und liefert präzise Antworten, die ausschließlich auf Ihrem proprietären Wissen basieren.

Zusätzlich zu Search with Answer bietet Openapi zwei weitere RAG-Dienste für die Dokumentensuche an: Search, das ein oder mehrere relevante Textauszüge zurückgibt, und Conversation, das kontextbezogene Gespräche basierend auf vorherigen Interaktionen ermöglicht. Alle drei Dienste sind weltweit verfügbar.

Um konsistente und relevante Ergebnisse mit RAG Search with Answer zu erzielen, sind drei Hauptschritte erforderlich:

Die Indexierung ermöglicht es, die relevantesten Informationen schnell als Antwort auf eine Anfrage abzurufen. Jedes Mal, wenn der RAG geändert wird (Dokument hochgeladen oder entfernt), ist es wichtig, die Indexierung neu zu starten, um aktuelle und genaue Antworten zu gewährleisten.

Erstellen eines neuen RAG

Der erste Schritt besteht darin, einen leeren RAG über den Endpoint POST /rag zu erstellen, in den später Dokumente eingefügt werden.

BEISPIEL ANFRAGE

In der Anfrage müssen angegeben werden:

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

BEISPIEL ANTWORT

Die Antwort enthält Details zum RAG (z. B. ID und Name, Status, Optionen, Einstellungen wie OCR, Anzahl der Dokumente insgesamt und indexiert, Erstellungs- und Aktualisierungsdaten, Datum der letzten Indexierung).

{
  "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
}

Zu jeder Zeit können Sie die Liste aller RAG oder die Details eines einzelnen RAG über die Endpoints GET /rag und GET /rag/{id} abrufen.

Dokument hochladen

Nachdem der RAG erstellt wurde, können Sie ein Dokument über den Endpoint POST /rag/{id}/documents hochladen.

BEISPIEL ANFRAGE

Als Parameter muss die ID des RAG angegeben werden, in den das Dokument hochgeladen wird.

Im Payload müssen folgende Angaben gemacht werden:

{
  "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
  }
}

BEISPIEL ANTWORT

Die Antwort liefert Details zum Dokument, einschließlich ID, Name, Status, Metadaten, Größe, Dateityp, Erstellungs- und Aktualisierungsdatum.

{
  "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
}

Sie können jederzeit die Liste der Dokumente innerhalb eines RAG über den Endpoint GET /rag/{id}/documents abrufen.

Indexierungsprozess starten

Wie oben erwähnt, ist es notwendig, die Indexierung jedes Mal zu starten, wenn Änderungen am RAG vorgenommen werden (z. B. wenn ein Dokument hochgeladen oder gelöscht wird). Ohne diesen Schritt basieren die Antworten weiterhin nur auf den bisherigen Daten und nicht auf den aktualisierten.

Die Indexierung kann manuell über PATCH/rag/{id} gestartet werden; alternativ kann eine automatische Indexierung eingerichtet werden, die in einem festgelegten Intervall startet. Die automatische Indexierung wird beim Erstellen des RAG über den Endpoint POST /rag definiert. Für die Indexierung, ob automatisch oder manuell, fallen keine zusätzlichen Kosten an.

BEISPIEL ANFRAGE

Als Parameter muss die ID des RAG angegeben werden, für den die manuelle Indexierung gestartet werden soll.

Im Request-Payload muss der Parameter startIndexing auf true gesetzt werden:

"startIndexing": true

BEISPIEL ANTWORT

Die Antwort liefert Details zum RAG-Namen, Status (z. B. ready, indexing), Einstellungen (z. B. OCR ja/nein, automatische Indexierung ja/nein), Anzahl der vorhandenen und indexierten Dokumente, aktuelle Größe des RAG in MB, Erstellungs- und Aktualisierungsdaten.

{
  "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

Nach den drei vorherigen Schritten kann die eigentliche Suche über den Endpoint POST /rag/search-with-answer gestartet werden.

RAG Search with Answer ermöglicht es Ihnen, über die API und in Echtzeit das gewünschte Dokument oder die Information innerhalb Ihrer Dateien zu finden und kontextbezogene Antworten in natürlicher Sprache zu erhalten. Alles geschieht sicher und ohne Risiko eines Datenlecks.

BEISPIEL ANFRAGE

Folgende Angaben sind erforderlich:

{
  "ragId": "688b2ab3bccc6a603202f87c",
  "query": "Welche Services gibt es?",
  "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"
  }
}

BEISPIEL ANTWORT

RAG Search with Answer liefert die relevantesten Dokumentinformationen, inklusive Textausschnitten, die helfen, die gewünschten Daten schnell zu finden.

Der Antwort-Payload enthält:

{
  "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
}

Mit RAG Search with Answer können Sie Ihre Dokumente schnell abfragen, präzise und verlässliche Antworten erhalten und dabei nur auf die tatsächlich hochgeladenen und indexierten Daten zugreifen. Ihre Informationen bleiben somit vollständig geschützt.

Der Service ist ideal für Unternehmen, die große Mengen an Dokumenten (Verträge, Berichte, Handbücher) verwalten, z. B.:

Im Allgemeinen unterstützt RAG Search with Answer alle Organisationen oder Fachkräfte, die schnell auf verlässliche Informationen zugreifen müssen, um Zeit und Präzision bei der Dokumentenverwaltung zu optimieren.