Struct ImageExtractionConfig 

pub struct ImageExtractionConfig {

    pub extract_images: bool,
    pub target_dpi: i32,
    pub max_image_dimension: i32,
    pub inject_placeholders: bool,
    pub auto_adjust_dpi: bool,
    pub min_dpi: i32,
    pub max_dpi: i32,
    pub max_images_per_page: Option<u32>,
    pub classify: bool,
    pub include_page_rasters: bool,
    pub run_ocr_on_images: bool,
    pub ocr_text_only: bool,
    pub append_ocr_text: bool,
    pub output_format: ImageOutputFormat,
    pub include_data_base64: bool,
}

Image extraction configuration.

Fields

extract_images: bool

Extract images from documents

target_dpi: i32

Target DPI for image normalization

max_image_dimension: i32

Maximum dimension for images (width or height)

inject_placeholders: bool

Whether to inject image reference placeholders into markdown output. When true (default), image references like ![Image 1](embedded:p1_i0) are appended to the markdown. Set to false to extract images as data without polluting the markdown output.

auto_adjust_dpi: bool

Automatically adjust DPI based on image content

min_dpi: i32

Minimum DPI threshold

max_dpi: i32

Maximum DPI threshold

max_images_per_page: Option<u32>

Maximum number of image objects to extract per PDF page.

Some PDFs (e.g. technical diagrams stored as thousands of raster fragments) can trigger extremely long or indefinite extraction times when every image object on a dense page is decoded individually via the PDF extractor. Setting this limit causes xberg to stop collecting individual images once the count per page reaches the cap and emit a warning instead.

None (default) means no limit — all images are extracted.

classify: bool

When true, extracted images are classified by kind and grouped into clusters where they appear to belong to one figure. Defaults to false — opt in explicitly to avoid unexpected ML overhead.

include_page_rasters: bool

When true, full-page renders produced during OCR preprocessing are captured and returned as ImageKind::PageRaster entries in ExtractedDocument.images.

PDF + OCR only. No rasters are captured for non-PDF inputs or when the document-level OCR bypass is active (whole-document backend). When OCR is enabled and this flag is set but the active backend skips per-page rendering, a ProcessingWarning is emitted in ExtractedDocument.processing_warnings.

Defaults to false. Enable when downstream consumers need page thumbnails (e.g. citation previews, visual grounding).

run_ocr_on_images: bool

Run OCR on extracted images and include the recognized text in the document content.

When true (default) and ExtractionConfig.ocr is configured, extracted images are processed with the configured OCR backend. Set to false to extract images without OCR processing, even when OCR is enabled.

ocr_text_only: bool

When true, image OCR results are rendered as plain text without the ![...](...) markdown placeholder. Only takes effect when run_ocr_on_images is also true.

append_ocr_text: bool

When true and ocr_text_only is false, append the OCR text after the image placeholder in the rendered output.

output_format: ImageOutputFormat

Target format for re-encoding extracted images.

When set to anything other than Native, each extracted image is re-encoded to the requested format before being returned. This lets callers receive uniform output without duplicating encode logic downstream.

Defaults to Native — no re-encode pass is performed and ExtractedImage.format reflects the source extractor’s output.

include_data_base64: bool

When true, populate ExtractedImage::data_base64 with a Base64-encoded copy of the raw image bytes.

Useful for JSON-only clients that cannot efficiently parse the default integer-array serialization of data. Defaults to false; enabling it doubles the in-memory image representation for the duration of the response.

Trait Implementations

impl Clone for ImageExtractionConfig

fn clone(&self) -> ImageExtractionConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageExtractionConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImageExtractionConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageExtractionConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ImageExtractionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.