aipim 0.1.1

AIPIM is a Rust library designed to provide a unified interface for interacting with various AI providers. It abstracts the complexities of different AI APIs, allowing developers to easily switch between providers without changing their codebase.
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
#![allow(unused)]
use async_trait::async_trait;
use log::{debug, trace};
use reqwest::Client;
use serde::{Deserialize, Serialize};

use crate::client;

use super::AIProvider;

const MAX_TOKENS: u32 = 8192;
const BASE_URL: &str = "https://generativelanguage.googleapis.com/v1beta/";
const MODELS: &[&str] = &[
    "gemini-1.0-pro",
    "gemini-1.0-pro-latest",
    "gemini-1.0-pro-vision-latest",
    "gemini-1.5-flash",
    "gemini-1.5-flash-latest",
    "gemini-1.5-pro",
    "gemini-1.5-pro-latest",
    "gemini-pro",
    "gemini-pro-vision",
];

/// Represents a Google Gemini client for interacting with the Gemini API.
pub struct Google {
    client: Client,
    api_key: String,
    model: String,
}

impl Google {
    /// Creates a new `Google` instance.
    ///
    /// # Arguments
    ///
    /// * `api_key` - A string slice that holds the API key.
    /// * `model` - A string slice that holds the name of the model.
    ///
    pub fn new(api_key: impl Into<String>, model: impl Into<String>) -> Self {
        Self {
            client: Client::new(),
            api_key: api_key.into(),
            model: model.into(),
        }
    }

    /// Sets the model for the `Google` instance.
    ///
    /// # Arguments
    ///
    /// * `model` - A string slice that holds the name of the model.
    ///
    pub fn with_model(self, model: impl Into<String>) -> Self {
        Self {
            model: model.into(),
            ..self
        }
    }
}

impl Default for Google {
    fn default() -> Self {
        Self::new(
            std::env::var("GEMINI_API_KEY").expect("GEMINI_API_KEY is not set"),
            MODELS[0],
        )
    }
}

#[async_trait]
impl AIProvider for Google {
    /// Sends a message to the Gemini API.
    ///
    /// # Arguments
    ///
    /// * `message` - A `client::Message` instance containing the message to be sent.
    ///
    /// # Errors
    ///
    /// Returns an error if the request fails or the response contains an error.
    ///
    async fn send_message(&self, message: client::Message) -> anyhow::Result<client::Response> {
        let request = build_request(message);
        log::info!(
            "JSON Request: {}",
            serde_json::to_string_pretty(&request).unwrap()
        );

        let url = format!(
            "{}models/{}:generateContent?key={}",
            BASE_URL, self.model, self.api_key
        );
        log::info!("url: {}", url);
        let response = self.client.post(&url).json(&request).send().await?;

        let response: serde_json::Value = response.json().await?;
        log::info!(
            "JSON Response: {}",
            serde_json::to_string_pretty(&response).unwrap()
        );

        let response = serde_json::from_value::<Response>(response)?;
        debug!("Google Response: {:#?}", response);

        match response {
            Response::Success(success) => {
                let content = &success.candidates[0].content;
                let text = content.parts[0].as_text().ok_or_else(|| {
                    anyhow::anyhow!("unsupported response content type: {:?}", content)
                })?;

                Ok(client::Response::new(text.to_string()))
            }
            Response::Error { error } => Err(anyhow::anyhow!(
                "{}: {} ({})",
                error.status,
                error.message,
                error.code
            )),
        }
    }
}

fn build_request(message: client::Message) -> Request {
    let mut content = Content {
        parts: vec![Part::Text(TextPart { text: message.text })],
        role: "user".to_string(),
    };

    if let Some(images) = message.images {
        for image in images {
            content.parts.insert(
                0,
                Part::InlineData(InlineData {
                    inline_data: Blob {
                        mime_type: image.mime_type,
                        data: image.data,
                    },
                }),
            );
        }
    }

    Request {
        contents: vec![content],
        safety_settings: vec![],
        generation_config: GenerationConfig {
            temperature: 0.9,
            top_p: 1.0,
            top_k: 1,
            max_output_tokens: MAX_TOKENS,
        },
    }
}

unsafe impl Send for Google {}
unsafe impl Sync for Google {}

