mineru 0.2.1

Rust client, CLI, and API server for OpenAI-compatible MinerU document parsing
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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
use crate::{NormalizedBbox, Rotation, SamplingParams, VlmError, VlmResult};
use bytes::Bytes;
use futures_core::Stream;
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};
use std::{
    fmt,
    path::PathBuf,
    pin::Pin,
    sync::{Arc, mpsc},
    time::Duration,
};
#[derive(Debug, Clone)]
pub struct OfficialPdfOptions {
    pub start_page: usize,
    pub end_page: Option<usize>,
    pub formula_enable: bool,
    pub table_enable: bool,
    pub image_analysis: bool,
    pub render_workers: usize,
    pub processing_window_size: usize,
    pub render_timeout: Duration,
    pub max_pdf_bytes: usize,
    pub max_pages: usize,
    pub max_page_pixels: u64,
    pub max_rendered_image_bytes: usize,
    pub max_in_flight_image_bytes: usize,
    pub max_raw_output_bytes: usize,
    pub max_layout_blocks_per_page: usize,
    pub max_semantic_requests_per_page: usize,
    pub max_requests_per_batch: usize,
    pub max_encoded_request_bytes: usize,
    pub max_encoded_batch_bytes: usize,
    pub max_encoded_document_bytes: usize,
    pub max_total_asset_bytes: usize,
    pub max_staged_text_bytes: usize,
    pub total_deadline: Duration,
}
impl Default for OfficialPdfOptions {
    fn default() -> Self {
        Self {
            start_page: 0,
            end_page: None,
            formula_enable: true,
            table_enable: true,
            image_analysis: true,
            render_workers: 3,
            processing_window_size: 64,
            render_timeout: Duration::from_secs(300),
            max_pdf_bytes: 512 * 1024 * 1024,
            max_pages: 10_000,
            max_page_pixels: 100_000_000,
            max_rendered_image_bytes: 64 * 1024 * 1024,
            max_in_flight_image_bytes: 128 * 1024 * 1024,
            max_raw_output_bytes: 128 * 1024 * 1024,
            max_layout_blocks_per_page: 256,
            max_semantic_requests_per_page: 128,
            max_requests_per_batch: 32,
            max_encoded_request_bytes: 16 * 1024 * 1024,
            max_encoded_batch_bytes: 64 * 1024 * 1024,
            max_encoded_document_bytes: 256 * 1024 * 1024,
            max_total_asset_bytes: 1024 * 1024 * 1024,
            max_staged_text_bytes: 256 * 1024 * 1024,
            total_deadline: Duration::from_secs(24 * 60 * 60),
        }
    }
}
impl OfficialPdfOptions {
    pub fn validate(&self) -> VlmResult<()> {
        if self.end_page.is_some_and(|end| {
            self.start_page > end
                || end
                    .checked_sub(self.start_page)
                    .and_then(|count| count.checked_add(1))
                    .is_none_or(|count| count > self.max_pages)
        }) || self.render_workers == 0
            || self.processing_window_size == 0
            || self.render_timeout.is_zero()
            || self.max_pdf_bytes == 0
            || self.max_pages == 0
            || self.max_page_pixels == 0
            || self.max_rendered_image_bytes == 0
            || self.max_in_flight_image_bytes == 0
            || self.max_raw_output_bytes == 0
            || self.max_layout_blocks_per_page == 0
            || self.max_semantic_requests_per_page == 0
            || self.max_requests_per_batch == 0
            || self.max_encoded_request_bytes == 0
            || self.max_encoded_batch_bytes == 0
            || self.max_encoded_document_bytes == 0
            || self.max_total_asset_bytes == 0
            || self.max_staged_text_bytes == 0
            || self.total_deadline.is_zero()
        {
            return Err(VlmError::InvalidConfig(
                "invalid official PDF options".into(),
            ));
        }
        Ok(())
    }
}
pub type VlmPriority = Option<i32>;
#[derive(Debug, Clone)]
pub enum VlmBatchPriority {
    All(VlmPriority),
    PerItem(Vec<VlmPriority>),
}
pub type VlmSemaphore = Option<Arc<tokio::sync::Semaphore>>;
#[derive(Clone, Default)]
pub(crate) struct TaskWorkLease(Option<Arc<tokio::sync::OwnedSemaphorePermit>>);
impl TaskWorkLease {
    pub(crate) fn from_permit(permit: tokio::sync::OwnedSemaphorePermit) -> Self {
        Self(Some(Arc::new(permit)))
    }

    pub(crate) fn wrap<T, F>(&self, job: F) -> impl FnOnce() -> T + Send + 'static
    where
        T: Send + 'static,
        F: FnOnce() -> T + Send + 'static,
    {
        let lease = self.clone();
        move || lease.run(job)
    }

    fn run<T>(self, job: impl FnOnce() -> T) -> T {
        let Self(permit) = self;
        let result = job();
        drop(permit);
        result
    }
}
pub type VlmBatchCompletionStream =
    Pin<Box<dyn Stream<Item = VlmResult<(usize, String)>> + Send + Unpin>>;
pub struct VlmSseStream {
    inner: mpsc::Receiver<VlmResult<String>>,
}
impl VlmSseStream {
    pub(crate) fn channel() -> (mpsc::Sender<VlmResult<String>>, Self) {
        let (sender, receiver) = mpsc::channel();
        (sender, Self { inner: receiver })
    }
}
impl Iterator for VlmSseStream {
    type Item = VlmResult<String>;
    fn next(&mut self) -> Option<Self::Item> {
        self.inner.recv().ok()
    }
}
#[derive(Clone)]
pub enum VlmImageInput {
    Path(PathBuf),
    Bytes {
        data: Bytes,
        media_type: Option<String>,
    },
    DataUrl(String),
    Base64 {
        data: String,
        media_type: Option<String>,
    },
    RemoteUrl(url::Url),
    None,
}
impl fmt::Debug for VlmImageInput {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Path(_) => f
                .debug_struct("VlmImageInput::Path")
                .field("configured", &true)
                .finish(),
            Self::Bytes { data, media_type } => f
                .debug_struct("VlmImageInput::Bytes")
                .field("byte_len", &data.len())
                .field("media_type", media_type)
                .finish(),
            Self::DataUrl(data) => f
                .debug_struct("VlmImageInput::DataUrl")
                .field("data_url_len", &data.len())
                .finish(),
            Self::Base64 { data, media_type } => f
                .debug_struct("VlmImageInput::Base64")
                .field("base64_len", &data.len())
                .field("media_type", media_type)
                .finish(),
            Self::RemoteUrl(_) => f
                .debug_struct("VlmImageInput::RemoteUrl")
                .field("configured", &true)
                .finish(),
            Self::None => f.write_str("VlmImageInput::None"),
        }
    }
}
#[derive(Debug, Clone)]
pub struct VlmEncodedImage {
    pub data: Bytes,
    pub media_type: String,
    pub width: u32,
    pub height: u32,
}
#[derive(Clone, Default)]
pub struct VlmRequest {
    pub images: Vec<VlmImageInput>,
    pub prompt: Option<String>,
    pub sampling: Option<SamplingParams>,
    pub priority: VlmPriority,
}
impl fmt::Debug for VlmRequest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("VlmRequest")
            .field("images", &self.images)
            .field("prompt_configured", &self.prompt.is_some())
            .field("prompt_len", &self.prompt.as_ref().map(String::len))
            .field("sampling", &self.sampling)
            .field("priority", &self.priority)
            .finish()
    }
}
#[derive(Clone)]
pub struct VlmCompletion {
    pub text: String,
    pub finish_reason: String,
    pub request_id: Option<String>,
}
impl fmt::Debug for VlmCompletion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("VlmCompletion")
            .field("text_len", &self.text.len())
            .field("finish_reason", &self.finish_reason)
            .field("request_id_configured", &self.request_id.is_some())
            .finish()
    }
}
#[derive(Debug, Clone)]
pub struct VlmLayoutBlock {
    pub block_type: String,
    pub bbox: NormalizedBbox,
    pub angle: Option<Rotation>,
    pub content: Option<String>,
    pub merge_prev: Option<bool>,
    pub metadata: Map<String, Value>,
}
#[derive(Debug, Clone)]
pub struct VlmExtractResult {
    pub blocks: Vec<VlmLayoutBlock>,
    pub layout_completion: Option<VlmCompletion>,
}
#[derive(Debug, Clone)]
pub struct VlmPreparedLayout {
    pub image: VlmEncodedImage,
}
#[derive(Debug, Clone)]
pub struct VlmPreparedExtraction {
    pub images: Vec<VlmEncodedImage>,
    pub prompts: Vec<String>,
    pub sampling: Vec<Option<SamplingParams>>,
    pub block_indices: Vec<usize>,
}
#[allow(dead_code)]
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ModelBlock {
    pub block_type: String,
    pub bbox: Option<NormalizedBbox>,
    pub angle: Option<Rotation>,
    pub content: Option<String>,
    pub merge_prev: Option<bool>,
    pub sub_type: Option<String>,
    pub extra: Map<String, Value>,
}
pub type ModelOutput = Vec<Vec<ModelBlock>>;

