Class: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/threads/runs/file_search_tool_call.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(ranker: , score_threshold: ) ⇒ Object

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

The ranking options for the file search.

Parameters:




# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 82

Instance Attribute Details

#ranker ⇒ Symbol, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions::Ranker

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

Returns:



70
71
72
73
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 70

required :ranker,
enum: -> {
  OpenAI::Beta::Threads::Runs::FileSearchToolCall::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) 


80
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 80

required :score_threshold, Float