Sortie de récupération et de génération du moteur RAG Vertex AI

Cette page explique chaque champ de la sortie du moteur RAG de Vertex AI.

retrieveContexts

Cette section décrit chaque champ défini dans l'API retrieveContexts et utilise les champs dans l'exemple de code.

Champs

Nom de champ Description
source_uri Fichier source d'origine avant son importation dans RAG. Si le fichier est importé depuis Cloud Storage ou Google Drive, source_uri correspond à l'URI du fichier d'origine dans Cloud Storage ou Drive. Si le fichier est importé, source_uri correspond à son nom à afficher.
source_display_name Nom à afficher du fichier.
text Bloc de texte pertinent pour la requête.
score Similitude ou distance entre la requête et le bloc de texte. La similarité ou la distance dépendent du vectorDB que vous choisissez. Pour ragManagedDB, le score correspond à COSINE_DISTANCE.

Exemple de sortie

Cet exemple de code montre comment utiliser les champs pour générer un exemple de résultat.

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

generateContent

La plupart des champs définis pour l'API generateContent se trouvent dans le corps de la réponse.

Champs

Cette section décrit chaque champ défini dans la partie grounding_metadata de l'API generateContent et utilise les champs dans l'exemple de code.

Nom de champ Description
text Réponse générée par Gemini.
grounding_chunks Il s'agit des blocs renvoyés par le moteur RAG Vertex AI.
retrieved_context Champ répété pouvant contenir zéro ou plusieurs blocs utilisés pour ancrer le contenu généré.
  • uri
  • source_uri indique l'emplacement de stockage initial des données.
  • title
  • source_display_name correspond au nom de fichier ou au nom à afficher du fichier d'origine.
  • text
  • Le bloc de texte est utilisé pour ancrer la réponse de Gemini.
grounding_supports Relation entre le contenu généré et les blocs d'ancrage. Il s'agit d'un champ répété. Chaque champ grounding_supports indique la relation entre un segment de texte du contexte généré et un ou plusieurs blocs de texte récupérés par RAG.
segment Segment de texte ancré du texte généré.
  • start_index
  • Premier index du texte ancré. Si start_index est manquant, start_index est défini sur 0.
  • end_index
  • Dernier index du texte ancré.
  • text
  • Texte ancré.
grounding_chunk_indices Bloc utilisé pour ancrer le segment de texte. Plusieurs blocs peuvent être utilisés pour ancrer le texte. L'index commence à 0, qui représente le premier bloc du champ grounding_chunks. Le sol se trouve sur l'ensemble du bloc. La partie du bloc qui ancre la réponse n'est pas spécifiée.
confidence_scores Score utilisé pour ancrer le texte sur un bloc donné. Le score le plus élevé possible est 1. Plus le score est élevé, plus le niveau de confiance est élevé. Chaque score correspond à chaque grounding_chunk_indices. Seuls les blocs dont le score de confiance est d'au moins 0.6 sont inclus dans le résultat.

Exemple de sortie

Cet exemple de code montre comment utiliser les champs pour générer un exemple de résultat.

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
    }
  }
}

Étapes suivantes