Table of Contents

Class GroundingMetadata

Namespace
GenerativeAI.Types
Assembly
GenerativeAI.dll

Metadata returned to client when grounding is enabled.

public class GroundingMetadata
Inheritance
GroundingMetadata
Inherited Members
Extension Methods

Properties

GoogleMapsWidgetContextToken

Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.

[JsonPropertyName("googleMapsWidgetContextToken")]
public string? GoogleMapsWidgetContextToken { get; set; }

Property Value

string

GroundingChunks

List of supporting references retrieved from the specified grounding source.

[JsonPropertyName("groundingChunks")]
public List<GroundingChunk>? GroundingChunks { get; set; }

Property Value

List<GroundingChunk>

GroundingSupports

List of grounding support.

[JsonPropertyName("groundingSupports")]
public List<GroundingSupport>? GroundingSupports { get; set; }

Property Value

List<GroundingSupport>

ImageSearchQueries

Image search queries used for grounding.

[JsonPropertyName("imageSearchQueries")]
public List<string>? ImageSearchQueries { get; set; }

Property Value

List<string>

RetrievalMetadata

Metadata related to retrieval in the grounding flow.

[JsonPropertyName("retrievalMetadata")]
public RetrievalMetadata? RetrievalMetadata { get; set; }

Property Value

RetrievalMetadata

RetrievalQueries

Optional. Queries executed by the retrieval tools.

[JsonPropertyName("retrievalQueries")]
public List<string>? RetrievalQueries { get; set; }

Property Value

List<string>

SearchEntryPoint

Optional. Google search entry for the following-up web searches.

[JsonPropertyName("searchEntryPoint")]
public SearchEntryPoint? SearchEntryPoint { get; set; }

Property Value

SearchEntryPoint

SourceFlaggingUris

Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.

[JsonPropertyName("sourceFlaggingUris")]
public List<GroundingMetadataSourceFlaggingUri>? SourceFlaggingUris { get; set; }

Property Value

List<GroundingMetadataSourceFlaggingUri>

WebSearchQueries

Web search queries for the following-up web search.

[JsonPropertyName("webSearchQueries")]
public List<string>? WebSearchQueries { get; set; }

Property Value

List<string>

See Also