Cloud AI Platform v1 API - Class Candidate (3.8.0)

Version 3.8.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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

Reference documentation and code samples for the Cloud AI Platform v1 API class Candidate.

A response candidate generated from the model.

Inheritance

object > Candidate

Implements

IMessageCandidate, IEquatableCandidate, IDeepCloneableCandidate, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Candidate()

public Candidate()

Candidate(Candidate)

public Candidate(Candidate other)

Parameter
Name	Description
other	Candidate

Properties

AvgLogprobs

public double AvgLogprobs { get; set; }

Output only. Average log probability score of the candidate.

Property Value
Type	Description
double

CitationMetadata

public CitationMetadata CitationMetadata { get; set; }

Output only. Source attribution of the generated content.

Property Value
Type	Description
CitationMetadata

Content

public Content Content { get; set; }

Output only. Content parts of the candidate.

Property Value
Type	Description
Content

FinishMessage

public string FinishMessage { get; set; }

Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when finish_reason is set.

Property Value
Type	Description
string

FinishReason

public Candidate.Types.FinishReason FinishReason { get; set; }

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

Property Value
Type	Description
CandidateTypesFinishReason

GroundingMetadata

public GroundingMetadata GroundingMetadata { get; set; }

Output only. Metadata specifies sources used to ground generated content.

Property Value
Type	Description
GroundingMetadata

HasFinishMessage

public bool HasFinishMessage { get; }

Gets whether the "finish_message" field is set

Property Value
Type	Description
bool

Index

public int Index { get; set; }

Output only. Index of the candidate.

Property Value
Type	Description
int

LogprobsResult

public LogprobsResult LogprobsResult { get; set; }

Output only. Log-likelihood scores for the response tokens and top tokens

Property Value
Type	Description
LogprobsResult

SafetyRatings

public RepeatedField<SafetyRating> SafetyRatings { get; }

Output only. List of ratings for the safety of a response candidate.

There is at most one rating per category.

Property Value
Type	Description
RepeatedFieldSafetyRating

Score

public double Score { get; set; }

Output only. Confidence score of the candidate.

Property Value
Type	Description
double