GetRAGSpaceInfo

Gibt Informationen über den angegebenen RAG-Space oder alle RAG-Spaces zurück, wenn keine Space ID angegeben ist.

Format 

GetRAGSpaceInfo ( ragKontoname {; spaceID } )

Parameter 

ragKontoname – ein Textausdruck für den Namen des zu verwendenden RAG-Kontos. Verwenden Sie in der aktuellen Datei den Scriptschritt „RAG-Konto konfigurieren“, um das Konto einzurichten und ihm diesen Namen zuzuweisen, bevor diese Funktion verwendet wird.

spaceID – ID eines RAG-Space. Wenn dieser Parameter weggelassen wird, werden Informationen zu allen RAG-Spaces für das angegebene Konto zurückgegeben.

Parameter in geschweiften Klammern { } sind optional.

Zurückgegebener Datentyp 

Text

Ursprung in Version 

22.0

Beschreibung 

GetRAGSpaceInfo gibt Informationen über Retrieval-Augmented Generation (RAG)-Spaces auf dem KI-Modellserver zurück, der durch ragKontoname angegeben ist. Sie können damit die Existenz eines RAG-Spaces überprüfen, dessen Inhalt überwachen und RAG-Vorgänge prüfen.

Wenn kein Wert für spaceID angegeben ist, gibt die Funktion ein JSON-Objekt zurück, das ein Array der RAG-Spaces enthält, die für das angegebene RAG-Konto verfügbar sind:

Kopieren 
{
  "rag_space_list": [
    {
      "space_id": "<string>",
      "model": "<string>"
    }
  ]
}

  • rag_space_list ist ein Array von RAG-Spaces.

  • space_id ist der Schlüssel für eine RAG-Space ID.

  • model ist der Schlüssel für den Namen des Modells, das zur Generierung von Text-Einbettungsvektoren in diesem RAG-Space verwendet wird.

Wenn ein spaceID-Wert angegeben ist, gibt die Funktion ein JSON-Objekt zurück, das Informationen über den RAG-Space und die darin enthaltenen Daten enthält:

Kopieren 
{
  "rag_space_id": "<string>",
  "model": "<string>",
  "entries": <zahl>,
  "values": [
    {
      "id": "<string>" oder <zahl>,
      "filename": "<string>"
    },
    {
      "id": "<string>" oder <zahl>,
      "text": "<string>"
    }
  ]
}

  • rag_space_id ist die RAG-Space ID.

  • model ist der Name des Modells, das zur Generierung von Text-Einbettungsvektoren in diesem RAG-Space verwendet wird.

  • entries ist die Anzahl der Elemente im Array werte.

  • values ist ein Array aus Textdokument-Blöcken und PDF-Dateinamen:

    • id ist eine Dokument-ID für ein Textdokument (die von allen Abschnitten dieses Dokuments gemeinsam genutzt wird) oder für eine PDF-Datei.

      Dokumente, die vor Version 26.0.1 des KI-Modellservers zu einem RAG-Space hinzugefügt wurden, haben numerische Dokument-IDs (zum Beispiel 1, 2, 3). Ab Version 26.0.1 sind Dokument-IDs UUID-Strings (zum Beispiel „5f7677a0-3258-55a3-bc86-737005cb3574“). Wenn Sie mit RAG-Spaces arbeiten, die Dokumente enthalten, die vor und nach der Änderung des ID-Formats hinzugefügt wurden, sollten Ihre Scripts beide Dokument-ID-Formate verarbeiten können.

      Siehe Scriptschritt „RAG-Aktion ausführen“.

    • filename ist der Name einer PDF-Datei, die zum Speicherplatz hinzugefügt wurde.

    • text ist ein Teil eines Textdokuments, der dem Speicherplatz hinzugefügt wurde. Blöcke aus demselben Textdokument haben dieselbe id.

