Class: OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions

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

Overview

See Also:

Defined Under Namespace

Modules: Ranker

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

Some parameter documentations has been truncated, see OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions for more details.

The ranking options for the file search. If not specified, the file search tool will use the ‘auto` ranker and a score_threshold of 0.

See the [file search tool documentation](platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.

Parameters:




# File 'lib/openai/models/beta/file_search_tool.rb', line 76

Instance Attribute Details

#ranker ⇒ Symbol, ...

The ranker to use for the file search. If not specified will use the ‘auto` ranker.

Returns:



74
 
# File 'lib/openai/models/beta/file_search_tool.rb', line 74

optional :ranker, enum: -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions::Ranker }

#score_threshold ⇒ Float

The score threshold for the file search. All values must be a floating point number between 0 and 1.

Returns:

  • (Float) 


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

required :score_threshold, Float