xberg 1.1.1

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

//! Mathematical formula extracted from a document.

use serde::{Deserialize, Serialize};

use super::extraction::BoundingBox;

/// A mathematical formula extracted from a document.
///
/// Three kinds of sources populate this type. Layout-guided OCR detects
/// formula regions and recognizes them; those formulas carry a `bbox` and a
/// `page`. VLM OCR recognizes formulas in transcribed text without layout, so
/// its formulas carry no geometry. Markup extraction (DOCX, PPTX, ODT, EPUB,
/// HTML, JATS, LaTeX, Markdown, and related formats) converts embedded math
/// to LaTeX, also without geometry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "api", derive(utoipa::ToSchema))]
pub struct Formula {
    /// LaTeX source of the formula, without surrounding `$$` delimiters.
    ///
    /// Markup converters and formula OCR produce real LaTeX. The native PDF
    /// layout path stores the plain text of a detected formula region, which
    /// keeps the original Unicode math characters instead of LaTeX commands.
    /// To render the formula in Markdown or other formats, wrap it in `$$..$$`.
    pub latex: String,

    /// Bounding box of the formula region on its page. `None` for markup sources.
    ///
    /// PDF OCR sources report PDF point coordinates with the origin at the
    /// bottom-left of the page, comparable to native PDF geometry. Image
    /// sources, and PDF pages whose geometry is unavailable, report pixels of
    /// the image the OCR backend saw. The C FFI reports an absent bbox as a
    /// null pointer.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub bbox: Option<BoundingBox>,

    /// 1-indexed page number the formula appears on. `None` when the source
    /// format has no page concept. The C FFI reports an absent page as `0`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub page: Option<u32>,
}