Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UsageMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1UsageMetadata

Returns a new instance of GoogleCloudAiplatformV1beta1UsageMetadata.



62698
62699
62700
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62698

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cache_tokens_details ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the cached content. Corresponds to the JSON property cacheTokensDetails

Returns:



62636
62637
62638
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62636

def cache_tokens_details
  @cache_tokens_details
end

#cached_content_token_count ⇒ Fixnum

Output only. The number of tokens in the cached content that was used for this request. Corresponds to the JSON property cachedContentTokenCount

Returns:

  • (Fixnum) 


62642
62643
62644
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62642

def cached_content_token_count
  @cached_content_token_count
end

#candidates_token_count ⇒ Fixnum

The total number of tokens in the generated candidates. Corresponds to the JSON property candidatesTokenCount

Returns:

  • (Fixnum) 


62647
62648
62649
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62647

def candidates_token_count
  @candidates_token_count
end

#candidates_tokens_details ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the generated candidates. Corresponds to the JSON property candidatesTokensDetails

Returns:



62653
62654
62655
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62653

def candidates_tokens_details
  @candidates_tokens_details
end

#prompt_token_count ⇒ Fixnum

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. Corresponds to the JSON property promptTokenCount

Returns:

  • (Fixnum) 


62660
62661
62662
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62660

def prompt_token_count
  @prompt_token_count
end

#prompt_tokens_details ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModalityTokenCount>

Output only. A detailed breakdown of the token count for each modality in the prompt. Corresponds to the JSON property promptTokensDetails

Returns:



62666
62667
62668
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62666

def prompt_tokens_details
  @prompt_tokens_details
end

#thoughts_token_count ⇒ Fixnum

Output only. The number of tokens that were part of the model's generated " thoughts" output, if applicable. Corresponds to the JSON property thoughtsTokenCount

Returns:

  • (Fixnum) 


62672
62673
62674
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62672

def thoughts_token_count
  @thoughts_token_count
end

#tool_use_prompt_token_count ⇒ Fixnum

Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. Corresponds to the JSON property toolUsePromptTokenCount

Returns:

  • (Fixnum) 


62678
62679
62680
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62678

def tool_use_prompt_token_count
  @tool_use_prompt_token_count
end

#tool_use_prompt_tokens_details ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModalityTokenCount>

Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. Corresponds to the JSON property toolUsePromptTokensDetails

Returns:



62684
62685
62686
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62684

def tool_use_prompt_tokens_details
  @tool_use_prompt_tokens_details
end

#total_token_count ⇒ Fixnum

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. Corresponds to the JSON property totalTokenCount

Returns:

  • (Fixnum) 


62691
62692
62693
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62691

def total_token_count
  @total_token_count
end

#traffic_type ⇒ String

Output only. The traffic type for this request. Corresponds to the JSON property trafficType

Returns:

  • (String) 


62696
62697
62698
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62696

def traffic_type
  @traffic_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



62703
62704
62705
62706
62707
62708
62709
62710
62711
62712
62713
62714
62715
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 62703

def update!(**args)
  @cache_tokens_details = args[:cache_tokens_details] if args.key?(:cache_tokens_details)
  @cached_content_token_count = args[:cached_content_token_count] if args.key?(:cached_content_token_count)
  @candidates_token_count = args[:candidates_token_count] if args.key?(:candidates_token_count)
  @candidates_tokens_details = args[:candidates_tokens_details] if args.key?(:candidates_tokens_details)
  @prompt_token_count = args[:prompt_token_count] if args.key?(:prompt_token_count)
  @prompt_tokens_details = args[:prompt_tokens_details] if args.key?(:prompt_tokens_details)
  @thoughts_token_count = args[:thoughts_token_count] if args.key?(:thoughts_token_count)
  @tool_use_prompt_token_count = args[:tool_use_prompt_token_count] if args.key?(:tool_use_prompt_token_count)
  @tool_use_prompt_tokens_details = args[:tool_use_prompt_tokens_details] if args.key?(:tool_use_prompt_tokens_details)
  @total_token_count = args[:total_token_count] if args.key?(:total_token_count)
  @traffic_type = args[:traffic_type] if args.key?(:traffic_type)
end