Class: OpenAI::Models::Beta::BetaResponseFileSearchToolCall

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

Defined Under Namespace

Modules: Status Classes: Agent, 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, 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(agent_name:) ⇒ Object

The agent that produced this item.

Parameters:

  • agent_name (String) —

    The canonical name of the agent that produced this item.




# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 46

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Agent?

The agent that produced this item.

Parameters:

  • value (OpenAI::Beta::BetaResponseFileSearchToolCall::Agent, nil)

Returns:



36
 
# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 36

optional :agent, -> { OpenAI::Beta::BetaResponseFileSearchToolCall::Agent }, nil?: true

#id ⇒ String

The unique ID of the file search tool call.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 11

required :id, String

#queries ⇒ Array<String>

The queries used to search for files.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


17
 
# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 17

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

#results ⇒ Array<OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Result>?

The results of the file search tool call.

Parameters:

  • value (::Array[OpenAI::Beta::BetaResponseFileSearchToolCall::Result], nil)

Returns:



42
43
44
 
# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 42

optional :results,
-> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::BetaResponseFileSearchToolCall::Result] },
nil?: true

#status ⇒ Symbol, OpenAI::Models::Beta::BetaResponseFileSearchToolCall::Status

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

Parameters:

  • value (OpenAI::Models::Beta::BetaResponseFileSearchToolCall::status)

Returns:



24
 
# File 'lib/openai/models/beta/beta_response_file_search_tool_call.rb', line 24

required :status, enum: -> { OpenAI::Beta::BetaResponseFileSearchToolCall::Status }

#type ⇒ Symbol, :file_search_call

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

Parameters:

  • value (:file_search_call)

Returns:

  • (Symbol, :file_search_call) 


30
 
# File 'lib/openai/models/beta/beta_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/beta/beta_response_file_search_tool_call.rb', line 79

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


38
 
# File 'sig/openai/models/beta/beta_response_file_search_tool_call.rbs', line 38

def to_hash: -> {