Class Candidate (1.14.0)

publicfinalclass CandidateextendsGeneratedMessageV3implementsCandidateOrBuilder

A response candidate generated from the model.

Protobuf type google.cloud.vertexai.v1.Candidate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Candidate

Implements

CandidateOrBuilder

Inherited Members

publicstaticfinalintAVG_LOGPROBS_FIELD_NUMBER

publicstaticfinalintCITATION_METADATA_FIELD_NUMBER

publicstaticfinalintCONTENT_FIELD_NUMBER

publicstaticfinalintFINISH_MESSAGE_FIELD_NUMBER

publicstaticfinalintFINISH_REASON_FIELD_NUMBER

publicstaticfinalintGROUNDING_METADATA_FIELD_NUMBER

publicstaticfinalintINDEX_FIELD_NUMBER

publicstaticfinalintSAFETY_RATINGS_FIELD_NUMBER

publicstaticfinalintSCORE_FIELD_NUMBER

publicstaticCandidategetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticCandidate.BuildernewBuilder()

publicstaticCandidate.BuildernewBuilder(Candidateprototype)

publicstaticCandidateparseDelimitedFrom(InputStreaminput)

publicstaticCandidateparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticCandidateparseFrom(byte[]data)

publicstaticCandidateparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticCandidateparseFrom(ByteStringdata)

publicstaticCandidateparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticCandidateparseFrom(CodedInputStreaminput)

publicstaticCandidateparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticCandidateparseFrom(InputStreaminput)

publicstaticCandidateparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticCandidateparseFrom(ByteBufferdata)

publicstaticCandidateparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Candidate>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicdoublegetAvgLogprobs()

Output only. Average log probability score of the candidate.

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

publicCitationMetadatagetCitationMetadata()

Output only. Source attribution of the generated content.

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

publicCitationMetadataOrBuildergetCitationMetadataOrBuilder()

Output only. Source attribution of the generated content.

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

publicContentgetContent()

Output only. Content parts of the candidate.

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

publicContentOrBuildergetContentOrBuilder()

Output only. Content parts of the candidate.

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

publicCandidategetDefaultInstanceForType()

publicStringgetFinishMessage()

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

publicByteStringgetFinishMessageBytes()

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

publicCandidate.FinishReasongetFinishReason()

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

publicintgetFinishReasonValue()

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

publicGroundingMetadatagetGroundingMetadata()

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

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

publicGroundingMetadataOrBuildergetGroundingMetadataOrBuilder()

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

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

publicintgetIndex()

Output only. Index of the candidate.

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

publicParser<Candidate>getParserForType()

GeneratedMessageV3.getParserForType()

publicSafetyRatinggetSafetyRatings(intindex)

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

publicintgetSafetyRatingsCount()

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

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

publicSafetyRatingOrBuildergetSafetyRatingsOrBuilder(intindex)

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

publicList<?extendsSafetyRatingOrBuilder>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];

publicdoublegetScore()

Output only. Confidence score of the candidate.

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

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicbooleanhasCitationMetadata()

Output only. Source attribution of the generated content.

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

publicbooleanhasContent()

Output only. Content parts of the candidate.

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

publicbooleanhasFinishMessage()

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

publicbooleanhasGroundingMetadata()

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

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

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicCandidate.BuildernewBuilderForType()

protectedCandidate.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicCandidate.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)