public static final class LogprobsResult.Candidate.Builder extends GeneratedMessage.Builder<LogprobsResult.Candidate.Builder> implements LogprobsResult.CandidateOrBuilderCandidate for the logprobs token and score.
Protobuf type google.cloud.vertexai.v1.LogprobsResult.Candidate
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > LogprobsResult.Candidate.BuilderImplements
LogprobsResult.CandidateOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
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. |
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. |
getDefaultInstanceForType()
public LogprobsResult.Candidate getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LogprobsResult.Candidate |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| 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 |
|
setLogProbability(float value)
public LogprobsResult.Candidate.Builder setLogProbability(float value)The candidate's log probability.
optional float log_probability = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
floatThe logProbability to set. |
| Returns | |
|---|---|
| Type | Description |
LogprobsResult.Candidate.Builder |
This builder for chaining. |
setToken(String value)
public LogprobsResult.Candidate.Builder setToken(String value)The candidate’s token string value.
optional string token = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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 |
ByteStringThe 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 |
intThe tokenId to set. |
| Returns | |
|---|---|
| Type | Description |
LogprobsResult.Candidate.Builder |
This builder for chaining. |