Class: OpenAI::Models::CreateEmbeddingResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/create_embedding_response.rb

Overview

See Also:

Defined Under Namespace

Classes: Usage

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, 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(data: , model: , usage: , object: :list) ⇒ Object

Parameters:

  • data (Array<OpenAI::Models::Embedding>) (defaults to: ) —

    The list of embeddings generated by the model.

  • model (String) (defaults to: ) —

    The name of the model used to generate the embedding.

  • usage (OpenAI::Models::CreateEmbeddingResponse::Usage) (defaults to: ) —

    The usage information for the request.

  • object (Symbol, :list) (defaults to: :list) —

    The object type, which is always “list”.




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

Instance Attribute Details

#data ⇒ Array<OpenAI::Models::Embedding>

The list of embeddings generated by the model.

Returns:



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

required :data, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Embedding] }

#model ⇒ String

The name of the model used to generate the embedding.

Returns:

  • (String) 


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

required :model, String

#object ⇒ Symbol, :list

The object type, which is always “list”.

Returns:

  • (Symbol, :list) 


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

required :object, const: :list

#usage ⇒ OpenAI::Models::CreateEmbeddingResponse::Usage

The usage information for the request.

Returns:



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

required :usage, -> { OpenAI::CreateEmbeddingResponse::Usage }