Pipeline options

Pipeline options allow to customize the execution of the models during the conversion pipeline. This includes options for the OCR engines, the table model as well as enrichment options which can be enabled with do_xyz = True.

This is an automatic generated API reference of the all the pipeline options available in Docling.

pipeline_options

Classes:

EasyOcrOptions –

Options for the EasyOCR engine.
OcrEngine –

Enum of valid OCR engines.
OcrMacOptions –

Options for the Mac OCR engine.
OcrOptions –

OCR options.
PdfBackend –

Enum of valid PDF backends.
PdfPipelineOptions –

Options for the PDF pipeline.
PipelineOptions –

Base pipeline options.
RapidOcrOptions –

Options for the RapidOCR engine.
TableFormerMode –

Modes for the TableFormer model.
TableStructureOptions –

Options for the table structure.
TesseractCliOcrOptions –

Options for the TesseractCli engine.
TesseractOcrOptions –

Options for the Tesseract engine.

EasyOcrOptions

Bases: OcrOptions

Options for the EasyOCR engine.

Attributes:

bitmap_area_threshold (float) –
download_enabled (bool) –
force_full_page_ocr (bool) –
kind (Literal['easyocr']) –
lang (List[str]) –
model_config –
model_storage_directory (Optional[str]) –
use_gpu (bool) –

bitmap_area_threshold `class-attribute` `instance-attribute`

bitmap_area_threshold: float = 0.05

download_enabled `class-attribute` `instance-attribute`

download_enabled: bool = True

force_full_page_ocr `class-attribute` `instance-attribute`

force_full_page_ocr: bool = False

kind `class-attribute` `instance-attribute`

kind: Literal['easyocr'] = 'easyocr'

lang `class-attribute` `instance-attribute`

lang: List[str] = ['fr', 'de', 'es', 'en']

model_config `class-attribute` `instance-attribute`

model_config = ConfigDict(
    extra="forbid", protected_namespaces=()
)

model_storage_directory `class-attribute` `instance-attribute`

model_storage_directory: Optional[str] = None

use_gpu `class-attribute` `instance-attribute`

use_gpu: bool = True

OcrEngine

Bases: str, Enum

Enum of valid OCR engines.

Attributes:

EASYOCR –
OCRMAC –
RAPIDOCR –
TESSERACT –
TESSERACT_CLI –

EASYOCR `class-attribute` `instance-attribute`

EASYOCR = 'easyocr'

OCRMAC `class-attribute` `instance-attribute`

OCRMAC = 'ocrmac'

RAPIDOCR `class-attribute` `instance-attribute`

RAPIDOCR = 'rapidocr'

TESSERACT `class-attribute` `instance-attribute`

TESSERACT = 'tesseract'

TESSERACT_CLI `class-attribute` `instance-attribute`

TESSERACT_CLI = 'tesseract_cli'

OcrMacOptions

Bases: OcrOptions

Options for the Mac OCR engine.

Attributes:

bitmap_area_threshold (float) –
force_full_page_ocr (bool) –
framework (str) –
kind (Literal['ocrmac']) –
lang (List[str]) –
model_config –
recognition (str) –

bitmap_area_threshold `class-attribute` `instance-attribute`

bitmap_area_threshold: float = 0.05

force_full_page_ocr `class-attribute` `instance-attribute`

force_full_page_ocr: bool = False

framework `class-attribute` `instance-attribute`

framework: str = 'vision'

kind `class-attribute` `instance-attribute`

kind: Literal['ocrmac'] = 'ocrmac'

lang `class-attribute` `instance-attribute`

lang: List[str] = ['fr-FR', 'de-DE', 'es-ES', 'en-US']

model_config `class-attribute` `instance-attribute`

model_config = ConfigDict(extra='forbid')

recognition `class-attribute` `instance-attribute`

recognition: str = 'accurate'

OcrOptions

Bases: BaseModel

OCR options.

Attributes:

bitmap_area_threshold (float) –
force_full_page_ocr (bool) –
kind (str) –
lang (List[str]) –

bitmap_area_threshold `class-attribute` `instance-attribute`

bitmap_area_threshold: float = 0.05

force_full_page_ocr `class-attribute` `instance-attribute`

force_full_page_ocr: bool = False

kind `instance-attribute`

kind: str

lang `instance-attribute`

lang: List[str]

PdfBackend

Bases: str, Enum

Enum of valid PDF backends.

Attributes:

DLPARSE_V1 –
DLPARSE_V2 –
PYPDFIUM2 –

DLPARSE_V1 `class-attribute` `instance-attribute`

DLPARSE_V1 = 'dlparse_v1'

DLPARSE_V2 `class-attribute` `instance-attribute`

DLPARSE_V2 = 'dlparse_v2'

PYPDFIUM2 `class-attribute` `instance-attribute`

PYPDFIUM2 = 'pypdfium2'

PdfPipelineOptions

Bases: PipelineOptions

Options for the PDF pipeline.

Attributes:

artifacts_path (Optional[Union[Path, str]]) –
create_legacy_output (bool) –
do_ocr (bool) –
do_table_structure (bool) –
document_timeout (Optional[float]) –
generate_page_images (bool) –
generate_picture_images (bool) –
generate_table_images (bool) –
images_scale (float) –
ocr_options (Union[EasyOcrOptions, TesseractCliOcrOptions, TesseractOcrOptions, OcrMacOptions, RapidOcrOptions]) –
table_structure_options (TableStructureOptions) –

artifacts_path `class-attribute` `instance-attribute`

artifacts_path: Optional[Union[Path, str]] = None

create_legacy_output `class-attribute` `instance-attribute`

create_legacy_output: bool = True

do_ocr `class-attribute` `instance-attribute`

do_ocr: bool = True

do_table_structure `class-attribute` `instance-attribute`

do_table_structure: bool = True

document_timeout `class-attribute` `instance-attribute`

document_timeout: Optional[float] = None

generate_page_images `class-attribute` `instance-attribute`

generate_page_images: bool = False

generate_picture_images `class-attribute` `instance-attribute`

generate_picture_images: bool = False

generate_table_images `class-attribute` `instance-attribute`

generate_table_images: bool = Field(
    default=False,
    deprecated="Field `generate_table_images` is deprecated. To obtain table images, set `PdfPipelineOptions.generate_page_images = True` before conversion and then use the `TableItem.get_image` function.",
)

images_scale `class-attribute` `instance-attribute`

images_scale: float = 1.0

ocr_options `class-attribute` `instance-attribute`

ocr_options: Union[
    EasyOcrOptions,
    TesseractCliOcrOptions,
    TesseractOcrOptions,
    OcrMacOptions,
    RapidOcrOptions,
] = Field(EasyOcrOptions(), discriminator="kind")

table_structure_options `class-attribute` `instance-attribute`

table_structure_options: TableStructureOptions = (
    TableStructureOptions()
)