Interface FileSearchOptions

Options for the File Search tool.

interface FileSearchOptions {
    filters?: FileSearchFilter;
    maxNumResults?: number;
    rankingOptions?: FileSearchRankingOptions;
    vectorStoreIds: string[];
}

Properties

A filter to apply based on file attributes/metadata. Use this to narrow down search results to specific categories or file types.

maxNumResults?: number

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

Ranking options to customize how results are scored and ordered.

vectorStoreIds: string[]

The IDs of the vector stores to search. You must have previously created vector stores and uploaded files to them.