public sealed class Candidate : IMessage<Candidate>, IEquatable<Candidate>, IDeepCloneable<Candidate>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class Candidate.
A response candidate generated from the model.
Implements
IMessageCandidate, IEquatableCandidate, IDeepCloneableCandidate, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.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 |
|
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 |
|