Class: Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsage

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

Statistics on the interaction request's token usage.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GenaiVertexV1beta1InteractionUsage

Returns a new instance of GenaiVertexV1beta1InteractionUsage.



3954
3955
3956
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3954

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

Instance Attribute Details

#cached_tokens_by_modality ⇒ Array<Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsageModalityTokens>

A breakdown of cached token usage by modality. Corresponds to the JSON property cachedTokensByModality

Returns:



3901
3902
3903
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3901

def cached_tokens_by_modality
  @cached_tokens_by_modality
end

#grounding_tool_count ⇒ Array<Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsageGroundingToolCount>

Grounding tool count. Corresponds to the JSON property groundingToolCount

Returns:



3906
3907
3908
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3906

def grounding_tool_count
  @grounding_tool_count
end

#input_tokens_by_modality ⇒ Array<Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsageModalityTokens>

A breakdown of input token usage by modality. Corresponds to the JSON property inputTokensByModality

Returns:



3911
3912
3913
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3911

def input_tokens_by_modality
  @input_tokens_by_modality
end

#output_tokens_by_modality ⇒ Array<Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsageModalityTokens>

A breakdown of output token usage by modality. Corresponds to the JSON property outputTokensByModality

Returns:



3916
3917
3918
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3916

def output_tokens_by_modality
  @output_tokens_by_modality
end

#tool_use_tokens_by_modality ⇒ Array<Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1InteractionUsageModalityTokens>

A breakdown of tool-use token usage by modality. Corresponds to the JSON property toolUseTokensByModality

Returns:



3921
3922
3923
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3921

def tool_use_tokens_by_modality
  @tool_use_tokens_by_modality
end

#total_cached_tokens ⇒ Fixnum

Number of tokens in the cached part of the prompt (the cached content). Corresponds to the JSON property totalCachedTokens

Returns:

  • (Fixnum) 


3926
3927
3928
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3926

def total_cached_tokens
  @total_cached_tokens
end

#total_input_tokens ⇒ Fixnum

Number of tokens in the prompt (context). Corresponds to the JSON property totalInputTokens

Returns:

  • (Fixnum) 


3931
3932
3933
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3931

def total_input_tokens
  @total_input_tokens
end

#total_output_tokens ⇒ Fixnum

Total number of tokens across all the generated responses. Corresponds to the JSON property totalOutputTokens

Returns:

  • (Fixnum) 


3936
3937
3938
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3936

def total_output_tokens
  @total_output_tokens
end

#total_thought_tokens ⇒ Fixnum

Number of tokens of thoughts for thinking models. Corresponds to the JSON property totalThoughtTokens

Returns:

  • (Fixnum) 


3941
3942
3943
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3941

def total_thought_tokens
  @total_thought_tokens
end

#total_tokens ⇒ Fixnum

Total token count for the interaction request (prompt + responses + other internal tokens). Corresponds to the JSON property totalTokens

Returns:

  • (Fixnum) 


3947
3948
3949
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3947

def total_tokens
  @total_tokens
end

#total_tool_use_tokens ⇒ Fixnum

Number of tokens present in tool-use prompt(s). Corresponds to the JSON property totalToolUseTokens

Returns:

  • (Fixnum) 


3952
3953
3954
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3952

def total_tool_use_tokens
  @total_tool_use_tokens
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 3959

def update!(**args)
  @cached_tokens_by_modality = args[:cached_tokens_by_modality] if args.key?(:cached_tokens_by_modality)
  @grounding_tool_count = args[:grounding_tool_count] if args.key?(:grounding_tool_count)
  @input_tokens_by_modality = args[:input_tokens_by_modality] if args.key?(:input_tokens_by_modality)
  @output_tokens_by_modality = args[:output_tokens_by_modality] if args.key?(:output_tokens_by_modality)
  @tool_use_tokens_by_modality = args[:tool_use_tokens_by_modality] if args.key?(:tool_use_tokens_by_modality)
  @total_cached_tokens = args[:total_cached_tokens] if args.key?(:total_cached_tokens)
  @total_input_tokens = args[:total_input_tokens] if args.key?(:total_input_tokens)
  @total_output_tokens = args[:total_output_tokens] if args.key?(:total_output_tokens)
  @total_thought_tokens = args[:total_thought_tokens] if args.key?(:total_thought_tokens)
  @total_tokens = args[:total_tokens] if args.key?(:total_tokens)
  @total_tool_use_tokens = args[:total_tool_use_tokens] if args.key?(:total_tool_use_tokens)
end