GetRAGSpaceInfo

Returnerar information om angiven RAG-plats, eller om alla RAG-platser ifall plats-ID inte anges.

Format 

GetRAGSpaceInfo ( ragKontonamn ; { platsID } )

Parametrar 

ragKontonamn – ett textuttryck för namnet på RAG-kontot som ska användas. Använd scriptsteget Scriptsteget Konfigurera RAG-konto i den aktuella filen för att konfigurera kontot och tilldela det namnet när som helst innan funktionen körs.

platsID – ID för en RAG-plats. Om alternativet utelämnas returneras information om alla RAG-platser för det angivna kontot.

Parametrar inom klamrar {} är valfria.

Returnerad datatyp 

text

Ursprungsversion 

22.0

Beskrivning 

GetRAGSpaceInfo returnerar information om RAG-platser (Retrieval-Augmented Generation) på den AI-modellserver som anges av ragKontonamn. Du kan använda funktionen för att verifiera förekomsten av en RAG-plats, övervaka dess innehåll och granska RAG-åtgärder.

Om inget värde anges för platsID returnerar funktionen ett JSON-objekt som innehåller en matris med RAG-platser som är tillgängliga för det angivna RAG-kontot:

Kopiera 
{
  "rag_space_list": [
    {
      "space_id": "<sträng>",
      "model": "<sträng>"
    }
  ]
}

  • rag_space_list är en matris med RAG-platser.

  • space_id är nyckeln till ett RAG-plats-ID.

  • model är nyckeln till namnet på den modell som används för att generera textinbäddningsvektorer på den här RAG-platsen.

Om ett spaceID-värde anges returnerar funktionen ett JSON-objekt som innehåller information om RAG-platsen och data i det:

Kopiera 
{
  "rag_space_id": "<sträng>",
  "model": "<sträng>",
  "entries": <tal>,
  "values": [
    {
      "id": "<sträng>" eller <tal>,
      "filename": "<sträng>"
    },
    {
      "id": "<sträng>" eller <tal>,
      "text": "<sträng>"
    }
  ]
}

  • rag_space_id är ID för RAG-platsen.

  • model är namnet på den modell som används för att generera textinbäddningsvektorer på den här RAG-platsen.

  • entries är antalet element i matrisen values.

  • values är en matris av textdokumentbitar och PDF-filnamn:

    • id är ett dokument-ID för ett textdokument (som är gemensamt för alla segment från det dokumentet), eller för en PDF-fil.

      Dokument som lagts till på en RAG-plats före version 26.0.1 av AI-modellservern har numeriska dokument-ID:n (till exempel 1, 2, 3). Från och med version 26.0.1 utgörs dokument-ID:n av UUID-strängar (till exempel "5f7677a0-3258-55a3-bc86-737005cb3574"). När du arbetar med RAG-platser som innehåller dokument som lagts till före och efter ändringen av ID-format behöver dina script hantera båda formaten för dokument-ID.

      Mer information finns i Scriptsteget Utför RAG-åtgärd.

    • filename är namnet på en PDF-fil som lagts till på platsen.

    • text är en bit av ett textdokument som lagts till på platsen. Bitar från samma textdokument har samma id.

Kommentarer 

  • Ett RAG-konto måste konfigureras med Scriptsteget Konfigurera RAG-konto innan du kan använda den här funktionen.

  • Den här funktionen är användbar för att verifiera att det finns en RAG-plats innan du utför åtgärder på den. Om det inte finns en plats för ett giltigt RAG-konto eller om det inte finns några data där, returnerar funktionen ett felmeddelande:

    Fel i [RAG-plats]. Orsak: RAG-plats {plats_id} hittades inte

  • Om RAG-kontot är ogiltigt eller inte finns returnerar funktionen ”?”.

  • Funktionen kan användas för att granska och övervaka RAG-platser i din FileMaker-lösning.

Exempel 1 

Hämtar information om alla RAG-platser för ett konfigurerat konto med namnet ”Kundsupport-rag-konto”.

GetRAGSpaceInfo ( "kundsupport-rag-konto" ) kan returnera följande om två RAG-platser innehåller data:

Kopiera 
{
  "rag_space_list": [
    {
      "space_id": "kunskapsbas",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    },
    {
      "space_id": "mötesanteckningar",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    }
  ]
}

Exempel 2 

Hämtar information om en specifik RAG-plats med ID "kunskapsbas".

GetRAGSpaceInfo ( "kundsupport-rag-konto" ; "kunskapsbas" ) kan returnera följande JSON för en plats med PDF-filer med namnen "Villkor.pdf" och "Policyer.pdf" och ett textdokument uppdelat i tre segment (trunkerat av utrymmesskäl). Observera att "Villkor.pdf" har ett numeriskt värde för id eftersom det lades till på RAG-platsen med en tidigare version av AI-modellservern (se Anteckningar).

Kopiera 
{
  "rag_space_id": "kunskapsbas",
  "model": "multi-qa-MiniLM-L6-cos-v1",
  "entries": 5,
  "values": [
    {
      "id": 42,
      "filename": "Villkor.pdf"
    },
    {
      "id": "f95d4266-66cd-5b50-a01b-07a4dd66c501",
      "filename": "Policyer.pdf"
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Kundtjänstpolicyer och procedurer för hantering av returer och byten …"
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Se till att varan du returnerar är förpackad med alla …"
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "text": "Du har 14 kalenderdagars returrätt för en vara från det datum då du tog emot den …"
    }
  ]
}

Exempel 3 

Använder GetRAGSpaceInfo i ett script för att verifiera att en RAG-plats finns innan åtgärder utförs.

Kopiera 
Konfigurera RAG-konto [ RAG-kontonamn: "kundsupport-rag-konto" ; Slutpunkt: "https://minserver.exempel.com/llm/v1/" ; API-nyckel: Global::RAG_API-nyckel ; Verifiera SSL-certifikat ]

Ange variabel [ $ragSpaceInfo ; Värde: GetRAGSpaceInfo ( "kundsupport-rag-konto" ; "kunskapsbas" ) ]

If [ PatternCount ( $ragSpaceInfo ; "Fel i [RAG Space]" ) > 0 eller PatternCount ( $ragSpaceInfo ; "?" ) > 0 ]

# RAG-platsen finns inte. Hantera fel.

Visa anpassad dialogruta [ "Fel" ; "Den angivna RAG-platsen hittades inte." ] 

Else

    # RAG-platsen finns. Fortsätt med åtgärder.
    
    Ange variabel [ $ragSpaceID ; Värde: JSONGetElement ( $ragSpaceInfo ; "rag_space_id" ) ]
    
    Visa anpassad dialog [ "Platsen hittades" ; "RAG-plats '" & $ragSpaceID & "' är tillgänglig för användning." ]

End If

Relaterade avsnitt