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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::FileSearchTool::FileSearch

Defined in:

lib/openai/models/beta/file_search_tool.rb

Overview

See Also:

• #file_search

Defined Under Namespace

Classes: RankingOptions

Instance Attribute Summary

• #max_num_results ⇒ Integer^?

  The maximum number of results the file search tool should output.

• #ranking_options ⇒ OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions^?

  The ranking options for the file search.

Instance Method Summary

• #initialize(max_num_results: nil, ranking_options: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see FileSearch for more details.

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(max_num_results: nil, ranking_options: nil) ⇒ Object

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

Overrides for the file search tool.

Parameters:

• max_num_results (Integer) (defaults to: nil) —

  The maximum number of results the file search tool should output. The default is

• ranking_options (OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions) (defaults to: nil) —

  The ranking options for the file search. If not specified, the file search tool

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

Instance Attribute Details

#max_num_results ⇒ Integer^?

The maximum number of results the file search tool should output. The default is 20 for ‘gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.

Note that the file search tool may output fewer than ‘max_num_results` results. See the [file search tool documentation](platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.

Returns:

• (Integer, nil)

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

optional :max_num_results, Integer

#ranking_options ⇒ OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions^?

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.

Returns:

• (OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions, nil)

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

optional :ranking_options, -> { OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions }