Output di recupero e generazione del motore RAG di Vertex AI

Questa pagina spiega ogni campo dell'output del motore RAG di Vertex AI.

retrieveContexts

Questa sezione descrive ogni campo definito nell'API retrieveContexts e utilizza i campi nel codice di esempio.

Campi

Nome campo Descrizione
source_uri Il file di origine originale prima dell'importazione in RAG. Se il file viene importato da Cloud Storage o Google Drive, source_uri è l'URI del file originale in Cloud Storage o Drive. Se il file è stato caricato, source_uri è il nome visualizzato del file.
source_display_name Il nome visualizzato del file.
text Il frammento di testo pertinente alla query.
score La somiglianza o la distanza tra la query e il frammento di testo. La somiglianza o la distanza dipende dal vectorDB che scegli. Per ragManagedDB, il punteggio è COSINE_DISTANCE.

Esempio di output

Questo esempio di codice dimostra l'utilizzo dei campi per produrre un output di esempio.

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

generateContent

La maggior parte dei campi definiti per l'API generateContent si trova nel corpo della risposta.

Campi

Questa sezione descrive ogni campo definito nella parte grounding_metadata dell'API generateContent e utilizza i campi nel codice di esempio.

Nome campo Descrizione
text La risposta generata da Gemini.
grounding_chunks I chunk restituiti dal motore RAG di Vertex AI.
retrieved_context Un campo ripetuto che può avere zero o più chunk utilizzati per basare i contenuti generati.
  • uri
  • source_uri specifica dove sono archiviati originariamente i dati.
  • title
  • source_display_name è il nome file o il nome visualizzato del file originale.
  • text
  • Il frammento di testo viene utilizzato per basare la risposta di Gemini.
grounding_supports La relazione tra i contenuti generati e i chunk di riferimento. Si tratta di un campo ripetuto. Ogni campo grounding_supports mostra la relazione tra un segmento di testo del contesto generato e uno o più blocchi di testo recuperati dalla RAG.
segment Il segmento di testo basato sul testo generato.
  • start_index
  • Il primo indice del testo basato su dati. Se start_index non è presente, start_index è 0.
  • end_index
  • L'ultimo indice del testo basato su dati.
  • text
  • Il testo giustificato.
grounding_chunk_indices Il chunk utilizzato per basare il segmento di testo. Può essere utilizzato più di un chunk per basare il testo. L'indice inizia da 0, che rappresenta il primo chunk nel campo grounding_chunks. Il suolo è presente nell'intero blocco. La parte del chunk che giustifica la risposta non è specificata.
confidence_scores Il punteggio utilizzato per basare il testo su un determinato chunk. Il punteggio più alto possibile è 1 e, più alto è il punteggio, maggiore è il livello di confidenza. Ogni punteggio corrisponde a ogni grounding_chunk_indices. Nell'output sono inclusi solo i chunk con un punteggio di confidenza di almeno 0.6.

Esempio di output

Questo esempio di codice dimostra l'utilizzo dei campi per produrre un output di esempio.

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

Passaggi successivi