Class LogprobsResult.Candidate (3.52.0)

public static final class LogprobsResult.Candidate extends GeneratedMessageV3 implements LogprobsResult.CandidateOrBuilder

Candidate for the logprobs token and score.

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

Static Fields

LOG_PROBABILITY_FIELD_NUMBER

public static final int LOG_PROBABILITY_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_FIELD_NUMBER

public static final int TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_ID_FIELD_NUMBER

public static final int TOKEN_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LogprobsResult.Candidate getDefaultInstance()
Returns
Type Description
LogprobsResult.Candidate

getDescriptor()

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

newBuilder()

public static LogprobsResult.Candidate.Builder newBuilder()
Returns
Type Description
LogprobsResult.Candidate.Builder

newBuilder(LogprobsResult.Candidate prototype)

public static LogprobsResult.Candidate.Builder newBuilder(LogprobsResult.Candidate prototype)
Parameter
Name Description
prototype LogprobsResult.Candidate
Returns
Type Description
LogprobsResult.Candidate.Builder

parseDelimitedFrom(InputStream input)

public static LogprobsResult.Candidate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LogprobsResult.Candidate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LogprobsResult.Candidate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LogprobsResult.Candidate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LogprobsResult.Candidate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LogprobsResult.Candidate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LogprobsResult.Candidate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogprobsResult.Candidate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LogprobsResult.Candidate> parser()
Returns
Type Description
Parser<Candidate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getLogProbability()

public float getLogProbability()

The candidate's log probability.

optional float log_probability = 2;

Returns
Type Description
float

The logProbability.

getParserForType()

public Parser<LogprobsResult.Candidate> getParserForType()
Returns
Type Description
Parser<Candidate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LogprobsResult.Candidate.Builder newBuilderForType()
Returns
Type Description
LogprobsResult.Candidate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogprobsResult.Candidate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LogprobsResult.Candidate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LogprobsResult.Candidate.Builder toBuilder()
Returns
Type Description
LogprobsResult.Candidate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException