Struct CreateFileRequest 

pub struct CreateFileRequest {
    pub file: PathBuf,
    pub purpose: FilePurpose,
    pub expires_after: Option<ExpiresAfter>,
    pub extra_body: Option<Map<String, Value>>,
}

Upload a file that can be used across various endpoints.

Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 1 TB.

The Assistants API supports files up to 2 million tokens and of specific file types. See the OpenAI Assistants Tools guide for details.

The Fine-tuning API only supports .jsonl files. The input also has certain required formats for fine-tuning chat or completions models.

The Batch API only supports .jsonl files up to 200 MB in size. The input also has a specific required format.

Please contact OpenAI if you need to increase these storage limits.

Fields

file: PathBuf

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

purpose: 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

expires_after: Option<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.

extra_body: Option<Map<String, Value>>

Trait Implementations

impl Clone for CreateFileRequest

fn clone(&self) -> CreateFileRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateFileRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateFileRequest

fn default() -> CreateFileRequest

Returns the “default value” for a type.

impl Post for CreateFileRequest

fn build_url(&self, base_url: &str) -> Result<String, OapiError>

Builds the URL for the request.

base_url should be like https://api.openai.com/v1

fn is_streaming(&self) -> bool

impl PostNoStream for CreateFileRequest

async fn get_response_string( &self, client: &Client, url: &str, key: &str, ) -> Result<String, OapiError>

Sends a file upload POST request using multipart/form-data format. This implementation handles the actual file upload with proper file handling.

type Response = FileObject

fn get_response( &self, client: &Client, url: &str, key: &str, ) -> impl Future<Output = Result<Self::Response, OapiError>> + Send + Sync

Sends a POST request and deserializes the response.

impl Serialize for CreateFileRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.