cognis 0.2.0

LLM application framework built on cognis-core
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
//! Embeddings factory and provider registry.
//!
//! Mirrors Python `langchain.embeddings.base` — provides the `init_embeddings`
//! factory function and model string parsing for embedding providers.

use std::collections::HashMap;

use serde_json::Value;

use cognis_core::embeddings::Embeddings;
use cognis_core::error::{CognisError, Result};

/// Configuration for an embedding provider implementation.
#[derive(Debug, Clone)]
pub struct EmbeddingProviderConfig {
    /// The module/crate name for the provider.
    pub module_name: String,
    /// The class/struct name for the embeddings implementation.
    pub class_name: String,
}

impl EmbeddingProviderConfig {
    /// Create a new embedding provider configuration.
    pub fn new(module_name: impl Into<String>, class_name: impl Into<String>) -> Self {
        Self {
            module_name: module_name.into(),
            class_name: class_name.into(),
        }
    }
}

/// Resolved configuration for an embeddings model.
///
/// Returned by `init_embeddings` with all provider and model information resolved.
#[derive(Debug, Clone)]
pub struct EmbeddingConfig {
    /// The resolved provider key (e.g. "openai", "cohere").
    pub provider: String,
    /// The model name (e.g. "text-embedding-3-small").
    pub model_name: String,
    /// The provider configuration (module/class info).
    pub provider_config: EmbeddingProviderConfig,
    /// Additional keyword arguments to pass to the model constructor.
    pub kwargs: HashMap<String, Value>,
}

/// Returns the built-in embedding provider registry.
///
/// This is the Rust equivalent of Python's `_BUILTIN_EMBEDDING_PROVIDERS` dict.
pub fn builtin_embedding_providers() -> HashMap<String, EmbeddingProviderConfig> {
    let mut m = HashMap::new();
    m.insert(
        "openai".to_string(),
        EmbeddingProviderConfig::new("cognis_openai", "OpenAIEmbeddings"),
    );
    m.insert(
        "azure_openai".to_string(),
        EmbeddingProviderConfig::new("cognis_openai", "AzureOpenAIEmbeddings"),
    );
    m.insert(
        "bedrock".to_string(),
        EmbeddingProviderConfig::new("cognis_aws", "BedrockEmbeddings"),
    );
    m.insert(
        "cohere".to_string(),
        EmbeddingProviderConfig::new("cognis_cohere", "CohereEmbeddings"),
    );
    m.insert(
        "google_genai".to_string(),
        EmbeddingProviderConfig::new("cognis_google_genai", "GoogleGenerativeAIEmbeddings"),
    );
    m.insert(
        "google_vertexai".to_string(),
        EmbeddingProviderConfig::new("cognis_google_vertexai", "VertexAIEmbeddings"),
    );
    m.insert(
        "huggingface".to_string(),
        EmbeddingProviderConfig::new("cognis_huggingface", "HuggingFaceEmbeddings"),
    );
    m.insert(
        "mistralai".to_string(),
        EmbeddingProviderConfig::new("cognis_mistralai", "MistralAIEmbeddings"),
    );
    m.insert(
        "ollama".to_string(),
        EmbeddingProviderConfig::new("cognis_ollama", "OllamaEmbeddings"),
    );
    m.insert(
        "anthropic".to_string(),
        EmbeddingProviderConfig::new("cognis_anthropic", "VoyageEmbeddings"),
    );
    m.insert(
        "voyage".to_string(),
        EmbeddingProviderConfig::new("cognis_anthropic", "VoyageEmbeddings"),
    );
    m
}

