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 un 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 au nom à afficher pour le fichier. |
source_display_name |
Nom à afficher du fichier. |
text |
Le fragment de texte pertinent pour la requête. |
score |
Similarité ou distance entre la requête et le segment de texte.
La similarité ou la distance dépend de l'vectorDB que vous choisissez. Pour ragManagedDB , le score est COSINE_DISTANCE . |
Exemple de résultat
Cet exemple de code montre comment utiliser les champs pour générer un exemple de sortie.
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 un exemple de code.
Nom de champ | Description |
---|---|
text |
Réponse générée par Gemini. |
grounding_chunks |
Les segments renvoyés par le moteur de RAG Vertex AI. |
retrieved_context |
Champ répété pouvant contenir zéro ou plusieurs segments utilisés pour appuyer le contenu généré. |
|
|
|
|
|
|
grounding_supports |
Relation entre le contenu généré et les segments 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 segments de texte récupérés par RAG. |
segment |
Segment de texte basé sur le texte généré. |
|
|
|
|
|
|
grounding_chunk_indices |
Bloc utilisé pour ancrer le segment de texte. Plusieurs segments peuvent être utilisés pour ancrer le texte. L'index commence à 0 , qui représente le premier segment du champ grounding_chunks . Le sol s'étend sur l'ensemble du bloc. La partie du bloc qui fonde la réponse n'est pas spécifiée. |
confidence_scores |
Score utilisé pour ancrer le texte sur un segment 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 segments dont le score de confiance est d'au moins 0.6 sont inclus dans la sortie. |
Exemple de résultat
Cet exemple de code montre comment utiliser les champs pour générer un exemple de sortie.
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
}
}
}
Étape suivante
- Pour en savoir plus sur le contexte RAG dans la documentation de référence de l'API, consultez la section Contexte.
- Pour en savoir plus sur la RAG, consultez la page Présentation du moteur de RAG Vertex AI.