Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::UsageMetadata (v1.38.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::UsageMetadata.

Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cache_tokens_details

def cache_tokens_details() -> ::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>
Returns

#cached_content_token_count

def cached_content_token_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of tokens in the cached content that was used for this request.

#candidates_token_count

def candidates_token_count() -> ::Integer
Returns
  • (::Integer) — The total number of tokens in the generated candidates.

#candidates_token_count=

def candidates_token_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The total number of tokens in the generated candidates.
Returns
  • (::Integer) — The total number of tokens in the generated candidates.

#candidates_tokens_details

def candidates_tokens_details() -> ::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>
Returns

#prompt_token_count

def prompt_token_count() -> ::Integer
Returns
  • (::Integer) — The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When cached_content is set, this also includes the number of tokens in the cached content.

#prompt_token_count=

def prompt_token_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When cached_content is set, this also includes the number of tokens in the cached content.
Returns
  • (::Integer) — The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When cached_content is set, this also includes the number of tokens in the cached content.

#prompt_tokens_details

def prompt_tokens_details() -> ::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>
Returns

#thoughts_token_count

def thoughts_token_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.

#tool_use_prompt_token_count

def tool_use_prompt_token_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.

#tool_use_prompt_tokens_details

def tool_use_prompt_tokens_details() -> ::Array<::Google::Cloud::AIPlatform::V1::ModalityTokenCount>
Returns

#total_token_count

def total_token_count() -> ::Integer
Returns
  • (::Integer) — The total number of tokens for the entire request. This is the sum of prompt_token_count, candidates_token_count, tool_use_prompt_token_count, and thoughts_token_count.

#total_token_count=

def total_token_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The total number of tokens for the entire request. This is the sum of prompt_token_count, candidates_token_count, tool_use_prompt_token_count, and thoughts_token_count.
Returns
  • (::Integer) — The total number of tokens for the entire request. This is the sum of prompt_token_count, candidates_token_count, tool_use_prompt_token_count, and thoughts_token_count.

#traffic_type

def traffic_type() -> ::Google::Cloud::AIPlatform::V1::UsageMetadata::TrafficType
Returns