Class GoogleCloudAiplatformV1GroundingMetadata

Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.

Inheritance

object

GoogleCloudAiplatformV1GroundingMetadata

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1.Data

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class GoogleCloudAiplatformV1GroundingMetadata : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

GoogleMapsWidgetContextToken

Optional. Output only. 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.

Declaration

[JsonProperty("googleMapsWidgetContextToken")]
public virtual string GoogleMapsWidgetContextToken { get; set; }

Property Value

Type	Description
string

GroundingChunks

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.

Declaration

[JsonProperty("groundingChunks")]
public virtual IList<GoogleCloudAiplatformV1GroundingChunk> GroundingChunks { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1GroundingChunk>

GroundingSupports

Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.

Declaration

[JsonProperty("groundingSupports")]
public virtual IList<GoogleCloudAiplatformV1GroundingSupport> GroundingSupports { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1GroundingSupport>

RetrievalMetadata

Optional. Output only. Metadata related to the retrieval grounding source.

Declaration

[JsonProperty("retrievalMetadata")]
public virtual GoogleCloudAiplatformV1RetrievalMetadata RetrievalMetadata { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1RetrievalMetadata

SearchEntryPoint

Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.

Declaration

[JsonProperty("searchEntryPoint")]
public virtual GoogleCloudAiplatformV1SearchEntryPoint SearchEntryPoint { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1SearchEntryPoint

SourceFlaggingUris

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.

Declaration

[JsonProperty("sourceFlaggingUris")]
public virtual IList<GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri> SourceFlaggingUris { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri>

WebSearchQueries

Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.

Declaration

[JsonProperty("webSearchQueries")]
public virtual IList<string> WebSearchQueries { get; set; }

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema