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,
sig/openai/models/file_create_params.rbs

Overview

See Also:

  • OpenAI::Resources::Files#create

Defined Under Namespace

Classes: ExpiresAfter

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, 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 ⇒ Object 



25
 
# File 'sig/openai/models/file_create_params.rbs', line 25

def initialize: (

Instance Attribute Details

#expires_after ⇒ OpenAI::Models::FileCreateParams::ExpiresAfter?

The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.

Returns:



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

optional :expires_after, -> { OpenAI::FileCreateParams::ExpiresAfter }

#file ⇒ Pathname, ...

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

Parameters:

  • value (OpenAI::Internal::file_input)

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

Parameters:

  • value (OpenAI::Models::file_purpose)

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/openai/models/file_create_params.rbs', line 32

def to_hash: -> {