uni-xervo 0.4.0

Unified Rust runtime for local and remote embedding, reranking, and generation models
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
//! Compile-time validation of provider-specific options JSON.
//!
//! Called during [`ModelRuntimeBuilder::build`](crate::runtime::ModelRuntimeBuilder::build) and
//! [`ModelRuntime::register`](crate::runtime::ModelRuntime::register) to reject
//! unknown or malformed options before any model loading occurs.

use crate::api::ModelTask;
use crate::error::{Result, RuntimeError};
use serde_json::Value;

/// Validate provider-specific options for the given `provider_id` and `task`.
///
/// Returns `Ok(())` if the options are valid or the provider is unknown (unknown
/// providers are silently accepted to allow third-party extensions).
pub fn validate_provider_options(
    provider_id: &str,
    task: ModelTask,
    options: &Value,
) -> Result<()> {
    match provider_id {
        "remote/openai" | "remote/mistral" | "remote/voyageai" => {
            validate_with_embedding_dimensions(provider_id, task, options, &["api_key_env"])
        }
        "remote/gemini" => validate_with_embedding_dimensions(
            provider_id,
            task,
            options,
            &["api_key_env", "api_version"],
        ),
        "remote/anthropic" => {
            validate_string_keys_only(provider_id, options, &["api_key_env", "anthropic_version"])
        }
        "remote/cohere" => validate_with_embedding_dimensions(
            provider_id,
            task,
            options,
            &["api_key_env", "input_type"],
        ),
        "remote/azure-openai" => validate_azure_openai_options(provider_id, task, options),
        "remote/vertexai" => validate_vertexai_options(provider_id, task, options),
        "local/candle" | "local/fastembed" => {
            validate_string_keys_only(provider_id, options, &["cache_dir"])
        }
        "local/mistralrs" => validate_mistralrs_options(provider_id, task, options),
        _ => Ok(()),
    }
}

/// Parse `options` as a JSON object map, returning `None` for null and an
/// error for non-object types.
fn as_object<'a>(
    provider_id: &str,
    options: &'a Value,
) -> Result<Option<&'a serde_json::Map<String, Value>>> {
    match options {
        Value::Null => Ok(None),
        Value::Object(map) => Ok(Some(map)),
        _ => Err(RuntimeError::Config(format!(
            "Options for provider '{}' must be a JSON object or null",
            provider_id
        ))),
    }
}

/// Return an error if `map` contains any key not in `allowed`.
fn reject_unknown_keys(
    provider_id: &str,
    map: &serde_json::Map<String, Value>,
    allowed: &[&str],
) -> Result<()> {
    for key in map.keys() {
        if !allowed.contains(&key.as_str()) {
            return Err(RuntimeError::Config(format!(
                "Unknown option '{}' for provider '{}'",
                key, provider_id
            )));
        }
    }
    Ok(())
}

/// Require that all specified keys, if present, are strings.
fn require_string_keys(
    provider_id: &str,
    map: &serde_json::Map<String, Value>,
    keys: &[&str],
) -> Result<()> {
    for key in keys {
        if let Some(value) = map.get(*key)
            && !value.is_string()
        {
            return Err(RuntimeError::Config(format!(
                "Option '{}' for provider '{}' must be a string",
                key, provider_id
            )));
        }
    }
    Ok(())
}

/// Require that the named key, if present, is a positive (> 0) integer.
fn require_positive_u64(
    provider_id: &str,
    map: &serde_json::Map<String, Value>,
    key: &str,
) -> Result<()> {
    if let Some(value) = map.get(key) {
        let Some(v) = value.as_u64() else {
            return Err(RuntimeError::Config(format!(
                "Option '{}' for provider '{}' must be a positive integer",
                key, provider_id
            )));
        };
        if v == 0 {
            return Err(RuntimeError::Config(format!(
                "Option '{}' for provider '{}' must be greater than 0",
                key, provider_id
            )));
        }
    }
    Ok(())
}

/// Validate that the embedding_dimensions option is a positive integer and only
/// used for embed tasks.
fn require_embedding_dimensions(
    provider_id: &str,
    task: ModelTask,
    map: &serde_json::Map<String, Value>,
) -> Result<()> {
    if map.contains_key("embedding_dimensions") {
        require_positive_u64(provider_id, map, "embedding_dimensions")?;
        if task != ModelTask::Embed {
            return Err(RuntimeError::Config(
                "Option 'embedding_dimensions' is only valid for embed tasks".to_string(),
            ));
        }
    }
    Ok(())
}

/// Validate providers whose options are all optional string keys.
fn validate_string_keys_only(
    provider_id: &str,
    options: &Value,
    allowed_keys: &[&str],
) -> Result<()> {
    let Some(map) = as_object(provider_id, options)? else {
        return Ok(());
    };
    reject_unknown_keys(provider_id, map, allowed_keys)?;
    require_string_keys(provider_id, map, allowed_keys)
}

/// Validate providers that accept string keys plus an optional
/// `embedding_dimensions` integer.
fn validate_with_embedding_dimensions(
    provider_id: &str,
    task: ModelTask,
    options: &Value,
    string_keys: &[&str],
) -> Result<()> {
    let Some(map) = as_object(provider_id, options)? else {
        return Ok(());
    };
    let mut all_keys: Vec<&str> = string_keys.to_vec();
    all_keys.push("embedding_dimensions");
    reject_unknown_keys(provider_id, map, &all_keys)?;
    require_string_keys(provider_id, map, string_keys)?;
    require_embedding_dimensions(provider_id, task, map)
}

/// Validate Azure OpenAI options: string keys, `api_version`, and optional
/// `embedding_dimensions`.
fn validate_azure_openai_options(
    provider_id: &str,
    task: ModelTask,
    options: &Value,
) -> Result<()> {
    let Some(map) = as_object(provider_id, options)? else {
        return Ok(());
    };
    reject_unknown_keys(
        provider_id,
        map,
        &[
            "api_key_env",
            "resource_name",
            "api_version",
            "embedding_dimensions",
        ],
    )?;
    require_string_keys(
        provider_id,
        map,
        &["api_key_env", "resource_name", "api_version"],
    )?;
    require_embedding_dimensions(provider_id, task, map)
}

/// Validate Vertex AI-specific options: string keys plus optional
/// `embedding_dimensions`.
fn validate_vertexai_options(provider_id: &str, task: ModelTask, options: &Value) -> Result<()> {
    let Some(map) = as_object(provider_id, options)? else {
        return Ok(());
    };
    reject_unknown_keys(
        provider_id,
        map,
        &[
            "api_token_env",
            "project_id",
            "location",
            "publisher",
            "embedding_dimensions",
        ],
    )?;
    require_string_keys(
        provider_id,
        map,
        &["api_token_env", "project_id", "location", "publisher"],
    )?;
    require_embedding_dimensions(provider_id, task, map)
}

