Share via


ItemFileSearchToolCall interface

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

Extends

Properties

id

The unique ID of the file search tool call.

queries

The queries used to search for files.

results

The results of the file search tool call.

status

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

type

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

Property Details

id

The unique ID of the file search tool call.

id: string

Property Value

string

queries

The queries used to search for files.

queries: string[]

Property Value

string[]

results

The results of the file search tool call.

results?: FileSearchToolCallResults[]

Property Value

status

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

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

Property Value

"in_progress" | "completed" | "incomplete" | "failed" | "searching"

type

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

type: "file_search_call"

Property Value

"file_search_call"