FileSearchTool interface

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

Properties

description	Optional user-defined description for this tool or configuration.
filters	Filters to apply to the file search.
max_num_results	The maximum number of results to return. This number should be between 1 and 50 inclusive.
name	Optional user-defined name for this tool or configuration.
ranking_options	Ranking options for search.
type	The type of the file search tool. Always `file_search`.
vector_store_ids	The IDs of the vector stores to search.

Optional user-defined description for this tool or configuration.

description?: string

string

Filters to apply to the file search.

filters?: Filters

Filters

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

max_num_results?: number

number

Optional user-defined name for this tool or configuration.

name?: string

string

Ranking options for search.

ranking_options?: RankingOptions

The type of the file search tool. Always file_search.

type: "file_search"

"file_search"

The IDs of the vector stores to search.

vector_store_ids: string[]

string[]