Class LogprobsResult.Candidate.Builder (3.55.0)

public static final class LogprobsResult.Candidate.Builder extends GeneratedMessageV3.Builder<LogprobsResult.Candidate.Builder> implements LogprobsResult.CandidateOrBuilder

Candidate for the logprobs token and score.

Protobuf type google.cloud.aiplatform.v1.LogprobsResult.Candidate

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLogProbability()

public LogprobsResult.Candidate.Builder clearLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearToken()

public LogprobsResult.Candidate.Builder clearToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

clearTokenId()

public LogprobsResult.Candidate.Builder clearTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

getLogProbability()

public float getLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type Description
float

The logProbability.

getToken()

public String getToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type Description
String

The token.

getTokenBytes()

public ByteString getTokenBytes()

The candidate’s token string value.

optional string token = 1;

Returns
Type Description
ByteString

The bytes for token.

getTokenId()

public int getTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type Description
int

The tokenId.

hasLogProbability()

public boolean hasLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type Description
boolean

Whether the logProbability field is set.

hasToken()

public boolean hasToken()

The candidate’s token string value.

optional string token = 1;

Returns
Type Description
boolean

Whether the token field is set.

hasTokenId()

public boolean hasTokenId()

The candidate’s token id value.

optional int32 token_id = 3;

Returns
Type Description
boolean

Whether the tokenId field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LogprobsResult.Candidate other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setLogProbability(float value)

public LogprobsResult.Candidate.Builder setLogProbability(float value)

The candidate's log probability.

optional float log_probability = 2;

Parameter
Name Description
value float

The logProbability to set.

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

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

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

setToken(String value)

public LogprobsResult.Candidate.Builder setToken(String value)

The candidate’s token string value.

optional string token = 1;

Parameter
Name Description
value String

The token to set.

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

setTokenBytes(ByteString value)

public LogprobsResult.Candidate.Builder setTokenBytes(ByteString value)

The candidate’s token string value.

optional string token = 1;

Parameter
Name Description
value ByteString

The bytes for token to set.

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

setTokenId(int value)

public LogprobsResult.Candidate.Builder setTokenId(int value)

The candidate’s token id value.

optional int32 token_id = 3;

Parameter
Name Description
value int

The tokenId to set.

Returns
Type Description
LogprobsResult.Candidate.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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