Class LogprobsResult.TopCandidates.Builder (1.34.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 1.34.0keyboard_arrow_down
public static final class LogprobsResult . TopCandidates . Builder extends GeneratedMessageV3 . Builder<LogprobsResult . TopCandidates . Builder > implements LogprobsResult . TopCandidatesOrBuilder
Candidates with top log probabilities at each decoding step.
Protobuf type google.cloud.vertexai.v1.LogprobsResult.TopCandidates
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addAllCandidates(Iterable<? extends LogprobsResult.Candidate> values)
public LogprobsResult . TopCandidates . Builder addAllCandidates ( Iterable <? extends LogprobsResult . Candidate > values )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
valuesIterable <? extends com.google.cloud.vertexai.api.LogprobsResult.Candidate >
addCandidates(LogprobsResult.Candidate value)
public LogprobsResult . TopCandidates . Builder addCandidates ( LogprobsResult . Candidate value )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
addCandidates(LogprobsResult.Candidate.Builder builderForValue)
public LogprobsResult . TopCandidates . Builder addCandidates ( LogprobsResult . Candidate . Builder builderForValue )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
addCandidates(int index, LogprobsResult.Candidate value)
public LogprobsResult . TopCandidates . Builder addCandidates ( int index , LogprobsResult . Candidate value )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
addCandidates(int index, LogprobsResult.Candidate.Builder builderForValue)
public LogprobsResult . TopCandidates . Builder addCandidates ( int index , LogprobsResult . Candidate . Builder builderForValue )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
addCandidatesBuilder()
public LogprobsResult . Candidate . Builder addCandidatesBuilder ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
addCandidatesBuilder(int index)
public LogprobsResult . Candidate . Builder addCandidatesBuilder ( int index )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
indexint
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public LogprobsResult . TopCandidates . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public LogprobsResult . TopCandidates build ()
buildPartial()
public LogprobsResult . TopCandidates buildPartial ()
clear()
public LogprobsResult . TopCandidates . Builder clear ()
Overrides
clearCandidates()
public LogprobsResult . TopCandidates . Builder clearCandidates ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
clearField(Descriptors.FieldDescriptor field)
public LogprobsResult . TopCandidates . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public LogprobsResult . TopCandidates . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public LogprobsResult . TopCandidates . Builder clone ()
Overrides
getCandidates(int index)
public LogprobsResult . Candidate getCandidates ( int index )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
indexint
getCandidatesBuilder(int index)
public LogprobsResult . Candidate . Builder getCandidatesBuilder ( int index )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
indexint
getCandidatesBuilderList()
public List<LogprobsResult . Candidate . Builder > getCandidatesBuilderList ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
getCandidatesCount()
public int getCandidatesCount ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Returns
Type Description
int
getCandidatesList()
public List<LogprobsResult . Candidate > getCandidatesList ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
getCandidatesOrBuilder(int index)
public LogprobsResult . CandidateOrBuilder getCandidatesOrBuilder ( int index )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
indexint
getCandidatesOrBuilderList()
public List <? extends LogprobsResult . CandidateOrBuilder > getCandidatesOrBuilderList ()
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Returns
Type Description
List <? extends com.google.cloud.vertexai.api.LogprobsResult.CandidateOrBuilder >
getDefaultInstanceForType()
public LogprobsResult . TopCandidates getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(LogprobsResult.TopCandidates other)
public LogprobsResult . TopCandidates . Builder mergeFrom ( LogprobsResult . TopCandidates other )
public LogprobsResult . TopCandidates . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public LogprobsResult . TopCandidates . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final LogprobsResult . TopCandidates . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
removeCandidates(int index)
public LogprobsResult . TopCandidates . Builder removeCandidates ( int index )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
Parameter
Name Description
indexint
setCandidates(int index, LogprobsResult.Candidate value)
public LogprobsResult . TopCandidates . Builder setCandidates ( int index , LogprobsResult . Candidate value )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
setCandidates(int index, LogprobsResult.Candidate.Builder builderForValue)
public LogprobsResult . TopCandidates . Builder setCandidates ( int index , LogprobsResult . Candidate . Builder builderForValue )
Sorted by log probability in descending order.
repeated .google.cloud.vertexai.v1.LogprobsResult.Candidate candidates = 1;
setField(Descriptors.FieldDescriptor field, Object value)
public LogprobsResult . TopCandidates . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public LogprobsResult . TopCandidates . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final LogprobsResult . TopCandidates . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-30 UTC."],[],[],null,[]]
