Class: OpenAI::Models::Responses::ResponseFileSearchToolCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_file_search_tool_call.rb,
sig/openai/models/responses/response_file_search_tool_call.rbs

Defined Under Namespace

Modules: Status Classes: Result

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, queries:, status:, results: nil, type: :file_search_call) ⇒ Object

Parameters:

  • id —

    The unique ID of the file search tool call.

  • queries —

    The queries used to search for files.

  • status —

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

  • results (defaults to: nil) —

    The results of the file search tool call.

  • type (defaults to: :file_search_call) —

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




# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 44

Instance Attribute Details

#id ⇒ String

The unique ID of the file search tool call.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 11

required :id, String

#queries ⇒ ::Array[String]

The queries used to search for files.

Returns:

  • (::Array[String]) 


17
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 17

required :queries, OpenAI::Internal::Type::ArrayOf[String]

#results ⇒ ::Array[OpenAI::Responses::ResponseFileSearchToolCall::Result]?

The results of the file search tool call.

Returns:

  • (::Array[OpenAI::Responses::ResponseFileSearchToolCall::Result], nil) 


36
37
38
39
40
41
42
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 36

optional(
  :results,
  -> {
    OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFileSearchToolCall::Result]
  },
  nil?: true
)

#status ⇒ OpenAI::Models::Responses::ResponseFileSearchToolCall::status

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

Returns:

  • (OpenAI::Models::Responses::ResponseFileSearchToolCall::status) 


24
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 24

required :status, enum: -> { OpenAI::Responses::ResponseFileSearchToolCall::Status }

#type ⇒ :file_search_call

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

Returns:

  • (:file_search_call) 


30
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 30

required :type, const: :file_search_call

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 78

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


49
 
# File 'sig/openai/models/responses/response_file_search_tool_call.rbs', line 49

def to_hash: -> {