Show / Hide Table of Contents

Class GoogleCloudAiplatformV1beta1Candidate

A response candidate generated from the model.

Inheritance
object
GoogleCloudAiplatformV1beta1Candidate
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.FirebaseML.v2beta.Data
Assembly: Google.Apis.FirebaseML.v2beta.dll
Syntax
public class GoogleCloudAiplatformV1beta1Candidate : IDirectResponseSchema

Properties

AvgLogprobs

Output only. Average log probability score of the candidate.

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

CitationMetadata

Output only. Source attribution of the generated content.

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

Content

Output only. Content parts of the candidate.

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

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 mode stopped generating tokens in more detail. This is only filled 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 the tokens.

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

GroundingMetadata

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

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

Index

Output only. Index of the candidate.

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

LogprobsResult

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

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

SafetyRatings

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

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX