Skip to main content
Module

x/openai/resources/beta/mod.ts>FileSearchTool.FileSearch

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
namespace FileSearchTool.FileSearch
import { FileSearchTool } from "https://deno.land/x/openai@v4.61.1/resources/beta/mod.ts";
const { FileSearch } = FileSearchTool;

Interfaces

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

interface FileSearchTool.FileSearch
import { type FileSearchTool } from "https://deno.land/x/openai@v4.61.1/resources/beta/mod.ts";
const { FileSearch } = FileSearchTool;

Overrides for the file search tool.

Properties

optional
max_num_results: 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.

optional
ranking_options: FileSearch.RankingOptions

The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0.

See the file search tool documentation for more information.