Class CountTokensRequest (1.40.0)

publicfinalclass CountTokensRequestextendsGeneratedMessageV3implementsCountTokensRequestOrBuilder

Request message for [PredictionService.CountTokens][].

Protobuf type google.cloud.vertexai.v1.CountTokensRequest

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

CONTENTS_FIELD_NUMBER

publicstaticfinalintCONTENTS_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_FIELD_NUMBER

publicstaticfinalintENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

GENERATION_CONFIG_FIELD_NUMBER

publicstaticfinalintGENERATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

publicstaticfinalintINSTANCES_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FIELD_NUMBER

publicstaticfinalintMODEL_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_INSTRUCTION_FIELD_NUMBER

publicstaticfinalintSYSTEM_INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int

TOOLS_FIELD_NUMBER

publicstaticfinalintTOOLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticCountTokensRequestgetDefaultInstance()
Returns
Type Description
CountTokensRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticCountTokensRequest.BuildernewBuilder()
Returns
Type Description
CountTokensRequest.Builder

newBuilder(CountTokensRequest prototype)

publicstaticCountTokensRequest.BuildernewBuilder(CountTokensRequestprototype)
Parameter
Name Description
prototype CountTokensRequest
Returns
Type Description
CountTokensRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticCountTokensRequestparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticCountTokensRequestparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticCountTokensRequestparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticCountTokensRequestparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticCountTokensRequestparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticCountTokensRequestparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticCountTokensRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CountTokensRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<CountTokensRequest>parser()
Returns
Type Description
Parser<CountTokensRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContents(int index)

publicContentgetContents(intindex)

Optional. Input content.

repeated .google.cloud.vertexai.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Content

getContentsCount()

publicintgetContentsCount()

Optional. Input content.

repeated .google.cloud.vertexai.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getContentsList()

publicList<Content>getContentsList()

Optional. Input content.

repeated .google.cloud.vertexai.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Content>

getContentsOrBuilder(int index)

publicContentOrBuildergetContentsOrBuilder(intindex)

Optional. Input content.

repeated .google.cloud.vertexai.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ContentOrBuilder

getContentsOrBuilderList()

publicList<?extendsContentOrBuilder>getContentsOrBuilderList()

Optional. Input content.

repeated .google.cloud.vertexai.v1.Content contents = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.ContentOrBuilder>

getDefaultInstanceForType()

publicCountTokensRequestgetDefaultInstanceForType()
Returns
Type Description
CountTokensRequest

getEndpoint()

publicStringgetEndpoint()

Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The endpoint.

getEndpointBytes()

publicByteStringgetEndpointBytes()

Required. The name of the Endpoint requested to perform token counting. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for endpoint.

getGenerationConfig()

publicGenerationConfiggetGenerationConfig()

Optional. Generation config that the model will use to generate the response.

optional .google.cloud.vertexai.v1.GenerationConfig generation_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GenerationConfig

The generationConfig.

getGenerationConfigOrBuilder()

publicGenerationConfigOrBuildergetGenerationConfigOrBuilder()

Optional. Generation config that the model will use to generate the response.

optional .google.cloud.vertexai.v1.GenerationConfig generation_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GenerationConfigOrBuilder

getInstances(int index)

publicValuegetInstances(intindex)

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Value

getInstancesCount()

publicintgetInstancesCount()

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getInstancesList()

publicList<Value>getInstancesList()

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Value>

getInstancesOrBuilder(int index)

publicValueOrBuildergetInstancesOrBuilder(intindex)

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ValueOrBuilder

getInstancesOrBuilderList()

publicList<?extendsValueOrBuilder>getInstancesOrBuilderList()

Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.

repeated .google.protobuf.Value instances = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.protobuf.ValueOrBuilder>

getModel()

publicStringgetModel()

Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

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

Returns
Type Description
String

The model.

getModelBytes()

publicByteStringgetModelBytes()

Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

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

Returns
Type Description
ByteString

The bytes for model.

getParserForType()

publicParser<CountTokensRequest>getParserForType()
Returns
Type Description
Parser<CountTokensRequest>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSystemInstruction()

publicContentgetSystemInstruction()

Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

optional .google.cloud.vertexai.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Content

The systemInstruction.

getSystemInstructionOrBuilder()

publicContentOrBuildergetSystemInstructionOrBuilder()

Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

optional .google.cloud.vertexai.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ContentOrBuilder

getTools(int index)

publicToolgetTools(intindex)

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

repeated .google.cloud.vertexai.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Tool

getToolsCount()

publicintgetToolsCount()

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

repeated .google.cloud.vertexai.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getToolsList()

publicList<Tool>getToolsList()

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

repeated .google.cloud.vertexai.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Tool>

getToolsOrBuilder(int index)

publicToolOrBuildergetToolsOrBuilder(intindex)

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

repeated .google.cloud.vertexai.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolOrBuilder

getToolsOrBuilderList()

publicList<?extendsToolOrBuilder>getToolsOrBuilderList()

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

repeated .google.cloud.vertexai.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.vertexai.api.ToolOrBuilder>

hasGenerationConfig()

publicbooleanhasGenerationConfig()

Optional. Generation config that the model will use to generate the response.

optional .google.cloud.vertexai.v1.GenerationConfig generation_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the generationConfig field is set.

hasSystemInstruction()

publicbooleanhasSystemInstruction()

Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.

optional .google.cloud.vertexai.v1.Content system_instruction = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the systemInstruction field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicCountTokensRequest.BuildernewBuilderForType()
Returns
Type Description
CountTokensRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedCountTokensRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CountTokensRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicCountTokensRequest.BuildertoBuilder()
Returns
Type Description
CountTokensRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.