xberg 1.3.2

High-performance document intelligence library for Rust. Extract text, metadata, and structured data from PDFs, Office documents, images, and 107 formats and 371 programming languages via tree-sitter code intelligence with async/sync APIs.
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
use super::*;

#[test]
fn test_postprocessor_config_default() {
    let config = PostProcessorConfig::default();
    assert!(config.enabled);
    assert!(config.enabled_processors.is_none());
    assert!(config.disabled_processors.is_none());
}

#[test]
fn test_postprocessor_config_build_lookup_sets() {
    let mut config = PostProcessorConfig {
        enabled: true,
        enabled_processors: Some(vec!["a".to_string(), "b".to_string()]),
        disabled_processors: Some(vec!["c".to_string()]),
        enabled_set: None,
        disabled_set: None,
    };

    config.build_lookup_sets();

    assert!(config.enabled_set.is_some());
    assert!(config.disabled_set.is_some());
    assert!(config.enabled_set.unwrap().contains("a"));
    assert!(config.disabled_set.unwrap().contains("c"));
}

#[test]
fn test_chunking_config_defaults() {
    let config = ChunkingConfig::default();
    assert_eq!(config.max_characters, 1000);
    assert_eq!(config.overlap, 200);
    assert!(config.trim);
    assert_eq!(config.chunker_type, ChunkerType::Text);
    assert!(matches!(config.sizing, ChunkSizing::Characters));
}

