Grounding API

Bei der generativen KI ist Fundierung die Fähigkeit, die Modellausgabe mit überprüfbaren Informationsquellen zu verbinden. Wenn Sie den Modellen Zugang zu bestimmten Datenquellen gewähren, dann bindet die Fundierung ihre Ausgabe an diese Daten und verringert die Wahrscheinlichkeit, dass Inhalte erfunden werden.

Mit Vertex AI können Sie Modellausgaben so fundieren:

  • Mit der Google Suche fundieren: Ein Modell mit öffentlich verfügbaren Webdaten fundieren.
  • Mit Google Maps fundieren: Ein Modell mit Geodaten aus Google Maps fundieren.
  • Fundierung auf Ihren Daten – Fundieren Sie ein Modell mit Ihren Daten aus Vertex AI Search als Datenspeicher.

Weitere Informationen zur Fundierung finden Sie unter Fundierungsübersicht.

Unterstützte Modelle

Parameterliste

Einzelheiten zur Implementierung finden Sie in den Beispielen.

googleSearch

Fundieren Sie die Antwort mit öffentlich verfügbaren Webdaten aus der Google Suche.

googleMaps

Fundieren Sie die Antwort mit öffentlich verfügbaren Geodaten aus Google Maps.

Die API-Eingabe enthält den folgenden Parameter:

Eingabeparameter

enable_widget

Erforderlich: boolean

Flag, das auf true oder false gesetzt werden kann. Bei einem Wert von true wird ein Token mit der API-Antwort zurückgegeben, das Sie mit der Benutzeroberfläche des Google Maps-Kontext-Widgets verwenden können.

Die API-Antwortstruktur enthält den folgenden Parameter:

Antwortparameter

grounding_metadata

Erforderlich: Object

Das primäre Feld, das Kontextinformationen enthält.
  • grounding_support: Ein Unterfeld, das die Ebene der Fundierung angibt.
  • grounding_chunks.maps: Ein Unterfeld mit den Orten, die als Quellen für die fundierte Antwort verwendet wurden.
    • place_answer_sources.review_snippets: Ein Unterfeld in grounding_chunks.maps, das angezeigt wird, wenn eine Ortsantwort zur Beantwortung einer Anfrage verwendet wird. Ortsbezogene Antworten enthalten mithilfe von Daten wie Nutzerrezensionen detailliertere Kontextinformationen zu einem bestimmten Ort. Die Antwort zum Ort basiert auf einer Liste von Quellen wie Nutzerrezensionen.

Attribute

Eine Quelle für Orts- oder Nutzerrezensionen hat die folgenden Attribute:

Attribute

title

Erforderlich: Object

Der Titel der Quelle.

uri

Erforderlich: string

Ein URI, der auf die Quelle verweist.

place_id

Erforderlich: string

Eine eindeutige Kennung für den Ort.

review_id

Erforderlich: string

Eine eindeutige Kennung für die Rezension.

retrieval

Fundieren Sie die Antwort mit privaten Daten aus Vertex AI Search als Datenspeicher. Definiert ein Abruftool, das das Modell aufrufen kann, um auf externes Wissen zuzugreifen.

Parameter

vertexAiSearch

Erforderlich: VertexAISearch

Fundierung mit Vertex AI Search-Datenquellen

VertexAISearch

Parameter

datastore

Erforderlich: string

Vollständig qualifizierte Datenspeicher-Ressourcen-ID aus Vertex AI Search im folgenden Format: projects/{project}/locations/{location}/collections/default_collection/dataStores/{datastore}

Beispiele

In diesem Abschnitt finden Sie Beispiele für die Fundierung einer Antwort auf öffentlichen Webdaten mit der Google Suche und die Fundierung einer Antwort auf privaten Daten mit Vertex AI Search.

Fundierungsantwort zu öffentlichen Webdaten mit der Google Suche

Fundiere die Antwort mit öffentlichen Daten aus der Google Suche. Fügen Sie das google_search_retrieval-Tool in die Anfrage ein. Es sind keine zusätzlichen Parameter erforderlich.

Python

Installieren

pip install --upgrade google-genai

Weitere Informationen finden Sie in der SDK-Referenzdokumentation.

