GetRAGSpaceInfo

Retorna informações sobre o espaço RAG especificado, ou todos os espaços RAG se nenhum ID de espaço for especificado.

Formato 

GetRAGSpaceInfo ( ragAccountName {; spaceID } )

Parâmetros 

ragAccountName - uma expressão de texto para o nome da conta RAG a ser usada. No arquivo atual, use a Etapa de script Configurar conta RAG para configurar a conta e atribuir esse nome a ela antes que a função seja usada.

spaceID - ID de um espaço RAG. Se omitido, retorna informações sobre todos os espaços RAG para a conta especificada.

Os parâmetros entre chaves { } são opcionais.

Tipo de dados retornado 

texto

Originada na versão 

22.0

Descrição

GetRAGSpaceInfo retorna informações sobre espaços de geração de recuperação aumentada (RAG) no servidor do modelo de IA especificado por ragAccountName. Ele pode ser usado para verificar a existência de um espaço RAG, monitorar seu conteúdo e auditar as operações RAG.

Se nenhum valor spaceID for especificado, a função retornará um objeto JSON que contém uma matriz de espaços RAG disponíveis para a conta RAG especificada:

Copiar 
{
  "rag_space_list": [
    {
      "space_id": "<string>",
      "modelo": "<string>"
    }
  ]
}

  • rag_space_list é uma matriz de espaços RAG.

  • space_id é a chave para um ID do espaço RAG.

  • model é a chave para o nome do modelo usado para gerar vetores de incorporação de texto neste espaço RAG.

Se um valor spaceID for especificado, a função retornará um objeto JSON que contém informações sobre o espaço RAG e os dados que ele contém:

Copiar 
{
  "rag_space_id": "<string>",
  "modelo": "<string>",
  "entradas": <número>,
  "valores": [
    {
      "id": "<string>" ou <número>,
      "nome de arquivo": "<string>"
    },
    {
      "id": "<string>" ou <número>,
      vtexto": "<string>"
    }
  ]
}

  • rag_space_id é o ID do espaço RAG.

  • model é o nome do modelo usado para gerar vetores de incorporação de texto neste espaço RAG.

  • entries é o número de elementos na matriz values.

  • values é uma matriz de fragmentos de documentos de texto e nomes de arquivos PDF:

    • O id é o ID de um documento de texto (compartilhado por todos os trechos desse documento) ou de um arquivo PDF.

      Documentos adicionados a um espaço RAG antes da versão 26.0.1 do servidor do modelo de IA têm IDs de documentos numéricos (por exemplo, 1, 2, 3). A partir da versão 26.0.1, os IDs de documentos são strings UUID (por exemplo, "5f7677a0-3258-55a3-bc86-737005cb3574"). Ao trabalhar com espaços RAG que contêm documentos adicionados antes e depois da alteração do formato de ID, os scripts devem lidar com os dois formatos de ID de documento.

      Veja a etapa de script Etapa de script Executar ação RAG.

    • filename é o nome de um arquivo PDF adicionado ao espaço.

    • text é um fragmento de um documento de texto adicionado ao espaço. Os fragmentos do mesmo documento de texto têm o mesmo id.

Notas 

  • Uma conta RAG deve ser configurada seguindo a Etapa de script Configurar conta RAG antes de usar essa função.

  • Esta função é útil para verificar se um espaço RAG existe antes que sejam executadas operações nele. Em uma conta RAG válida, se um espaço não existir ou não contiver dados, essa função retorna uma mensagem de erro:

    Erro [Espaço RAG]. Motivo: espaço RAG {space_id} não encontrado

  • Se a conta RAG for inválida ou não existir, esta função retornará "?".

  • A função pode ser usada para auditoria e monitoramento de espaços RAG dentro da sua solução FileMaker.

Exemplo 1 

Obtém informações sobre todos os espaços RAG para uma conta configurada chamada "customer-support-rag-account".

GetRAGSpaceInfo ( "customer-support-rag-account" ) pode retornar o seguinte se dois espaços RAG contiverem dados:

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

Exemplo 2 

Obtém informações sobre um espaço RAG específico com o ID "knowledge-base".

GetRAGSpaceInfo ( "customer-support-rag-account" ; "knowledge-base" ) pode retornar o seguinte JSON para um espaço com os arquivos PDF "Terms.pdf" e "Policies.pdf" e um documento de texto dividido em três partes (truncado para ser breve). Observe que "Terms.pdf" tem um valor numérico para id porque foi adicionado ao espaço RAG usando uma versão anterior do servidor do modelo de IA (veja Notas).

Copiar 
{
  "rag_space_id": "knowledge-base",
  "modelo": "multi-qa-MiniLM-L6-cos-v1",
  "entradas": 5,
  "valores": [
    {
      "id": 42,
      "nome do arquivo": “Terms.pdf"
    },
    {
      "id": "f95d4266-66cd-5b50-a01b-07a4dd66c501",
      "nome do arquivo": "Policies.pdf"
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "texto": "Políticas e procedimentos de suporte ao cliente para lidar com devoluções e trocas..."
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "texto": "Garante que o item que você está devolvendo seja reembalado com todos..."
    },
    {
      "id": "5f7677a0-3258-55a3-bc86-737005cb3574",
      "texto": "Você tem 14 dias corridos para devolver um item a partir da data em que o recebeu..."
    }
  ]
}

Exemplo 3 

Usa GetRAGSpaceInfo em um script para verificar se existe um espaço RAG antes de executar as operações.

Copiar 
Configurar conta RAG [ Nome da Conta RAG: "customer-support-rag-account" ; Ponto de extremidade: "https://myserver.example.com/llm/v1/" ; Chave de API: Global::RAG_API_Key ; Verificar certificados SSL ]

Definir variável [ $ragSpaceInfo ; Valor: GetRAGSpaceInfo ( "customer-support-rag-account" ; "knowledge-base" ) ]

Se [ PatternCount ( $ragSpaceInfo ; "Erro [RAG Space]" ) > 0 or PatternCount ( $ragSpaceInfo ; "?" ) > 0 ]

    # O espaço RAG não existe. Trate o erro.

    Mostrar caixa de diálogo personalizada [ "Erro" ; "O espaço RAG especificado não foi encontrado." ] 

Else

    # O espaço RAG existe. Prossiga com as operações.
    
    Definir variável [ $ragSpaceID ; Valor: JSONGetElement ( $ragSpaceInfo ; "rag_space_id" ) ]
    
    Mostrar caixa de diálogo personalizada [ "Espaço encontrado" ; "Espaço RAG '" & $ragSpaceID & "' está disponível para uso." ]

End If

Tópicos relacionados