xberg 1.3.10

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

//! Page extraction and tracking configuration.
//!
//! Controls how pages are extracted, tracked, and represented in extraction results.
//! When `None`, page tracking is disabled.

use serde::{Deserialize, Serialize};

/// Page extraction and tracking configuration.
///
/// Controls how pages are extracted, tracked, and represented in the extraction results.
/// When `None`, page tracking is disabled.
///
/// Page range tracking in chunk metadata (first_page/last_page) is automatically enabled
/// when page boundaries are available and chunking is configured.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct PageConfig {
    /// Extract pages as separate array (ExtractedDocument.pages)
    #[serde(default)]
    pub extract_pages: bool,

    /// Insert page markers in main content string
    #[serde(default)]
    pub insert_page_markers: bool,

    /// Page marker format (use {page_num} placeholder)
    /// Default: "\n\n<!-- PAGE {page_num} -->\n\n"
    #[serde(default = "default_page_marker_format")]
    pub marker_format: String,

    /// Keep the text layer of a PDF page whose `content` OCR output replaces, for a caller that needs the exact
    /// characters of a short born-digital page. The text layer is returned in `PageContent::native_content`.
    /// Needs `extract_pages`.
    #[serde(default)]
    #[cfg_attr(feature = "alef-meta", alef(since = "1.3.8"))]
    pub keep_native_content: bool,
}

impl PageConfig {
    /// Validate the settings that depend on each other.
    ///
    /// # Errors
    ///
    /// Returns `XbergError::Validation` when `keep_native_content` is on and `extract_pages` is off.
    pub(crate) fn validate(&self) -> crate::Result<()> {
        if self.keep_native_content && !self.extract_pages {
            return Err(crate::XbergError::validation(
                "`pages.keep_native_content` needs `pages.extract_pages = true`. The kept text is returned on `pages[]`.",
            ));
        }
        Ok(())
    }
}

impl Default for PageConfig {
    fn default() -> Self {
        Self {
            extract_pages: false,
            insert_page_markers: false,
            marker_format: "\n\n<!-- PAGE {page_num} -->\n\n".to_string(),
            keep_native_content: false,
        }
    }
}

fn default_page_marker_format() -> String {
    "\n\n<!-- PAGE {page_num} -->\n\n".to_string()
}

/// Regex matching one whole line that is a rendered instance of `marker_format`
/// (every `{page_num}` placeholder replaced by digits). Used to recognize page
/// marker lines so renderers pass them through verbatim.
pub(crate) fn marker_line_regex(marker_format: &str) -> regex::Regex {
    let pattern = marker_format
        .trim()
        .split("{page_num}")
        .map(regex::escape)
        .collect::<Vec<_>>()
        .join(r"\d+");
    regex::Regex::new(&format!("^{pattern}$")).expect("escaped marker format is a valid regex")
}

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

    #[test]
    fn test_page_config_default() {
        let config = PageConfig::default();
        assert!(!config.extract_pages);
        assert!(!config.insert_page_markers);
        assert_eq!(config.marker_format, "\n\n<!-- PAGE {page_num} -->\n\n");
    }

    #[test]
    fn keep_native_content_without_extract_pages_is_rejected() {
        let rejected = PageConfig {
            keep_native_content: true,
            ..Default::default()
        };
        let error = rejected
            .validate()
            .expect_err("the kept text has no page to be returned on");
        assert!(matches!(error, crate::XbergError::Validation { .. }), "got: {error:?}");
        assert!(
            error.to_string().contains("`pages.extract_pages = true`"),
            "the error must name the setting to change; got: {error}"
        );

        let accepted = PageConfig {
            extract_pages: true,
            keep_native_content: true,
            ..Default::default()
        };
        accepted.validate().expect("both settings on is a valid config");
        PageConfig::default().validate().expect("the default config is valid");
    }

    #[test]
    fn keep_native_content_is_read_from_its_key_and_is_off_without_it() {
        let with_key: PageConfig = serde_json::from_str(r#"{"extract_pages": true, "keep_native_content": true}"#)
            .expect("a config with the key parses");
        assert!(with_key.keep_native_content);
        assert_ne!(with_key.keep_native_content, PageConfig::default().keep_native_content);

        let without_key: PageConfig =
            serde_json::from_str(r#"{"extract_pages": true}"#).expect("a config without the key parses");
        assert!(without_key.extract_pages);
        assert!(!without_key.keep_native_content);
    }
}