com.google.cloud.vertexai.api

Class LogprobsResult.Candidate

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vertexai.api.LogprobsResult.Candidate

All Implemented Interfaces:

LogprobsResult.CandidateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

LogprobsResult

public static final class LogprobsResult.Candidate
extends com.google.protobuf.GeneratedMessageV3
implements LogprobsResult.CandidateOrBuilder

 Candidate for the logprobs token and score.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogprobsResult.Candidate.Builder Candidate for the logprobs token and score.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOG_PROBABILITY_FIELD_NUMBER
static int	TOKEN_FIELD_NUMBER
static int	TOKEN_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static LogprobsResult.Candidate	getDefaultInstance()
LogprobsResult.Candidate	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getLogProbability() The candidate's log probability.
com.google.protobuf.Parser<LogprobsResult.Candidate>	getParserForType()
int	getSerializedSize()
String	getToken() The candidate’s token string value.
com.google.protobuf.ByteString	getTokenBytes() The candidate’s token string value.
int	getTokenId() The candidate’s token id value.
int	hashCode()
boolean	hasLogProbability() The candidate's log probability.
boolean	hasToken() The candidate’s token string value.
boolean	hasTokenId() The candidate’s token id value.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static LogprobsResult.Candidate.Builder	newBuilder()
static LogprobsResult.Candidate.Builder	newBuilder(LogprobsResult.Candidate prototype)
LogprobsResult.Candidate.Builder	newBuilderForType()
protected LogprobsResult.Candidate.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static LogprobsResult.Candidate	parseDelimitedFrom(InputStream input)
static LogprobsResult.Candidate	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogprobsResult.Candidate	parseFrom(byte[] data)
static LogprobsResult.Candidate	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogprobsResult.Candidate	parseFrom(ByteBuffer data)
static LogprobsResult.Candidate	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogprobsResult.Candidate	parseFrom(com.google.protobuf.ByteString data)
static LogprobsResult.Candidate	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogprobsResult.Candidate	parseFrom(com.google.protobuf.CodedInputStream input)
static LogprobsResult.Candidate	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static LogprobsResult.Candidate	parseFrom(InputStream input)
static LogprobsResult.Candidate	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LogprobsResult.Candidate>	parser()
LogprobsResult.Candidate.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TOKEN_FIELD_NUMBER

public static final int TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

TOKEN_ID_FIELD_NUMBER

public static final int TOKEN_ID_FIELD_NUMBER

See Also:

Constant Field Values

LOG_PROBABILITY_FIELD_NUMBER

public static final int LOG_PROBABILITY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasToken

public boolean hasToken()

 The candidate’s token string value.
 

optional string token = 1;

Specified by:

hasToken in interface LogprobsResult.CandidateOrBuilder

Returns:

Whether the token field is set.

getToken

public String getToken()

 The candidate’s token string value.
 

optional string token = 1;

Specified by:

getToken in interface LogprobsResult.CandidateOrBuilder

Returns:

The token.

getTokenBytes

public com.google.protobuf.ByteString getTokenBytes()

 The candidate’s token string value.
 

optional string token = 1;

Specified by:

getTokenBytes in interface LogprobsResult.CandidateOrBuilder

Returns:

The bytes for token.

hasTokenId

public boolean hasTokenId()

 The candidate’s token id value.
 

optional int32 token_id = 3;

Specified by:

hasTokenId in interface LogprobsResult.CandidateOrBuilder

Returns:

Whether the tokenId field is set.

getTokenId

public int getTokenId()

 The candidate’s token id value.
 

optional int32 token_id = 3;

Specified by:

getTokenId in interface LogprobsResult.CandidateOrBuilder

Returns:

The tokenId.

hasLogProbability

public boolean hasLogProbability()

 The candidate's log probability.
 

optional float log_probability = 2;

Specified by:

hasLogProbability in interface LogprobsResult.CandidateOrBuilder

Returns:

Whether the logProbability field is set.

getLogProbability

public float getLogProbability()

 The candidate's log probability.
 

optional float log_probability = 2;

Specified by:

getLogProbability in interface LogprobsResult.CandidateOrBuilder

Returns:

The logProbability.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LogprobsResult.Candidate parseFrom(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogprobsResult.Candidate parseFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static LogprobsResult.Candidate parseFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogprobsResult.Candidate parseDelimitedFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static LogprobsResult.Candidate parseDelimitedFrom(InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseFrom

public static LogprobsResult.Candidate parseFrom(com.google.protobuf.CodedInputStream input)
                                          throws IOException

Throws:

IOException

parseFrom

public static LogprobsResult.Candidate parseFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

newBuilderForType

public LogprobsResult.Candidate.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LogprobsResult.Candidate.Builder newBuilder()

newBuilder

public static LogprobsResult.Candidate.Builder newBuilder(LogprobsResult.Candidate prototype)

toBuilder

public LogprobsResult.Candidate.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LogprobsResult.Candidate.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static LogprobsResult.Candidate getDefaultInstance()

parser

public static com.google.protobuf.Parser<LogprobsResult.Candidate> parser()

getParserForType

public com.google.protobuf.Parser<LogprobsResult.Candidate> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LogprobsResult.Candidate getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder