openai4rs 0.1.9

A non-official Rust crate for calling the OpenAI service
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
use serde::ser::SerializeSeq;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone)]
pub enum Input {
    Text(String),
    List(Vec<String>),
}

#[derive(Debug, Clone, Deserialize)]
pub struct EmbeddingResponse {
    pub model: String,
    #[serde(default = "default_list")]
    pub object: String,
    pub data: Vec<Embedding>,
    pub usage: Usage,
    #[serde(flatten)]
    pub extra_fields: Option<HashMap<String, serde_json::Value>>,
}

#[derive(Debug, Clone, Deserialize)]
pub struct Usage {
    pub prompt_tokens: usize,
    pub total_tokens: usize,
}

#[derive(Debug, Clone)]
pub enum EmbeddingData {
    Float(Vec<f32>),
    Base64(String),
}

#[derive(Debug, Clone)]
pub struct Embedding {
    pub embedding: EmbeddingData,
    pub index: usize,
    pub object: String,
}

#[derive(Debug, Clone, Default, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum EncodingFormat {
    #[default]
    Float,
    Base64,
}

fn default_list() -> String {
    "list".to_string()
}

impl EmbeddingResponse {
    /// Returns the number of embeddings in the response
    pub fn len(&self) -> usize {
        self.data.len()
    }

    /// Checks if the response contains any embeddings
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    /// Returns the total number of tokens used in the request
    pub fn total_tokens(&self) -> usize {
        self.usage.total_tokens
    }

    /// Returns the number of prompt tokens used in the request
    pub fn prompt_tokens(&self) -> usize {
        self.usage.prompt_tokens
    }

    /// Returns the embeddings data
    pub fn embeddings(&self) -> &Vec<Embedding> {
        &self.data
    }

    /// Returns a specific embedding by index
    pub fn get_embedding(&self, index: usize) -> Option<&Embedding> {
        self.data.get(index)
    }

    /// Returns all embedding vectors as a vector of float vectors, ignoring any base64-encoded embeddings
    pub fn embedding_vectors(&self) -> Vec<Vec<f32>> {
        self.data
            .iter()
            .filter_map(|e| match &e.embedding {
                EmbeddingData::Float(vec) => Some(vec.clone()),
                EmbeddingData::Base64(_) => None,
            })
            .collect()
    }

    /// Returns all embeddings as float vectors, attempting to decode base64 if needed
    pub fn embedding_vectors_decoded(&self) -> Vec<Vec<f32>> {
        self.data.iter().filter_map(|e| e.vector()).collect()
    }
}

impl Embedding {
    /// Returns the dimensionality of the embedding vector
    pub fn dimensions(&self) -> usize {
        match &self.embedding {
            EmbeddingData::Float(vec) => vec.len(),
            EmbeddingData::Base64(_) => {
                // For base64, we could decode it to get the actual float count
                // For now, return 0 or we could implement proper decoding
                0
            }
        }
    }

    /// Returns the embedding vector as a float vector, attempting to decode from base64 if needed
    pub fn vector(&self) -> Option<Vec<f32>> {
        match &self.embedding {
            EmbeddingData::Float(vec) => Some(vec.clone()),
            EmbeddingData::Base64(base64_str) => {
                // Attempt to decode base64 to float vector
                decode_base64_embedding(base64_str)
            }
        }
    }

    /// Returns the index of this embedding in the response
    pub fn index(&self) -> usize {
        self.index
    }

    /// Returns the embedding data as base64 string, if available
    pub fn as_base64(&self) -> Option<&str> {
        match &self.embedding {
            EmbeddingData::Base64(base64_str) => Some(base64_str),
            _ => None,
        }
    }

    /// Returns the embedding data as float vector, if available
    pub fn as_float(&self) -> Option<&Vec<f32>> {
        match &self.embedding {
            EmbeddingData::Float(vec) => Some(vec),
            _ => None,
        }
    }

    /// Converts the embedding data to a float vector, if available
    pub fn to_float(self) -> Option<Vec<f32>> {
        match self.embedding {
            EmbeddingData::Float(vec) => Some(vec),
            EmbeddingData::Base64(base64_str) => decode_base64_embedding(base64_str.as_str()),
        }
    }
}

/// Helper function to decode base64-encoded embedding data to float vector
fn decode_base64_embedding(base64_str: &str) -> Option<Vec<f32>> {
    use base64::Engine;
    use base64::engine::general_purpose;
    match general_purpose::STANDARD.decode(base64_str) {
        Ok(decoded_bytes) => {
            // Convert bytes to f32 slice - this assumes the data is serialized as f32 bytes
            // This might need adjustment based on how OpenAI actually encodes the embeddings
            if decoded_bytes.len() % std::mem::size_of::<f32>() == 0 {
                // This is a simplified conversion - in practice, we'd need to handle byte order properly
                let float_count = decoded_bytes.len() / std::mem::size_of::<f32>();
                let mut result = Vec::with_capacity(float_count);

                for chunk in decoded_bytes.chunks_exact(std::mem::size_of::<f32>()) {
                    let bytes: [u8; 4] = [chunk[0], chunk[1], chunk[2], chunk[3]];
                    result.push(f32::from_le_bytes(bytes)); // Assuming little endian
                }
                Some(result)
            } else {
                None
            }
        }
        Err(_) => None,
    }
}

impl Serialize for Input {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Input::Text(text) => {
                let mut seq = serializer.serialize_seq(Some(1))?;
                seq.serialize_element(text)?;
                seq.end()
            }
            Input::List(list) => list.serialize(serializer),
        }
    }
}

impl<'de> serde::Deserialize<'de> for Embedding {
    fn deserialize<D>(deserializer: D) -> Result<Embedding, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::{self, MapAccess, Visitor};
        use std::fmt;

        struct EmbeddingVisitor;

        impl<'de> Visitor<'de> for EmbeddingVisitor {
            type Value = Embedding;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("struct Embedding")
            }

            fn visit_map<V>(self, mut map: V) -> Result<Embedding, V::Error>
            where
                V: MapAccess<'de>,
            {
                let mut embedding = None;
                let mut index = None;
                let mut object = None;

                while let Some(key) = map.next_key::<String>()? {
                    match key.as_str() {
                        "embedding" => {
                            if embedding.is_some() {
                                return Err(de::Error::duplicate_field("embedding"));
                            }
                            embedding = Some(map.next_value()?);
                        }
                        "index" => {
                            if index.is_some() {
                                return Err(de::Error::duplicate_field("index"));
                            }
                            index = Some(map.next_value()?);
                        }
                        "object" => {
                            if object.is_some() {
                                return Err(de::Error::duplicate_field("object"));
                            }
                            object = Some(map.next_value()?);
                        }
                        _ => {
                            let _ = map.next_value::<serde::de::IgnoredAny>()?;
                        }
                    }
                }

                let embedding = embedding.ok_or_else(|| de::Error::missing_field("embedding"))?;
                let index = index.ok_or_else(|| de::Error::missing_field("index"))?;
                let object = object.unwrap_or_else(|| "embedding".to_string());

                Ok(Embedding {
                    embedding,
                    index,
                    object,
                })
            }
        }

        deserializer.deserialize_struct(
            "Embedding",
            &["embedding", "index", "object"],
            EmbeddingVisitor,
        )
    }
}

impl<'de> serde::Deserialize<'de> for EmbeddingData {
    fn deserialize<D>(deserializer: D) -> Result<EmbeddingData, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::{self, Visitor};
        use std::fmt;

        struct EmbeddingDataVisitor;

        impl<'de> Visitor<'de> for EmbeddingDataVisitor {
            type Value = EmbeddingData;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("a float array or a base64 string")
            }

            fn visit_seq<A>(self, mut seq: A) -> Result<EmbeddingData, A::Error>
            where
                A: serde::de::SeqAccess<'de>,
            {
                let mut vec = Vec::new();
                while let Some(value) = seq.next_element::<f32>()? {
                    vec.push(value);
                }
                Ok(EmbeddingData::Float(vec))
            }

            fn visit_str<E>(self, value: &str) -> Result<EmbeddingData, E>
            where
                E: de::Error,
            {
                // For now, we'll assume string values are base64 format
                Ok(EmbeddingData::Base64(value.to_string()))
            }
        }

        deserializer.deserialize_any(EmbeddingDataVisitor)
    }
}

impl<'a> From<&'a str> for Input {
    fn from(val: &'a str) -> Self {
        Input::Text(val.to_string())
    }
}

