com.google.cloud.vertexai.api

Interface CandidateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Candidate, Candidate.Builder

public interface CandidateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
double	getAvgLogprobs() Output only.
CitationMetadata	getCitationMetadata() Output only.
CitationMetadataOrBuilder	getCitationMetadataOrBuilder() Output only.
Content	getContent() Output only.
ContentOrBuilder	getContentOrBuilder() Output only.
String	getFinishMessage() Output only.
com.google.protobuf.ByteString	getFinishMessageBytes() Output only.
Candidate.FinishReason	getFinishReason() Output only.
int	getFinishReasonValue() Output only.
GroundingMetadata	getGroundingMetadata() Output only.
GroundingMetadataOrBuilder	getGroundingMetadataOrBuilder() Output only.
int	getIndex() Output only.
LogprobsResult	getLogprobsResult() Output only.
LogprobsResultOrBuilder	getLogprobsResultOrBuilder() Output only.
SafetyRating	getSafetyRatings(int index) Output only.
int	getSafetyRatingsCount() Output only.
List<SafetyRating>	getSafetyRatingsList() Output only.
SafetyRatingOrBuilder	getSafetyRatingsOrBuilder(int index) Output only.
List<? extends SafetyRatingOrBuilder>	getSafetyRatingsOrBuilderList() Output only.
double	getScore() Output only.
boolean	hasCitationMetadata() Output only.
boolean	hasContent() Output only.
boolean	hasFinishMessage() Output only.
boolean	hasGroundingMetadata() Output only.
boolean	hasLogprobsResult() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIndex

int getIndex()

 Output only. Index of the candidate.
 

int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The index.

hasContent

boolean hasContent()

 Output only. Content parts of the candidate.
 

.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the content field is set.

getContent

Content getContent()

 Output only. Content parts of the candidate.
 

.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The content.

getContentOrBuilder

ContentOrBuilder getContentOrBuilder()

 Output only. Content parts of the candidate.
 

.google.cloud.vertexai.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

getScore

double getScore()

 Output only. Confidence score of the candidate.
 

double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The score.

getAvgLogprobs

double getAvgLogprobs()

 Output only. Average log probability score of the candidate.
 

double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The avgLogprobs.

hasLogprobsResult

boolean hasLogprobsResult()

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

.google.cloud.vertexai.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the logprobsResult field is set.

getLogprobsResult

LogprobsResult getLogprobsResult()

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

.google.cloud.vertexai.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The logprobsResult.

getLogprobsResultOrBuilder

LogprobsResultOrBuilder getLogprobsResultOrBuilder()

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

.google.cloud.vertexai.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getFinishReasonValue

int getFinishReasonValue()

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

.google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for finishReason.

getFinishReason

Candidate.FinishReason getFinishReason()

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

.google.cloud.vertexai.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The finishReason.

getSafetyRatingsList

List<SafetyRating> getSafetyRatingsList()

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

 There is at most one rating per category.
 

repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSafetyRatings

SafetyRating getSafetyRatings(int index)

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

 There is at most one rating per category.
 

repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSafetyRatingsCount

int getSafetyRatingsCount()

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

 There is at most one rating per category.
 

repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSafetyRatingsOrBuilderList

List<? extends SafetyRatingOrBuilder> getSafetyRatingsOrBuilderList()

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

 There is at most one rating per category.
 

repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSafetyRatingsOrBuilder

SafetyRatingOrBuilder getSafetyRatingsOrBuilder(int index)

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

 There is at most one rating per category.
 

repeated .google.cloud.vertexai.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasFinishMessage

boolean hasFinishMessage()

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

optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the finishMessage field is set.

getFinishMessage

String getFinishMessage()

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

optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The finishMessage.

getFinishMessageBytes

com.google.protobuf.ByteString getFinishMessageBytes()

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

optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for finishMessage.

hasCitationMetadata

boolean hasCitationMetadata()

 Output only. Source attribution of the generated content.
 

.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the citationMetadata field is set.

getCitationMetadata

CitationMetadata getCitationMetadata()

 Output only. Source attribution of the generated content.
 

.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The citationMetadata.

getCitationMetadataOrBuilder

CitationMetadataOrBuilder getCitationMetadataOrBuilder()

 Output only. Source attribution of the generated content.
 

.google.cloud.vertexai.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasGroundingMetadata

boolean hasGroundingMetadata()

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

.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the groundingMetadata field is set.

getGroundingMetadata

GroundingMetadata getGroundingMetadata()

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

.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The groundingMetadata.

getGroundingMetadataOrBuilder

GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()

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

.google.cloud.vertexai.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];