class

OpenAI::FileSearchTool

Inherits JSON::Serializable < Reference < Object

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : FileSearchToolType = FileSearchToolType::FileSearch, vector_store_ids : Array(String) = [] of String, max_num_results : Int64 | Nil = nil, ranking_options : RankingOptions | Nil = nil, filters : FileSearchToolFilters | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

filters
Source
filters=(filters : FileSearchToolFilters | Nil)
Source
max_num_results

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Source
max_num_results=(max_num_results : Int64 | Nil)

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Source
ranking_options

Ranking options for search.

Source
ranking_options=(ranking_options : RankingOptions | Nil)

Ranking options for search.

Source
type_value

The type of the file search tool. Always file_search.

Source
type_value=(type_value : FileSearchToolType)

The type of the file search tool. Always file_search.

Source
vector_store_ids

The IDs of the vector stores to search.

Source
vector_store_ids=(vector_store_ids : Array(String))

The IDs of the vector stores to search.

Source