Class: OpenAI::Models::Embedding

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

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

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

Represents an embedding vector returned by embedding endpoint.

Parameters:

  • embedding (Array<Float>) (defaults to: ) —

    The embedding vector, which is a list of floats. The length of vector depends on

  • index (Integer) (defaults to: ) —

    The index of the embedding in the list of embeddings.

  • object (Symbol, :embedding) (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](platform.openai.com/docs/guides/embeddings).

Returns:

  • (Array<Float>) 


12
 
# 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) 


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

required :index, Integer

#object ⇒ Symbol, :embedding

The object type, which is always “embedding”.

Returns:

  • (Symbol, :embedding) 


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

required :object, const: :embedding