Struct ConvertDocumentsRequestOptions

Source

pub struct ConvertDocumentsRequestOptions {Show 29 fields
    pub from_formats: Option<Vec<InputFormat>>,
    pub to_formats: Option<Vec<OutputFormat>>,
    pub image_export_mode: Option<ImageRefMode>,
    pub do_ocr: Option<bool>,
    pub force_ocr: Option<bool>,
    pub ocr_engine: Option<OcrEngine>,
    pub ocr_lang: Option<Vec<String>>,
    pub pdf_backend: Option<PdfBackend>,
    pub table_mode: Option<TableFormerMode>,
    pub table_cell_matching: Option<bool>,
    pub pipeline: Option<ProcessingPipeline>,
    pub page_range: Option<(i64, i64)>,
    pub document_timeout: Option<f64>,
    pub abort_on_error: Option<bool>,
    pub do_table_structure: Option<bool>,
    pub include_images: Option<bool>,
    pub images_scale: Option<f64>,
    pub md_page_break_placeholder: Option<String>,
    pub do_code_enrichment: Option<bool>,
    pub do_formula_enrichment: Option<bool>,
    pub do_picture_classification: Option<bool>,
    pub do_chart_extraction: Option<bool>,
    pub do_picture_description: Option<bool>,
    pub picture_description_area_threshold: Option<f64>,
    pub vlm_pipeline_model: Option<VlmModelType>,
    pub picture_description_local: Option<Value>,
    pub picture_description_api: Option<Value>,
    pub vlm_pipeline_model_local: Option<Value>,
    pub vlm_pipeline_model_api: Option<Value>,
}

Expand description

Options for document conversion. All fields are optional — the server applies sensible defaults for any omitted field.

Fields§

§from_formats: Option<Vec<InputFormat>>

Input format(s) to convert from.

§to_formats: Option<Vec<OutputFormat>>

Output format(s) to convert to. Defaults to ["md"].

§image_export_mode: Option<ImageRefMode>

Image export mode. Defaults to embedded.

§do_ocr: Option<bool>

Enable OCR processing. Defaults to true.

§force_ocr: Option<bool>

Force OCR over existing text. Defaults to false.

§ocr_engine: Option<OcrEngine>

OCR engine to use. Defaults to easyocr.

§ocr_lang: Option<Vec<String>>

Languages for the OCR engine.

§pdf_backend: Option<PdfBackend>

PDF parsing backend. Defaults to dlparse_v4.

§table_mode: Option<TableFormerMode>

Table structure extraction mode. Defaults to accurate.

§table_cell_matching: Option<bool>

Match table cell predictions back to PDF cells. Defaults to true.

§pipeline: Option<ProcessingPipeline>

Processing pipeline. Defaults to standard.

§page_range: Option<(i64, i64)>

Page range to convert [start, end]. Pages start at 1.

§document_timeout: Option<f64>

Per-document processing timeout in seconds. Defaults to 604800.

§abort_on_error: Option<bool>

Abort on error. Defaults to false.

§do_table_structure: Option<bool>

Extract table structure. Defaults to true.

§include_images: Option<bool>

Extract images from documents. Defaults to true.

§images_scale: Option<f64>

Scale factor for images. Defaults to 2.0.

§md_page_break_placeholder: Option<String>

Placeholder between pages in markdown output.

§do_code_enrichment: Option<bool>

Enable OCR code enrichment. Defaults to false.

§do_formula_enrichment: Option<bool>

Enable formula OCR (LaTeX). Defaults to false.

§do_picture_classification: Option<bool>

Enable picture classification. Defaults to false.

§do_chart_extraction: Option<bool>

Enable chart data extraction. Defaults to false.

§do_picture_description: Option<bool>

Enable picture description. Defaults to false.

§picture_description_area_threshold: Option<f64>

Minimum area percentage for picture processing. Defaults to 0.05.

§vlm_pipeline_model: Option<VlmModelType>

VLM pipeline model preset.

§picture_description_local: Option<Value>

Options for running a local VLM for picture description. Pass as a JSON object. Mutually exclusive with picture_description_api.

§picture_description_api: Option<Value>

API details for a VLM used for picture description. Pass as a JSON object. Mutually exclusive with picture_description_local.

§vlm_pipeline_model_local: Option<Value>

Options for running a local VLM for the VLM pipeline. Pass as a JSON object. Mutually exclusive with vlm_pipeline_model_api and vlm_pipeline_model.

§vlm_pipeline_model_api: Option<Value>

API details for a VLM used in the VLM pipeline. Pass as a JSON object. Mutually exclusive with vlm_pipeline_model_local and vlm_pipeline_model.