Class: OpenAI::Models::CreateEmbeddingResponse::Usage

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::CreateEmbeddingResponse::Usage

Defined in:

lib/openai/models/create_embedding_response.rb,
sig/openai/models/create_embedding_response.rbs

Overview

See Also:

• OpenAI::Models::CreateEmbeddingResponse#usage

Instance Attribute Summary

• #prompt_tokens ⇒ Integer

  The number of tokens used by the prompt.

• #total_tokens ⇒ Integer

  The total number of tokens used by the request.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(prompt_tokens:, total_tokens:) ⇒ Usage constructor

  A new instance of Usage.

• #to_hash ⇒ { prompt_tokens: Integer, total_tokens: Integer }

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(prompt_tokens:, total_tokens:) ⇒ Usage

Returns a new instance of Usage.

Parameters:

• prompt_tokens —

  The number of tokens used by the prompt.

• total_tokens —

  The total number of tokens used by the request.

• prompt_tokens: (Integer)
• total_tokens: (Integer)

# File 'lib/openai/models/create_embedding_response.rb', line 58

Instance Attribute Details

#prompt_tokens ⇒ Integer

The number of tokens used by the prompt.

Returns:

• (Integer)

# File 'lib/openai/models/create_embedding_response.rb', line 50

required :prompt_tokens, Integer

#total_tokens ⇒ Integer

The total number of tokens used by the request.

Returns:

• (Integer)

# File 'lib/openai/models/create_embedding_response.rb', line 56

required :total_tokens, Integer

Instance Method Details

#to_hash ⇒ { prompt_tokens: Integer, total_tokens: Integer }

Returns:

• ({ prompt_tokens: Integer, total_tokens: Integer })

# File 'sig/openai/models/create_embedding_response.rbs', line 61

def to_hash: -> { prompt_tokens: Integer, total_tokens: Integer }