edgequake-llm 0.5.1

Multi-provider LLM abstraction library with caching, rate limiting, and cost tracking
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
//! Jina AI Embeddings provider implementation.
//!
//! This module provides integration with Jina AI's embedding API.
//!
//! # Environment Variables
//!
//! - `JINA_API_KEY`: Your Jina AI API key (required)
//!
//! # Example
//!
//! ```rust,ignore
//! use edgequake_llm::JinaProvider;
//!
//! let provider = JinaProvider::from_env()?;
//! let embeddings = provider.embed(vec!["Hello, world!".to_string()]).await?;
//! ```

use async_trait::async_trait;
use reqwest::Client;
use serde::{Deserialize, Serialize};
use tracing::debug;

use crate::error::LlmError;
use crate::traits::EmbeddingProvider;

/// Default Jina embedding model
const DEFAULT_JINA_EMBEDDING_MODEL: &str = "jina-embeddings-v3";

/// Default Jina API base URL
const DEFAULT_JINA_BASE_URL: &str = "https://api.jina.ai";

/// Jina AI Embeddings provider.
///
/// Supports Jina's embedding models including:
/// - `jina-embeddings-v4`: Multimodal multilingual (3.8B parameters)
/// - `jina-embeddings-v3`: Multilingual with task LoRA
/// - `jina-embeddings-v2-*`: Various specialized models
/// - `jina-clip-v2`: CLIP-style multimodal embeddings
#[derive(Debug, Clone)]
pub struct JinaProvider {
    client: Client,
    api_key: String,
    base_url: String,
    embedding_model: String,
    embedding_dimension: usize,
    /// Task type for embeddings (retrieval.query, retrieval.passage, etc.)
    task: Option<String>,
    /// Whether to normalize embeddings
    normalized: bool,
}

/// Builder for JinaProvider
#[derive(Debug, Clone)]
pub struct JinaProviderBuilder {
    api_key: Option<String>,
    base_url: String,
    embedding_model: String,
    embedding_dimension: usize,
    task: Option<String>,
    normalized: bool,
}

impl Default for JinaProviderBuilder {
    fn default() -> Self {
        Self {
            api_key: None,
            base_url: DEFAULT_JINA_BASE_URL.to_string(),
            embedding_model: DEFAULT_JINA_EMBEDDING_MODEL.to_string(),
            embedding_dimension: 1024, // jina-embeddings-v3 default
            task: None,
            normalized: true,
        }
    }
}

impl JinaProviderBuilder {
    /// Create a new builder with default settings
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the API key
    pub fn api_key(mut self, api_key: impl Into<String>) -> Self {
        self.api_key = Some(api_key.into());
        self
    }

    /// Set the base URL
    pub fn base_url(mut self, base_url: impl Into<String>) -> Self {
        self.base_url = base_url.into();
        self
    }

    /// Set the embedding model
    pub fn embedding_model(mut self, model: impl Into<String>) -> Self {
        self.embedding_model = model.into();
        self
    }

    /// Set the embedding dimension
    pub fn embedding_dimension(mut self, dimension: usize) -> Self {
        self.embedding_dimension = dimension;
        self
    }

    /// Set the task type for embeddings
    ///
    /// Supported tasks:
    /// - `retrieval.query`: For query embeddings in search
    /// - `retrieval.passage`: For document/passage embeddings
    /// - `separation`: For clustering/separation tasks
    /// - `classification`: For classification tasks
    /// - `text-matching`: For semantic similarity
    pub fn task(mut self, task: impl Into<String>) -> Self {
        self.task = Some(task.into());
        self
    }

    /// Set whether to normalize embeddings (L2 normalization)
    pub fn normalized(mut self, normalized: bool) -> Self {
        self.normalized = normalized;
        self
    }

    /// Build the JinaProvider
    pub fn build(self) -> Result<JinaProvider, LlmError> {
        let api_key = self
            .api_key
            .ok_or_else(|| LlmError::ConfigError("JINA_API_KEY is required".to_string()))?;

        let client = Client::builder()
            .timeout(std::time::Duration::from_secs(120))
            .build()
            .map_err(|e| LlmError::NetworkError(e.to_string()))?;

        Ok(JinaProvider {
            client,
            api_key,
            base_url: self.base_url,
            embedding_model: self.embedding_model,
            embedding_dimension: self.embedding_dimension,
            task: self.task,
            normalized: self.normalized,
        })
    }
}

impl JinaProvider {
    /// Create a new JinaProvider from environment variables.
    ///
    /// Required environment variables:
    /// - `JINA_API_KEY`: Your Jina AI API key
    ///
    /// Optional environment variables:
    /// - `JINA_BASE_URL`: Custom API base URL
    /// - `JINA_EMBEDDING_MODEL`: Model to use (default: jina-embeddings-v3)
    pub fn from_env() -> Result<Self, LlmError> {
        let api_key = std::env::var("JINA_API_KEY").map_err(|_| {
            LlmError::ConfigError("JINA_API_KEY environment variable is required".to_string())
        })?;

        let base_url =
            std::env::var("JINA_BASE_URL").unwrap_or_else(|_| DEFAULT_JINA_BASE_URL.to_string());

        let embedding_model = std::env::var("JINA_EMBEDDING_MODEL")
            .unwrap_or_else(|_| DEFAULT_JINA_EMBEDDING_MODEL.to_string());

        // Get dimension based on model
        let embedding_dimension = get_model_dimension(&embedding_model);

        JinaProviderBuilder::new()
            .api_key(api_key)
            .base_url(base_url)
            .embedding_model(embedding_model)
            .embedding_dimension(embedding_dimension)
            .build()
    }

    /// Create a new builder for JinaProvider
    pub fn builder() -> JinaProviderBuilder {
        JinaProviderBuilder::new()
    }
}

/// Get the default dimension for a Jina model
fn get_model_dimension(model: &str) -> usize {
    match model {
        "jina-embeddings-v4" => 1024,
        "jina-embeddings-v3" => 1024,
        "jina-embeddings-v2-base-en" => 768,
        "jina-embeddings-v2-small-en" => 512,
        "jina-embeddings-v2-base-de" => 768,
        "jina-embeddings-v2-base-zh" => 768,
        "jina-embeddings-v2-base-code" => 768,
        "jina-clip-v2" => 1024,
        "jina-clip-v1" => 768,
        _ => 1024, // Default
    }
}

// Request/Response structures for Jina API

#[derive(Debug, Serialize)]
struct EmbeddingRequest {
    model: String,
    input: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    task: Option<String>,
    #[serde(skip_serializing_if = "std::ops::Not::not")]
    normalized: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    dimensions: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    embedding_type: Option<String>,
}

#[allow(dead_code)]
#[derive(Debug, Deserialize)]
struct EmbeddingResponse {
    model: String,
    data: Vec<EmbeddingData>,
    usage: EmbeddingUsage,
}

#[derive(Debug, Deserialize)]
struct EmbeddingData {
    index: usize,
    embedding: Vec<f32>,
}

#[allow(dead_code)]
#[derive(Debug, Deserialize)]
struct EmbeddingUsage {
    total_tokens: u32,
    #[serde(default)]
    prompt_tokens: u32,
}

#[derive(Debug, Deserialize)]
struct JinaError {
    detail: String,
}

#[async_trait]
impl EmbeddingProvider for JinaProvider {
    fn name(&self) -> &str {
        "jina"
    }

    fn model(&self) -> &str {
        &self.embedding_model
    }

    fn dimension(&self) -> usize {
        self.embedding_dimension
    }

    fn max_tokens(&self) -> usize {
        // jina-embeddings-v3 supports 8192 tokens
        8192
    }

