Struct Uploads

pub struct Uploads<'c, C: Config> { /* private fields */ }

Allows you to upload large files in multiple parts.

Implementations

impl<'c, C: Config> Uploads<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create( &self, request: CreateUploadRequest, ) -> Result<Upload, OpenAIError>

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purposes, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case:

• Assistants

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File. Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purposes, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case:

• Assistants

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

pub async fn create_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

For certain purposes, the correct mime_type must be specified. Please refer to documentation for the supported MIME types for your use case:

• Assistants

For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.

pub async fn add_part( &self, upload_id: &str, request: AddUploadPartRequest, ) -> Result<UploadPart, OpenAIError>

Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload. Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.

pub async fn add_part_byot<T0: Display, T1: Clone, R: DeserializeOwned>( &self, upload_id: T0, request: T1, ) -> Result<R, OpenAIError>

where Form: AsyncTryFrom<T1, Error = OpenAIError>,

Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.

pub async fn complete( &self, upload_id: &str, request: CompleteUploadRequest, ) -> Result<Upload, OpenAIError>

Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.

pub async fn complete_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, upload_id: T0, request: T1, ) -> Result<R, OpenAIError>

Completes the Upload.

Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.

You can specify the order of the Parts by passing in an ordered list of the Part IDs.

The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.

pub async fn cancel(&self, upload_id: &str) -> Result<Upload, OpenAIError>

Cancels the Upload. No Parts may be added after an Upload is cancelled. Cancels the Upload. No Parts may be added after an Upload is cancelled.

pub async fn cancel_byot<T0: Display, R: DeserializeOwned>( &self, upload_id: T0, ) -> Result<R, OpenAIError>

Cancels the Upload. No Parts may be added after an Upload is cancelled.