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

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

Defined Under Namespace

Modules: Status Classes: Result

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #dump, dump, #inspect, inspect, 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

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseFileSearchToolCall for more details.

The results of a file search tool call. See the [file search guide](platform.openai.com/docs/guides/tools-file-search) for more information.

Parameters:

  • id (String) (defaults to: ) —

    The unique ID of the file search tool call.

  • queries (Array<String>) (defaults to: ) —

    The queries used to search for files.

  • status (Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status) (defaults to: ) —

    The status of the file search tool call. One of ‘in_progress`,

  • results (Array<OpenAI::Models::Responses::ResponseFileSearchToolCall::Result>, nil) (defaults to: nil) —

    The results of the file search tool call.

  • type (Symbol, :file_search_call) (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 42

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::Models::Responses::ResponseFileSearchToolCall::Result>?

The results of the file search tool call.

Returns:



36
37
38
39
40
 
# 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 ⇒ Symbol, OpenAI::Models::Responses::ResponseFileSearchToolCall::Status

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

Returns:



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

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

#type ⇒ Symbol, :file_search_call

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

Returns:

  • (Symbol, :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 73