pub(crate) fn model_output_wire(output: &ModelOutput) -> VlmResult<Value> {
    let mut pages = Vec::with_capacity(output.len());
    for page in output {
        let mut blocks = Vec::with_capacity(page.len());
        for block in page {
            if block.block_type.is_empty() {
                return model_error("model block type is required");
            }
            let bbox = block
                .bbox
                .ok_or_else(|| model_protocol("model block bbox is required"))?;
            let angle = block
                .angle
                .ok_or_else(|| model_protocol("model block angle is required"))?;
            if block.extra.keys().any(|key| {
                matches!(
                    key.as_str(),
                    "type" | "bbox" | "angle" | "content" | "merge_prev" | "sub_type"
                )
            }) {
                return model_error("model block extra collides with reserved key");
            }
            let mut value = block.extra.clone();
            value.insert("type".into(), Value::String(block.block_type.clone()));
            value.insert(
                "bbox".into(),
                serde_json::json!([bbox.left, bbox.top, bbox.right, bbox.bottom]),
            );
            value.insert(
                "angle".into(),
                Value::from(match angle {
                    Rotation::Deg0 => 0,
                    Rotation::Deg90 => 90,
                    Rotation::Deg180 => 180,
                    Rotation::Deg270 => 270,
                }),
            );
            value.insert(
                "content".into(),
                block
                    .content
                    .clone()
                    .map(Value::String)
                    .unwrap_or(Value::Null),
            );
            if let Some(merge_prev) = block.merge_prev {
                value.insert("merge_prev".into(), Value::Bool(merge_prev));
            }
            if let Some(sub_type) = &block.sub_type {
                value.insert("sub_type".into(), Value::String(sub_type.clone()));
            }
            blocks.push(Value::Object(value));
        }
        pages.push(Value::Array(blocks));
    }
    Ok(Value::Array(pages))
}
fn model_error<T>(message: &str) -> VlmResult<T> {
    Err(model_protocol(message))
}
fn model_protocol(message: &str) -> VlmError {
    VlmError::Protocol {
        operation: "official model serialization",
        message: message.into(),
    }
}
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct OfficialOutputManifest {
    pub root: PathBuf,
    pub stem: String,
    pub vlm_dir: PathBuf,
}
#[allow(dead_code)]
pub fn sanitize_stem(value: &str) -> String {
    value
        .chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || c == '-' || c == '_' {
                c
            } else {
                '_'
            }
        })
        .collect()
}
#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn task_work_lease_releases_only_after_last_clone() {
        let gate = Arc::new(tokio::sync::Semaphore::new(1));
        let permit = gate.clone().acquire_owned().await.unwrap();
        let root = TaskWorkLease::from_permit(permit);
        let first = root.clone();
        let last = first.clone();

        drop(root);
        drop(first);
        assert!(gate.clone().try_acquire_owned().is_err());
        drop(last);
        assert!(gate.try_acquire_owned().is_ok());
    }

    #[test]
    fn image_request_admits_zero_or_many_inputs() {
        assert!(VlmRequest::default().images.is_empty());
        let request = VlmRequest {
            images: vec![
                VlmImageInput::None,
                VlmImageInput::Bytes {
                    data: Bytes::new(),
                    media_type: Some("image/png".into()),
                },
            ],
            ..Default::default()
        };
        assert_eq!(request.images.len(), 2);
    }

    #[test]
    fn sensitive_vlm_debug_output_is_redacted() {
        let image = VlmImageInput::Bytes {
            data: Bytes::from_static(b"image-bytes-secret-marker"),
            media_type: Some("image/png".into()),
        };
        let data_url =
            VlmImageInput::DataUrl("data:image/png;base64,data-url-secret-marker".into());
        let base64 = VlmImageInput::Base64 {
            data: "base64-secret-marker".into(),
            media_type: None,
        };
        let request = VlmRequest {
            images: vec![image, data_url, base64],
            prompt: Some("prompt-secret-marker".into()),
            ..Default::default()
        };
        let completion = VlmCompletion {
            text: "completion-secret-marker".into(),
            finish_reason: "stop".into(),
            request_id: Some("request-id".into()),
        };
        for (debug, marker) in [
            (format!("{request:?}"), "image-bytes-secret-marker"),
            (format!("{request:?}"), "data-url-secret-marker"),
            (format!("{request:?}"), "base64-secret-marker"),
            (format!("{request:?}"), "prompt-secret-marker"),
            (format!("{completion:?}"), "completion-secret-marker"),
        ] {
            assert!(!debug.contains(marker), "{debug}");
        }
    }

    #[test]
    fn output_stem_is_safe() {
        assert_eq!(sanitize_stem("a bad/pdf"), "a_bad_pdf");
    }

    #[test]
    fn model_wire_requires_geometry_and_rejects_reserved_extra() {
        let base = ModelBlock {
            block_type: "text".into(),
            bbox: Some(NormalizedBbox::new(0.0, 0.0, 1.0, 1.0).unwrap()),
            angle: Some(Rotation::Deg0),
            ..Default::default()
        };
        let mut missing_bbox = base.clone();
        missing_bbox.bbox = None;
        assert!(model_output_wire(&vec![vec![missing_bbox]]).is_err());
        let mut missing_angle = base.clone();
        missing_angle.angle = None;
        assert!(model_output_wire(&vec![vec![missing_angle]]).is_err());
        let mut collision = base;
        collision.extra.insert("type".into(), Value::Null);
        assert!(model_output_wire(&vec![vec![collision]]).is_err());
    }

    #[test]
    fn model_wire_serializes_optional_and_extra_fields() {
        let output = vec![vec![ModelBlock {
            block_type: "text".into(),
            bbox: Some(NormalizedBbox::new(0.0, 0.25, 0.75, 1.0).unwrap()),
            angle: Some(Rotation::Deg90),
            content: Some("continued".into()),
            merge_prev: Some(true),
            sub_type: Some("paragraph".into()),
            extra: Map::from_iter([
                ("confidence".into(), serde_json::json!(0.75)),
                ("source".into(), serde_json::json!({"page": 3})),
            ]),
        }]];

        assert_eq!(
            model_output_wire(&output).unwrap(),
            serde_json::json!([[{
                "type": "text",
                "bbox": [0.0, 0.25, 0.75, 1.0],
                "angle": 90,
                "content": "continued",
                "merge_prev": true,
                "sub_type": "paragraph",
                "confidence": 0.75,
                "source": {"page": 3}
            }]])
        );
    }

    #[test]
    fn official_pdf_options_validate_table() {
        let cases = [
            (OfficialPdfOptions::default(), true),
            (
                OfficialPdfOptions {
                    start_page: 2,
                    end_page: Some(1),
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    end_page: Some(10_000),
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    render_workers: 4,
                    ..Default::default()
                },
                true,
            ),
            (
                OfficialPdfOptions {
                    render_workers: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    processing_window_size: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    render_timeout: Duration::ZERO,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_raw_output_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_requests_per_batch: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_pdf_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_pages: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_page_pixels: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_rendered_image_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_in_flight_image_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_total_asset_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_encoded_batch_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_encoded_document_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    max_staged_text_bytes: 0,
                    ..Default::default()
                },
                false,
            ),
            (
                OfficialPdfOptions {
                    total_deadline: Duration::ZERO,
                    ..Default::default()
                },
                false,
            ),
        ];
        for (options, valid) in cases {
            assert_eq!(options.validate().is_ok(), valid);
        }
    }
}