Hinweise 

  • Ein RAG-Konto muss mit dem Scriptschritt „RAG-Konto konfigurieren“ konfiguriert werden, bevor diese Funktion verwendet werden kann.

  • Diese Funktion ist nützlich, um zu überprüfen, ob ein RAG-Space vorhanden ist, bevor Operationen darauf ausgeführt werden. Bei einem gültigen RAG-Konto gibt diese Funktion eine Fehlermeldung zurück, wenn ein Space nicht existiert oder keine Daten enthält:

    [RAG-Space] Fehler. Grund: RAG-Space {space_id} nicht gefunden

  • Ist das RAG-Konto ungültig oder nicht vorhanden, gibt diese Funktion „?“ zurück.

  • Die Funktion kann zur Überwachung und Kontrolle von RAG-Spaces innerhalb Ihrer FileMaker-Lösung verwendet werden.

Beispiel 1 

Ruft Informationen zu allen RAG-Spaces für ein konfiguriertes Konto mit dem Namen „kundensupport-rag-konto“ ab.

GetRAGSpaceInfo ( "kundensupport-rag-konto” ) kann Folgendes zurückgeben, wenn zwei RAG-Spaces Daten enthalten:

Kopieren 
{
  "rag_space_list": [
    {
      "space_id": "knowledge-base",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    },
    {
      "space_id": "meeting-notizen",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    }
  ]
}

Beispiel 2 

Ruft Informationen über einen bestimmten RAG-Space mit der ID „knowledge-base” ab.

GetRAGSpaceInfo ( „kundensupport-rag-konto“ ; „knowledge-base“ ) kann den folgenden JSON-Code für einen Space mit PDF-Dateien namens „Bedingungen.pdf“ und "Richtlinien.pdf" sowie einem in drei Teile unterteilten Textdokument zurückgeben (der der Übersichtlichkeit halber gekürzt wurde). Beachten Sie, dass „Bedingungen.pdf“ einen numerischen Wert für id aufweist, da es mit einer früheren Version des KI-Modellservers zum RAG-Space hinzugefügt wurde (siehe Hinweise).

Kopieren 
{
  "rag_space_id": "knowledge-base",
  "model": "multi-qa-MiniLM-L6-cos-v1",
  "entries": 5,
  "values": [
    {
      "id": 42,
      "filename": "Bedingungen.pdf"
    },
    {
      "id": "f95d4266-66cd-5b50-a01b-07a4dd66c501",
      "filename": "Richtlinien.pdf"
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Richtlinien und Verfahren des Kundensupports für die Bearbeitung von Rückgaben und Umtausch ..."
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Stellen Sie sicher, dass der zurückzugebende Artikel in der Originalverpackung ..."
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Ab dem Datum des Erhalts haben Sie 14 Kalendertage Zeit, um einen Artikel zurückzugeben ..."
    }
  ]
}

Beispiel 3 

Verwendet GetRAGSpaceInfo in einem Script, um vor der Ausführung von Operationen zu überprüfen, ob ein RAG-Space vorhanden ist.

Kopieren 
RAG-Konto konfigurieren [ RAG-Kontoname: "kundensupport-rag-konto" ; Endpunkt: "https://meinserver.beispiel.com/llm/v1/" ; API-Schlüssel: Global::RAG_API_Schlüssel ; SSL-Zertifikate verifizieren ]

Variable setzen [ $ragSpaceInfo ; Wert: GetRAGSpaceInfo ( "kundensupport-rag-konto" ; "knowledge-base" ) ]

Wenn [ MusterAnzahl ( $ragSpaceInfo ; "[RAG-Space] Fehler" ) > 0 oder MusterAnzahl ( $ragSpaceInfo ; "?" ) > 0 ]

    # # RAG-Space ist nicht vorhanden. Fehler behandeln. Eigenes Dialogfeld anzeigen [ "Fehler" ; "Der angegebene RAG-Space wurde nicht gefunden." ] 

Sonst

    # RAG-Space ist vorhanden. Vorgänge fortsetzen.
    
    Variable setzen [ $ragSpaceID ; Wert: JSONGetElement ( $ragSpaceInfo ; "rag_space_id" ) ]
    
    Eigenes Dialogfeld anzeigen [ "Space gefunden" ; "RAG-Space '" & $ragSpaceID & "' kann verwendet werden." ] 

Ende (wenn)

Weiterführende Themen