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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
// src/api/assistants.rs
//! This module defines the `Assistants` API client, which provides methods
//! for interacting with the `OpenAI` Assistants API.
//!
//! For more details, refer to the [`OpenAI` Assistants API documentation](https://platform.openai.com/docs/api-reference/assistants).
/// 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::assistants_shared::
{
AssistantObject,
ListAssistantsResponse,
DeleteAssistantResponse,
};
use crate::components::common::ListQuery;
// External crates
/// The client for the `OpenAI` Assistants API.
#[ derive( Debug, Clone ) ]
pub struct Assistants< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
client : &'client Client< E >,
}
impl< 'client, E > Assistants< 'client, E >
where
E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{
/// Creates a new `Assistants` client.
///
/// # Arguments
/// - `client`: The core `OpenAI` `Client` to use for requests.
#[ inline ]
pub(crate) fn new( client : &'client Client< E > ) -> Self
{
Self { client }
}
/// Creates an assistant.
///
/// # Arguments
/// - `request`: The request body for creating an assistant.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn create( &self, request : AssistantObject ) -> Result< AssistantObject >
{
self.client.post( "assistants", &request ).await
}
/// Retrieves an assistant.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant to retrieve.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn retrieve( &self, assistant_id : &str ) -> Result< AssistantObject >
{
let path = format!( "/assistants/{assistant_id}" );
self.client.get( &path ).await
}
/// Modifies an assistant.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant to modify.
/// - `request`: The request body for modifying the assistant.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn modify( &self, assistant_id : &str, request : AssistantObject ) -> Result< AssistantObject >
{
let path = format!( "/assistants/{assistant_id}" );
self.client.post( &path, &request ).await
}
/// Deletes an assistant.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant to delete.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn delete( &self, assistant_id : &str ) -> Result< DeleteAssistantResponse >
{
let path = format!( "/assistants/{assistant_id}" );
self.client.delete( &path ).await
}
/// Lists assistants.
///
/// # Arguments
/// - `query`: Optional query parameters for listing assistants.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list( &self, query : Option< ListQuery > ) -> Result< ListAssistantsResponse >
{
let path = "/assistants";
if let Some( q ) = query
{
self.client.get_with_query( path, &q ).await
}
else
{
self.client.get( path ).await
}
}
/// Creates an assistant file.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant to create the file for.
/// - `file_id`: The ID of the file to associate with the assistant.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn create_file( &self, assistant_id : &str, file_id : &str ) -> Result< serde_json::Value >
{
let path = format!( "/assistants/{assistant_id}/files" );
let request = serde_json::json!({ "file_id": file_id });
self.client.post( &path, &request ).await
}
/// Retrieves an assistant file.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant.
/// - `file_id`: The ID of the file to retrieve.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn retrieve_file( &self, assistant_id : &str, file_id : &str ) -> Result< serde_json::Value >
{
let path = format!( "/assistants/{assistant_id}/files/{file_id}" );
self.client.get( &path ).await
}
/// Deletes an assistant file.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant.
/// - `file_id`: The ID of the file to delete.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn delete_file( &self, assistant_id : &str, file_id : &str ) -> Result< serde_json::Value >
{
let path = format!( "/assistants/{assistant_id}/files/{file_id}" );
self.client.delete( &path ).await
}
/// Lists assistant files.
///
/// # Arguments
/// - `assistant_id`: The ID of the assistant to list files for.
/// - `query`: Optional query parameters for listing files.
///
/// # Errors
/// Returns `OpenAIError` if the request fails.
#[ inline ]
pub async fn list_files( &self, assistant_id : &str, query : Option< ListQuery > ) -> Result< serde_json::Value >
{
let path = format!( "/assistants/{assistant_id}/files" );
if let Some( q ) = query
{
self.client.get_with_query( &path, &q ).await
}
else
{
self.client.get( &path ).await
}
}
}
} // end mod private
crate ::mod_interface!
{
// Expose all structs defined in this module
exposed use
{
Assistants,
};
}