Method: projects.locations.endpoints.countTokens

Perform a token counting.

HTTP request

POST https://{service-endpoint}/v1beta1/{endpoint}:countTokens

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
endpoint

string

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "model": string,
  "instances": [
    value
  ],
  "contents": [
    {
      object (Content)
    }
  ]
}
Fields
model

string

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

instances[]

value (Value format)

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

contents[]

object (Content)

Required. Input content.

Response body

If successful, the response body contains an instance of CountTokensResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the endpoint resource:

  • aiplatform.endpoints.predict

For more information, see the IAM documentation.