GetRAGSpaceInfo

Retourneert informatie over de opgegeven RAG-ruimte of alle RAG-ruimten, als er geen ruimte-ID is opgegeven.

Opmaak 

GetRAGSpaceInfo ( ragAccountName {; spaceID } )

Parameters 

RagAccountName - een tekstexpressie voor de naam van het RAG-account dat u wilt gebruiken. Gebruik in het huidige bestand de RAG-account configureren scriptstap om het account in te stellen en deze naam toe te wijzen op elk moment voordat deze functie wordt uitgevoerd.

spaceID - ID van een RAG-ruimte. Als deze optie wordt weggelaten, wordt informatie geretourneerd over alle RAG-ruimten voor het opgegeven account.

Parameters tussen accolades { } zijn optioneel.

Resulterend gegevenstype 

tekst

Afkomstig uit versie 

22.0

Beschrijving 

GetRAGSpaceInfo retourneert informatie over retrieval-augmented generation-ruimten (RAG) op de AI-modelserver gespecificeerd door ragAccountName. U kunt deze gebruiken om het bestaan van een RAG-ruimte te controleren, de inhoud ervan te bewaken en RAG-activiteiten te controleren.

Als er geen spaceID-waarde is opgegeven, retourneert de functie een JSON-object met een matrix van RAG-ruimten die beschikbaar zijn voor het opgegeven RAG-account:

Kopiëren 
{
  "rag_space_list": [
    {
      "space_id": "<string>",
      "model": "<string>"
    }
  ]
}

  • rag_space_list is een matrix van RAG-ruimten.

  • space_id is de sleutel voor een RAG-ruimte-ID.

  • model is de sleutel voor de naam van het model dat wordt gebruikt om vectoren voor het insluiten van tekst in deze RAG-ruimte te genereren.

Als er een spaceID-waarde is opgegeven, retourneert de functie een JSON-object met informatie over de RAG-ruimte en de gegevens daarin:

Kopiëren 
{
  "rag_space_id": "<string>",
  "model": "<string>",
  "entries": <number>,
  "values": [
    {
      "id": <number>,
      "filename": "<string>"
    },
    {
      "id": <number>,
      "text": "<string>"
    }
  ]
}

  • rag_space_id is de ID van de RAG-ruimte.

  • model is de naam van het model dat wordt gebruikt voor het genereren van vectoren voor het insluiten van tekst in deze RAG-ruimte.

  • entries is het aantal elementen in de matrix values.

  • values is een matrix van delen van tekstdocumenten en PDF-bestandsnamen:

    • id is een numerieke ID voor het tekstdocument waaruit een tekstblok afkomstig is, of voor een PDF-bestand.

    • filename is de naam van een PDF-bestand dat aan de ruimte wordt toegevoegd.

    • text is een deel van een tekstdocument dat aan de ruimte wordt toegevoegd. Delen uit hetzelfde tekstdocument hebben dezelfde id.

Opmerkingen 

  • Een RAG-account moet worden geconfigureerd met de RAG-account configureren scriptstap voordat u deze functie kunt gebruiken.

  • Deze functie is handig om te controleren of er een RAG-ruimte bestaat voordat er bewerkingen op worden uitgevoerd. Als er voor een geldige RAG-account geen ruimte bestaat of er geen gegevens in staan, retourneert deze functie een foutbericht:

    [RAG Space]-fout. Reden: Ruimte {space_id} niet gevonden

  • Als het RAG-account ongeldig is of niet bestaat, retourneert deze functie '?'.

  • De functie kan worden gebruikt voor het controleren en bewaken van RAG-ruimten binnen uw FileMaker-oplossing.

Voorbeeld 1 

Hiermee krijgt u informatie over alle RAG-ruimten voor een geconfigureerd account met de naam "customer-support-rag-account".

GetRAGSpaceInfo ( "customer-support-rag-account" ) kan het volgende retourneren als twee RAG-ruimten gegevens bevatten:

Kopiëren 
{
  "rag_space_list": [
    {
      "space_id": "knowledge-base",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    },
    {
      "space_id": "meeting-notes",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    }
  ]
}

Voorbeeld 2 

Hiermee krijgt u informatie over een specifieke RAG-ruimte met de ID "knowledge-base".

GetRAGSpaceInfo ( "customer-support-rag-account" ; "knowledge-base" ) kan de volgende JSON retourneren voor een ruimte met een PDF-bestand genaamd "Policies.pdf" en een tekstdocument verdeeld in drie blokken (afgekapt voor beknoptheid).

Kopiëren 
{
  "rag_space_id": "knowledge-base",
  "model": "multi-qa-MiniLM-L6-cos-v1",
  "entries": 4,
  "values": [
    {
      "id": 1,
      "filename": "Policies.pdf"
    },
    {
      "id": 2,
      "text": "Klantenservicebeleid en -procedures voor het verwerken van retourneringen en ruilingen..."
    },
    {
      "id": 2,
      "text": "Zorg ervoor dat het artikel dat u retourneert, opnieuw is verpakt met alle..."
    },
    {
      "id": 2,
      "text": "U hebt 14 kalenderdagen de tijd om een artikel te retourneren vanaf de datum waarop u het hebt ontvangen..."
    }
  ]
}

Voorbeeld 3 

Gebruikt GetRAGSpaceInfo in een script om te controleren of een RAG-ruimte bestaat voordat u bewerkingen uitvoert.

Kopiëren 
RAG-account configureren [ Naam van RAG-account: "customer-support-rag-account" ; Eindpunt: "https://myserver.example.com/llm/v1/" ; API-sleutel: Global::RAG_API_Key ; SSL-certificaten verifiëren ]

Variabele instellen [ $ragSpaceInfo ; Waarde: GetRAGSpaceInfo ( "customer-support-rag-account" ; "knowledge-base" ) ]

If [ PatternCount ( $ragSpaceInfo ; "[RAG Space] error" ) > 0 or PatternCount ( $ragSpaceInfo ; "?" ) > 0 ]

    # RAG ruimte bestaat niet. Fout bij verwerken.

Aangepast dialoogvenster tonen [ "fout" ; "De opgegeven RAG-ruimte is niet gevonden." ] 

Else

    # RAG-ruimte bestaat. Ga verder met de werkzaamheden.

Variabele instellen [ $ragSpaceID ; Waarde: JSONGetElement ( $ragSpaceInfo ; "rag_space_id" ) ]
    
    Aangepast dialoogvenster tonen [ "Ruimte gevonden" ; "RAG-ruimte '" & $ragSpaceID & "' is beschikbaar om te gebruiken." ]

End If

Verwante onderwerpen