1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
// src/api/files.rs
//! This module defines the `Files` API client, which provides methods
//! for interacting with the `OpenAI` Files API.
//!
//! For more details, refer to the [`OpenAI` Files API documentation](https://platform.openai.com/docs/api-reference/files).
/// Define a private namespace for all its items.
mod private
{
// Use crate root for base access
use crate::
{
client ::Client,
error ::Result,
environment ::{ OpenaiEnvironment, EnvironmentInterface },
};
use crate::components::files::
{
FileObject,
ListFilesResponse,
CreateFileRequest,
};
use crate::components::common::ListQuery;
// External crates
use reqwest::multipart::{ Form, Part };
use serde_json;
/// The client for the `OpenAI` Files API.
#[ derive( Debug, Clone ) ]
pub struct Files< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
client : &'client Client< E >,
}
impl< 'client, E > Files< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
/// Creates a new `Files` client.
///
/// # Arguments
/// - `client`: The core `OpenAI` `Client` to use for requests.
#[ inline ]
pub(crate) fn new( client : &'client Client< E > ) -> Self
{
Self { client }
}
/// 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.
#[ inline ]
pub async fn upload( &self, request : CreateFileRequest ) -> Result< FileObject >
{
// Create multipart form
let file_part = Part::bytes( request.file )
.file_name( request.filename.clone() )
.mime_str( "application/octet-stream" )
.map_err( | e | crate::error::OpenAIError::Internal( format!( "Failed to create file part : {e}" ) ) )?;
let form = Form::new()
.part( "file", file_part )
.text( "purpose", request.purpose );
let path = "/files";
self.client.post_multipart( path, form ).await
}
/// Lists files that belong to the user's organization.
///
/// # Arguments
/// - `query`: Optional query parameters for listing files.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list( &self, query : Option< ListQuery > ) -> Result< ListFilesResponse >
{
let path = "/files";
if let Some( q ) = query
{
self.client.get_with_query( path, &q ).await
}
else
{
self.client.get( path ).await
}
}
/// Retrieves a file.
///
/// # Arguments
/// - `file_id`: The ID of the file to retrieve.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn retrieve( &self, file_id : &str ) -> Result< FileObject >
{
let path = format!( "/files/{file_id}" );
self.client.get( &path ).await
}
/// Deletes a file.
///
/// # Arguments
/// - `file_id`: The ID of the file to delete.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn delete( &self, file_id : &str ) -> Result< serde_json::Value >
{
let path = format!( "/files/{file_id}" );
self.client.delete( &path ).await
}
/// 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.
#[ inline ]
pub async fn retrieve_content( &self, file_id : &str ) -> Result< Vec< u8 > >
{
let path = format!( "/files/{file_id}/content" );
let response = self.client.get( &path ).await?;
Ok( response )
}
}
} // end mod private
crate ::mod_interface!
{
// Expose all structs defined in this module
exposed use
{
Files,
};
}