Umgebungsvariablen für die Verwendung des Gen AI SDK mit Vertex AI festlegen: 

# Replace the `GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_LOCATION` values
# with appropriate values for your project.
export GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT
export GOOGLE_CLOUD_LOCATION=global
export GOOGLE_GENAI_USE_VERTEXAI=True
 

from google import genai
from google.genai.types import (
    GenerateContentConfig,
    GoogleSearch,
    HttpOptions,
    Tool,
)

client = genai.Client(http_options=HttpOptions(api_version="v1"))

response = client.models.generate_content(
    model="gemini-2.5-flash",
    contents="When is the next total solar eclipse in the United States?",
    config=GenerateContentConfig(
        tools=[
            # Use Google Search Tool
            Tool(google_search=GoogleSearch())
        ],
    ),
)

print(response.text)
# Example response:
# 'The next total solar eclipse in the United States will occur on ...'

Go

Informationen zum Installieren oder Aktualisieren von Go

Weitere Informationen finden Sie in der SDK-Referenzdokumentation.

Umgebungsvariablen für die Verwendung des Gen AI SDK mit Vertex AI festlegen: 

# Replace the `GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_LOCATION` values
# with appropriate values for your project.
export GOOGLE_CLOUD_PROJECT=GOOGLE_CLOUD_PROJECT
export GOOGLE_CLOUD_LOCATION=global
export GOOGLE_GENAI_USE_VERTEXAI=True
 

import (
	"context"
	"fmt"
	"io"

	genai "google.golang.org/genai"
)

// generateWithGoogleSearch shows how to generate text using Google Search.
func generateWithGoogleSearch(w io.Writer) error {
	ctx := context.Background()

	client, err := genai.NewClient(ctx, &genai.ClientConfig{
		HTTPOptions: genai.HTTPOptions{APIVersion: "v1"},
	})
	if err != nil {
		return fmt.Errorf("failed to create genai client: %w", err)
	}

	modelName := "gemini-2.5-flash"
	contents := []*genai.Content{
		{Parts: []*genai.Part{
			{Text: "When is the next total solar eclipse in the United States?"},
		},
			Role: "user"},
	}
	config := &genai.GenerateContentConfig{
		Tools: []*genai.Tool{
			{GoogleSearch: &genai.GoogleSearch{}},
		},
	}

	resp, err := client.Models.GenerateContent(ctx, modelName, contents, config)
	if err != nil {
		return fmt.Errorf("failed to generate content: %w", err)
	}

	respText := resp.Text()

	fmt.Fprintln(w, respText)

	// Example response:
	// The next total solar eclipse in the United States will occur on March 30, 2033, but it will only ...

	return nil
}

Fundierungsantwort für private Daten mit Vertex AI Search

Fundieren Sie die Antwort mit Daten aus einem Vertex AI Search-Datenspeicher. Weitere Informationen finden Sie unter KI-Anwendungen.

Bevor Sie eine Antwort mit privaten Daten beginnen, erstellen Sie einen Datenspeicher und eine Such-App.

ACHTUNG: Derzeit wird der „Chunk-Modus“ von Vertex AI Search in dieser Oberfläche für die Fundierung nicht unterstützt.

Gen AI SDK für Python

from google import genai
from google.genai.types import (
    GenerateContentConfig,
    HttpOptions,
    Retrieval,
    Tool,
    VertexAISearch,
)

client = genai.Client(http_options=HttpOptions(api_version="v1"))

# Load Data Store ID from Vertex AI Search
# datastore = "projects/111111111111/locations/global/collections/default_collection/dataStores/data-store-id"

response = client.models.generate_content(
    model="gemini-2.5-flash",
    contents="How do I make an appointment to renew my driver's license?",
    config=GenerateContentConfig(
        tools=[
            # Use Vertex AI Search Tool
            Tool(
                retrieval=Retrieval(
                    vertex_ai_search=VertexAISearch(
                        datastore=datastore,
                    )
                )
            )
        ],
    ),
)

print(response.text)
# Example response:
# 'The process for making an appointment to renew your driver's license varies depending on your location. To provide you with the most accurate instructions...'

Nächste Schritte

Eine ausführliche Dokumentation finden Sie hier: