Class TokensInfo (1.13.0)

public final class TokensInfo extends GeneratedMessageV3 implements TokensInfoOrBuilder

Tokens info with a list of tokens and the corresponding list of token ids.

Protobuf type google.cloud.vertexai.v1.TokensInfo

Implements

TokensInfoOrBuilder

Static Fields

ROLE_FIELD_NUMBER

public static final int ROLE_FIELD_NUMBER
Field Value
Type Description
int

TOKENS_FIELD_NUMBER

public static final int TOKENS_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_IDS_FIELD_NUMBER

public static final int TOKEN_IDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TokensInfo getDefaultInstance()
Returns
Type Description
TokensInfo

getDescriptor()

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

newBuilder()

public static TokensInfo.Builder newBuilder()
Returns
Type Description
TokensInfo.Builder

newBuilder(TokensInfo prototype)

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

parseDelimitedFrom(InputStream input)

public static TokensInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TokensInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static TokensInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TokensInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static TokensInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TokensInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static TokensInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TokensInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static TokensInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TokensInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<TokensInfo> parser()
Returns
Type Description
Parser<TokensInfo>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public TokensInfo getDefaultInstanceForType()
Returns
Type Description
TokensInfo

getParserForType()

public Parser<TokensInfo> getParserForType()
Returns
Type Description
Parser<TokensInfo>
Overrides

getRole()

public String getRole()

Optional. Optional fields for the role from the corresponding Content.

string role = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The role.

getRoleBytes()

public ByteString getRoleBytes()

Optional. Optional fields for the role from the corresponding Content.

string role = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for role.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTokenIds(int index)

public long getTokenIds(int index)

A list of token ids from the input.

repeated int64 token_ids = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The tokenIds at the given index.

getTokenIdsCount()

public int getTokenIdsCount()

A list of token ids from the input.

repeated int64 token_ids = 2;

Returns
Type Description
int

The count of tokenIds.

getTokenIdsList()

public List<Long> getTokenIdsList()

A list of token ids from the input.

repeated int64 token_ids = 2;

Returns
Type Description
List<Long>

A list containing the tokenIds.

getTokens(int index)

public ByteString getTokens(int index)

A list of tokens from the input.

repeated bytes tokens = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
ByteString

The tokens at the given index.

getTokensCount()

public int getTokensCount()

A list of tokens from the input.

repeated bytes tokens = 1;

Returns
Type Description
int

The count of tokens.

getTokensList()

public List<ByteString> getTokensList()

A list of tokens from the input.

repeated bytes tokens = 1;

Returns
Type Description
List<ByteString>

A list containing the tokens.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public TokensInfo.Builder toBuilder()
Returns
Type Description
TokensInfo.Builder

writeTo(CodedOutputStream output)

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