allms 0.40.0

One Library to rule them aLLMs
Documentation
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use anyhow::{anyhow, Result};
use backoff::{future::retry, ExponentialBackoff};
use log::{error, info};
use reqwest::Client;
use serde::{Deserialize, Serialize};
use serde_json::json;
use std::time::Duration;

use crate::assistants::{OpenAIAssistantResource, OpenAIAssistantVersion};
use crate::domain::AllmsError;

#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct OpenAIVectorStore {
    pub id: Option<String>,
    pub name: String,
    api_key: String,
    status: OpenAIVectorStoreStatus,
    debug: bool,
    version: OpenAIAssistantVersion,
}

impl OpenAIVectorStore {
    /// Constructor
    pub fn new(id: Option<String>, name: &str, api_key: &str) -> Self {
        OpenAIVectorStore {
            id,
            name: name.to_string(),
            api_key: api_key.to_string(),
            status: OpenAIVectorStoreStatus::InProgress,
            debug: false,
            version: OpenAIAssistantVersion::V2,
        }
    }

    ///
    /// This method can be used to set turn on/off the debug mode
    ///
    pub fn debug(mut self) -> Self {
        self.debug = !self.debug;
        self
    }

    ///
    /// This method can be used to set the version of Assistants API Beta
    /// Current default is V2
    ///
    pub fn version(mut self, version: OpenAIAssistantVersion) -> Self {
        // VectorStores endpoint is only available for v2 so if v1 is selected we overwrite
        let version = match version {
            OpenAIAssistantVersion::V1 => OpenAIAssistantVersion::V2,
            _ => version,
        };
        self.version = version;
        self
    }

    /*
     * This function creates a new Vector Store and updates the ID of the struct
     */
    async fn create(&mut self, file_ids: Option<Vec<String>>) -> Result<()> {
        let vector_store_url = self
            .version
            .get_endpoint(&OpenAIAssistantResource::VectorStores);

        // If debug is true, print the URL
        if self.debug {
            info!(
                "[debug] OpenAI Vector Store Create API URL: {:#?}",
                vector_store_url
            );
        }

        //Make the API call
        let client = Client::new();

        //Get the version-specific header
        let version_headers = self.version.get_headers(&self.api_key);

        let mut body = json!({
            "name": self.name.clone(),
        });
        if let Some(ids) = file_ids {
            body["file_ids"] = json!(ids.to_vec());
        }

        let response = client
            .post(vector_store_url)
            .headers(version_headers)
            .json(&body)
            .send()
            .await?;

        let response_status = response.status();
        let response_text = response.text().await?;

        if self.debug {
            info!(
                "[allms][OpenAI][VectorStore][debug] VectorStore Create API response: [{}] {:#?}",
                &response_status, &response_text
            );
        }

        //Deserialize the string response into the Assistant object
        let response_deser: OpenAIVectorStoreResp =
            serde_json::from_str(&response_text).map_err(|error| {
                let error = AllmsError {
                    crate_name: "allms".to_string(),
                    module: "assistants::openai_vector_store".to_string(),
                    error_message: format!(
                        "VectorStore Create API response serialization error: {}",
                        error
                    ),
                    error_detail: response_text,
                };
                error!("{:?}", error);
                anyhow!("{:?}", error)
            })?;

        //Add correct ID & status to self
        self.id = Some(response_deser.id);
        self.status = response_deser.status;

        Ok(())
    }

    ///
    /// This method uploads files to a Vector Store. If no ID was provided the method first creates the Vector Store
    ///
    pub async fn upload(&mut self, file_ids: &[String]) -> Result<Self> {
        // If the Vector Store was not yet created we do that first
        if self.id.is_none() {
            self.create(Some(file_ids.to_vec())).await?;
        } else {
            // If working with existing Vector Store we simply upload files
            self.assign_to_store(file_ids).await?;
        }

        // Before returning ensure the files are processed

        // First ensure it's in Completed state
        let backoff_config = ExponentialBackoff {
            initial_interval: Duration::from_secs(1),
            max_interval: Duration::from_secs(1),
            max_elapsed_time: Some(Duration::from_secs(90)),
            ..Default::default()
        };

        retry(backoff_config.clone(), || async {
            let status = self.status().await?;
            if status == OpenAIVectorStoreStatus::Completed {
                Ok(())
            } else {
                Err(backoff::Error::transient(anyhow!(
                    "[allms][OpenAI][Vector Store] Vector store failed to initialize in time."
                )))
            }
        })
        .await?;

        // Then make sure all files are processed
        retry(backoff_config, || async {
            let file_count = self.file_count().await?;
            if file_count.in_progress == 0 {
                Ok(())
            } else {
                Err(backoff::Error::transient(anyhow!(
                    "[allms][OpenAI][Vector Store] Files processing did not complete in time."
                )))
            }
        })
        .await?;

        // Return the Vector Store
        Ok(self.clone())
    }

