Vertex AI v1 API - Class GroundingMetadata (3.45.0) 

public sealed class GroundingMetadata : IMessage<GroundingMetadata>, IEquatable<GroundingMetadata>, IDeepCloneable<GroundingMetadata>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1 API class GroundingMetadata.

Metadata returned to client when grounding is enabled.

Inheritance

object > GroundingMetadata

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

GroundingMetadata()

public GroundingMetadata()

GroundingMetadata(GroundingMetadata)

public GroundingMetadata(GroundingMetadata other)
Parameter
Name Description
other GroundingMetadata

Properties

GoogleMapsWidgetContextToken

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.

Property Value
Type Description
string

GroundingChunks

public RepeatedField<GroundingChunk> GroundingChunks { get; }

List of supporting references retrieved from specified grounding source.

Property Value
Type Description
RepeatedFieldGroundingChunk

GroundingSupports

public RepeatedField<GroundingSupport> GroundingSupports { get; }

Optional. List of grounding support.

Property Value
Type Description
RepeatedFieldGroundingSupport

HasGoogleMapsWidgetContextToken

public bool HasGoogleMapsWidgetContextToken { get; }

Gets whether the "google_maps_widget_context_token" field is set

Property Value
Type Description
bool

RetrievalMetadata

public RetrievalMetadata RetrievalMetadata { get; set; }

Optional. Output only. Retrieval metadata.

Property Value
Type Description
RetrievalMetadata

SearchEntryPoint

public SearchEntryPoint SearchEntryPoint { get; set; }

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

Property Value
Type Description
SearchEntryPoint

WebSearchQueries

public RepeatedField<string> WebSearchQueries { get; }

Optional. Web search queries for the following-up web search.

Property Value
Type Description
RepeatedFieldstring