Class FileSearch

Search for relevant content from uploaded files.

See

https://platform.openai.com/docs/guides/tools-file-search

Hierarchy (view full)

Constructors

constructor

Properties

[PROVIDER_TOOL_SYMBOL] [TOOL_SYMBOL] filters id maxNumResults rankingOptions type vectorStoreIds

Methods

toToolConfig

Constructors

constructor

Properties

Readonly [PROVIDER_TOOL_SYMBOL]

[PROVIDER_TOOL_SYMBOL]: true

Readonly [TOOL_SYMBOL]

[TOOL_SYMBOL]: true

Readonly filters

filters: undefined | null | ComparisonFilter | CompoundFilter

Filter to apply to file search results.

Readonly id

id: string

Stable identifier used to key the tool inside a ToolContext. For function tools this mirrors name; for provider tools this is the provider tool id.

Readonly maxNumResults

maxNumResults: undefined | number

Maximum number of results to return.

Readonly rankingOptions

rankingOptions: undefined | RankingOptions

Ranking options for search.

Readonly type

type: "provider"

Readonly vectorStoreIds

vectorStoreIds: string[]

IDs of the vector stores to search.

Methods

toToolConfig

Settings

Member Visibility

Theme

On This Page

constructor[PROVIDER_TOOL_SYMBOL][TOOL_SYMBOL]filtersidmaxNumResultsrankingOptionstypevectorStoreIdstoToolConfig