Class: OpenAI::Models::Admin::Organization::UsageCostsResponse::Data::Result::OrganizationUsageCompletionsResult

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/openai/models/admin/organization/usage_costs_response.rb,
sig/openai/models/admin/organization/usage_costs_response.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize ⇒ Object 



178
 
# File 'sig/openai/models/admin/organization/usage_costs_response.rbs', line 178

def initialize: (

Instance Attribute Details

#api_key_id ⇒ String?

When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


197
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 197

optional :api_key_id, String, nil?: true

#batch ⇒ Boolean?

When group_by=batch, this field tells whether the grouped usage result is batch or not.

Parameters:

Returns:



204
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 204

optional :batch, OpenAI::Internal::Type::Boolean, nil?: true

#input_audio_tokens ⇒ Integer?

The aggregated number of uncached audio input tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


210
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 210

optional :input_audio_tokens, Integer

#input_cache_write_tokens ⇒ Integer?

The aggregated number of input tokens written to the cache.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


216
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 216

optional :input_cache_write_tokens, Integer

#input_cached_audio_tokens ⇒ Integer?

The aggregated number of cached audio input tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


222
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 222

optional :input_cached_audio_tokens, Integer

#input_cached_image_tokens ⇒ Integer?

The aggregated number of cached image input tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


228
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 228

optional :input_cached_image_tokens, Integer

#input_cached_text_tokens ⇒ Integer?

The aggregated number of cached text input tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


234
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 234

optional :input_cached_text_tokens, Integer

#input_cached_tokens ⇒ Integer?

The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


241
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 241

optional :input_cached_tokens, Integer

#input_image_tokens ⇒ Integer?

The aggregated number of uncached image input tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


247
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 247

optional :input_image_tokens, Integer

#input_text_tokens ⇒ Integer?

The aggregated number of uncached text input tokens used, excluding cache-write tokens.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


254
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 254

optional :input_text_tokens, Integer

#input_tokens ⇒ Integer

The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


171
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 171

required :input_tokens, Integer

#input_uncached_tokens ⇒ Integer?

The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


261
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 261

optional :input_uncached_tokens, Integer

#model ⇒ String?

When group_by=model, this field provides the model name of the grouped usage result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


268
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 268

optional :model, String, nil?: true

#num_model_requests ⇒ Integer

The count of requests made to the model.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


177
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 177

required :num_model_requests, Integer

#object ⇒ Symbol, :"organization.usage.completions.result"

Parameters:

  • value (:"organization.usage.completions.result")

Returns:

  • (Symbol, :"organization.usage.completions.result") 


182
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 182

required :object, const: :"organization.usage.completions.result"

#output_audio_tokens ⇒ Integer?

The aggregated number of audio output tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


274
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 274

optional :output_audio_tokens, Integer

#output_image_tokens ⇒ Integer?

The aggregated number of image output tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


280
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 280

optional :output_image_tokens, Integer

#output_text_tokens ⇒ Integer?

The aggregated number of text output tokens used.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


286
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 286

optional :output_text_tokens, Integer

#output_tokens ⇒ Integer

The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


190
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 190

required :output_tokens, Integer

#project_id ⇒ String?

When group_by=project_id, this field provides the project ID of the grouped usage result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


293
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 293

optional :project_id, String, nil?: true

#service_tier ⇒ String?

When group_by=service_tier, this field provides the service tier of the grouped usage result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


300
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 300

optional :service_tier, String, nil?: true

#user_id ⇒ String?

When group_by=user_id, this field provides the user ID of the grouped usage result.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


307
 
# File 'lib/openai/models/admin/organization/usage_costs_response.rb', line 307

optional :user_id, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


203
 
# File 'sig/openai/models/admin/organization/usage_costs_response.rbs', line 203

def to_hash: -> {