RAG Search

RAG Search ist der API-Dienst, der auf der Technologie Retrieval-Augmented Generation (RAG) basiert und intelligente Suchanfragen in Ihren Daten und Dokumenten ermöglicht. Dabei werden die relevantesten Informationen in Echtzeit anhand einer Anfrage identifiziert. Dank eines fortschrittlichen Systems, unterstützt durch künstliche Intelligenz, liefert der Dienst ein oder mehrere relevante Textausschnitte zurück, die präzise und sichere Antworten gewährleisten, ohne dass sensible Daten gefährdet werden.

Die RAG-as-a-Service von Openapi ermöglicht Unternehmen den Zugriff auf ihre eigenen Daten, die Verarbeitung und die Generierung präziser Antworten basierend auf proprietären Daten. Unser Dienst überbrückt die Lücke zwischen Large Language Models (LLM) und organisationsspezifischem Wissen, eliminiert "Halluzinationen" und gewährleistet zuverlässige, konsistente und stets kontextbezogene Antworten.

Mit RAG-as-a-Service können Sie RAG-Funktionen einfach und skalierbar in Ihre Anwendungen integrieren, ohne komplexe Infrastrukturen oder Datenpipelines verwalten zu müssen. Der Dienst ermöglicht es, Ihre strukturierten Daten automatisch hinzuzufügen und zu indexieren, sodass das LLM in Echtzeit auf aktuelle und relevante Informationen zugreifen kann. So kombiniert Openapi die Leistung fortschrittlicher Sprachmodelle mit kontextbezogener Suche in Unternehmensdaten und liefert präzise, aktuelle und wirklich wissensbasierte Antworten.

Zusätzlich zu RAG Search bietet Openapi zwei weitere Dokumentensuchdienste an: Search with Answer (ermöglicht eine KI-generierte Antwort) und Conversation (ermöglicht das Starten neuer Gespräche mit kontextbezogenen Antworten basierend auf vorherigen Gesprächen). Alle drei Dienste sind weltweit verfügbar.

Damit der RAG Search-Dienst korrekt funktioniert und die generierte Antwort so relevant und kohärent wie möglich ist, müssen drei Schritte durchgeführt werden:

Indexierung bezeichnet den Prozess, mit dem die relevantesten Informationen schnell als Antwort auf eine Abfrage abgerufen werden können. Für kontextbezogene und präzise Antworten ist es entscheidend, die Indexierung jedes Mal zu starten, wenn der RAG geändert wird (Dokument hinzugefügt oder gelöscht).

Neuen RAG erstellen

Der erste Schritt besteht darin, einen leeren RAG zu erstellen, in den später ein oder mehrere Dokumente hochgeladen werden können. Dies ist über das Endpoint POST /rag möglich.

BEISPIEL ANFRAGE

Die Anfrage muss Folgendes enthalten:

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

BEISPIEL ANTWORT

Die Antwort liefert Details zum RAG wie ID, Name, Status, Optionen, Einstellungen (z.B. OCR deaktiviert), Gesamtzahl der Dokumente und indizierten Dokumente sowie Erstellungs-, Aktualisierungs- und letzte Indexierungsdaten.

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

Dokument hochladen

Sobald der RAG erstellt wurde, können Sie mit dem Hinzufügen eines Dokuments über den Endpoint POST /rag/{id}/documents fortfahren.

BEISPIELANFRAGE

In der Anfrage muss die ID des RAG angegeben werden, in den das Dokument hochgeladen wird.

Im Payload müssen folgende Angaben enthalten sein:

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

BEISPIELANTWORT

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

{
  "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 das Endpoint GET /rag/{id}/documents abrufen.

Indexierungsprozess starten

Wie oben dargestellt: Um kontextbezogene und präzise Antworten zu erhalten, ist es unerlässlich, die Indexierung jedes Mal zu starten, wenn am RAG eine Änderung vorgenommen wird (also wenn ein Dokument hochgeladen oder gelöscht wird). Wird dieser Schritt nicht ausgeführt, verwendet das System weiterhin nur die vorherigen Daten und nicht die aktualisierten.

Die Indexierung kann manuell über PATCH/rag/{id} gestartet werden; alternativ kann eine automatische Indexierung eingerichtet werden, die alle X Stunden (vom Benutzer festgelegt) startet. Letzteres wird beim Erstellen des RAG über das Endpoint POST /rag konfiguriert. Für die Indexierung — ob automatisch oder manuell — fallen keine zusätzlichen Kosten an.

BEISPIELANFRAGE

In der Anfrage muss die ID des RAG angegeben werden, für den der manuelle Indexierungsprozess gestartet wird.

Im Payload muss der Parameter startIndexing auf true gesetzt sein, um den Indexierungsprozess zu starten:

"startIndexing": true

BEISPIELANTWORT

Die Antwort liefert Details zum RAG-Namen, zum Status (z. B. ready, indexing), zu den Einstellungen (z. B. OCR ja/nein, automatische Indexierung ja/nein), zur Anzahl der vorhandenen und indizierten Dokumente, zur aktuellen Größe des RAG in MB sowie zu 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

Nachdem Sie die drei oben genannten Schritte ausgeführt haben, können Sie mit der eigentlichen Suche fortfahren über den Endpoint POST /rag/search.

Wie bereits erwähnt, ermöglicht RAG Search – über API und in Echtzeit – das Auffinden des gewünschten Dokuments oder der benötigten Information in all Ihren Dateien, dank einer KI-gestützten Suchtechnologie auf Basis einer Abfrage. Alles dies sicher und ohne Risiko sensibler Datenlecks.

BEISPIELANFRAGE

Die Anfrage muss Folgendes enthalten:

{
  "ragId": "688b2ab3bccc6a603202f87c",
  "query": "Welche Dienste sind verfügbar?",
  "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"
  }
}

BEISPIELANTWORT

RAG Search liefert Informationen über die für Ihre Anfrage relevantesten Dokumente, einschließlich Textauszüge, um Ihnen zu helfen, die gesuchten Daten schnell zu finden.

Genauer gesagt enthält die Antwort-Payload:

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

Dank RAG Search können Sie Ihre Dokumente schnell abfragen, wobei das System garantiert, dass es die präzisesten Antworten liefert und Informationen ausschließlich aus den tatsächlich hochgeladenen und indizierten Daten extrahiert. Auf diese Weise bleiben Ihre Informationen vollständig sicher.

Der Dienst ist insbesondere für Unternehmen konzipiert, die große Mengen an Dokumenten (Verträge, Berichte, Handbücher) verwalten, zum Beispiel:

Allgemein ist RAG Search ideal für jede Organisation oder jeden Fachmann, der schnellen Zugriff auf präzise und aktuelle Informationen innerhalb seiner Dokumente benötigt – und damit Suchzeiten und Ergebniszuverlässigkeit optimiert.