siumai 0.10.3

A unified LLM interface library for Rust
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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
//! Gemini Embeddings Implementation
//!
//! This module provides the Gemini implementation of the EmbeddingCapability trait,
//! supporting task-type optimization, title context, and custom dimensions.

use async_trait::async_trait;
use serde::{Deserialize, Serialize};

use crate::error::LlmError;
use crate::traits::{EmbeddingCapability, EmbeddingExtensions, GeminiEmbeddingCapability};
use crate::types::{EmbeddingModelInfo, EmbeddingRequest, EmbeddingResponse, EmbeddingTaskType};

use super::types::GeminiConfig;

/// Gemini embedding request structure
#[derive(Debug, Clone, Serialize)]
struct GeminiEmbeddingRequest {
    /// Model name (required for batch requests)
    #[serde(skip_serializing_if = "Option::is_none")]
    model: Option<String>,
    /// Content to embed (single content object)
    content: GeminiContent,
    /// Embedding configuration
    #[serde(skip_serializing_if = "Option::is_none")]
    embedding_config: Option<GeminiEmbeddingConfig>,
}

/// Gemini embedding configuration
#[derive(Debug, Clone, Serialize)]
struct GeminiEmbeddingConfig {
    /// Task type for optimization
    #[serde(skip_serializing_if = "Option::is_none")]
    task_type: Option<String>,
    /// Title for context
    #[serde(skip_serializing_if = "Option::is_none")]
    title: Option<String>,
    /// Output dimensions
    #[serde(skip_serializing_if = "Option::is_none")]
    output_dimensionality: Option<u32>,
}

/// Gemini content structure for embeddings
#[derive(Debug, Clone, Serialize)]
struct GeminiContent {
    /// Content parts
    parts: Vec<GeminiPart>,
}

/// Gemini content part
#[derive(Debug, Clone, Serialize)]
struct GeminiPart {
    /// Text content
    text: String,
}

/// Gemini embedding response structure
#[derive(Debug, Clone, Deserialize)]
struct GeminiEmbeddingResponse {
    /// Embedding data
    embedding: GeminiEmbeddingData,
}

/// Gemini embedding data
#[derive(Debug, Clone, Deserialize)]
struct GeminiEmbeddingData {
    /// Embedding values
    values: Vec<f32>,
}

/// Gemini batch embedding request for multiple contents
#[derive(Debug, Clone, Serialize)]
struct GeminiBatchEmbeddingRequest {
    /// Multiple embedding requests
    requests: Vec<GeminiEmbeddingRequest>,
}

/// Gemini batch embedding response
#[derive(Debug, Clone, Deserialize)]
struct GeminiBatchEmbeddingResponse {
    /// List of embeddings
    embeddings: Vec<GeminiEmbeddingData>,
}

/// Gemini embeddings capability implementation.
///
/// This struct provides the Gemini-specific implementation of text embeddings
/// using the Gemini Embedding API with support for task types and context.
///
/// # Supported Models
/// - text-embedding-004 (768 dimensions)
/// - text-multilingual-embedding-002 (768 dimensions)
///
/// # API Reference
/// <https://ai.google.dev/api/embed-content>
#[derive(Debug, Clone)]
pub struct GeminiEmbeddings {
    /// Gemini configuration
    config: GeminiConfig,
    /// HTTP client
    http_client: reqwest::Client,
}

impl GeminiEmbeddings {
    /// Create a new Gemini embeddings instance
    pub fn new(config: GeminiConfig, http_client: reqwest::Client) -> Self {
        Self {
            config,
            http_client,
        }
    }

    /// Convert task type to Gemini format
    fn convert_task_type(task_type: &EmbeddingTaskType) -> String {
        match task_type {
            EmbeddingTaskType::RetrievalQuery => "RETRIEVAL_QUERY".to_string(),
            EmbeddingTaskType::RetrievalDocument => "RETRIEVAL_DOCUMENT".to_string(),
            EmbeddingTaskType::SemanticSimilarity => "SEMANTIC_SIMILARITY".to_string(),
            EmbeddingTaskType::Classification => "CLASSIFICATION".to_string(),
            EmbeddingTaskType::Clustering => "CLUSTERING".to_string(),
            EmbeddingTaskType::QuestionAnswering => "QUESTION_ANSWERING".to_string(),
            EmbeddingTaskType::FactVerification => "FACT_VERIFICATION".to_string(),
            EmbeddingTaskType::Unspecified => "TASK_TYPE_UNSPECIFIED".to_string(),
        }
    }

    /// Build the request body for Gemini API (single content)
    fn build_request(
        &self,
        text: &str,
        task_type: Option<&EmbeddingTaskType>,
        title: Option<&str>,
        output_dimensionality: Option<u32>,
    ) -> GeminiEmbeddingRequest {
        let content = GeminiContent {
            parts: vec![GeminiPart {
                text: text.to_string(),
            }],
        };

        let embedding_config =
            if task_type.is_some() || title.is_some() || output_dimensionality.is_some() {
                Some(GeminiEmbeddingConfig {
                    task_type: task_type.map(Self::convert_task_type),
                    title: title.map(|s| s.to_string()),
                    output_dimensionality,
                })
            } else {
                None
            };

        GeminiEmbeddingRequest {
            model: None, // Single requests don't need model field
            content,
            embedding_config,
        }
    }

    /// Build batch request for multiple contents
    fn build_batch_request(
        &self,
        texts: &[String],
        task_type: Option<&EmbeddingTaskType>,
        title: Option<&str>,
        output_dimensionality: Option<u32>,
    ) -> GeminiBatchEmbeddingRequest {
        let requests: Vec<GeminiEmbeddingRequest> = texts
            .iter()
            .map(|text| {
                let content = GeminiContent {
                    parts: vec![GeminiPart { text: text.clone() }],
                };

                let embedding_config =
                    if task_type.is_some() || title.is_some() || output_dimensionality.is_some() {
                        Some(GeminiEmbeddingConfig {
                            task_type: task_type.map(Self::convert_task_type),
                            title: title.map(|s| s.to_string()),
                            output_dimensionality,
                        })
                    } else {
                        None
                    };

                GeminiEmbeddingRequest {
                    model: Some(format!("models/{}", self.config.model)),
                    content,
                    embedding_config,
                }
            })
            .collect();

        GeminiBatchEmbeddingRequest { requests }
    }

    /// Make HTTP request to Gemini API for single embedding
    async fn make_request(
        &self,
        request: GeminiEmbeddingRequest,
    ) -> Result<GeminiEmbeddingResponse, LlmError> {
        let model = if !self.config.model.is_empty() {
            &self.config.model
        } else {
            "gemini-embedding-001"
        };

        let url = crate::utils::url::join_url(
            &self.config.base_url,
            &format!("models/{model}:embedContent"),
        );

        let response = self
            .http_client
            .post(&url)
            .header("Content-Type", "application/json")
            .header("x-goog-api-key", &self.config.api_key)
            .json(&request)
            .send()
            .await
            .map_err(|e| LlmError::HttpError(e.to_string()))?;

        if !response.status().is_success() {
            let status_code = response.status().as_u16();
            let error_text = response.text().await.unwrap_or_default();
            return Err(LlmError::api_error(
                status_code,
                format!("Gemini API error: {status_code} - {error_text}"),
            ));
        }

        let gemini_response: GeminiEmbeddingResponse = response
            .json()
            .await
            .map_err(|e| LlmError::ParseError(format!("Failed to parse Gemini response: {e}")))?;

        Ok(gemini_response)
    }

    /// Make batch request to Gemini API
    async fn make_batch_request(
        &self,
        request: GeminiBatchEmbeddingRequest,
    ) -> Result<GeminiBatchEmbeddingResponse, LlmError> {
        let model = if !self.config.model.is_empty() {
            &self.config.model
        } else {
            "gemini-embedding-001"
        };

        let url = crate::utils::url::join_url(
            &self.config.base_url,
            &format!("models/{model}:batchEmbedContents"),
        );

        let response = self
            .http_client
            .post(&url)
            .header("Content-Type", "application/json")
            .header("x-goog-api-key", &self.config.api_key)
            .json(&request)
            .send()
            .await
            .map_err(|e| LlmError::HttpError(e.to_string()))?;

        if !response.status().is_success() {
            let status_code = response.status().as_u16();
            let error_text = response.text().await.unwrap_or_default();
            return Err(LlmError::api_error(
                status_code,
                format!("Gemini batch API error: {status_code} - {error_text}"),
            ));
        }

        let gemini_response: GeminiBatchEmbeddingResponse = response.json().await.map_err(|e| {
            LlmError::ParseError(format!("Failed to parse Gemini batch response: {e}"))
        })?;

        Ok(gemini_response)
    }

    /// Convert Gemini response to our standard format
    fn convert_response(&self, gemini_response: GeminiEmbeddingResponse) -> EmbeddingResponse {
        let embeddings = vec![gemini_response.embedding.values];
        let model = if !self.config.model.is_empty() {
            self.config.model.clone()
        } else {
            "gemini-embedding-001".to_string()
        };

        EmbeddingResponse::new(embeddings, model)
    }

    /// Convert Gemini batch response to our standard format
    fn convert_batch_response(
        &self,
        gemini_response: GeminiBatchEmbeddingResponse,
    ) -> EmbeddingResponse {
        let embeddings: Vec<Vec<f32>> = gemini_response
            .embeddings
            .into_iter()
            .map(|embedding| embedding.values)
            .collect();

        let model = if !self.config.model.is_empty() {
            self.config.model.clone()
        } else {
            "gemini-embedding-001".to_string()
        };

        EmbeddingResponse::new(embeddings, model)
    }

    /// Get model information for Gemini embedding models
    fn get_model_info(&self, model_id: &str) -> EmbeddingModelInfo {
        match model_id {
            "gemini-embedding-001" => EmbeddingModelInfo::new(
                model_id.to_string(),
                "Gemini Embedding 001".to_string(),
                3072, // Default dimension, can be customized
                2048,
            )
            .with_task(EmbeddingTaskType::RetrievalQuery)
            .with_task(EmbeddingTaskType::RetrievalDocument)
            .with_task(EmbeddingTaskType::SemanticSimilarity)
            .with_task(EmbeddingTaskType::Classification)
            .with_task(EmbeddingTaskType::Clustering)
            .with_task(EmbeddingTaskType::QuestionAnswering)
            .with_task(EmbeddingTaskType::FactVerification),

            _ => EmbeddingModelInfo::new(model_id.to_string(), model_id.to_string(), 3072, 2048),
        }
    }
}

#[async_trait]
impl EmbeddingCapability for GeminiEmbeddings {
    async fn embed(&self, input: Vec<String>) -> Result<EmbeddingResponse, LlmError> {
        if input.is_empty() {
            return Err(LlmError::InvalidInput("Input cannot be empty".to_string()));
        }

        if input.len() == 1 {
            // Single embedding request
            let request = self.build_request(&input[0], None, None, None);
            let response = self.make_request(request).await?;
            Ok(self.convert_response(response))
        } else {
            // Batch embedding request
            let batch_request = self.build_batch_request(&input, None, None, None);
            let batch_response = self.make_batch_request(batch_request).await?;
            Ok(self.convert_batch_response(batch_response))
        }
    }

    fn embedding_dimension(&self) -> usize {
        3072 // Default dimension for Gemini embedding models (can be customized)
    }

    fn max_tokens_per_embedding(&self) -> usize {
        2048 // Gemini's current limit
    }

    fn supported_embedding_models(&self) -> Vec<String> {
        vec!["gemini-embedding-001".to_string()]
    }
}

#[async_trait]
impl EmbeddingExtensions for GeminiEmbeddings {
    async fn embed_with_config(
        &self,
        request: EmbeddingRequest,
    ) -> Result<EmbeddingResponse, LlmError> {
        if request.input.is_empty() {
            return Err(LlmError::InvalidInput("Input cannot be empty".to_string()));
        }

        // Extract Gemini-specific parameters
        let task_type = request
            .provider_params
            .get("task_type")
            .and_then(|v| v.as_str())
            .map(|s| match s {
                "RETRIEVAL_QUERY" => EmbeddingTaskType::RetrievalQuery,
                "RETRIEVAL_DOCUMENT" => EmbeddingTaskType::RetrievalDocument,
                "SEMANTIC_SIMILARITY" => EmbeddingTaskType::SemanticSimilarity,
                "CLASSIFICATION" => EmbeddingTaskType::Classification,
                "CLUSTERING" => EmbeddingTaskType::Clustering,
                "QUESTION_ANSWERING" => EmbeddingTaskType::QuestionAnswering,
                "FACT_VERIFICATION" => EmbeddingTaskType::FactVerification,
                _ => EmbeddingTaskType::Unspecified,
            });

        let title = request
            .provider_params
            .get("title")
            .and_then(|v| v.as_str());

        if request.input.len() == 1 {
            // Single embedding request
            let gemini_request = self.build_request(
                &request.input[0],
                task_type.as_ref(),
                title,
                request.dimensions,
            );

            let response = self.make_request(gemini_request).await?;
            Ok(self.convert_response(response))
        } else {
            // Batch embedding request
            let batch_request = self.build_batch_request(
                &request.input,
                task_type.as_ref(),
                title,
                request.dimensions,
            );

            let batch_response = self.make_batch_request(batch_request).await?;
            Ok(self.convert_batch_response(batch_response))
        }
    }

    async fn list_embedding_models(&self) -> Result<Vec<EmbeddingModelInfo>, LlmError> {
        let models = self.supported_embedding_models();
        let model_infos = models
            .into_iter()
            .map(|id| self.get_model_info(&id))
            .collect();
        Ok(model_infos)
    }
}

#[async_trait]
impl GeminiEmbeddingCapability for GeminiEmbeddings {
    async fn embed_with_task_type(
        &self,
        input: Vec<String>,
        task_type: EmbeddingTaskType,
    ) -> Result<EmbeddingResponse, LlmError> {
        if input.is_empty() {
            return Err(LlmError::InvalidInput("Input cannot be empty".to_string()));
        }

        if input.len() == 1 {
            let request = self.build_request(&input[0], Some(&task_type), None, None);
            let response = self.make_request(request).await?;
            Ok(self.convert_response(response))
        } else {
            let batch_request = self.build_batch_request(&input, Some(&task_type), None, None);
            let batch_response = self.make_batch_request(batch_request).await?;
            Ok(self.convert_batch_response(batch_response))
        }
    }

    async fn embed_with_title(
        &self,
        input: Vec<String>,
        title: String,
    ) -> Result<EmbeddingResponse, LlmError> {
        if input.is_empty() {
            return Err(LlmError::InvalidInput("Input cannot be empty".to_string()));
        }

        if input.len() == 1 {
            let request = self.build_request(&input[0], None, Some(&title), None);
            let response = self.make_request(request).await?;
            Ok(self.convert_response(response))
        } else {
            let batch_request = self.build_batch_request(&input, None, Some(&title), None);
            let batch_response = self.make_batch_request(batch_request).await?;
            Ok(self.convert_batch_response(batch_response))
        }
    }

    async fn embed_with_output_dimensionality(
        &self,
        input: Vec<String>,
        output_dimensionality: u32,
    ) -> Result<EmbeddingResponse, LlmError> {
        if input.is_empty() {
            return Err(LlmError::InvalidInput("Input cannot be empty".to_string()));
        }

        if input.len() == 1 {
            let request = self.build_request(&input[0], None, None, Some(output_dimensionality));
            let response = self.make_request(request).await?;
            Ok(self.convert_response(response))
        } else {
            let batch_request =
                self.build_batch_request(&input, None, None, Some(output_dimensionality));
            let batch_response = self.make_batch_request(batch_request).await?;
            Ok(self.convert_batch_response(batch_response))
        }
    }
}

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

    #[test]
    fn test_convert_task_type() {
        assert_eq!(
            GeminiEmbeddings::convert_task_type(&EmbeddingTaskType::RetrievalQuery),
            "RETRIEVAL_QUERY"
        );
        assert_eq!(
            GeminiEmbeddings::convert_task_type(&EmbeddingTaskType::SemanticSimilarity),
            "SEMANTIC_SIMILARITY"
        );
        assert_eq!(
            GeminiEmbeddings::convert_task_type(&EmbeddingTaskType::Unspecified),
            "TASK_TYPE_UNSPECIFIED"
        );
    }

    #[test]
    fn test_embedding_dimensions() {
        let config = GeminiConfig {
            api_key: "test-key".to_string(),
            base_url: "https://generativelanguage.googleapis.com/v1beta".to_string(),
            model: "gemini-embedding-001".to_string(),
            generation_config: None,
            safety_settings: None,
            timeout: Some(30),
        };
        let client = reqwest::Client::new();
        let embeddings = GeminiEmbeddings::new(config, client);

        assert_eq!(embeddings.embedding_dimension(), 3072);
        assert_eq!(embeddings.max_tokens_per_embedding(), 2048);
    }

    #[test]
    fn test_supported_models() {
        let config = GeminiConfig {
            api_key: "test-key".to_string(),
            base_url: "https://generativelanguage.googleapis.com/v1beta".to_string(),
            model: "gemini-embedding-001".to_string(),
            generation_config: None,
            safety_settings: None,
            timeout: Some(30),
        };
        let client = reqwest::Client::new();
        let embeddings = GeminiEmbeddings::new(config, client);

        let models = embeddings.supported_embedding_models();
        assert!(models.contains(&"gemini-embedding-001".to_string()));
    }

    #[test]
    fn test_model_info() {
        let config = GeminiConfig {
            api_key: "test-key".to_string(),
            base_url: "https://generativelanguage.googleapis.com/v1beta".to_string(),
            model: "gemini-embedding-001".to_string(),
            generation_config: None,
            safety_settings: None,
            timeout: Some(30),
        };
        let client = reqwest::Client::new();
        let embeddings = GeminiEmbeddings::new(config, client);

        let info = embeddings.get_model_info("gemini-embedding-001");
        assert_eq!(info.id, "gemini-embedding-001");
        assert_eq!(info.dimension, 3072);
        assert!(
            info.supported_tasks
                .contains(&EmbeddingTaskType::RetrievalQuery)
        );
    }
}