/// Parse a model string in "provider:model_name" format for embeddings.
///
/// If the string contains a colon, splits into (provider, model_name).
/// Unlike chat models, embedding model names are less standardized,
/// so inference without a provider prefix is limited.
///
/// # Examples
/// ```
/// use cognis::embeddings::base::parse_model_string;
///
/// let (provider, model) = parse_model_string("openai:text-embedding-3-small").unwrap();
/// assert_eq!(provider, "openai");
/// assert_eq!(model, "text-embedding-3-small");
/// ```
pub fn parse_model_string(model: &str) -> Result<(String, String)> {
    if let Some((provider, model_name)) = model.split_once(':') {
        if provider.is_empty() {
            return Err(CognisError::Other(
                "Provider name cannot be empty in 'provider:model' format".to_string(),
            ));
        }
        if model_name.is_empty() {
            return Err(CognisError::Other(
                "Model name cannot be empty in 'provider:model' format".to_string(),
            ));
        }
        Ok((provider.to_string(), model_name.to_string()))
    } else {
        // Try to infer provider from model name
        if let Some(provider) = attempt_infer_embedding_provider(model) {
            Ok((provider, model.to_string()))
        } else {
            Err(CognisError::Other(format!(
                "Unable to infer embedding provider for model '{}'. \
                 Use 'provider:model' format (e.g., 'openai:text-embedding-3-small').",
                model
            )))
        }
    }
}

/// Attempt to infer the embedding provider from a model name.
///
/// Returns `Some(provider_key)` if a match is found, `None` otherwise.
///
/// # Known prefix mappings
/// - `text-embedding-` -> "openai"
/// - `embed-` -> "cohere"
/// - `amazon.titan-embed` -> "bedrock"
/// - `models/embedding`, `models/text-embedding` -> "google_genai"
/// - `mistral-embed` -> "mistralai"
fn attempt_infer_embedding_provider(model_name: &str) -> Option<String> {
    let lower = model_name.to_lowercase();

    // OpenAI embeddings
    if lower.starts_with("text-embedding-") {
        return Some("openai".to_string());
    }

    // Cohere embeddings
    if lower.starts_with("embed-") {
        return Some("cohere".to_string());
    }

    // AWS Bedrock embeddings
    if lower.starts_with("amazon.titan-embed") {
        return Some("bedrock".to_string());
    }

    // Google GenAI embeddings
    if lower.starts_with("models/embedding") || lower.starts_with("models/text-embedding") {
        return Some("google_genai".to_string());
    }

    // Mistral embeddings
    if lower.starts_with("mistral-embed") {
        return Some("mistralai".to_string());
    }

    // Voyage AI embeddings (Anthropic ecosystem)
    if lower.starts_with("voyage-") {
        return Some("anthropic".to_string());
    }

    None
}

/// Initialize an embeddings model by provider and model name.
///
/// Returns an `EmbeddingConfig` with all resolved provider and model information.
/// Since provider crates are not dynamically loaded in Rust, this function resolves
/// the configuration that can be used to construct the appropriate model.
///
/// # Arguments
/// - `model` — Model string, either "provider:model_name" or just "model_name" (inferred).
/// - `provider` — Optional explicit provider override (bypasses inference).
/// - `kwargs` — Optional additional keyword arguments for the model constructor.
///
/// # Errors
/// Returns an error if the provider is unknown or cannot be inferred.
pub fn init_embeddings(
    model: &str,
    provider: Option<&str>,
    kwargs: Option<HashMap<String, Value>>,
) -> Result<EmbeddingConfig> {
    let providers = builtin_embedding_providers();
    let kwargs = kwargs.unwrap_or_default();

    let (resolved_provider, model_name) = if let Some(explicit_provider) = provider {
        // Explicit provider given — use it directly
        let model_name = if let Some((_p, m)) = model.split_once(':') {
            m.to_string()
        } else {
            model.to_string()
        };
        (explicit_provider.to_string(), model_name)
    } else {
        parse_model_string(model)?
    };

    if let Some(config) = providers.get(&resolved_provider) {
        Ok(EmbeddingConfig {
            provider: resolved_provider.clone(),
            model_name,
            provider_config: config.clone(),
            kwargs,
        })
    } else {
        Err(CognisError::Other(format!(
            "Unknown embedding provider '{}'. Available providers: {:?}",
            resolved_provider,
            providers.keys().collect::<Vec<_>>()
        )))
    }
}

