Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/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) ⇒ GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata

Returns a new instance of GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.



17089
17090
17091
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17089

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

Instance Attribute Details

#cache_tokens_details ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>

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

Returns:



17027
17028
17029
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17027

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) 


17033
17034
17035
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17033

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) 


17038
17039
17040
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17038

def candidates_token_count
  @candidates_token_count
end

#candidates_tokens_details ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>

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

Returns:



17044
17045
17046
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17044

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) 


17051
17052
17053
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17051

def prompt_token_count
  @prompt_token_count
end

#prompt_tokens_details ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>

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

Returns:



17057
17058
17059
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17057

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) 


17063
17064
17065
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17063

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) 


17069
17070
17071
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17069

def tool_use_prompt_token_count
  @tool_use_prompt_token_count
end

#tool_use_prompt_tokens_details ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ModalityTokenCount>

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:



17075
17076
17077
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17075

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) 


17082
17083
17084
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17082

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) 


17087
17088
17089
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17087

def traffic_type
  @traffic_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 17094

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