Class: OpenAI::Models::UploadCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/upload_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(bytes: , filename: , mime_type: , purpose: , request_options: {}) ⇒ Object

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

Parameters:

  • bytes (Integer) (defaults to: ) —

    The number of bytes in the file you are uploading.

  • filename (String) (defaults to: ) —

    The name of the file to upload.

  • mime_type (String) (defaults to: ) —

    The MIME type of the file.

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

    The intended purpose of the uploaded file.

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



# File 'lib/openai/models/upload_create_params.rb', line 40

Instance Attribute Details

#bytes ⇒ Integer

The number of bytes in the file you are uploading.

Returns:

  • (Integer) 


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

required :bytes, Integer

#filename ⇒ String

The name of the file to upload.

Returns:

  • (String) 


20
 
# File 'lib/openai/models/upload_create_params.rb', line 20

required :filename, String

#mime_type ⇒ String

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Returns:

  • (String) 


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

required :mime_type, String

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

The intended purpose of the uploaded file.

See the [documentation on File purposes](platform.openai.com/docs/api-reference/files/create#files-create-purpose).

Returns:



38
 
# File 'lib/openai/models/upload_create_params.rb', line 38

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