#[test]
fn chunk_sizing_rejects_unknown_fields() {
    assert!(serde_json::from_str::<ChunkSizing>(r#"{"type":"characters","model":"ignored"}"#).is_err());
}

#[test]
fn chunking_config_serialization_omits_removed_breadcrumb_settings() {
    let config = serde_json::to_value(ChunkingConfig::default()).expect("chunking config must serialize");

    assert!(config.get("prepend_heading_context").is_none());
    assert!(config.get("breadcrumb_target").is_none());
}

#[test]
fn chunking_config_rejects_removed_breadcrumb_settings() {
    for json in [
        r#"{"prepend_heading_context":true}"#,
        r#"{"breadcrumb_target":"metadata"}"#,
    ] {
        assert!(serde_json::from_str::<ChunkingConfig>(json).is_err());
    }
}

#[test]
fn test_embedding_config_default() {
    let config = EmbeddingConfig::default();
    assert!(config.normalize);
    assert_eq!(config.batch_size, 32);
    assert!(config.cache_dir.is_none());
}

/// Tests that `EmbeddingModelType::default()` returns the "gte-modernbert-base" preset.
///
/// Language bindings that use struct-level `#[serde(default)]` resolve absent
/// `model` fields via this impl. An empty-string name caused "Unknown embedding
/// preset: " panics in `get_preset()`; the default must be a valid preset.
#[test]
fn test_embedding_model_type_default_is_gte_modernbert() {
    match EmbeddingModelType::default() {
        EmbeddingModelType::Preset { name } => {
            assert_eq!(
                name, "gte-modernbert-base",
                "Default model should be the gte-modernbert-base preset"
            );
        }
        other => panic!("Expected Preset variant, got {:?}", other),
    }
}

/// Tests that EmbeddingModelType::Preset serializes with "type" field (internally-tagged).
/// This validates the API schema matches the documented format:
/// `{"type": "preset", "name": "fast"}` NOT `{"preset": {"name": "fast"}}`
#[test]
fn test_embedding_model_type_preset_serialization() {
    let model = EmbeddingModelType::Preset {
        name: "fast".to_string(),
    };
    let json = serde_json::to_string(&model).unwrap();

    assert!(json.contains(r#""type":"preset""#), "Should contain type:preset field");
    assert!(json.contains(r#""name":"fast""#), "Should contain name:fast field");

    assert!(
        !json.contains(r#"{"preset":"#),
        "Should NOT use adjacently-tagged format"
    );
}

/// Tests that EmbeddingModelType::Preset deserializes from the documented API format.
/// API documentation shows: `{"type": "preset", "name": "fast"}`
#[test]
fn test_embedding_model_type_preset_deserialization() {
    let json = r#"{"type": "preset", "name": "fast"}"#;
    let model: EmbeddingModelType = serde_json::from_str(json).unwrap();

    match model {
        EmbeddingModelType::Preset { name } => {
            assert_eq!(name, "fast");
        }
        _ => panic!("Expected Preset variant"),
    }
}

/// Tests that the wrong format (adjacently-tagged) is rejected.
/// This ensures the API doesn't accept the old/wrong documentation format.
#[test]
fn test_embedding_model_type_rejects_wrong_format() {
    let wrong_json = r#"{"preset": {"name": "fast"}}"#;
    let result: Result<EmbeddingModelType, _> = serde_json::from_str(wrong_json);

    assert!(result.is_err(), "Should reject adjacently-tagged format");
}

#[test]
fn embedding_model_type_rejects_unknown_fields() {
    let json = r#"{"type":"preset","name":"fast","extra_name":"slow"}"#;
    assert!(serde_json::from_str::<EmbeddingModelType>(json).is_err());
}

/// Tests round-trip serialization/deserialization of EmbeddingConfig.
#[test]
fn test_embedding_config_roundtrip() {
    let config = EmbeddingConfig {
        model: EmbeddingModelType::Preset {
            name: "balanced".to_string(),
        },
        normalize: true,
        batch_size: 64,
        show_download_progress: false,
        cache_dir: None,
        acceleration: None,
        max_embed_duration_secs: Some(60),
        max_sequence_length: None,
    };

    let json = serde_json::to_string(&config).unwrap();
    let deserialized: EmbeddingConfig = serde_json::from_str(&json).unwrap();

    match deserialized.model {
        EmbeddingModelType::Preset { name } => {
            assert_eq!(name, "balanced");
        }
        _ => panic!("Expected Preset variant"),
    }
    assert!(deserialized.normalize);
    assert_eq!(deserialized.batch_size, 64);
}

/// Tests Custom model type serialization format.
#[test]
fn test_embedding_model_type_custom_serialization() {
    let model = EmbeddingModelType::Custom {
        model_id: "sentence-transformers/all-MiniLM-L6-v2".to_string(),
        dimensions: 384,
    };
    let json = serde_json::to_string(&model).unwrap();

    assert!(json.contains(r#""type":"custom""#), "Should contain type:custom field");
    assert!(json.contains(r#""model_id":"#), "Should contain model_id field");
    assert!(json.contains(r#""dimensions":384"#), "Should contain dimensions field");
}

#[test]
#[cfg(feature = "embeddings")]
fn test_resolve_preset_balanced() {
    let config = ChunkingConfig {
        preset: Some("balanced".to_string()),
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert_eq!(resolved.max_characters, 1024);
    assert_eq!(resolved.overlap, 100);
    assert!(resolved.embedding.is_none());
}

#[test]
#[cfg(feature = "embeddings")]
fn test_resolve_preset_preserves_explicit_embedding() {
    let explicit_embedding = EmbeddingConfig {
        model: EmbeddingModelType::Custom {
            model_id: "custom/model".to_string(),
            dimensions: 512,
        },
        batch_size: 64,
        ..Default::default()
    };
    let config = ChunkingConfig {
        preset: Some("fast".to_string()),
        embedding: Some(explicit_embedding),
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert_eq!(resolved.max_characters, 512);
    assert_eq!(resolved.overlap, 50);
    match &resolved.embedding.unwrap().model {
        EmbeddingModelType::Custom { model_id, .. } => assert_eq!(model_id, "custom/model"),
        _ => panic!("Expected Custom model type to be preserved"),
    }
}

#[cfg(any(feature = "embeddings", feature = "chunking"))]
#[test]
fn test_resolve_preset_no_preset_returns_unchanged() {
    let config = ChunkingConfig {
        max_characters: 500,
        overlap: 50,
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert_eq!(resolved.max_characters, 500);
    assert_eq!(resolved.overlap, 50);
    assert!(resolved.embedding.is_none());
}

#[cfg(any(feature = "embeddings", feature = "chunking"))]
#[test]
fn test_resolve_preset_unknown_name_returns_unchanged() {
    let config = ChunkingConfig {
        max_characters: 500,
        preset: Some("nonexistent".to_string()),
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert_eq!(resolved.max_characters, 500);
}

#[test]
fn test_embedding_model_type_llm_roundtrip() {
    let model_type = EmbeddingModelType::Llm {
        llm: Box::new(crate::core::config::llm::LlmConfig {
            model: "openai/text-embedding-3-small".to_string(),
            ..Default::default()
        }),
    };
    let json = serde_json::to_string(&model_type).unwrap();
    assert!(json.contains("\"type\":\"llm\""));
    assert!(json.contains("openai/text-embedding-3-small"));

    let deserialized: EmbeddingModelType = serde_json::from_str(&json).unwrap();
    match deserialized {
        EmbeddingModelType::Llm { llm } => {
            assert_eq!(llm.model, "openai/text-embedding-3-small");
        }
        _ => panic!("Expected Llm variant"),
    }
}

#[test]
#[should_panic(expected = "topic_threshold must be in [0.0, 1.0]")]
fn test_with_topic_threshold_panics_above_one() {
    ChunkingConfig::default().with_topic_threshold(1.1);
}

#[test]
#[should_panic(expected = "topic_threshold must be in [0.0, 1.0]")]
fn test_with_topic_threshold_panics_below_zero() {
    ChunkingConfig::default().with_topic_threshold(-0.1);
}

#[test]
fn test_with_topic_threshold_accepts_boundary_values() {
    let config = ChunkingConfig::default().with_topic_threshold(0.0);
    assert_eq!(config.topic_threshold, Some(0.0));

    let config = ChunkingConfig::default().with_topic_threshold(1.0);
    assert_eq!(config.topic_threshold, Some(1.0));
}

/// Tests Custom model type deserialization.
#[test]
fn test_embedding_model_type_custom_deserialization() {
    let json = r#"{"type": "custom", "model_id": "test/model", "dimensions": 512}"#;
    let model: EmbeddingModelType = serde_json::from_str(json).unwrap();

    match model {
        EmbeddingModelType::Custom { model_id, dimensions } => {
            assert_eq!(model_id, "test/model");
            assert_eq!(dimensions, 512);
        }
        _ => panic!("Expected Custom variant"),
    }
}

#[test]
fn test_embedding_model_type_plugin_roundtrip() {
    let model = EmbeddingModelType::Plugin {
        name: "lilbee-llamacpp".to_string(),
    };
    let json = serde_json::to_string(&model).unwrap();
    assert!(json.contains("\"type\":\"plugin\""));
    assert!(json.contains("lilbee-llamacpp"));

    let deserialized: EmbeddingModelType = serde_json::from_str(&json).unwrap();
    match deserialized {
        EmbeddingModelType::Plugin { name } => assert_eq!(name, "lilbee-llamacpp"),
        _ => panic!("Expected Plugin variant"),
    }
}

#[test]
fn test_embedding_model_type_plugin_deserialization() {
    let json = r#"{"type": "plugin", "name": "my-embedder"}"#;
    let model: EmbeddingModelType = serde_json::from_str(json).unwrap();
    match model {
        EmbeddingModelType::Plugin { name } => assert_eq!(name, "my-embedder"),
        _ => panic!("Expected Plugin variant"),
    }
}

/// Preset with no explicit embedding: embedding must remain None.
///
/// Before the fix, `resolve_preset()` would silently inject an
/// `EmbeddingConfig` whenever a preset was configured, causing every
/// chunk to have an unexpected `.embedding` field populated.
#[test]
#[cfg(feature = "embeddings")]
fn test_resolve_preset_does_not_inject_embedding_when_none() {
    let config = ChunkingConfig {
        preset: Some("multilingual".to_string()),
        embedding: None,
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert!(
        resolved.embedding.is_none(),
        "preset alone must not inject an EmbeddingConfig (#797)"
    );
}

/// Preset with an explicit embedding: the embedding must be preserved unchanged.
#[test]
#[cfg(feature = "embeddings")]
fn test_resolve_preset_preserves_explicit_embedding_config() {
    let explicit = EmbeddingConfig {
        model: EmbeddingModelType::Custom {
            model_id: "my-org/model".to_string(),
            dimensions: 768,
        },
        batch_size: 16,
        ..Default::default()
    };
    let config = ChunkingConfig {
        preset: Some("multilingual".to_string()),
        embedding: Some(explicit),
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    let emb = resolved
        .embedding
        .expect("explicit embedding must survive resolve_preset");
    assert_eq!(emb.batch_size, 16);
    match emb.model {
        EmbeddingModelType::Custom { model_id, dimensions } => {
            assert_eq!(model_id, "my-org/model");
            assert_eq!(dimensions, 768);
        }
        other => panic!("expected Custom model type, got {other:?}"),
    }
}

/// No preset, no embedding: embedding must stay None (regression guard).
#[cfg(any(feature = "embeddings", feature = "chunking"))]
#[test]
fn test_resolve_preset_no_preset_no_embedding_stays_none() {
    let config = ChunkingConfig {
        preset: None,
        embedding: None,
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert!(resolved.embedding.is_none(), "no-preset path must not touch embedding");
}

#[test]
fn table_chunking_mode_defaults_to_split_when_field_absent() {
    let c: ChunkingConfig = serde_json::from_str("{}").unwrap();
    assert_eq!(c.table_chunking, TableChunkingMode::Split);
}

/// Regression guard for #268: a `ChunkingConfig` JSON payload written before
/// `sparse_embedding`/`late_interaction` existed (i.e. missing both keys) must still
/// deserialize, with both fields defaulting to `None`. `ChunkingConfig` is nested inside
/// `ExtractionConfig`, which is `#[serde(deny_unknown_fields)]` — this guards the other
/// direction of that contract: old payloads must not become invalid just because the
/// schema grew new optional fields.
#[test]
fn sparse_and_late_interaction_configs_default_to_none_when_absent_from_json() {
    let c: ChunkingConfig = serde_json::from_str("{}").unwrap();
    assert!(c.sparse_embedding.is_none());
    assert!(c.late_interaction.is_none());
}

/// `ChunkingConfig::default()` must leave both new vector configs unset (#268) — no
/// behaviour change for existing callers who never opt in.
#[test]
fn chunking_config_default_has_no_sparse_or_late_interaction_config() {
    let config = ChunkingConfig::default();
    assert!(config.sparse_embedding.is_none());
    assert!(config.late_interaction.is_none());
}

/// `resolve_preset()` must carry an explicitly-set `sparse_embedding`/`late_interaction`
/// config through unchanged (#268), the same way it already preserves `embedding`.
#[cfg(any(feature = "embeddings", feature = "chunking"))]
#[test]
fn resolve_preset_preserves_explicit_sparse_and_late_interaction_configs() {
    let config = ChunkingConfig {
        preset: Some("balanced".to_string()),
        sparse_embedding: Some(crate::core::config::SparseEmbeddingConfig {
            batch_size: 4,
            ..Default::default()
        }),
        late_interaction: Some(crate::core::config::LateInteractionConfig {
            batch_size: 8,
            ..Default::default()
        }),
        ..Default::default()
    };
    let resolved = config.resolve_preset();
    assert_eq!(
        resolved
            .sparse_embedding
            .expect("sparse_embedding must survive resolve_preset")
            .batch_size,
        4
    );
    assert_eq!(
        resolved
            .late_interaction
            .expect("late_interaction must survive resolve_preset")
            .batch_size,
        8
    );
}