google-genai-kotlin/com.google.genai.kotlin.types/GroundingMetadata

GroundingMetadata

@Serializable

data class GroundingMetadata(val imageSearchQueries: List<String>? = null, val groundingChunks: List<GroundingChunk>? = null, val groundingSupports: List<GroundingSupport>? = null, val retrievalMetadata: RetrievalMetadata? = null, val searchEntryPoint: SearchEntryPoint? = null, val webSearchQueries: List<String>? = null, val googleMapsWidgetContextToken: String? = null, val retrievalQueries: List<String>? = null, val sourceFlaggingUris: List<GroundingMetadataSourceFlaggingUri>? = null)

Information for various kinds of grounding.

Constructors

GroundingMetadata

constructor(imageSearchQueries: List<String>? = null, groundingChunks: List<GroundingChunk>? = null, groundingSupports: List<GroundingSupport>? = null, retrievalMetadata: RetrievalMetadata? = null, searchEntryPoint: SearchEntryPoint? = null, webSearchQueries: List<String>? = null, googleMapsWidgetContextToken: String? = null, retrievalQueries: List<String>? = null, sourceFlaggingUris: List<GroundingMetadataSourceFlaggingUri>? = null)

Properties

googleMapsWidgetContextToken

val googleMapsWidgetContextToken: String? = null

Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.

groundingChunks

val groundingChunks: List<GroundingChunk>? = null

A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

groundingSupports

val groundingSupports: List<GroundingSupport>? = null

List of grounding support.

imageSearchQueries

val imageSearchQueries: List<String>? = null

Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.

retrievalMetadata

val retrievalMetadata: RetrievalMetadata? = null

Metadata related to retrieval in the grounding flow.

retrievalQueries

val retrievalQueries: List<String>? = null

Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. This field is not supported in Gemini API.

searchEntryPoint

val searchEntryPoint: SearchEntryPoint? = null

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

sourceFlaggingUris

val sourceFlaggingUris: List<GroundingMetadataSourceFlaggingUri>? = null

Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API.

webSearchQueries

val webSearchQueries: List<String>? = null

Web search queries for the following-up web search.