    async fn embed(&self, texts: &[String]) -> Result<Vec<Vec<f32>>, LlmError> {
        if texts.is_empty() {
            return Ok(vec![]);
        }

        debug!(
            "Jina embedding request: {} texts with model {}",
            texts.len(),
            self.embedding_model
        );

        let url = format!("{}/v1/embeddings", self.base_url);

        let request = EmbeddingRequest {
            model: self.embedding_model.clone(),
            input: texts.to_vec(),
            task: self.task.clone(),
            normalized: self.normalized,
            dimensions: None,
            embedding_type: Some("float".to_string()),
        };

        let response = self
            .client
            .post(&url)
            .header("Authorization", format!("Bearer {}", self.api_key))
            .header("Content-Type", "application/json")
            .json(&request)
            .send()
            .await
            .map_err(|e| LlmError::NetworkError(e.to_string()))?;

        let status = response.status();
        if !status.is_success() {
            let error_text = response.text().await.unwrap_or_default();
            if let Ok(error) = serde_json::from_str::<JinaError>(&error_text) {
                return Err(LlmError::ApiError(format!(
                    "Jina API error ({}): {}",
                    status, error.detail
                )));
            }
            return Err(LlmError::ApiError(format!(
                "Jina API error ({}): {}",
                status, error_text
            )));
        }

        let response: EmbeddingResponse = response
            .json()
            .await
            .map_err(|e| LlmError::ApiError(format!("Failed to parse response: {}", e)))?;

        // Sort by index and extract embeddings
        let mut embeddings: Vec<_> = response
            .data
            .into_iter()
            .map(|d| (d.index, d.embedding))
            .collect();
        embeddings.sort_by_key(|(i, _)| *i);

        let embeddings: Vec<Vec<f32>> = embeddings.into_iter().map(|(_, e)| e).collect();

        debug!(
            "Jina embedding response: {} embeddings of dimension {}",
            embeddings.len(),
            embeddings.first().map(|e| e.len()).unwrap_or(0)
        );

        Ok(embeddings)
    }
}

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

    #[test]
    fn test_builder_creation() {
        let result = JinaProviderBuilder::new()
            .api_key("test-key")
            .embedding_model("jina-embeddings-v3")
            .embedding_dimension(1024)
            .normalized(true)
            .build();

        assert!(result.is_ok());
        let provider = result.unwrap();
        assert_eq!(EmbeddingProvider::name(&provider), "jina");
        assert_eq!(EmbeddingProvider::model(&provider), "jina-embeddings-v3");
        assert_eq!(EmbeddingProvider::dimension(&provider), 1024);
    }

    #[test]
    fn test_builder_with_task() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .task("retrieval.query")
            .build()
            .unwrap();

        assert_eq!(provider.task, Some("retrieval.query".to_string()));
    }

    #[test]
    fn test_builder_missing_api_key() {
        let result = JinaProviderBuilder::new().build();
        assert!(result.is_err());
    }

    #[test]
    fn test_model_dimensions() {
        assert_eq!(get_model_dimension("jina-embeddings-v4"), 1024);
        assert_eq!(get_model_dimension("jina-embeddings-v3"), 1024);
        assert_eq!(get_model_dimension("jina-embeddings-v2-base-en"), 768);
        assert_eq!(get_model_dimension("jina-embeddings-v2-small-en"), 512);
        assert_eq!(get_model_dimension("jina-clip-v2"), 1024);
        assert_eq!(get_model_dimension("unknown-model"), 1024);
    }

    #[tokio::test]
    async fn test_embed_empty_input() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .build()
            .unwrap();

        let result = provider.embed(&[]).await;
        assert!(result.is_ok());
        assert!(result.unwrap().is_empty());
    }

    #[test]
    fn test_builder_default_values() {
        let builder = JinaProviderBuilder::default();

        assert!(builder.api_key.is_none());
        assert_eq!(builder.base_url, "https://api.jina.ai");
        assert_eq!(builder.embedding_model, "jina-embeddings-v3");
        assert_eq!(builder.embedding_dimension, 1024);
        assert!(builder.task.is_none());
        assert!(builder.normalized);
    }

    #[test]
    fn test_builder_custom_base_url() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .base_url("https://custom.jina.ai")
            .build()
            .unwrap();

        assert_eq!(provider.base_url, "https://custom.jina.ai");
    }

    #[test]
    fn test_builder_normalized_false() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .normalized(false)
            .build()
            .unwrap();

        assert!(!provider.normalized);
    }

    #[test]
    fn test_model_dimension_v2_variants() {
        assert_eq!(get_model_dimension("jina-embeddings-v2-base-de"), 768);
        assert_eq!(get_model_dimension("jina-embeddings-v2-base-zh"), 768);
        assert_eq!(get_model_dimension("jina-embeddings-v2-base-code"), 768);
    }

    #[test]
    fn test_model_dimension_clip() {
        assert_eq!(get_model_dimension("jina-clip-v1"), 768);
        assert_eq!(get_model_dimension("jina-clip-v2"), 1024);
    }

    #[test]
    fn test_constants() {
        assert_eq!(DEFAULT_JINA_EMBEDDING_MODEL, "jina-embeddings-v3");
        assert_eq!(DEFAULT_JINA_BASE_URL, "https://api.jina.ai");
    }

    #[test]
    fn test_from_env_missing_api_key() {
        // Clear env vars to ensure clean test
        std::env::remove_var("JINA_API_KEY");
        std::env::remove_var("JINA_BASE_URL");
        std::env::remove_var("JINA_EMBEDDING_MODEL");

        let result = JinaProvider::from_env();
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("JINA_API_KEY"));
    }

    #[test]
    fn test_embedding_provider_max_tokens() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .build()
            .unwrap();

        assert_eq!(provider.max_tokens(), 8192);
    }

    #[test]
    fn test_embedding_provider_name_is_jina() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .build()
            .unwrap();

        assert_eq!(EmbeddingProvider::name(&provider), "jina");
    }

    #[test]
    fn test_builder_all_tasks() {
        let tasks = vec![
            "retrieval.query",
            "retrieval.passage",
            "separation",
            "classification",
            "text-matching",
        ];

        for task in tasks {
            let provider = JinaProviderBuilder::new()
                .api_key("test-key")
                .task(task)
                .build()
                .unwrap();
            assert_eq!(provider.task, Some(task.to_string()));
        }
    }

    #[test]
    fn test_builder_chaining() {
        let provider = JinaProviderBuilder::new()
            .api_key("test-key")
            .base_url("https://custom.api")
            .embedding_model("jina-clip-v2")
            .embedding_dimension(1024)
            .task("retrieval.query")
            .normalized(false)
            .build()
            .unwrap();

        assert_eq!(provider.base_url, "https://custom.api");
        assert_eq!(provider.embedding_model, "jina-clip-v2");
        assert_eq!(provider.embedding_dimension, 1024);
        assert_eq!(provider.task, Some("retrieval.query".to_string()));
        assert!(!provider.normalized);
    }
}