com.google.cloud.vertexai.api

Class Candidate

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vertexai.api.Candidate

All Implemented Interfaces:

CandidateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Candidate
extends com.google.protobuf.GeneratedMessageV3
implements CandidateOrBuilder

 A response candidate generated from the model.
 

Protobuf type google.cloud.vertexai.v1.Candidate

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Candidate.Builder A response candidate generated from the model.
static class	Candidate.FinishReason The reason why the model stopped generating tokens.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVG_LOGPROBS_FIELD_NUMBER
static int	CITATION_METADATA_FIELD_NUMBER
static int	CONTENT_FIELD_NUMBER
static int	FINISH_MESSAGE_FIELD_NUMBER
static int	FINISH_REASON_FIELD_NUMBER
static int	GROUNDING_METADATA_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER
static int	LOGPROBS_RESULT_FIELD_NUMBER
static int	SAFETY_RATINGS_FIELD_NUMBER
static int	SCORE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getAvgLogprobs() Output only.
CitationMetadata	getCitationMetadata() Output only.
CitationMetadataOrBuilder	getCitationMetadataOrBuilder() Output only.
Content	getContent() Output only.
ContentOrBuilder	getContentOrBuilder() Output only.
static Candidate	getDefaultInstance()
Candidate	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Candidate>	getParserForType()
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.
int	getSerializedSize()
boolean	hasCitationMetadata() Output only.
boolean	hasContent() Output only.
boolean	hasFinishMessage() Output only.
boolean	hasGroundingMetadata() Output only.
int	hashCode()
boolean	hasLogprobsResult() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Candidate.Builder	newBuilder()
static Candidate.Builder	newBuilder(Candidate prototype)
Candidate.Builder	newBuilderForType()
protected Candidate.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Candidate	parseDelimitedFrom(InputStream input)
static Candidate	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Candidate	parseFrom(byte[] data)
static Candidate	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Candidate	parseFrom(ByteBuffer data)
static Candidate	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Candidate	parseFrom(com.google.protobuf.ByteString data)
static Candidate	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Candidate	parseFrom(com.google.protobuf.CodedInputStream input)
static Candidate	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Candidate	parseFrom(InputStream input)
static Candidate	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Candidate>	parser()
Candidate.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

See Also:

Constant Field Values

AVG_LOGPROBS_FIELD_NUMBER

public static final int AVG_LOGPROBS_FIELD_NUMBER

See Also:

Constant Field Values

LOGPROBS_RESULT_FIELD_NUMBER

public static final int LOGPROBS_RESULT_FIELD_NUMBER

See Also:

Constant Field Values

FINISH_REASON_FIELD_NUMBER

public static final int FINISH_REASON_FIELD_NUMBER

See Also:

Constant Field Values

SAFETY_RATINGS_FIELD_NUMBER

public static final int SAFETY_RATINGS_FIELD_NUMBER

See Also:

Constant Field Values

FINISH_MESSAGE_FIELD_NUMBER

public static final int FINISH_MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

CITATION_METADATA_FIELD_NUMBER

public static final int CITATION_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_METADATA_FIELD_NUMBER

public static final int GROUNDING_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getIndex

public int getIndex()

 Output only. Index of the candidate.
 

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

Specified by:

getIndex in interface CandidateOrBuilder

Returns:

The index.

hasContent

public boolean hasContent()

 Output only. Content parts of the candidate.
 

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

Specified by:

hasContent in interface CandidateOrBuilder

Returns:

Whether the content field is set.

getContent

public Content getContent()

 Output only. Content parts of the candidate.
 

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

Specified by:

getContent in interface CandidateOrBuilder

Returns:

The content.

getContentOrBuilder

public ContentOrBuilder getContentOrBuilder()

 Output only. Content parts of the candidate.
 

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

Specified by:

getContentOrBuilder in interface CandidateOrBuilder

getScore

public double getScore()

 Output only. Confidence score of the candidate.
 

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

Specified by:

getScore in interface CandidateOrBuilder

Returns:

The score.

getAvgLogprobs

public double getAvgLogprobs()

 Output only. Average log probability score of the candidate.
 

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

Specified by:

getAvgLogprobs in interface CandidateOrBuilder

Returns:

The avgLogprobs.

hasLogprobsResult

public 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];

Specified by:

hasLogprobsResult in interface CandidateOrBuilder

Returns:

Whether the logprobsResult field is set.

getLogprobsResult

public 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];

Specified by:

getLogprobsResult in interface CandidateOrBuilder

Returns:

The logprobsResult.

getLogprobsResultOrBuilder

public 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];

Specified by:

getLogprobsResultOrBuilder in interface CandidateOrBuilder

getFinishReasonValue

public 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];

Specified by:

getFinishReasonValue in interface CandidateOrBuilder

Returns:

The enum numeric value on the wire for finishReason.

getFinishReason

public 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];

Specified by:

getFinishReason in interface CandidateOrBuilder

Returns:

The finishReason.

getSafetyRatingsList

public 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];

Specified by:

getSafetyRatingsList in interface CandidateOrBuilder

getSafetyRatingsOrBuilderList

public 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];

Specified by:

getSafetyRatingsOrBuilderList in interface CandidateOrBuilder

getSafetyRatingsCount

public 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];

Specified by:

getSafetyRatingsCount in interface CandidateOrBuilder

getSafetyRatings

public 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];

Specified by:

getSafetyRatings in interface CandidateOrBuilder

getSafetyRatingsOrBuilder

public 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];

Specified by:

getSafetyRatingsOrBuilder in interface CandidateOrBuilder

hasFinishMessage

public 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];

Specified by:

hasFinishMessage in interface CandidateOrBuilder

Returns:

Whether the finishMessage field is set.

getFinishMessage

public 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];

Specified by:

getFinishMessage in interface CandidateOrBuilder

Returns:

The finishMessage.

getFinishMessageBytes

public 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];

Specified by:

getFinishMessageBytes in interface CandidateOrBuilder

Returns:

The bytes for finishMessage.

hasCitationMetadata

public boolean hasCitationMetadata()

 Output only. Source attribution of the generated content.
 

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

Specified by:

hasCitationMetadata in interface CandidateOrBuilder

Returns:

Whether the citationMetadata field is set.

getCitationMetadata

public CitationMetadata getCitationMetadata()

 Output only. Source attribution of the generated content.
 

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

Specified by:

getCitationMetadata in interface CandidateOrBuilder

Returns:

The citationMetadata.

getCitationMetadataOrBuilder

public CitationMetadataOrBuilder getCitationMetadataOrBuilder()

 Output only. Source attribution of the generated content.
 

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

Specified by:

getCitationMetadataOrBuilder in interface CandidateOrBuilder

hasGroundingMetadata

public 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];

Specified by:

hasGroundingMetadata in interface CandidateOrBuilder

Returns:

Whether the groundingMetadata field is set.

getGroundingMetadata

public 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];

Specified by:

getGroundingMetadata in interface CandidateOrBuilder

Returns:

The groundingMetadata.

getGroundingMetadataOrBuilder

public 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];

Specified by:

getGroundingMetadataOrBuilder in interface CandidateOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Candidate parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Candidate parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Candidate parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Candidate parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Candidate parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static Candidate parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Candidate parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public Candidate.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Candidate.Builder newBuilder()

newBuilder

public static Candidate.Builder newBuilder(Candidate prototype)

toBuilder

public Candidate.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Candidate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Candidate getDefaultInstance()

parser

public static com.google.protobuf.Parser<Candidate> parser()

getParserForType

public com.google.protobuf.Parser<Candidate> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Candidate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder