Package version:

Interface FileSearchToolDefinitionDetails

Options overrides for the file search tool.

interface FileSearchToolDefinitionDetails {
    maxNumResults?: number;
    rankingOptions?: FileSearchRankingOptions;
}

Properties

maxNumResults?: number

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 for more information.

rankingOptions?: FileSearchRankingOptions

Ranking options for file search.