Class: OpenAI::Models::VectorStoreSearchParams::RankingOptions

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::VectorStoreSearchParams::RankingOptions

Defined in:

lib/openai/models/vector_store_search_params.rb

Defined Under Namespace

Modules: Ranker

Instance Attribute Summary

• #ranker ⇒ Symbol, ...
• #score_threshold ⇒ Float^?

Instance Method Summary

• #initialize(ranker: nil, score_threshold: nil) ⇒ Object constructor

  Ranking options for search.

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(ranker: nil, score_threshold: nil) ⇒ Object

Ranking options for search.

Parameters:

• ranker (Symbol, OpenAI::Models::VectorStoreSearchParams::RankingOptions::Ranker) (defaults to: nil)
• score_threshold (Float) (defaults to: nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 97

Instance Attribute Details

#ranker ⇒ Symbol, ...

Returns:

• (Symbol, OpenAI::Models::VectorStoreSearchParams::RankingOptions::Ranker, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 90

optional :ranker, enum: -> { OpenAI::VectorStoreSearchParams::RankingOptions::Ranker }

#score_threshold ⇒ Float^?

Returns:

• (Float, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 95

optional :score_threshold, Float