GetRAGSpaceInfo

Renvoie les informations relatives à l’espace RAG spécifié, ou à tous les espaces RAG si aucun ID n’a été spécifié.

Format 

GetRAGSpaceInfo ( nomCompteRAG ; { IDEspace } )

Paramètres 

nomCompteRAG : une expression de texte pour le nom du compte RAG à utiliser. Dans le fichier actuel, utilisez l'action de script Configurer un compte RAG pour configurer le compte et lui attribuer ce nom avant l'exécution de cette fonction.

IDEspace : ID d'un espace RAG. S'il est omis, renvoie des informations sur tous les espaces RAG pour le compte spécifié.

Les paramètres situés entre deux accolades { } sont facultatifs.

Résultat 

Texte

Provient de la version 

22.0

Description 

GetRAGSpaceInfo renvoie des informations sur les espaces de génération augmentée par récupération (RAG) sur le serveur de modèles d'IA spécifié par nomCompteRAG. Vous pouvez l'utiliser pour vérifier l'existence d'un espace RAG, surveiller son contenu et auditer les opérations RAG.

Si aucune valeur IDEspace n'est spécifiée, la fonction renvoie un objet JSON contenant un tableau d'espaces RAG disponibles pour le compte RAG spécifié :

Copier
{
  "rag_space_list": [
    {
      "space_id": "<chaîne>",
      "model": "<chaîne>"
    }
  ]
}
  • rag_space_list est un tableau d'espaces RAG.

  • space_id est la clé d'un ID d'espace RAG.

  • model est la clé du nom du modèle utilisé pour générer des vecteurs d'intégration de texte dans cet espace RAG.

Si une valeur IDEspace est spécifiée, la fonction renvoie un objet JSON contenant des informations sur l'espace RAG et les données qu'il contient :

Copier
{
  "rag_space_id": "<chaîne>",
  "model": "<chaîne>",
  "entries": <nombre>,
  "values": [
    {
      "id": <nombre>,
      "filename": "<chaîne>"
    },
    {
      "id": <nombre>,
      "text": "<chaîne>"
    }
  ]
}
  • rag_space_id est l'ID de l'espace RAG.

  • model est le nom du modèle utilisé pour générer des vecteurs d'intégration de texte dans cet espace RAG.

  • entries est le nombre d'éléments dans le tableau values.

  • values est un tableau de morceaux de documents texte et de noms de fichiers PDF :

    • id est un identifiant numérique pour le document texte d'où provient un morceau de texte, ou pour un fichier PDF.

    • filename est le nom d'un fichier PDF ajouté à l'espace.

    • text est un morceau d'un document texte ajouté à l'espace. Les morceaux d'un même document texte ont le même id.

Remarques 

  • Un compte RAG doit être configuré à l'aide de l'action de script Configurer un compte RAG avant d'utiliser cette fonction.

  • Cette fonction est utile pour vérifier qu'un espace RAG existe avant d'effectuer des opérations dessus. Pour un compte RAG valide, si un espace n'existe pas ou ne contient pas de données, cette fonction renvoie un message d'erreur :

    Erreur [Espace RAG]. Raison : espace RAG {space_id} introuvable

  • Si le compte RAG est invalide ou n'existe pas, cette fonction renvoie "?".

  • La fonction peut être utilisée pour l'audit et la surveillance des espaces RAG au sein de votre solution FileMaker.

Exemple 1 

Obtient des informations sur tous les espaces RAG pour un compte configuré nommé "compte-rag-support-client".

GetRAGSpaceInfo ( "compte-rag-support-client" ) peut renvoyer les éléments suivants si deux espaces RAG contiennent des données :

Copier
{
  "rag_space_list": [
    {
      "space_id": "base-connaissance",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    },
    {
      "space_id": "notes-meeting",
      "model": "multi-qa-MiniLM-L6-cos-v1"
    }
  ]
}

Exemple 2 

Obtient des informations sur un espace RAG spécifique avec l'ID "base-connaissance".

GetRAGSpaceInfo ( "compte-rag-support-client" ; "base-connaissance" ) peut renvoyer le JSON suivant pour un espace avec un fichier PDF nommé "Politiques.pdf" et un document texte divisé en trois morceaux (tronqué par souci de concision).

Copier
{
  "rag_space_id": "base-connaissance",
  "model": "multi-qa-MiniLM-L6-cos-v1",
  "entries": 4,
  "values": [
    {
      "id": 1,
      "filename": "Politiques.pdf"
    },
    {
      "id": 2,
      "text": "Procédures et politiques d'assistance client pour le traitement des retours et échanges..."
    },
    {
      "id": 2,
      "text": "Assurez-vous que l'emballage de l'article que vous renvoyez contient..."
    },
    {
      "id": 2,
      "text": "Vous disposez de 14 jours calendaires pour renvoyer un article à partir de la date de réception..."
    }
  ]
}

Exemple 3 

Utilise GetRAGSpaceInfo dans un script pour vérifier l'existence d'un espace RAG avant d'effectuer des opérations.

Copier
Configurer un compte RAG [ Nom du compte RAG: "compte-rag-support-client" ; Point de terminaison : "https://monserveur.exemple.com/llm/v1/" ; Clé API : Global::Clé_API_RAG ; Vérifier les certificats SSL ]

Définir variable [ $ragSpaceInfo ; Valeur: GetRAGSpaceInfo ( "compte-rag-support-client" ; "base-connaissance" ) ]

Si [ Occurrences ( $ragSpaceInfo ; "Erreur [RAG Space]" ) > 0 ou Occurrences ( $ragSpaceInfo ; "?" ) > 0 ]

    # L'espace RAG n'existe pas. Gérer l'erreur.

    Ouvrir boîte dial. person. [ "Erreur" ; "L'espace RAG spécifié n'a pas été trouvé." ] 

Sinon

    # L'espace RAG existe. Procéder aux opérations.
    
    Définir variable [ $ragSpaceID ; Valeur: JSONGetElement ( $ragSpaceInfo ; "rag_space_id" ) ]
    
    Ouvrir boîte dial. person. [ "Espace trouvé" ; "L'espace RAG '" & $ragSpaceID & "' est disponible." ]

Fin de si