Class GoogleCloudAiplatformV1Candidate

A response candidate generated from the model.

Inheritance
object
GoogleCloudAiplatformV1Candidate
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1Candidate : IDirectResponseSchema

Properties

AvgLogprobs

Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.

Declaration
[JsonProperty("avgLogprobs")]
public virtual double? AvgLogprobs { get; set; }
Property Value
Type Description
double?

CitationMetadata

Output only. A collection of citations that apply to the generated content.

Declaration
[JsonProperty("citationMetadata")]
public virtual GoogleCloudAiplatformV1CitationMetadata CitationMetadata { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1CitationMetadata

Content

Output only. The content of the candidate.

Declaration
[JsonProperty("content")]
public virtual GoogleCloudAiplatformV1Content Content { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1Content

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FinishMessage

Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when finish_reason is set.

Declaration
[JsonProperty("finishMessage")]
public virtual string FinishMessage { get; set; }
Property Value
Type Description
string

FinishReason

Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.

Declaration
[JsonProperty("finishReason")]
public virtual string FinishReason { get; set; }
Property Value
Type Description
string

GroundingMetadata

Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.

Declaration
[JsonProperty("groundingMetadata")]
public virtual GoogleCloudAiplatformV1GroundingMetadata GroundingMetadata { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1GroundingMetadata

Index

Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when candidate_count > 1.

Declaration
[JsonProperty("index")]
public virtual int? Index { get; set; }
Property Value
Type Description
int?

LogprobsResult

Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".

Declaration
[JsonProperty("logprobsResult")]
public virtual GoogleCloudAiplatformV1LogprobsResult LogprobsResult { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1LogprobsResult

SafetyRatings

Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.

Declaration
[JsonProperty("safetyRatings")]
public virtual IList<GoogleCloudAiplatformV1SafetyRating> SafetyRatings { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1SafetyRating>

UrlContextMetadata

Output only. Metadata returned when the model uses the url_context tool to get information from a user-provided URL.

Declaration
[JsonProperty("urlContextMetadata")]
public virtual GoogleCloudAiplatformV1UrlContextMetadata UrlContextMetadata { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1UrlContextMetadata

Implements