public sealed class GroundingMetadata : IMessage<GroundingMetadata>, IEquatable<GroundingMetadata>, IDeepCloneable<GroundingMetadata>, IBufferMessage, IMessage
Reference documentation and code samples for the Vertex AI v1beta1 API class GroundingMetadata.
Metadata returned to client when grounding is enabled.
public string GoogleMapsWidgetContextToken { get; set; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis page provides reference documentation for the \u003ccode\u003eGroundingMetadata\u003c/code\u003e class within the Vertex AI v1beta1 API, specifically the latest version, 1.0.0-beta21.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGroundingMetadata\u003c/code\u003e is a sealed class that implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and it inherits from \u003ccode\u003eobject\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class \u003ccode\u003eGroundingMetadata\u003c/code\u003e has several key properties, such as \u003ccode\u003eGroundingChunks\u003c/code\u003e, \u003ccode\u003eGroundingSupports\u003c/code\u003e, \u003ccode\u003eRetrievalMetadata\u003c/code\u003e, \u003ccode\u003eRetrievalQueries\u003c/code\u003e, \u003ccode\u003eSearchEntryPoint\u003c/code\u003e, and \u003ccode\u003eWebSearchQueries\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGroundingMetadata\u003c/code\u003e has two constructors, a default constructor, and a constructor that accepts another \u003ccode\u003eGroundingMetadata\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThis class returns metadata to clients when grounding is enabled, and it includes lists of supporting references, grounding support, retrieval metadata, retrieval and web search queries, and a search entry point.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class GroundingMetadata (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.GroundingMetadata)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.GroundingMetadata) \n\n public sealed class GroundingMetadata : IMessage\u003cGroundingMetadata\u003e, IEquatable\u003cGroundingMetadata\u003e, IDeepCloneable\u003cGroundingMetadata\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Vertex AI v1beta1 API class GroundingMetadata.\n\nMetadata returned to client when grounding is enabled. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e GroundingMetadata \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[GroundingMetadata](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.GroundingMetadata), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[GroundingMetadata](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.GroundingMetadata), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[GroundingMetadata](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.GroundingMetadata), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### GroundingMetadata()\n\n public GroundingMetadata()\n\n### GroundingMetadata(GroundingMetadata)\n\n public GroundingMetadata(GroundingMetadata other)\n\nProperties\n----------\n\n### GoogleMapsWidgetContextToken\n\n public string GoogleMapsWidgetContextToken { get; set; }\n\nOptional. Output only. Resource name of the Google Maps widget context\ntoken to be used with the PlacesContextElement widget to render contextual\ndata. This is populated only for Google Maps grounding.\n\n### GroundingChunks\n\n public RepeatedField\u003cGroundingChunk\u003e GroundingChunks { get; }\n\nList of supporting references retrieved from specified grounding source.\n\n### GroundingSupports\n\n public RepeatedField\u003cGroundingSupport\u003e GroundingSupports { get; }\n\nOptional. List of grounding support.\n\n### HasGoogleMapsWidgetContextToken\n\n public bool HasGoogleMapsWidgetContextToken { get; }\n\nGets whether the \"google_maps_widget_context_token\" field is set\n\n### RetrievalMetadata\n\n public RetrievalMetadata RetrievalMetadata { get; set; }\n\nOptional. Output only. Retrieval metadata.\n\n### RetrievalQueries\n\n public RepeatedField\u003cstring\u003e RetrievalQueries { get; }\n\nOptional. Queries executed by the retrieval tools.\n\n### SearchEntryPoint\n\n public SearchEntryPoint SearchEntryPoint { get; set; }\n\nOptional. Google search entry for the following-up web searches.\n\n### WebSearchQueries\n\n public RepeatedField\u003cstring\u003e WebSearchQueries { get; }\n\nOptional. Web search queries for the following-up web search."]]