impl<'a, T> From<&'a [T]> for Input
where
    T: AsRef<str>,
{
    fn from(slice: &'a [T]) -> Self {
        Input::List(slice.iter().map(|s| s.as_ref().to_string()).collect())
    }
}

impl<T> From<Vec<T>> for Input
where
    T: AsRef<str>,
{
    fn from(vec: Vec<T>) -> Self {
        Input::List(vec.into_iter().map(|s| s.as_ref().to_string()).collect())
    }
}

impl<const N: usize> From<[&str; N]> for Input {
    fn from(val: [&str; N]) -> Self {
        Input::List(val.iter().map(|s| s.to_string()).collect())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use base64::Engine;
    use serde_json;

    #[test]
    fn test_into_input() {
        let _input: Input = Input::from("test");
        let _input: Input = Input::from(vec!["test"]);
        let _input: Input = Input::from(["t1", "t2"]);
        let _input: Input = Input::from(vec!["t1".to_string(), "t2".to_string()]);
    }

    #[test]
    fn test_encoding_format_serialization() {
        assert_eq!(
            serde_json::to_string(&EncodingFormat::Float).unwrap(),
            "\"float\""
        );
        assert_eq!(
            serde_json::to_string(&EncodingFormat::Base64).unwrap(),
            "\"base64\""
        );
    }

    #[test]
    fn test_embedding_data_deserialize_float() {
        let json = "[0.1, 0.2, 0.3]";
        let result: EmbeddingData = serde_json::from_str(json).unwrap();

        match result {
            EmbeddingData::Float(vec) => {
                assert_eq!(vec, vec![0.1, 0.2, 0.3]);
            }
            EmbeddingData::Base64(_) => panic!("Expected Float variant"),
        }
    }

    #[test]
    fn test_embedding_data_deserialize_base64() {
        let json = "\"SGVsbG8gV29ybGQ=\"";
        let result: EmbeddingData = serde_json::from_str(json).unwrap();

        match result {
            EmbeddingData::Base64(s) => {
                assert_eq!(s, "SGVsbG8gV29ybGQ=");
            }
            EmbeddingData::Float(_) => panic!("Expected Base64 variant"),
        }
    }

    #[test]
    fn test_embedding_deserialize() {
        let json = r#"{
            "embedding": [0.1, 0.2, 0.3],
            "index": 0,
            "object": "embedding"
        }"#;

        let result: Embedding = serde_json::from_str(json).unwrap();
        assert_eq!(result.index, 0);
        assert_eq!(result.object, "embedding");

        match result.embedding {
            EmbeddingData::Float(vec) => {
                assert_eq!(vec, vec![0.1, 0.2, 0.3]);
            }
            EmbeddingData::Base64(_) => panic!("Expected Float variant"),
        }
    }

    #[test]
    fn test_embedding_with_base64_data() {
        let json = r#"{
            "embedding": "SGVsbG8gV29ybGQ=",
            "index": 0,
            "object": "embedding"
        }"#;

        let result: Embedding = serde_json::from_str(json).unwrap();
        assert_eq!(result.index, 0);
        assert_eq!(result.object, "embedding");

        match result.embedding {
            EmbeddingData::Base64(s) => {
                assert_eq!(s, "SGVsbG8gV29ybGQ=");
            }
            EmbeddingData::Float(_) => panic!("Expected Base64 variant"),
        }
    }

    #[test]
    fn test_decode_base64_embedding() {
        // Create a simple test with some float values and encode them to base64
        let original_values = vec![1.0f32, 2.0f32, 3.0f32];
        let bytes: Vec<u8> = original_values
            .iter()
            .flat_map(|f| f.to_le_bytes())
            .collect();
        let base64_str = base64::engine::general_purpose::STANDARD.encode(&bytes);

        let decoded = decode_base64_embedding(&base64_str);
        assert!(decoded.is_some());
        let decoded_values = decoded.unwrap();
        assert_eq!(decoded_values.len(), 3);
        assert!((decoded_values[0] - 1.0).abs() < f32::EPSILON);
        assert!((decoded_values[1] - 2.0).abs() < f32::EPSILON);
        assert!((decoded_values[2] - 3.0).abs() < f32::EPSILON);
    }
}