Class: OpenAI::Models::Embedding

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Embedding

Defined in:

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

Instance Attribute Summary

• #embedding ⇒ ::Array[Float]

  The embedding vector, which is a list of floats.

• #index ⇒ Integer

  The index of the embedding in the list of embeddings.

• #object ⇒ :embedding

  The object type, which is always "embedding".

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(embedding:, index:, object: :embedding) ⇒ Object constructor
• #to_hash ⇒ {

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(embedding:, index:, object: :embedding) ⇒ Object

Parameters:

• embedding —

  The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

• index —

  The index of the embedding in the list of embeddings.

• object (defaults to: :embedding) —

  The object type, which is always "embedding".

# File 'lib/openai/models/embedding.rb', line 26

Instance Attribute Details

#embedding ⇒ ::Array[Float]

The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the embedding guide.

Returns:

• (::Array[Float])

# File 'lib/openai/models/embedding.rb', line 12

required :embedding, OpenAI::Internal::Type::ArrayOf[Float]

#index ⇒ Integer

The index of the embedding in the list of embeddings.

Returns:

• (Integer)

# File 'lib/openai/models/embedding.rb', line 18

required :index, Integer

#object ⇒ :embedding

The object type, which is always "embedding".

Returns:

• (:embedding)

# File 'lib/openai/models/embedding.rb', line 24

required :object, const: :embedding

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/embedding.rbs', line 32

def to_hash: -> {