Struct Files 

pub struct Files<'client, E>
where
    E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{ /* private fields */ }

The client for the OpenAI Files API.

Implementations

impl<'client, E> Files<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,

pub async fn upload(&self, request: CreateFileRequest) -> Result<FileObject>

Uploads a file that can be used across various features.

Arguments

• request: The request body for uploading a file.

Errors

Returns OpenAIError if the request fails.

pub async fn list(&self, query: Option<ListQuery>) -> Result<ListFilesResponse>

Lists files that belong to the user’s organization.

Arguments

• query: Optional query parameters for listing files.

Errors

Returns OpenAIError if the request fails.

pub async fn retrieve(&self, file_id: &str) -> Result<FileObject>

Retrieves a file.

Arguments

• file_id: The ID of the file to retrieve.

Errors

Returns OpenAIError if the request fails.

pub async fn delete(&self, file_id: &str) -> Result<Value>

Deletes a file.

Arguments

• file_id: The ID of the file to delete.

Errors

Returns OpenAIError if the request fails.

pub async fn retrieve_content(&self, file_id: &str) -> Result<Vec<u8>>

Retrieves the content of the specified file.

Arguments

• file_id: The ID of the file to retrieve content for.

Errors

Returns OpenAIError if the request fails.

Trait Implementations

impl<'client, E> Clone for Files<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static + Clone,

fn clone(&self) -> Files<'client, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'client, E> Debug for Files<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.