class

OpenAI::FileSearchToolCall

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)
Source
new(id : String = "", type_value : FileSearchToolCallType = FileSearchToolCallType::FileSearchCall, status : FileSearchToolCallStatus = FileSearchToolCallStatus::InProgress, queries : Array(String) = [] of String, results : FileSearchToolCallResults | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

id

The unique ID of the file search tool call.

Source
id=(id : String)

The unique ID of the file search tool call.

Source
queries

The queries used to search for files.

Source
queries=(queries : Array(String))

The queries used to search for files.

Source
results
Source
results=(results : FileSearchToolCallResults | Nil)
Source
status

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

Source
status=(status : FileSearchToolCallStatus)

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

Source
type_value

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

Source
type_value=(type_value : FileSearchToolCallType)

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

Source