Class: OpenAI::Models::Responses::ResponseInputFile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_input_file.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(file_data: nil, file_id: nil, filename: nil, type: :input_file) ⇒ Object

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

A file input to the model.

Parameters:

  • file_data (String) (defaults to: nil) —

    The content of the file to be sent to the model.

  • file_id (String, nil) (defaults to: nil) —

    The ID of the file to be sent to the model.

  • filename (String) (defaults to: nil) —

    The name of the file to be sent to the model.

  • type (Symbol, :input_file) (defaults to: :input_file) —

    The type of the input item. Always ‘input_file`.




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

Instance Attribute Details

#file_data ⇒ String?

The content of the file to be sent to the model.

Returns:

  • (String, nil) 


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

optional :file_data, String

#file_id ⇒ String?

The ID of the file to be sent to the model.

Returns:

  • (String, nil) 


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

optional :file_id, String, nil?: true

#filename ⇒ String?

The name of the file to be sent to the model.

Returns:

  • (String, nil) 


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

optional :filename, String

#type ⇒ Symbol, :input_file

The type of the input item. Always ‘input_file`.

Returns:

  • (Symbol, :input_file) 


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

required :type, const: :input_file