Class: OpenAI::Models::Responses::ResponseFileSearchCallCompletedEvent

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

Instance Attribute 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(item_id: , output_index: , sequence_number: , type: :"response.file_search_call.completed") ⇒ Object

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

Emitted when a file search call is completed (results found).

Parameters:

  • item_id (String) (defaults to: ) —

    The ID of the output item that the file search call is initiated.

  • output_index (Integer) (defaults to: ) —

    The index of the output item that the file search call is initiated.

  • sequence_number (Integer) (defaults to: ) —

    The sequence number of this event.

  • type (Symbol, :"response.file_search_call.completed") (defaults to: :"response.file_search_call.completed") —

    The type of the event. Always ‘response.file_search_call.completed`.




# File 'lib/openai/models/responses/response_file_search_call_completed_event.rb', line 31

Instance Attribute Details

#item_id ⇒ String

The ID of the output item that the file search call is initiated.

Returns:

  • (String) 


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

required :item_id, String

#output_index ⇒ Integer

The index of the output item that the file search call is initiated.

Returns:

  • (Integer) 


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

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

  • (Integer) 


23
 
# File 'lib/openai/models/responses/response_file_search_call_completed_event.rb', line 23

required :sequence_number, Integer

#type ⇒ Symbol, :"response.file_search_call.completed"

The type of the event. Always ‘response.file_search_call.completed`.

Returns:

  • (Symbol, :"response.file_search_call.completed") 


29
 
# File 'lib/openai/models/responses/response_file_search_call_completed_event.rb', line 29

required :type, const: :"response.file_search_call.completed"