Class: OpenAI::Models::VectorStoreSearchResponse

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

Overview

See Also:

Defined Under Namespace

Modules: Attribute Classes: Content

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#attributes ⇒ Hash{Symbol=>String, Float, Boolean}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


15
16
17
 
# File 'lib/openai/models/vector_store_search_response.rb', line 15

required :attributes,
-> { OpenAI::Internal::Type::HashOf[union: OpenAI::Models::VectorStoreSearchResponse::Attribute] },
nil?: true

#content ⇒ Array<OpenAI::Models::VectorStoreSearchResponse::Content>

Content chunks from the file.

Returns:



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

required :content,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::VectorStoreSearchResponse::Content] }

#file_id ⇒ String

The ID of the vector store file.

Returns:

  • (String) 


30
 
# File 'lib/openai/models/vector_store_search_response.rb', line 30

required :file_id, String

#filename ⇒ String

The name of the vector store file.

Returns:

  • (String) 


36
 
# File 'lib/openai/models/vector_store_search_response.rb', line 36

required :filename, String

#score ⇒ Float

The similarity score for the result.

Returns:

  • (Float) 


42
 
# File 'lib/openai/models/vector_store_search_response.rb', line 42

required :score, Float

Class Method Details

.variants ⇒ Array(String, Float, Boolean)

Returns:




# File 'lib/openai/models/vector_store_search_response.rb', line 67