/// Create an embeddings provider instance by name.
///
/// Supports the following providers:
/// - `"openai"` — requires the `openai` feature
/// - `"ollama"` — requires the `ollama` feature
///
/// # Arguments
/// - `provider` — Provider name (e.g. "openai", "ollama").
/// - `kwargs` — Optional keyword arguments for the provider constructor.
///   For OpenAI: `api_key`, `model`, `dimensions`, `base_url`.
///   For Ollama: `model`, `base_url`.
///
/// # Errors
/// Returns an error if the provider is unknown or not enabled via feature flag.
pub fn create_embeddings(
    provider: &str,
    kwargs: Option<HashMap<String, Value>>,
) -> Result<Box<dyn Embeddings>> {
    let kwargs = kwargs.unwrap_or_default();

    match provider {
        #[cfg(feature = "openai")]
        "openai" => {
            let mut builder = super::openai::OpenAIEmbeddings::builder();

            if let Some(key) = kwargs.get("api_key").and_then(|v| v.as_str()) {
                builder = builder.api_key(key);
            }
            if let Some(model) = kwargs.get("model").and_then(|v| v.as_str()) {
                builder = builder.model(model);
            }
            if let Some(dims) = kwargs.get("dimensions").and_then(|v| v.as_u64()) {
                builder = builder.dimensions(dims as usize);
            }
            if let Some(url) = kwargs.get("base_url").and_then(|v| v.as_str()) {
                builder = builder.base_url(url);
            }

            Ok(Box::new(builder.build()?))
        }
        #[cfg(feature = "ollama")]
        "ollama" => {
            let mut builder = super::ollama::OllamaEmbeddings::builder();

            if let Some(model) = kwargs.get("model").and_then(|v| v.as_str()) {
                builder = builder.model(model);
            }
            if let Some(url) = kwargs.get("base_url").and_then(|v| v.as_str()) {
                builder = builder.base_url(url);
            }

            Ok(Box::new(builder.build()))
        }
        #[cfg(feature = "google")]
        "google" | "google_genai" => {
            let mut builder = super::google::GoogleEmbeddings::builder();

            if let Some(key) = kwargs.get("api_key").and_then(|v| v.as_str()) {
                builder = builder.api_key(key);
            }
            if let Some(model) = kwargs.get("model").and_then(|v| v.as_str()) {
                builder = builder.model(model);
            }
            if let Some(tt) = kwargs.get("task_type").and_then(|v| v.as_str()) {
                builder = builder.task_type(tt);
            }

            Ok(Box::new(builder.build()?))
        }
        #[cfg(feature = "anthropic")]
        "anthropic" | "voyage" => {
            let mut builder = super::anthropic::VoyageEmbeddings::builder();

            if let Some(key) = kwargs.get("api_key").and_then(|v| v.as_str()) {
                builder = builder.api_key(key);
            }
            if let Some(model) = kwargs.get("model").and_then(|v| v.as_str()) {
                builder = builder.model(model);
            }
            if let Some(it) = kwargs.get("input_type").and_then(|v| v.as_str()) {
                builder = builder.input_type(it);
            }

            Ok(Box::new(builder.build()?))
        }
        _ => Err(CognisError::Other(format!(
            "Unknown or disabled embedding provider '{}'. \
             Make sure the corresponding feature flag is enabled.",
            provider
        ))),
    }
}

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

    #[test]
    fn test_parse_model_string_with_provider() {
        let (provider, model) = parse_model_string("openai:text-embedding-3-small").unwrap();
        assert_eq!(provider, "openai");
        assert_eq!(model, "text-embedding-3-small");
    }

    #[test]
    fn test_parse_model_string_cohere() {
        let (provider, model) = parse_model_string("cohere:embed-english-v3.0").unwrap();
        assert_eq!(provider, "cohere");
        assert_eq!(model, "embed-english-v3.0");
    }

    #[test]
    fn test_parse_model_string_infer_openai() {
        let (provider, model) = parse_model_string("text-embedding-3-small").unwrap();
        assert_eq!(provider, "openai");
        assert_eq!(model, "text-embedding-3-small");
    }

    #[test]
    fn test_parse_model_string_infer_cohere() {
        let (provider, model) = parse_model_string("embed-english-v3.0").unwrap();
        assert_eq!(provider, "cohere");
        assert_eq!(model, "embed-english-v3.0");
    }

    #[test]
    fn test_parse_model_string_infer_bedrock() {
        let (provider, model) = parse_model_string("amazon.titan-embed-text-v1").unwrap();
        assert_eq!(provider, "bedrock");
        assert_eq!(model, "amazon.titan-embed-text-v1");
    }

    #[test]
    fn test_parse_model_string_infer_mistral() {
        let (provider, model) = parse_model_string("mistral-embed").unwrap();
        assert_eq!(provider, "mistralai");
        assert_eq!(model, "mistral-embed");
    }

    #[test]
    fn test_parse_model_string_infer_google() {
        let (provider, model) = parse_model_string("models/embedding-001").unwrap();
        assert_eq!(provider, "google_genai");
        assert_eq!(model, "models/embedding-001");
    }

    #[test]
    fn test_parse_model_string_unknown() {
        let result = parse_model_string("some-random-embedding");
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("Unable to infer embedding provider"));
    }

    #[test]
    fn test_parse_model_string_empty_provider() {
        let result = parse_model_string(":text-embedding-3-small");
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("Provider name cannot be empty"));
    }

    #[test]
    fn test_parse_model_string_empty_model() {
        let result = parse_model_string("openai:");
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("Model name cannot be empty"));
    }

    #[test]
    fn test_builtin_embedding_providers_contains_expected() {
        let providers = builtin_embedding_providers();
        assert!(providers.contains_key("openai"));
        assert!(providers.contains_key("azure_openai"));
        assert!(providers.contains_key("bedrock"));
        assert!(providers.contains_key("cohere"));
        assert!(providers.contains_key("google_genai"));
        assert!(providers.contains_key("google_vertexai"));
        assert!(providers.contains_key("huggingface"));
        assert!(providers.contains_key("mistralai"));
        assert!(providers.contains_key("ollama"));
        assert!(providers.contains_key("anthropic"));
        assert!(providers.contains_key("voyage"));
        assert_eq!(providers.len(), 11);
    }

    #[test]
    fn test_init_embeddings_known_provider() {
        let result = init_embeddings("openai:text-embedding-3-small", None, None);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.provider, "openai");
        assert_eq!(config.model_name, "text-embedding-3-small");
        assert_eq!(config.provider_config.module_name, "cognis_openai");
        assert_eq!(config.provider_config.class_name, "OpenAIEmbeddings");
    }

    #[test]
    fn test_init_embeddings_inferred_provider() {
        let result = init_embeddings("text-embedding-3-large", None, None);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.provider, "openai");
        assert_eq!(config.model_name, "text-embedding-3-large");
    }

    #[test]
    fn test_init_embeddings_explicit_provider() {
        let result = init_embeddings("my-custom-embedding", Some("cohere"), None);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.provider, "cohere");
        assert_eq!(config.model_name, "my-custom-embedding");
        assert_eq!(config.provider_config.class_name, "CohereEmbeddings");
    }

    #[test]
    fn test_init_embeddings_with_kwargs() {
        let mut kwargs = HashMap::new();
        kwargs.insert("dimensions".to_string(), serde_json::json!(256));
        let result = init_embeddings("openai:text-embedding-3-small", None, Some(kwargs));
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.kwargs["dimensions"], serde_json::json!(256));
    }

    #[test]
    fn test_init_embeddings_unknown_provider() {
        let result = init_embeddings("unknown_provider:some-model", None, None);
        assert!(result.is_err());
        let err = result.unwrap_err().to_string();
        assert!(err.contains("Unknown embedding provider"));
    }

    #[test]
    fn test_init_embeddings_azure_openai() {
        let result = init_embeddings("my-deployment", Some("azure_openai"), None);
        assert!(result.is_ok());
        let config = result.unwrap();
        assert_eq!(config.provider, "azure_openai");
        assert_eq!(config.provider_config.class_name, "AzureOpenAIEmbeddings");
    }

    #[test]
    fn test_embedding_provider_config_fields() {
        let config = EmbeddingProviderConfig::new("my_crate", "MyEmbeddings");
        assert_eq!(config.module_name, "my_crate");
        assert_eq!(config.class_name, "MyEmbeddings");
    }

    #[test]
    fn test_attempt_infer_embedding_provider_none() {
        assert_eq!(attempt_infer_embedding_provider("totally-unknown"), None);
    }

    #[test]
    fn test_attempt_infer_embedding_provider_case_insensitive() {
        assert_eq!(
            attempt_infer_embedding_provider("Text-Embedding-3-Small"),
            Some("openai".to_string())
        );
        assert_eq!(
            attempt_infer_embedding_provider("Embed-English-v3.0"),
            Some("cohere".to_string())
        );
    }
}