Interface ResponseFileSearchToolCall

The results of a file search tool call. See the file search guide for more information.

interface ResponseFileSearchToolCall {
    id: string;
    queries: string[];
    results?: null | OpenAIClient.Responses.ResponseFileSearchToolCall.Result[];
    status:
        | "in_progress"
        | "searching"
        | "completed"
        | "failed"
        | "incomplete";
    type: "file_search_call";
}

Properties

id queries results? status type

Properties

id

id: string

The unique ID of the file search tool call.

queries

queries: string[]

The queries used to search for files.

Optionalresults

results?: null | OpenAIClient.Responses.ResponseFileSearchToolCall.Result[]

The results of the file search tool call.

status

status:
    | "in_progress"
    | "searching"
    | "completed"
    | "failed"
    | "incomplete"

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

type

type: "file_search_call"

The type of the file search tool call. Always file_search_call.

Settings

Member Visibility

On This Page

Properties