/// Validate mistral.rs-specific options: ISQ type, boolean flags, GGUF files,
/// pipeline selection, and embedding dimensions.
fn validate_mistralrs_options(provider_id: &str, task: ModelTask, options: &Value) -> Result<()> {
    let Some(map) = as_object(provider_id, options)? else {
        return Ok(());
    };

    // All known keys across all pipelines
    reject_unknown_keys(
        provider_id,
        map,
        &[
            "isq",
            "force_cpu",
            "paged_attention",
            "max_num_seqs",
            "chat_template",
            "tokenizer_json",
            "embedding_dimensions",
            "gguf_files",
            "dtype",
            "pipeline",
            "diffusion_loader_type",
            "speech_loader_type",
        ],
    )?;

    // Validate pipeline value if present
    let pipeline = if let Some(value) = map.get("pipeline") {
        let s = value.as_str().ok_or_else(|| {
            RuntimeError::Config(format!(
                "Option 'pipeline' for provider '{}' must be a string",
                provider_id
            ))
        })?;
        let valid = ["text", "vision", "diffusion", "speech"];
        if !valid.contains(&s) {
            return Err(RuntimeError::Config(format!(
                "Option 'pipeline' for provider '{}' must be one of: text, vision, diffusion, speech",
                provider_id
            )));
        }
        s
    } else {
        "text"
    };

    // Shared validation across all pipelines
    require_string_keys(provider_id, map, &["dtype"])?;

    if let Some(value) = map.get("dtype") {
        if let Some(s) = value.as_str() {
            let valid = ["auto", "f16", "bf16", "f32"];
            if !valid.contains(&s.to_lowercase().as_str()) {
                return Err(RuntimeError::Config(format!(
                    "Option 'dtype' for provider '{}' must be one of: auto, f16, bf16, f32",
                    provider_id
                )));
            }
        }
    }

    if let Some(value) = map.get("force_cpu")
        && !value.is_boolean()
    {
        return Err(RuntimeError::Config(format!(
            "Option 'force_cpu' for provider '{}' must be a boolean",
            provider_id
        )));
    }

    // Pipeline-specific validation
    match pipeline {
        "vision" => {
            if map.contains_key("gguf_files") {
                return Err(RuntimeError::Config(
                    "Option 'gguf_files' is not supported for the vision pipeline".to_string(),
                ));
            }
            if map.contains_key("embedding_dimensions") {
                return Err(RuntimeError::Config(
                    "Option 'embedding_dimensions' is not supported for the vision pipeline"
                        .to_string(),
                ));
            }
            require_string_keys(
                provider_id,
                map,
                &["isq", "chat_template", "tokenizer_json"],
            )?;
            if let Some(value) = map.get("paged_attention")
                && !value.is_boolean()
            {
                return Err(RuntimeError::Config(format!(
                    "Option 'paged_attention' for provider '{}' must be a boolean",
                    provider_id
                )));
            }
            require_positive_u64(provider_id, map, "max_num_seqs")?;
        }
        "diffusion" => {
            // Validate diffusion_loader_type
            if let Some(value) = map.get("diffusion_loader_type") {
                let s = value.as_str().ok_or_else(|| {
                    RuntimeError::Config(format!(
                        "Option 'diffusion_loader_type' for provider '{}' must be a string",
                        provider_id
                    ))
                })?;
                let valid = ["flux", "flux_offloaded"];
                if !valid.contains(&s) {
                    return Err(RuntimeError::Config(format!(
                        "Option 'diffusion_loader_type' for provider '{}' must be one of: flux, flux_offloaded",
                        provider_id
                    )));
                }
            }
            // Reject options not relevant to diffusion
            for key in [
                "isq",
                "paged_attention",
                "max_num_seqs",
                "chat_template",
                "tokenizer_json",
                "embedding_dimensions",
                "gguf_files",
                "speech_loader_type",
            ] {
                if map.contains_key(key) {
                    return Err(RuntimeError::Config(format!(
                        "Option '{}' is not supported for the diffusion pipeline",
                        key
                    )));
                }
            }
        }
        "speech" => {
            // Validate speech_loader_type
            if let Some(value) = map.get("speech_loader_type") {
                let s = value.as_str().ok_or_else(|| {
                    RuntimeError::Config(format!(
                        "Option 'speech_loader_type' for provider '{}' must be a string",
                        provider_id
                    ))
                })?;
                let valid = ["dia"];
                if !valid.contains(&s) {
                    return Err(RuntimeError::Config(format!(
                        "Option 'speech_loader_type' for provider '{}' must be one of: dia",
                        provider_id
                    )));
                }
            }
            // Reject options not relevant to speech
            for key in [
                "isq",
                "paged_attention",
                "max_num_seqs",
                "chat_template",
                "tokenizer_json",
                "embedding_dimensions",
                "gguf_files",
                "diffusion_loader_type",
            ] {
                if map.contains_key(key) {
                    return Err(RuntimeError::Config(format!(
                        "Option '{}' is not supported for the speech pipeline",
                        key
                    )));
                }
            }
        }
        _ => {
            // text pipeline (default) — full validation
            require_string_keys(
                provider_id,
                map,
                &["isq", "chat_template", "tokenizer_json"],
            )?;

            if let Some(value) = map.get("paged_attention")
                && !value.is_boolean()
            {
                return Err(RuntimeError::Config(format!(
                    "Option 'paged_attention' for provider '{}' must be a boolean",
                    provider_id
                )));
            }

            require_positive_u64(provider_id, map, "max_num_seqs")?;
            require_embedding_dimensions(provider_id, task, map)?;

            if let Some(value) = map.get("gguf_files") {
                let Some(items) = value.as_array() else {
                    return Err(RuntimeError::Config(format!(
                        "Option 'gguf_files' for provider '{}' must be an array of strings",
                        provider_id
                    )));
                };
                if items.iter().any(|item| !item.is_string()) {
                    return Err(RuntimeError::Config(format!(
                        "Option 'gguf_files' for provider '{}' must be an array of strings",
                        provider_id
                    )));
                }
            }
        }
    }

    Ok(())
}