Class LogprobsResult.TopCandidates.Builder (3.53.0)

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.aiplatform.v1.LogprobsResult.TopCandidates

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.LogprobsResult.Candidate>
Returns
Type Description
LogprobsResult.TopCandidates.Builder

addCandidates(LogprobsResult.Candidate value)

public LogprobsResult.TopCandidates.Builder addCandidates(LogprobsResult.Candidate value)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
value LogprobsResult.Candidate
Returns
Type Description
LogprobsResult.TopCandidates.Builder

addCandidates(LogprobsResult.Candidate.Builder builderForValue)

public LogprobsResult.TopCandidates.Builder addCandidates(LogprobsResult.Candidate.Builder builderForValue)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
builderForValue LogprobsResult.Candidate.Builder
Returns
Type Description
LogprobsResult.TopCandidates.Builder

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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameters
Name Description
index int
value LogprobsResult.Candidate
Returns
Type Description
LogprobsResult.TopCandidates.Builder

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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameters
Name Description
index int
builderForValue LogprobsResult.Candidate.Builder
Returns
Type Description
LogprobsResult.TopCandidates.Builder

addCandidatesBuilder()

public LogprobsResult.Candidate.Builder addCandidatesBuilder()

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Returns
Type Description
LogprobsResult.Candidate.Builder

addCandidatesBuilder(int index)

public LogprobsResult.Candidate.Builder addCandidatesBuilder(int index)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
index int
Returns
Type Description
LogprobsResult.Candidate.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogprobsResult.TopCandidates.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

build()

public LogprobsResult.TopCandidates build()
Returns
Type Description
LogprobsResult.TopCandidates

buildPartial()

public LogprobsResult.TopCandidates buildPartial()
Returns
Type Description
LogprobsResult.TopCandidates

clear()

public LogprobsResult.TopCandidates.Builder clear()
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

clearCandidates()

public LogprobsResult.TopCandidates.Builder clearCandidates()

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Returns
Type Description
LogprobsResult.TopCandidates.Builder

clearField(Descriptors.FieldDescriptor field)

public LogprobsResult.TopCandidates.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public LogprobsResult.TopCandidates.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

clone()

public LogprobsResult.TopCandidates.Builder clone()
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

getCandidates(int index)

public LogprobsResult.Candidate getCandidates(int index)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
index int
Returns
Type Description
LogprobsResult.Candidate

getCandidatesBuilder(int index)

public LogprobsResult.Candidate.Builder getCandidatesBuilder(int index)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
index int
Returns
Type Description
LogprobsResult.Candidate.Builder

getCandidatesBuilderList()

public List<LogprobsResult.Candidate.Builder> getCandidatesBuilderList()

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Returns
Type Description
List<Builder>

getCandidatesCount()

public int getCandidatesCount()

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Returns
Type Description
List<Candidate>

getCandidatesOrBuilder(int index)

public LogprobsResult.CandidateOrBuilder getCandidatesOrBuilder(int index)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
index int
Returns
Type Description
LogprobsResult.CandidateOrBuilder

getCandidatesOrBuilderList()

public List<? extends LogprobsResult.CandidateOrBuilder> getCandidatesOrBuilderList()

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.LogprobsResult.CandidateOrBuilder>

getDefaultInstanceForType()

public LogprobsResult.TopCandidates getDefaultInstanceForType()
Returns
Type Description
LogprobsResult.TopCandidates

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LogprobsResult.TopCandidates other)

public LogprobsResult.TopCandidates.Builder mergeFrom(LogprobsResult.TopCandidates other)
Parameter
Name Description
other LogprobsResult.TopCandidates
Returns
Type Description
LogprobsResult.TopCandidates.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogprobsResult.TopCandidates.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LogprobsResult.TopCandidates.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogprobsResult.TopCandidates.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

removeCandidates(int index)

public LogprobsResult.TopCandidates.Builder removeCandidates(int index)

Sorted by log probability in descending order.

repeated .google.cloud.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameter
Name Description
index int
Returns
Type Description
LogprobsResult.TopCandidates.Builder

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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameters
Name Description
index int
value LogprobsResult.Candidate
Returns
Type Description
LogprobsResult.TopCandidates.Builder

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.aiplatform.v1.LogprobsResult.Candidate candidates = 1;

Parameters
Name Description
index int
builderForValue LogprobsResult.Candidate.Builder
Returns
Type Description
LogprobsResult.TopCandidates.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public LogprobsResult.TopCandidates.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogprobsResult.TopCandidates.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final LogprobsResult.TopCandidates.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LogprobsResult.TopCandidates.Builder
Overrides