Class LogprobsResult.TopCandidates (3.54.0)

public static final class LogprobsResult.TopCandidates extends GeneratedMessageV3 implements LogprobsResult.TopCandidatesOrBuilder

Candidates with top log probabilities at each decoding step.

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

Static Fields

CANDIDATES_FIELD_NUMBER

public static final int CANDIDATES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(LogprobsResult.TopCandidates prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.TopCandidates.Builder newBuilderForType()
Returns
Type Description
LogprobsResult.TopCandidates.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogprobsResult.TopCandidates.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LogprobsResult.TopCandidates.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.TopCandidates.Builder toBuilder()
Returns
Type Description
LogprobsResult.TopCandidates.Builder

writeTo(CodedOutputStream output)

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