Class: OpenAI::Models::FileCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/file_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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: , purpose: , request_options: {}) ⇒ Object

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

Parameters:

  • file (Pathname, StringIO, IO, String, OpenAI::FilePart) (defaults to: ) —

    The File object (not file name) to be uploaded.

  • purpose (Symbol, OpenAI::Models::FilePurpose) (defaults to: ) —

    The intended purpose of the uploaded file. One of: - ‘assistants`: Used in the A

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/openai/models/file_create_params.rb', line 25

Instance Attribute Details

#file ⇒ Pathname, ...

The File object (not file name) to be uploaded.

Returns:



14
 
# File 'lib/openai/models/file_create_params.rb', line 14

required :file, OpenAI::Internal::Type::FileInput

#purpose ⇒ Symbol, OpenAI::Models::FilePurpose

The intended purpose of the uploaded file. One of: - ‘assistants`: Used in the Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`: Flexible file type for any purpose - `evals`: Used for eval data sets

Returns:



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

required :purpose, enum: -> { OpenAI::FilePurpose }