Resultados de obtenção e geração do Vertex AI RAG Engine

Esta página explica cada campo do resultado do motor RAG da Vertex AI.

retrieveContexts

Esta secção descreve cada campo definido na API retrieveContexts e usa os campos no código de exemplo.

Campos

Nome do campo Descrição
source_uri O ficheiro de origem original antes de ser importado para a RAG. Se o ficheiro for importado do Cloud Storage ou do Google Drive, source_uri é o URI do ficheiro original no Cloud Storage ou no Drive. Se o ficheiro for carregado, source_uri é o nome a apresentar do ficheiro.
source_display_name O nome a apresentar do ficheiro.
text O fragmento de texto relevante para a consulta.
score A semelhança ou a distância entre a consulta e o fragmento de texto. A semelhança ou a distância depende do vectorDB que escolher. Para ragManagedDB, a pontuação é COSINE_DISTANCE.

Exemplo de saída

Este exemplo de código demonstra a utilização dos campos para produzir um resultado de exemplo.

contexts {
    source_uri: "gs://sample_folder/hello_world.txt"
    source_display_name: "hello_world.txt"
    text: "Hello World!"
    score: 0.60545359030757784
  }

generateContent

A maioria dos campos definidos para a API generateContent pode ser encontrada no corpo da resposta.

Campos

Esta secção descreve cada campo definido na parte grounding_metadata da API generateContent e usa os campos no código de exemplo.

Nome do campo Descrição
text A resposta gerada pelo Gemini.
grounding_chunks Os fragmentos devolvidos pelo Vertex AI RAG Engine.
retrieved_context Um campo repetido que pode ter zero ou mais blocos usados para fundamentar o conteúdo gerado.
  • uri
  • O elemento source_uri especifica onde os dados são armazenados originalmente.
  • title
  • O elemento source_display_name é o nome do ficheiro ou o nome a apresentar do ficheiro original.
  • text
  • O fragmento de texto é usado para fundamentar a resposta do Gemini.
grounding_supports A relação entre o conteúdo gerado e os fragmentos de base. Este é um campo repetido. Cada campo grounding_supports mostra a relação entre um segmento de texto do contexto gerado e um ou mais fragmentos de texto obtidos através da RAG.
segment O segmento de texto fundamentado do texto gerado.
  • start_index
  • O primeiro índice do texto fundamentado. Se o elemento start_index estiver em falta, o elemento start_index é 0.
  • end_index
  • O último índice do texto fundamentado.
  • text
  • O texto fundamentado.
grounding_chunk_indices O fragmento usado para fundamentar o segmento de texto. Pode haver mais do que um fragmento usado para fundamentar o texto. O índice começa em 0, que representa o primeiro fragmento no campo grounding_chunks. O chão está em todo o bloco. A parte do fragmento que fundamenta a resposta não está especificada.
confidence_scores A pontuação usada para fundamentar o texto num determinado fragmento. A pontuação mais alta possível é 1 e, quanto mais elevada for a pontuação, mais elevado é o nível de confiança. Cada pontuação corresponde a cada grounding_chunk_indices. Apenas os fragmentos com uma pontuação de confiança de, pelo menos, 0.6 são incluídos no resultado.

Exemplo de saída

Este exemplo de código demonstra a utilização dos campos para produzir um resultado de exemplo.

candidates {
  content {
    role: "model"
    parts {
      text: "The rectangle is red and the background is white. The rectangle appears to be on some type of document editing software. \n"
    }
  }
  grounding_metadata {
    grounding_chunks {
      retrieved_context {
        uri: "a.txt"
        title: "a.txt"
        text: "Okay ,  I  see  a  red  rectangle  on  a  white  background .  It looks like it\'s on some sort of document editing software. It has those small squares and circles around it, indicating that it\'s a selected object ."
      }
    }
    grounding_chunks {
      retrieved_context {
        uri: "b.txt"
        title: "b.txt"
        text: "The  video  is  identical  to  the  last  time  I  described  it .  It shows a blue rectangle on a white background."
      }
    }
    grounding_chunks {
      retrieved_context {
        uri: "c.txt"
        title: "c.txt"
        text: "Okay ,  I  remember  the  rectangle  was  blue  in  the  past  session . Now it is red.\n The  red  rectangle  is  still  there .  It \' s  still  in  the same position on the white background, with the same handles around it. Nothing new is visible since last time.\n You \' re  welcome .  The  red  rectangle  is  still  the  only  thing visible."
      }
    }
    grounding_supports {
      segment {
        end_index: 49
        text: "The rectangle is red and the background is white."
      }
      grounding_chunk_indices: 2
      grounding_chunk_indices: 0
      confidence_scores: 0.958192229
      confidence_scores: 0.992316723
    }
    grounding_supports {
      segment {
        start_index: 50
        end_index: 120
        text: "The rectangle appears to be on some type of document editing software."
      }
      grounding_chunk_indices: 0
      confidence_scores: 0.98374176
    }
  }
}

O que se segue?