Class: OpenAI::Models::Containers::FileCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Containers::FileCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/containers/file_create_params.rb

Overview

See Also:

• Resources::Containers::Files#create

Instance Attribute Summary

• #file ⇒ Pathname, ...

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

• #file_id ⇒ String^?

  Name of the file to create.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(file: nil, file_id: nil, request_options: {}) ⇒ Object constructor

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

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

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

Parameters:

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

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

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

  Name of the file to create.

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

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

Instance Attribute Details

#file ⇒ Pathname, ...

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

Returns:

• (Pathname, StringIO, IO, String, OpenAI::FilePart, nil)

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

optional :file, OpenAI::Internal::Type::FileInput

#file_id ⇒ String^?

Name of the file to create.

Returns:

• (String, nil)

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

optional :file_id, String