    /*
     * This function assigns OpenAI Files to an existing Vector Store
     */
    async fn assign_to_store(&self, file_ids: &[String]) -> Result<()> {
        // The function requires an ID of an existing vector store
        let vs_id = if let Some(id) = &self.id {
            id
        } else {
            return Err(anyhow!(
                "[allms][OpenAI][VectorStore][debug] Unable to assign files. No ID provided."
            ));
        };

        // Construct the API url
        let vector_store_resource = OpenAIAssistantResource::VectorStoreFileBatches {
            vector_store_id: vs_id.to_string(),
        };
        let url = self.version.get_endpoint(&vector_store_resource);

        //Get the version-specific header
        let version_headers = self.version.get_headers(&self.api_key);

        //Make the API call
        let client = Client::new();

        let body = json!({
            "file_ids": file_ids.to_vec(),
        });

        let response = client
            .post(&url)
            .headers(version_headers)
            .json(&body)
            .send()
            .await?;

        let response_status = response.status();
        let response_text = response.text().await?;

        if self.debug {
            info!(
                "[allms][OpenAI][VectorStore][debug] VectorStore Batch Upload API response: [{}] {:#?}",
                &response_status, &response_text
            );
        }

        //Deserialize & validate the string response
        serde_json::from_str::<OpenAIVectorStoreFileBatchResp>(&response_text)
            .map_err(|error| {
                let error = AllmsError {
                    crate_name: "allms".to_string(),
                    module: "assistants::openai_vector_store".to_string(),
                    error_message: format!(
                        "VectorStore Batch Upload API response serialization error: {}",
                        error
                    ),
                    error_detail: response_text,
                };
                error!("{:?}", error);
                anyhow!("{:?}", error)
            })
            .map(|_| Ok(()))?
    }

    ///
    /// This method checks the status of a Vector Store
    ///
    pub async fn status(&self) -> Result<OpenAIVectorStoreStatus> {
        // Requires an ID of an existing vector store
        let vs_id = if let Some(id) = &self.id {
            id
        } else {
            return Err(anyhow!(
                "[allms][OpenAI][VectorStore][debug] Unable to check status. No ID provided."
            ));
        };

        // Construct the API url
        let vector_store_resource = OpenAIAssistantResource::VectorStore {
            vector_store_id: vs_id.to_string(),
        };
        let url = self.version.get_endpoint(&vector_store_resource);

        //Get the version-specific header
        let version_headers = self.version.get_headers(&self.api_key);

        //Make the API call
        let client = Client::new();

        let response = client.get(&url).headers(version_headers).send().await?;

        let response_status = response.status();
        let response_text = response.text().await?;

        if self.debug {
            info!(
                "[allms][OpenAI][VectorStore][debug] VectorStore Status API response: [{}] {:#?}",
                &response_status, &response_text
            );
        }

        //Deserialize & validate the string response
        let response_deser: OpenAIVectorStoreResp =
            serde_json::from_str(&response_text).map_err(|error| {
                let error = AllmsError {
                    crate_name: "allms".to_string(),
                    module: "assistants::openai_vector_store".to_string(),
                    error_message: format!(
                        "VectorStore Status API response serialization error: {}",
                        error
                    ),
                    error_detail: response_text,
                };
                error!("{:?}", error);
                anyhow!("{:?}", error)
            })?;
        Ok(response_deser.status)
    }

    ///
    /// This method checks the counts of files added to a Vector Store and their statuses
    ///
    pub async fn file_count(&self) -> Result<OpenAIVectorStoreFileCounts> {
        // Requires an ID of an existing vector store
        let vs_id = if let Some(id) = &self.id {
            id
        } else {
            return Err(anyhow!(
                "[allms][OpenAI][VectorStore][debug] Unable to check status. No ID provided."
            ));
        };

        // Construct the API url
        let vector_store_resource = OpenAIAssistantResource::VectorStore {
            vector_store_id: vs_id.to_string(),
        };
        let url = self.version.get_endpoint(&vector_store_resource);

        //Get the version-specific header
        let version_headers = self.version.get_headers(&self.api_key);

        //Make the API call
        let client = Client::new();

        let response = client.get(&url).headers(version_headers).send().await?;

        let response_status = response.status();
        let response_text = response.text().await?;

        if self.debug {
            info!(
                "[allms][OpenAI][VectorStore][debug] VectorStore Status API response: [{}] {:#?}",
                &response_status, &response_text
            );
        }

        //Deserialize & validate the string response
        let response_deser: OpenAIVectorStoreResp =
            serde_json::from_str(&response_text).map_err(|error| {
                let error = AllmsError {
                    crate_name: "allms".to_string(),
                    module: "assistants::openai_vector_store".to_string(),
                    error_message: format!(
                        "VectorStore Status API response serialization error: {}",
                        error
                    ),
                    error_detail: response_text,
                };
                error!("{:?}", error);
                anyhow!("{:?}", error)
            })?;
        Ok(response_deser.file_counts)
    }

