Class: OpenAI::Models::ImageGenCompletedEvent::Usage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/image_gen_completed_event.rb,
sig/openai/models/image_gen_completed_event.rbs

Overview

See Also:

  • OpenAI::Models::ImageGenCompletedEvent#usage

Defined Under Namespace

Classes: InputTokensDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #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(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::ImageGenCompletedEvent::Usage for more details.

For the GPT image models only, the token usage information for the image generation.

Parameters:

  • input_tokens (Integer) —

    The number of tokens (images and text) in the input prompt.

  • input_tokens_details (OpenAI::Models::ImageGenCompletedEvent::Usage::InputTokensDetails) —

    The input tokens detailed information for the image generation.

  • output_tokens (Integer) —

    The number of image tokens in the output image.

  • total_tokens (Integer) —

    The total number of tokens (images and text) used for the image generation.




# File 'lib/openai/models/image_gen_completed_event.rb', line 161

Instance Attribute Details

#input_tokens ⇒ Integer

The number of tokens (images and text) in the input prompt.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


141
 
# File 'lib/openai/models/image_gen_completed_event.rb', line 141

required :input_tokens, Integer

#input_tokens_details ⇒ OpenAI::Models::ImageGenCompletedEvent::Usage::InputTokensDetails

The input tokens detailed information for the image generation.

Parameters:

  • value (OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails)

Returns:



147
 
# File 'lib/openai/models/image_gen_completed_event.rb', line 147

required :input_tokens_details, -> { OpenAI::ImageGenCompletedEvent::Usage::InputTokensDetails }

#output_tokens ⇒ Integer

The number of image tokens in the output image.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


153
 
# File 'lib/openai/models/image_gen_completed_event.rb', line 153

required :output_tokens, Integer

#total_tokens ⇒ Integer

The total number of tokens (images and text) used for the image generation.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


159
 
# File 'lib/openai/models/image_gen_completed_event.rb', line 159

required :total_tokens, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


128
 
# File 'sig/openai/models/image_gen_completed_event.rbs', line 128

def to_hash: -> {