#[derive(Serialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents a request to the Gemini API.
struct Request {
    contents: Vec<Content>,
    safety_settings: Vec<SafetySetting>,
    generation_config: GenerationConfig,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents the content of a message.
struct Content {
    parts: Vec<Part>,
    role: String,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
/// Represents different parts of a message.
enum Part {
    Text(TextPart),
    InlineData(InlineData),
}

impl Part {
    fn as_text(&self) -> Option<&str> {
        match self {
            Part::Text(part) => Some(&part.text),
            _ => None,
        }
    }
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents text in a message.
struct TextPart {
    text: String,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents inline data (e.g., images) in a message.
struct InlineData {
    inline_data: Blob,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
struct Blob {
    mime_type: String,
    data: String,
}

#[derive(Serialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents safety settings for content generation.
struct SafetySetting {
    category: String,
    threshold: String,
}

#[derive(Serialize, Debug)]
/// Represents configuration for content generation.
#[serde(rename_all = "camelCase")]
struct GenerationConfig {
    temperature: f32,
    top_p: f32,
    top_k: u32,
    max_output_tokens: u32,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(untagged)]
/// Represents a response from the Gemini API.
enum Response {
    Success(SuccessResponse),
    Error { error: ErrorResponse },
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents a successful response from the Gemini API.
struct SuccessResponse {
    candidates: Vec<Candidate>,
    usage_metadata: Option<UsageMetadata>,
    prompt_feedback: Option<PromptFeedback>,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents a candidate response from the Gemini API.
struct Candidate {
    content: Content,
    finish_reason: String,
    index: u32,
    safety_ratings: Vec<SafetyRating>,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents usage metadata for the response.
struct UsageMetadata {
    candidates_token_count: u32,
    prompt_token_count: u32,
    total_token_count: u32,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents feedback on the prompt.
struct PromptFeedback {
    safety_ratings: Vec<SafetyRating>,
}

#[derive(Serialize, Deserialize, Debug)]
#[serde(rename_all = "camelCase")]
/// Represents a safety rating for content.
struct SafetyRating {
    category: String,
    probability: String,
}

#[derive(Serialize, Deserialize, Debug)]
/// Represents an error response from the Gemini API.
struct ErrorResponse {
    code: u32,
    message: String,
    status: String,
}

#[cfg(test)]
/// Unit tests for the Google module.
mod tests {
    use super::*;

    #[test]
    /// Tests creating a new `Google` instance.
    fn test_gemini_new() {
        let api_key = "test_api_key";
        let model = "gemini-pro";
        let gemini = Google::new(api_key, model);
        assert_eq!(gemini.api_key, api_key);
        assert_eq!(gemini.model, model);
    }

    #[test]
    /// Tests setting the model for a `Google` instance.
    fn test_gemini_with_model() {
        let api_key = "test_api_key";
        let model = "gemini-pro";
        let new_model = "gemini-pro-vision";
        let gemini = Google::new(api_key, model).with_model(new_model);
        assert_eq!(gemini.model, new_model);
    }

    #[test]
    fn test_stringify_part() {
        let part = Part::Text(TextPart {
            text: "Hello, world!".to_string(),
        });
        assert_eq!(part.as_text(), Some("Hello, world!"));
    }

    #[test]
    /// Tests parsing a successful response from the Gemini API.
    fn test_parse_success() {
        let res = r#"
        {
          "candidates": [
            {
              "content": {
                "parts": [
                  {
                    "text": "Hello! How can I assist you today?"
                  }
                ],
                "role": "model"
              },
              "finishReason": "STOP",
              "index": 0,
              "safetyRatings": [
                {
                  "category": "HARM_CATEGORY_SEXUALLY_EXPLICIT",
                  "probability": "NEGLIGIBLE"
                }
              ]
            }
          ],
          "promptFeedback": {
            "safetyRatings": [
              {
                "category": "HARM_CATEGORY_SEXUALLY_EXPLICIT",
                "probability": "NEGLIGIBLE"
              }
            ]
          }
        }
        "#;
        let response = serde_json::from_str::<Response>(res).unwrap();
        if let Response::Success(success) = response {
            assert_eq!(
                success.candidates[0].content.parts[0].as_text(),
                Some("Hello! How can I assist you today?")
            );
        } else {
            panic!("Expected successful response");
        }
    }

    #[test]
    /// Tests parsing an error response from the Gemini API.
    fn test_parse_error() {
        let error = r#"
        {
          "error": {
            "code": 400,
            "message": "Invalid argument: 'model'.",
            "status": "INVALID_ARGUMENT"
          }
        }
        "#;
        let response = serde_json::from_str::<Response>(error).unwrap();
        if let Response::Error { error } = response {
            assert_eq!(error.code, 400);
            assert_eq!(error.message, "Invalid argument: 'model'.");
            assert_eq!(error.status, "INVALID_ARGUMENT");
        } else {
            panic!("Expected error response");
        }
    }

    #[test]
    fn test_build_request() {
        let message = client::Message {
            text: "Hello, world!".to_string(),
            images: None,
            model: None,
        };
        let request = build_request(message);
        assert_eq!(request.contents.len(), 1);
        assert_eq!(request.contents[0].parts.len(), 1);
        assert_eq!(
            request.contents[0].parts[0].as_text(),
            Some("Hello, world!")
        );
    }

    #[test]
    fn test_build_request_with_images() {
        let message = client::Message {
            text: "Hello, world!".to_string(),
            images: Some(vec![client::Image {
                data: "data".to_string(),
                mime_type: "image/png".to_string(),
            }]),
            model: None,
        };
        let request = build_request(message);
        assert_eq!(request.contents.len(), 1);
        assert_eq!(request.contents[0].parts.len(), 2);
        assert_eq!(request.contents[0].parts[0].as_text(), None);
        assert_eq!(
            request.contents[0].parts[1].as_text(),
            Some("Hello, world!")
        );
    }
}