    ///
    /// This method can be used to delete a Vector Store
    ///
    pub async fn delete(&self) -> Result<()> {
        // Requires an ID of an existing vector store
        let vs_id = if let Some(id) = &self.id {
            id
        } else {
            return Err(anyhow!(
                "[allms][OpenAI][VectorStore][debug] Unable to delete. No ID provided."
            ));
        };

        // Construct the API url
        let vector_store_resource = OpenAIAssistantResource::VectorStore {
            vector_store_id: vs_id.to_string(),
        };
        let url = self.version.get_endpoint(&vector_store_resource);

        //Get the version-specific header
        let version_headers = self.version.get_headers(&self.api_key);

        //Make the API call
        let client = Client::new();

        let response = client.delete(&url).headers(version_headers).send().await?;

        let response_status = response.status();
        let response_text = response.text().await?;

        if self.debug {
            info!(
                "[allms][OpenAI][VectorStore][debug] VectorStore Delete API response: [{}] {:#?}",
                &response_status, &response_text
            );
        }

        //Deserialize & validate the string response
        serde_json::from_str::<OpenAIVectorStoreDeleteResp>(&response_text)
            .map_err(|error| {
                let error = AllmsError {
                    crate_name: "allms".to_string(),
                    module: "assistants::openai_vector_store".to_string(),
                    error_message: format!(
                        "VectorStore Delete API response serialization error: {}",
                        error
                    ),
                    error_detail: response_text,
                };
                error!("{:?}", error);
                anyhow!("{:?}", error)
            })
            .and_then(|response| match response.deleted {
                true => Ok(()),
                false => Err(anyhow!(
                    "[OpenAIAssistant] VectorStore Delete API failed to delete the store."
                )),
            })
    }
}

/******************************************************************************************
*
* API Response serialization / deserialization structs
*
******************************************************************************************/
#[derive(Deserialize, Serialize, Debug, Clone)]
struct OpenAIVectorStoreResp {
    id: String,
    name: String,
    status: OpenAIVectorStoreStatus,
    created_at: i64,
    expires_at: Option<i64>,
    last_active_at: Option<i64>,
    file_counts: OpenAIVectorStoreFileCounts,
}

#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct OpenAIVectorStoreFileCounts {
    pub in_progress: i32,
    pub completed: i32,
    pub failed: i32,
    pub cancelled: i32,
    pub total: i32,
}

#[derive(Deserialize, Serialize, Debug, Clone, Eq, PartialEq)]
pub enum OpenAIVectorStoreStatus {
    #[serde(rename(deserialize = "expired", serialize = "expired"))]
    Expired,
    #[serde(rename(deserialize = "in_progress", serialize = "in_progress"))]
    InProgress,
    #[serde(rename(deserialize = "completed", serialize = "completed"))]
    Completed,
}

#[derive(Deserialize, Serialize, Debug, Clone)]
struct OpenAIVectorStoreFileBatchResp {
    id: String,
    vector_store_id: String,
    status: OpenAIVectorStoreFileBatchStatus,
    created_at: i64,
    file_counts: OpenAIVectorStoreFileCounts,
}

#[derive(Deserialize, Serialize, Debug, Clone)]
pub enum OpenAIVectorStoreFileBatchStatus {
    #[serde(rename(deserialize = "in_progress", serialize = "in_progress"))]
    InProgress,
    #[serde(rename(deserialize = "completed", serialize = "completed"))]
    Completed,
    #[serde(rename(deserialize = "cancelled", serialize = "cancelled"))]
    Cancelled,
    #[serde(rename(deserialize = "failed", serialize = "failed"))]
    Failed,
}

#[derive(Deserialize, Serialize, Debug, Clone)]
struct OpenAIVectorStoreDeleteResp {
    id: String,
    deleted: bool,
}