mirror of
https://github.com/DS4SD/docling.git
synced 2025-07-27 04:24:45 +00:00
9678 lines
286 KiB
HTML
9678 lines
286 KiB
HTML
|
||
<!doctype html>
|
||
<html lang="en" class="no-js">
|
||
<head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://docling-project.github.io/docling/reference/document_converter/">
|
||
|
||
|
||
<link rel="prev" href="../../integrations/vectara/">
|
||
|
||
|
||
<link rel="next" href="../pipeline_options/">
|
||
|
||
|
||
<link rel="icon" href="../../assets/logo.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
|
||
|
||
|
||
|
||
<title>Document Converter - Docling</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
|
||
|
||
|
||
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
||
|
||
<link rel="stylesheet" href="../../stylesheets/extra.css">
|
||
|
||
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo">
|
||
|
||
|
||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
<label class="md-overlay" for="__drawer"></label>
|
||
<div data-md-component="skip">
|
||
|
||
|
||
<a href="#document-converter" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<header class="md-header" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href="../.." title="Docling" class="md-header__button md-logo" aria-label="Docling" data-md-component="logo">
|
||
|
||
<img src="../../assets/logo.png" alt="logo">
|
||
|
||
</a>
|
||
<label class="md-header__button md-icon" for="__drawer">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||
</label>
|
||
<div class="md-header__title" data-md-component="header-title">
|
||
<div class="md-header__ellipsis">
|
||
<div class="md-header__topic">
|
||
<span class="md-ellipsis">
|
||
Docling
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
Document Converter
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<form class="md-header__option" data-md-component="palette">
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
||
</label>
|
||
|
||
|
||
</form>
|
||
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-header__button md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
</label>
|
||
<div class="md-search" data-md-component="search" role="dialog">
|
||
<label class="md-search__overlay" for="__search"></label>
|
||
<div class="md-search__inner" role="search">
|
||
<form class="md-search__form" name="search">
|
||
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||
<label class="md-search__icon md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</label>
|
||
<nav class="md-search__options" aria-label="Search">
|
||
|
||
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||
</button>
|
||
</nav>
|
||
|
||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||
|
||
</form>
|
||
<div class="md-search__output">
|
||
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||
<div class="md-search-result" data-md-component="search-result">
|
||
<div class="md-search-result__meta">
|
||
Initializing search
|
||
</div>
|
||
<ol class="md-search-result__list" role="presentation"></ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-header__source">
|
||
<a href="https://github.com/docling-project/docling" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
docling-project/docling
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
||
<div class="md-grid">
|
||
<ul class="md-tabs__list">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../.." class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Home
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../concepts/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Concepts
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../examples/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Examples
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../integrations/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Integrations
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item md-tabs__item--active">
|
||
<a href="./" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Reference
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
|
||
<main class="md-main" data-md-component="main">
|
||
<div class="md-main__inner md-grid">
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
||
<label class="md-nav__title" for="__drawer">
|
||
<a href="../.." title="Docling" class="md-nav__button md-logo" aria-label="Docling" data-md-component="logo">
|
||
|
||
<img src="../../assets/logo.png" alt="logo">
|
||
|
||
</a>
|
||
Docling
|
||
</label>
|
||
|
||
<div class="md-nav__source">
|
||
<a href="https://github.com/docling-project/docling" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
docling-project/docling
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../.." class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Home
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_1">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Home
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_2" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../installation/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Installation
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_1_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Installation
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_3" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../usage/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Usage
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_1_3" id="__nav_1_3_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_1_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Usage
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../usage/supported_formats/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Supported formats
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../usage/enrichments/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Enrichment features
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../usage/vision_models/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Vision models
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_4" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../faq/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
FAQ
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_1_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
FAQ
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../concepts/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Concepts
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Concepts
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/architecture/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Architecture
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/docling_document/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Docling Document
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/serialization/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Serialization
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/confidence_scores/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Confidence Scores
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/chunking/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Chunking
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../concepts/plugins/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Plugins
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../examples/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Examples
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Examples
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🔀 Conversion
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🔀 Conversion
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/minimal/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Simple conversion
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/custom_convert/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Custom conversion
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/batch_convert/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Batch conversion
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/run_with_formats/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Multi-format conversion
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/minimal_vlm_pipeline/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
VLM pipeline with SmolDocling
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/vlm_pipeline_api_model/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
VLM pipeline with remote model
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/compare_vlm_models/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Compare VLM models
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/minimal_asr_pipeline/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
ASR pipeline with Whisper
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/export_figures/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Figure export
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/export_tables/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Table export
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/export_multimodal/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Multimodal export
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/full_page_ocr/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Force full page OCR
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/tesseract_lang_detection/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Automatic OCR language detection with tesseract
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rapidocr_with_custom_models/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RapidOCR with custom OCR models
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/run_with_accelerator/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Accelerator options
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/translate/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Simple translation
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/backend_csv/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Conversion of CSV files
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/backend_xml_rag/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Conversion of custom XML
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
✂️ Serialization & chunking
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
✂️ Serialization & chunking
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/serialization/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Serialization
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/hybrid_chunking/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Hybrid chunking
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/advanced_chunking_and_serialization/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Advanced chunking & serialization
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🤖 RAG with AI dev frameworks
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🤖 RAG with AI dev frameworks
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_haystack/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with Haystack
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_langchain/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with LangChain
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_llamaindex/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with LlamaIndex
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/visual_grounding/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Visual grounding
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_5" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🖼️ Picture annotation
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_5">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🖼️ Picture annotation
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/pictures_description/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Annotate picture with local VLM
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/pictures_description_api/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Annotate picture with remote VLM
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
✨ Enrichment development
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_6">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
✨ Enrichment development
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/develop_picture_enrichment/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Figure enrichment
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/develop_formula_understanding/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Formula enrichment
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/enrich_doclingdocument/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Enrich DoclingDocument
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🗂️ More examples
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_3_7">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🗂️ More examples
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_milvus/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with Milvus
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_weaviate/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with Weaviate
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="https://github.com/ibm-granite-community/granite-snack-cookbook/blob/main/recipes/RAG/Granite_Docling_RAG.ipynb" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with Granite [↗]
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/rag_azuresearch/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RAG with Azure AI Search
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../examples/retrieval_qdrant/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Retrieval with Qdrant
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../integrations/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Integrations
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Integrations
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🤖 Agentic / AI dev frameworks
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🤖 Agentic / AI dev frameworks
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/bee/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Bee Agent Framework
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/crewai/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Crew AI
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/haystack/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Haystack
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/langchain/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
LangChain
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/llamaindex/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
LlamaIndex
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/txtai/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
txtai
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
⭐️ Featured
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
⭐️ Featured
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/apify/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Apify
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/data_prep_kit/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Data Prep Kit
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/instructlab/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
InstructLab
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/nvidia/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
NVIDIA
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/prodigy/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Prodigy
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/rhel_ai/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
RHEL AI
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/spacy/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
spaCy
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
🗂️ More integrations
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_4_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
🗂️ More integrations
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/cloudera/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Cloudera
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/docetl/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
DocETL
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/kotaemon/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Kotaemon
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/opencontracts/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
OpenContracts
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/openwebui/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Open WebUI
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../integrations/vectara/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Vectara
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Reference
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_5">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Reference
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" checked>
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_5_1" id="__nav_5_1_label" tabindex="">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Python API
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_1_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_5_1">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Python API
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active">
|
||
|
||
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Document Converter
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Document Converter
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> document_converter
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" document_converter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> DocumentConverter
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" DocumentConverter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.allowed_formats" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> allowed_formats
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.format_to_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> format_to_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.initialized_pipelines" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> initialized_pipelines
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.convert" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.convert_all" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert_all
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.initialize_pipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> initialize_pipeline
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ConversionResult
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ConversionResult">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.assembled" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> assembled
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.confidence" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> confidence
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.document" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> document
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.errors" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> errors
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.input" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> input
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.legacy_document" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> legacy_document
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.pages" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pages
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.status" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> status
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.timings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> timings
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ConversionStatus
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ConversionStatus">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.FAILURE" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> FAILURE
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.PARTIAL_SUCCESS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PARTIAL_SUCCESS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.PENDING" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PENDING
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.SKIPPED" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> SKIPPED
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.STARTED" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> STARTED
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.SUCCESS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> SUCCESS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> FormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" FormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> InputFormat
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" InputFormat">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.ASCIIDOC" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> ASCIIDOC
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.AUDIO" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> AUDIO
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.CSV" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> CSV
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.DOCX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> DOCX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.HTML" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> HTML
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.IMAGE" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> IMAGE
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.JSON_DOCLING" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> JSON_DOCLING
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.MD" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> MD
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.PDF" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PDF
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.PPTX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PPTX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XLSX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XLSX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XML_JATS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XML_JATS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XML_USPTO" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XML_USPTO
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> PdfFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" PdfFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ImageFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ImageFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> StandardPdfPipeline
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" StandardPdfPipeline">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.build_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> build_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.enrichment_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> enrichment_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.keep_backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.keep_images" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_images
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.reading_order_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> reading_order_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.download_models_hf" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> download_models_hf
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.execute" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> execute
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_default_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_default_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_ocr_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_ocr_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_picture_description_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_picture_description_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.initialize_page" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> initialize_page
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.is_backend_supported" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> is_backend_supported
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> WordFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" WordFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> PowerpointFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" PowerpointFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> MarkdownFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" MarkdownFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> AsciiDocFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" AsciiDocFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> HTMLFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" HTMLFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SimplePipeline
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" SimplePipeline">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.build_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> build_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.enrichment_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> enrichment_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.keep_images" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_images
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.execute" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> execute
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.get_default_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_default_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.is_backend_supported" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> is_backend_supported
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../pipeline_options/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Pipeline options
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../docling_document/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
Docling Document
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
CLI
|
||
|
||
</span>
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_5_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
CLI
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../cli/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
CLI reference
|
||
|
||
</span>
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
Table of contents
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> document_converter
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" document_converter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> DocumentConverter
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" DocumentConverter">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.allowed_formats" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> allowed_formats
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.format_to_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> format_to_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.initialized_pipelines" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> initialized_pipelines
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.convert" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.convert_all" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> convert_all
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.DocumentConverter.initialize_pipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> initialize_pipeline
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ConversionResult
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ConversionResult">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.assembled" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> assembled
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.confidence" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> confidence
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.document" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> document
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.errors" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> errors
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.input" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> input
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.legacy_document" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> legacy_document
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.pages" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pages
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.status" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> status
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionResult.timings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> timings
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ConversionStatus
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ConversionStatus">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.FAILURE" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> FAILURE
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.PARTIAL_SUCCESS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PARTIAL_SUCCESS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.PENDING" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PENDING
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.SKIPPED" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> SKIPPED
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.STARTED" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> STARTED
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ConversionStatus.SUCCESS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> SUCCESS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> FormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" FormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.FormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> InputFormat
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" InputFormat">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.ASCIIDOC" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> ASCIIDOC
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.AUDIO" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> AUDIO
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.CSV" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> CSV
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.DOCX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> DOCX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.HTML" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> HTML
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.IMAGE" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> IMAGE
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.JSON_DOCLING" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> JSON_DOCLING
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.MD" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> MD
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.PDF" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PDF
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.PPTX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> PPTX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XLSX" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XLSX
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XML_JATS" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XML_JATS
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.InputFormat.XML_USPTO" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> XML_USPTO
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> PdfFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" PdfFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PdfFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> ImageFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" ImageFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.ImageFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> StandardPdfPipeline
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" StandardPdfPipeline">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.build_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> build_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.enrichment_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> enrichment_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.keep_backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.keep_images" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_images
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.reading_order_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> reading_order_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.download_models_hf" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> download_models_hf
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.execute" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> execute
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_default_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_default_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_ocr_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_ocr_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.get_picture_description_model" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_picture_description_model
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.initialize_page" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> initialize_page
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.StandardPdfPipeline.is_backend_supported" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> is_backend_supported
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> WordFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" WordFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.WordFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> PowerpointFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" PowerpointFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.PowerpointFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> MarkdownFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" MarkdownFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.MarkdownFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> AsciiDocFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" AsciiDocFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.AsciiDocFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> HTMLFormatOption
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" HTMLFormatOption">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.backend" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> backend
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.model_config" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> model_config
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.pipeline_cls" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_cls
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.HTMLFormatOption.set_optional_field_default" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> set_optional_field_default
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> SimplePipeline
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label=" SimplePipeline">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.build_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> build_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.enrichment_pipe" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> enrichment_pipe
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.keep_images" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> keep_images
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.pipeline_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> pipeline_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.execute" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> execute
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.get_default_options" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> get_default_options
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#docling.document_converter.SimplePipeline.is_backend_supported" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code> is_backend_supported
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h1 id="document-converter">Document converter</h1>
|
||
<p>This is an automatic generated API reference of the main components of Docling.</p>
|
||
|
||
|
||
<div class="doc doc-object doc-module">
|
||
|
||
|
||
|
||
<h2 id="docling.document_converter" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">document_converter</span>
|
||
|
||
|
||
</h2>
|
||
|
||
<div class="doc doc-contents first">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Classes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" DocumentConverter (docling.document_converter.DocumentConverter)" href="#docling.document_converter.DocumentConverter">DocumentConverter</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" ConversionResult (docling.document_converter.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" ConversionStatus (docling.document_converter.ConversionStatus)" href="#docling.document_converter.ConversionStatus">ConversionStatus</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" InputFormat (docling.document_converter.InputFormat)" href="#docling.document_converter.InputFormat">InputFormat</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
<p>A document format supported by document backend parsers.</p>
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PdfFormatOption (docling.document_converter.PdfFormatOption)" href="#docling.document_converter.PdfFormatOption">PdfFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" ImageFormatOption (docling.document_converter.ImageFormatOption)" href="#docling.document_converter.ImageFormatOption">ImageFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" StandardPdfPipeline (docling.document_converter.StandardPdfPipeline)" href="#docling.document_converter.StandardPdfPipeline">StandardPdfPipeline</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" WordFormatOption (docling.document_converter.WordFormatOption)" href="#docling.document_converter.WordFormatOption">WordFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PowerpointFormatOption (docling.document_converter.PowerpointFormatOption)" href="#docling.document_converter.PowerpointFormatOption">PowerpointFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" MarkdownFormatOption (docling.document_converter.MarkdownFormatOption)" href="#docling.document_converter.MarkdownFormatOption">MarkdownFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" AsciiDocFormatOption (docling.document_converter.AsciiDocFormatOption)" href="#docling.document_converter.AsciiDocFormatOption">AsciiDocFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" HTMLFormatOption (docling.document_converter.HTMLFormatOption)" href="#docling.document_converter.HTMLFormatOption">HTMLFormatOption</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.document_converter.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
<p>SimpleModelPipeline.</p>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.DocumentConverter" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">DocumentConverter</span>
|
||
|
||
|
||
</h3>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">DocumentConverter</span><span class="p">(</span><span class="n">allowed_formats</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="typing.List">List</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" InputFormat (docling.datamodel.base_models.InputFormat)" href="#docling.document_converter.InputFormat">InputFormat</a></span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">format_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="typing.Dict">Dict</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" InputFormat (docling.datamodel.base_models.InputFormat)" href="#docling.document_converter.InputFormat">InputFormat</a></span><span class="p">,</span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" convert (docling.document_converter.DocumentConverter.convert)" href="#docling.document_converter.DocumentConverter.convert">convert</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" convert_all (docling.document_converter.DocumentConverter.convert_all)" href="#docling.document_converter.DocumentConverter.convert_all">convert_all</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" initialize_pipeline (docling.document_converter.DocumentConverter.initialize_pipeline)" href="#docling.document_converter.DocumentConverter.initialize_pipeline">initialize_pipeline</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
<p>Initialize the conversion pipeline for the selected format.</p>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" allowed_formats
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.DocumentConverter.allowed_formats)" href="#docling.document_converter.DocumentConverter.allowed_formats">allowed_formats</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" format_to_options
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.DocumentConverter.format_to_options)" href="#docling.document_converter.DocumentConverter.format_to_options">format_to_options</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" initialized_pipelines
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.DocumentConverter.initialized_pipelines)" href="#docling.document_converter.DocumentConverter.initialized_pipelines">initialized_pipelines</a></code></b>
|
||
(<code><span title="typing.Dict">Dict</span>[<span title="typing.Tuple">Tuple</span>[<span title="typing.Type">Type</span>[<span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span>], <span title="str">str</span>], <span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.allowed_formats" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">allowed_formats</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">allowed_formats</span> <span class="o">=</span> <span class="n"><span title="docling.document_converter.DocumentConverter(allowed_formats)">allowed_formats</span></span> <span class="k">if</span> <span class="n"><span title="docling.document_converter.DocumentConverter(allowed_formats)">allowed_formats</span></span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="n"><span title="list">list</span></span><span class="p">(</span><span class="n"><a class="autorefs autorefs-internal" title=" InputFormat (docling.datamodel.base_models.InputFormat)" href="#docling.document_converter.InputFormat">InputFormat</a></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.format_to_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">format_to_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">format_to_options</span> <span class="o">=</span> <span class="p">{</span><span class="n"><span title="format">format</span></span><span class="p">:</span> <span class="n"><span title="docling.document_converter._get_default_option">_get_default_option</span></span><span class="p">(</span><span class="n"><span title="docling.document_converter._get_default_option(format)">format</span></span><span class="o">=</span><span class="n"><span title="format">format</span></span><span class="p">)</span> <span class="k">if</span> <span class="p">(</span><span class="n"><span title="custom_option">custom_option</span></span> <span class="o">:=</span> <span class="n"><span title="get">get</span></span><span class="p">(</span><span class="n"><span title="format">format</span></span><span class="p">))</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">_vbFFvttc5kcyfor</span> <span class="n"><span title="format">format</span></span> <span class="ow">in</span> <span class="n"><span title="docling.document_converter.DocumentConverter(self).allowed_formats">allowed_formats</span></span><span class="p">}</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.initialized_pipelines" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">initialized_pipelines</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">initialized_pipelines</span><span class="p">:</span> <span class="n"><span title="typing.Dict">Dict</span></span><span class="p">[</span><span class="n"><span title="typing.Tuple">Tuple</span></span><span class="p">[</span><span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span></span><span class="p">],</span> <span class="n"><span title="str">str</span></span><span class="p">],</span> <span class="n"><span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.convert" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">convert</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">convert</span><span class="p">(</span><span class="n">source</span><span class="p">:</span> <span class="n"><span title="typing.Union">Union</span></span><span class="p">[</span><span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="docling.datamodel.base_models.DocumentStream">DocumentStream</span></span><span class="p">],</span> <span class="n">headers</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="typing.Dict">Dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="str">str</span></span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">raises_on_error</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">max_num_pages</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="n"><span title="sys.maxsize">maxsize</span></span><span class="p">,</span> <span class="n">max_file_size</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="n"><span title="sys.maxsize">maxsize</span></span><span class="p">,</span> <span class="n">page_range</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.settings.PageRange">PageRange</span></span> <span class="o">=</span> <span class="n"><span title="docling.datamodel.settings.DEFAULT_PAGE_RANGE">DEFAULT_PAGE_RANGE</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" ConversionResult (docling.datamodel.document.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.convert_all" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">convert_all</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">convert_all</span><span class="p">(</span><span class="n">source</span><span class="p">:</span> <span class="n"><span title="collections.abc.Iterable">Iterable</span></span><span class="p">[</span><span class="n"><span title="typing.Union">Union</span></span><span class="p">[</span><span class="n"><span title="pathlib.Path">Path</span></span><span class="p">,</span> <span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="docling.datamodel.base_models.DocumentStream">DocumentStream</span></span><span class="p">]],</span> <span class="n">headers</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="typing.Dict">Dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="str">str</span></span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">raises_on_error</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="n">max_num_pages</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="n"><span title="sys.maxsize">maxsize</span></span><span class="p">,</span> <span class="n">max_file_size</span><span class="p">:</span> <span class="n"><span title="int">int</span></span> <span class="o">=</span> <span class="n"><span title="sys.maxsize">maxsize</span></span><span class="p">,</span> <span class="n">page_range</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.settings.PageRange">PageRange</span></span> <span class="o">=</span> <span class="n"><span title="docling.datamodel.settings.DEFAULT_PAGE_RANGE">DEFAULT_PAGE_RANGE</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="collections.abc.Iterator">Iterator</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" ConversionResult (docling.datamodel.document.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></span><span class="p">]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.DocumentConverter.initialize_pipeline" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">initialize_pipeline</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">initialize_pipeline</span><span class="p">(</span><span class="nb">format</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" InputFormat (docling.datamodel.base_models.InputFormat)" href="#docling.document_converter.InputFormat">InputFormat</a></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
<p>Initialize the conversion pipeline for the selected format.</p>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.ConversionResult" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ConversionResult</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" assembled
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.assembled)" href="#docling.document_converter.ConversionResult.assembled">assembled</a></code></b>
|
||
(<code><span title="docling.datamodel.base_models.AssembledUnit">AssembledUnit</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" confidence
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.confidence)" href="#docling.document_converter.ConversionResult.confidence">confidence</a></code></b>
|
||
(<code><span title="docling.datamodel.base_models.ConfidenceReport">ConfidenceReport</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" document
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.document)" href="#docling.document_converter.ConversionResult.document">document</a></code></b>
|
||
(<code><a class="autorefs autorefs-internal" title=" DoclingDocument (docling_core.types.doc.DoclingDocument)" href="../docling_document/#docling_core.types.doc.DoclingDocument">DoclingDocument</a></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" errors
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.errors)" href="#docling.document_converter.ConversionResult.errors">errors</a></code></b>
|
||
(<code><span title="typing.List">List</span>[<span title="docling.datamodel.base_models.ErrorItem">ErrorItem</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" input
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.input)" href="#docling.document_converter.ConversionResult.input">input</a></code></b>
|
||
(<code><span title="docling.datamodel.document.InputDocument">InputDocument</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" legacy_document
|
||
|
||
|
||
|
||
property
|
||
(docling.document_converter.ConversionResult.legacy_document)" href="#docling.document_converter.ConversionResult.legacy_document">legacy_document</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pages
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.pages)" href="#docling.document_converter.ConversionResult.pages">pages</a></code></b>
|
||
(<code><span title="typing.List">List</span>[<span title="docling.datamodel.base_models.Page">Page</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" status
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.status)" href="#docling.document_converter.ConversionResult.status">status</a></code></b>
|
||
(<code><a class="autorefs autorefs-internal" title=" ConversionStatus (docling.datamodel.base_models.ConversionStatus)" href="#docling.document_converter.ConversionStatus">ConversionStatus</a></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" timings
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionResult.timings)" href="#docling.document_converter.ConversionResult.timings">timings</a></code></b>
|
||
(<code><span title="typing.Dict">Dict</span>[<span title="str">str</span>, <span title="docling.utils.profiling.ProfilingItem">ProfilingItem</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.assembled" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">assembled</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">assembled</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.base_models.AssembledUnit">AssembledUnit</span></span> <span class="o">=</span> <span class="n"><span title="docling.datamodel.base_models.AssembledUnit">AssembledUnit</span></span><span class="p">()</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.confidence" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">confidence</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">confidence</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.base_models.ConfidenceReport">ConfidenceReport</span></span> <span class="o">=</span> <span class="n"><span title="pydantic.Field">Field</span></span><span class="p">(</span><span class="n"><span title="pydantic.Field(default_factory)">default_factory</span></span><span class="o">=</span><span class="n"><span title="docling.datamodel.base_models.ConfidenceReport">ConfidenceReport</span></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.document" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">document</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">document</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" DoclingDocument (docling_core.types.doc.DoclingDocument)" href="../docling_document/#docling_core.types.doc.DoclingDocument">DoclingDocument</a></span> <span class="o">=</span> <span class="n"><span title="docling.datamodel.document._EMPTY_DOCLING_DOC">_EMPTY_DOCLING_DOC</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.errors" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">errors</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">errors</span><span class="p">:</span> <span class="n"><span title="typing.List">List</span></span><span class="p">[</span><span class="n"><span title="docling.datamodel.base_models.ErrorItem">ErrorItem</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.input" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">input</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nb">input</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.document.InputDocument">InputDocument</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.legacy_document" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">legacy_document</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">legacy_document</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.pages" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pages</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pages</span><span class="p">:</span> <span class="n"><span title="typing.List">List</span></span><span class="p">[</span><span class="n"><span title="docling.datamodel.base_models.Page">Page</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.status" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">status</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">status</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" ConversionStatus (docling.datamodel.base_models.ConversionStatus)" href="#docling.document_converter.ConversionStatus">ConversionStatus</a></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" PENDING
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.datamodel.base_models.ConversionStatus.PENDING)" href="#docling.document_converter.ConversionStatus.PENDING">PENDING</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionResult.timings" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">timings</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">timings</span><span class="p">:</span> <span class="n"><span title="typing.Dict">Dict</span></span><span class="p">[</span><span class="n"><span title="str">str</span></span><span class="p">,</span> <span class="n"><span title="docling.utils.profiling.ProfilingItem">ProfilingItem</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.ConversionStatus" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ConversionStatus</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="str">str</span></code>, <code><span title="enum.Enum">Enum</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" FAILURE
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.FAILURE)" href="#docling.document_converter.ConversionStatus.FAILURE">FAILURE</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PARTIAL_SUCCESS
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.PARTIAL_SUCCESS)" href="#docling.document_converter.ConversionStatus.PARTIAL_SUCCESS">PARTIAL_SUCCESS</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PENDING
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.PENDING)" href="#docling.document_converter.ConversionStatus.PENDING">PENDING</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" SKIPPED
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.SKIPPED)" href="#docling.document_converter.ConversionStatus.SKIPPED">SKIPPED</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" STARTED
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.STARTED)" href="#docling.document_converter.ConversionStatus.STARTED">STARTED</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" SUCCESS
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ConversionStatus.SUCCESS)" href="#docling.document_converter.ConversionStatus.SUCCESS">SUCCESS</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.FAILURE" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">FAILURE</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">FAILURE</span> <span class="o">=</span> <span class="s1">'failure'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.PARTIAL_SUCCESS" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">PARTIAL_SUCCESS</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">PARTIAL_SUCCESS</span> <span class="o">=</span> <span class="s1">'partial_success'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.PENDING" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">PENDING</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">PENDING</span> <span class="o">=</span> <span class="s1">'pending'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.SKIPPED" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">SKIPPED</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">SKIPPED</span> <span class="o">=</span> <span class="s1">'skipped'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.STARTED" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">STARTED</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">STARTED</span> <span class="o">=</span> <span class="s1">'started'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ConversionStatus.SUCCESS" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">SUCCESS</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">SUCCESS</span> <span class="o">=</span> <span class="s1">'success'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.FormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">FormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="pydantic.BaseModel">BaseModel</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.FormatOption.set_optional_field_default)" href="#docling.document_converter.FormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.FormatOption.backend)" href="#docling.document_converter.FormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.FormatOption.model_config)" href="#docling.document_converter.FormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.FormatOption.pipeline_cls)" href="#docling.document_converter.FormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.FormatOption.pipeline_options)" href="#docling.document_converter.FormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.FormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.FormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.FormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span></span><span class="p">]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.FormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.FormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.InputFormat" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">InputFormat</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="str">str</span></code>, <code><span title="enum.Enum">Enum</span></code></p>
|
||
|
||
|
||
<p>A document format supported by document backend parsers.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" ASCIIDOC
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.ASCIIDOC)" href="#docling.document_converter.InputFormat.ASCIIDOC">ASCIIDOC</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" AUDIO
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.AUDIO)" href="#docling.document_converter.InputFormat.AUDIO">AUDIO</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" CSV
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.CSV)" href="#docling.document_converter.InputFormat.CSV">CSV</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" DOCX
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.DOCX)" href="#docling.document_converter.InputFormat.DOCX">DOCX</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" HTML
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.HTML)" href="#docling.document_converter.InputFormat.HTML">HTML</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" IMAGE
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.IMAGE)" href="#docling.document_converter.InputFormat.IMAGE">IMAGE</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" JSON_DOCLING
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.JSON_DOCLING)" href="#docling.document_converter.InputFormat.JSON_DOCLING">JSON_DOCLING</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" MD
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.MD)" href="#docling.document_converter.InputFormat.MD">MD</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PDF
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.PDF)" href="#docling.document_converter.InputFormat.PDF">PDF</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" PPTX
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.PPTX)" href="#docling.document_converter.InputFormat.PPTX">PPTX</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" XLSX
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.XLSX)" href="#docling.document_converter.InputFormat.XLSX">XLSX</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" XML_JATS
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.XML_JATS)" href="#docling.document_converter.InputFormat.XML_JATS">XML_JATS</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" XML_USPTO
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.InputFormat.XML_USPTO)" href="#docling.document_converter.InputFormat.XML_USPTO">XML_USPTO</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.ASCIIDOC" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">ASCIIDOC</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">ASCIIDOC</span> <span class="o">=</span> <span class="s1">'asciidoc'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.AUDIO" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">AUDIO</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">AUDIO</span> <span class="o">=</span> <span class="s1">'audio'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.CSV" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">CSV</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">CSV</span> <span class="o">=</span> <span class="s1">'csv'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.DOCX" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">DOCX</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">DOCX</span> <span class="o">=</span> <span class="s1">'docx'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.HTML" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">HTML</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">HTML</span> <span class="o">=</span> <span class="s1">'html'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.IMAGE" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">IMAGE</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">IMAGE</span> <span class="o">=</span> <span class="s1">'image'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.JSON_DOCLING" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">JSON_DOCLING</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">JSON_DOCLING</span> <span class="o">=</span> <span class="s1">'json_docling'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.MD" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">MD</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">MD</span> <span class="o">=</span> <span class="s1">'md'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.PDF" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">PDF</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">PDF</span> <span class="o">=</span> <span class="s1">'pdf'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.PPTX" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">PPTX</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">PPTX</span> <span class="o">=</span> <span class="s1">'pptx'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.XLSX" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">XLSX</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">XLSX</span> <span class="o">=</span> <span class="s1">'xlsx'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.XML_JATS" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">XML_JATS</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">XML_JATS</span> <span class="o">=</span> <span class="s1">'xml_jats'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.InputFormat.XML_USPTO" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">XML_USPTO</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">XML_USPTO</span> <span class="o">=</span> <span class="s1">'xml_uspto'</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.PdfFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">PdfFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.PdfFormatOption.set_optional_field_default)" href="#docling.document_converter.PdfFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PdfFormatOption.backend)" href="#docling.document_converter.PdfFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PdfFormatOption.model_config)" href="#docling.document_converter.PdfFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PdfFormatOption.pipeline_cls)" href="#docling.document_converter.PdfFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PdfFormatOption.pipeline_options)" href="#docling.document_converter.PdfFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PdfFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.docling_parse_v4_backend.DoclingParseV4DocumentBackend">DoclingParseV4DocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PdfFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PdfFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" StandardPdfPipeline (docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline)" href="#docling.document_converter.StandardPdfPipeline">StandardPdfPipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PdfFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.PdfFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.ImageFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">ImageFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.ImageFormatOption.set_optional_field_default)" href="#docling.document_converter.ImageFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ImageFormatOption.backend)" href="#docling.document_converter.ImageFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ImageFormatOption.model_config)" href="#docling.document_converter.ImageFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ImageFormatOption.pipeline_cls)" href="#docling.document_converter.ImageFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.ImageFormatOption.pipeline_options)" href="#docling.document_converter.ImageFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ImageFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.docling_parse_v4_backend.DoclingParseV4DocumentBackend">DoclingParseV4DocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ImageFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ImageFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" StandardPdfPipeline (docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline)" href="#docling.document_converter.StandardPdfPipeline">StandardPdfPipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.ImageFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.ImageFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.StandardPdfPipeline" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">StandardPdfPipeline</span>
|
||
|
||
|
||
</h3>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">StandardPdfPipeline</span><span class="p">(</span><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" PdfPipelineOptions (docling.datamodel.pipeline_options.PdfPipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PdfPipelineOptions">PdfPipelineOptions</a></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="docling.pipeline.base_pipeline.PaginatedPipeline">PaginatedPipeline</span></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" download_models_hf
|
||
|
||
|
||
|
||
staticmethod
|
||
(docling.document_converter.StandardPdfPipeline.download_models_hf)" href="#docling.document_converter.StandardPdfPipeline.download_models_hf">download_models_hf</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" execute (docling.document_converter.StandardPdfPipeline.execute)" href="#docling.document_converter.StandardPdfPipeline.execute">execute</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" get_default_options
|
||
|
||
|
||
|
||
classmethod
|
||
(docling.document_converter.StandardPdfPipeline.get_default_options)" href="#docling.document_converter.StandardPdfPipeline.get_default_options">get_default_options</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" get_ocr_model (docling.document_converter.StandardPdfPipeline.get_ocr_model)" href="#docling.document_converter.StandardPdfPipeline.get_ocr_model">get_ocr_model</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" get_picture_description_model (docling.document_converter.StandardPdfPipeline.get_picture_description_model)" href="#docling.document_converter.StandardPdfPipeline.get_picture_description_model">get_picture_description_model</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" initialize_page (docling.document_converter.StandardPdfPipeline.initialize_page)" href="#docling.document_converter.StandardPdfPipeline.initialize_page">initialize_page</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" is_backend_supported
|
||
|
||
|
||
|
||
classmethod
|
||
(docling.document_converter.StandardPdfPipeline.is_backend_supported)" href="#docling.document_converter.StandardPdfPipeline.is_backend_supported">is_backend_supported</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" build_pipe
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.build_pipe)" href="#docling.document_converter.StandardPdfPipeline.build_pipe">build_pipe</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" enrichment_pipe
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.enrichment_pipe)" href="#docling.document_converter.StandardPdfPipeline.enrichment_pipe">enrichment_pipe</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" keep_backend
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.keep_backend)" href="#docling.document_converter.StandardPdfPipeline.keep_backend">keep_backend</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" keep_images
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.keep_images)" href="#docling.document_converter.StandardPdfPipeline.keep_images">keep_images</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.pipeline_options)" href="#docling.document_converter.StandardPdfPipeline.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><a class="autorefs autorefs-internal" title=" PdfPipelineOptions (docling.datamodel.pipeline_options.PdfPipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PdfPipelineOptions">PdfPipelineOptions</a></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" reading_order_model
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.StandardPdfPipeline.reading_order_model)" href="#docling.document_converter.StandardPdfPipeline.reading_order_model">reading_order_model</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.build_pipe" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">build_pipe</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">build_pipe</span> <span class="o">=</span> <span class="p">[</span><span class="n"><span title="docling.models.page_preprocessing_model.PagePreprocessingModel">PagePreprocessingModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.page_preprocessing_model.PagePreprocessingModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.models.page_preprocessing_model.PagePreprocessingOptions">PagePreprocessingOptions</span></span><span class="p">(</span><span class="n"><span title="docling.models.page_preprocessing_model.PagePreprocessingOptions(images_scale)">images_scale</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).images_scale">images_scale</span></span><span class="p">)),</span> <span class="n"><span title="ocr_model">ocr_model</span></span><span class="p">,</span> <span class="n"><span title="docling.models.layout_model.LayoutModel">LayoutModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.layout_model.LayoutModel(artifacts_path)">artifacts_path</span></span><span class="o">=</span><span class="n"><span title="artifacts_path">artifacts_path</span></span><span class="p">,</span> <span class="n"><span title="docling.models.layout_model.LayoutModel(accelerator_options)">accelerator_options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).accelerator_options">accelerator_options</span></span><span class="p">,</span> <span class="n"><span title="docling.models.layout_model.LayoutModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).layout_options">layout_options</span></span><span class="p">),</span> <span class="n"><span title="docling.models.table_structure_model.TableStructureModel">TableStructureModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.table_structure_model.TableStructureModel(enabled)">enabled</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_table_structure">do_table_structure</span></span><span class="p">,</span> <span class="n"><span title="docling.models.table_structure_model.TableStructureModel(artifacts_path)">artifacts_path</span></span><span class="o">=</span><span class="n"><span title="artifacts_path">artifacts_path</span></span><span class="p">,</span> <span class="n"><span title="docling.models.table_structure_model.TableStructureModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).table_structure_options">table_structure_options</span></span><span class="p">,</span> <span class="n"><span title="docling.models.table_structure_model.TableStructureModel(accelerator_options)">accelerator_options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).accelerator_options">accelerator_options</span></span><span class="p">),</span> <span class="n"><span title="docling.models.page_assemble_model.PageAssembleModel">PageAssembleModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.page_assemble_model.PageAssembleModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.models.page_assemble_model.PageAssembleOptions">PageAssembleOptions</span></span><span class="p">())]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.enrichment_pipe" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">enrichment_pipe</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">enrichment_pipe</span> <span class="o">=</span> <span class="p">[</span><span class="n"><span title="docling.models.code_formula_model.CodeFormulaModel">CodeFormulaModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.code_formula_model.CodeFormulaModel(enabled)">enabled</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_code_enrichment">do_code_enrichment</span></span> <span class="ow">or</span> <span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_formula_enrichment">do_formula_enrichment</span></span><span class="p">,</span> <span class="n"><span title="docling.models.code_formula_model.CodeFormulaModel(artifacts_path)">artifacts_path</span></span><span class="o">=</span><span class="n"><span title="artifacts_path">artifacts_path</span></span><span class="p">,</span> <span class="n"><span title="docling.models.code_formula_model.CodeFormulaModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.models.code_formula_model.CodeFormulaModelOptions">CodeFormulaModelOptions</span></span><span class="p">(</span><span class="n"><span title="docling.models.code_formula_model.CodeFormulaModelOptions(do_code_enrichment)">do_code_enrichment</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_code_enrichment">do_code_enrichment</span></span><span class="p">,</span> <span class="n"><span title="docling.models.code_formula_model.CodeFormulaModelOptions(do_formula_enrichment)">do_formula_enrichment</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_formula_enrichment">do_formula_enrichment</span></span><span class="p">),</span> <span class="n"><span title="docling.models.code_formula_model.CodeFormulaModel(accelerator_options)">accelerator_options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).accelerator_options">accelerator_options</span></span><span class="p">),</span> <span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifier">DocumentPictureClassifier</span></span><span class="p">(</span><span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifier(enabled)">enabled</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).do_picture_classification">do_picture_classification</span></span><span class="p">,</span> <span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifier(artifacts_path)">artifacts_path</span></span><span class="o">=</span><span class="n"><span title="artifacts_path">artifacts_path</span></span><span class="p">,</span> <span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifier(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifierOptions">DocumentPictureClassifierOptions</span></span><span class="p">(),</span> <span class="n"><span title="docling.models.document_picture_classifier.DocumentPictureClassifier(accelerator_options)">accelerator_options</span></span><span class="o">=</span><span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(pipeline_options).accelerator_options">accelerator_options</span></span><span class="p">),</span> <span class="n"><span title="picture_description_model">picture_description_model</span></span><span class="p">]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.keep_backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">keep_backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">keep_backend</span> <span class="o">=</span> <span class="kc">True</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.keep_images" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">keep_images</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">keep_images</span> <span class="o">=</span> <span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(self).pipeline_options.generate_page_images">generate_page_images</span></span> <span class="ow">or</span> <span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(self).pipeline_options.generate_picture_images">generate_picture_images</span></span> <span class="ow">or</span> <span class="n"><span title="docling.pipeline.standard_pdf_pipeline.StandardPdfPipeline(self).pipeline_options.generate_table_images">generate_table_images</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" PdfPipelineOptions (docling.datamodel.pipeline_options.PdfPipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PdfPipelineOptions">PdfPipelineOptions</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.reading_order_model" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">reading_order_model</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">reading_order_model</span> <span class="o">=</span> <span class="n"><span title="docling.models.readingorder_model.ReadingOrderModel">ReadingOrderModel</span></span><span class="p">(</span><span class="n"><span title="docling.models.readingorder_model.ReadingOrderModel(options)">options</span></span><span class="o">=</span><span class="n"><span title="docling.models.readingorder_model.ReadingOrderOptions">ReadingOrderOptions</span></span><span class="p">())</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.download_models_hf" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">download_models_hf</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">download_models_hf</span><span class="p">(</span><span class="n">local_dir</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="pathlib.Path">Path</span></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">force</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="pathlib.Path">Path</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.execute" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">execute</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">execute</span><span class="p">(</span><span class="n">in_doc</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.document.InputDocument">InputDocument</span></span><span class="p">,</span> <span class="n">raises_on_error</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" ConversionResult (docling.datamodel.document.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.get_default_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_default_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_default_options</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" PdfPipelineOptions (docling.datamodel.pipeline_options.PdfPipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PdfPipelineOptions">PdfPipelineOptions</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.get_ocr_model" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_ocr_model</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_ocr_model</span><span class="p">(</span><span class="n">artifacts_path</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="pathlib.Path">Path</span></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="docling.models.base_ocr_model.BaseOcrModel">BaseOcrModel</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.get_picture_description_model" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_picture_description_model</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_picture_description_model</span><span class="p">(</span><span class="n">artifacts_path</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="pathlib.Path">Path</span></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><span title="docling.models.picture_description_base_model.PictureDescriptionBaseModel">PictureDescriptionBaseModel</span></span><span class="p">]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.initialize_page" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">initialize_page</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">initialize_page</span><span class="p">(</span><span class="n">conv_res</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" ConversionResult (docling.datamodel.document.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></span><span class="p">,</span> <span class="n">page</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.base_models.Page">Page</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><span title="docling.datamodel.base_models.Page">Page</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.StandardPdfPipeline.is_backend_supported" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">is_backend_supported</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">is_backend_supported</span><span class="p">(</span><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.WordFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">WordFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.WordFormatOption.set_optional_field_default)" href="#docling.document_converter.WordFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.WordFormatOption.backend)" href="#docling.document_converter.WordFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.WordFormatOption.model_config)" href="#docling.document_converter.WordFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.WordFormatOption.pipeline_cls)" href="#docling.document_converter.WordFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.WordFormatOption.pipeline_options)" href="#docling.document_converter.WordFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.WordFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.msword_backend.MsWordDocumentBackend">MsWordDocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.WordFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.WordFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.pipeline.simple_pipeline.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.WordFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.WordFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.PowerpointFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">PowerpointFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.PowerpointFormatOption.set_optional_field_default)" href="#docling.document_converter.PowerpointFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PowerpointFormatOption.backend)" href="#docling.document_converter.PowerpointFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PowerpointFormatOption.model_config)" href="#docling.document_converter.PowerpointFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PowerpointFormatOption.pipeline_cls)" href="#docling.document_converter.PowerpointFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.PowerpointFormatOption.pipeline_options)" href="#docling.document_converter.PowerpointFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PowerpointFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.mspowerpoint_backend.MsPowerpointDocumentBackend">MsPowerpointDocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PowerpointFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PowerpointFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.pipeline.simple_pipeline.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.PowerpointFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.PowerpointFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.MarkdownFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">MarkdownFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.MarkdownFormatOption.set_optional_field_default)" href="#docling.document_converter.MarkdownFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.MarkdownFormatOption.backend)" href="#docling.document_converter.MarkdownFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.MarkdownFormatOption.model_config)" href="#docling.document_converter.MarkdownFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.MarkdownFormatOption.pipeline_cls)" href="#docling.document_converter.MarkdownFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.MarkdownFormatOption.pipeline_options)" href="#docling.document_converter.MarkdownFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.MarkdownFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.md_backend.MarkdownDocumentBackend">MarkdownDocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.MarkdownFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.MarkdownFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.pipeline.simple_pipeline.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.MarkdownFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.MarkdownFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.AsciiDocFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">AsciiDocFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.AsciiDocFormatOption.set_optional_field_default)" href="#docling.document_converter.AsciiDocFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.AsciiDocFormatOption.backend)" href="#docling.document_converter.AsciiDocFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.AsciiDocFormatOption.model_config)" href="#docling.document_converter.AsciiDocFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.AsciiDocFormatOption.pipeline_cls)" href="#docling.document_converter.AsciiDocFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.AsciiDocFormatOption.pipeline_options)" href="#docling.document_converter.AsciiDocFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.AsciiDocFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.asciidoc_backend.AsciiDocBackend">AsciiDocBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.AsciiDocFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.AsciiDocFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.pipeline.simple_pipeline.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.AsciiDocFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.AsciiDocFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.HTMLFormatOption" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">HTMLFormatOption</span>
|
||
|
||
|
||
</h3>
|
||
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></code></p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" set_optional_field_default (docling.document_converter.HTMLFormatOption.set_optional_field_default)" href="#docling.document_converter.HTMLFormatOption.set_optional_field_default">set_optional_field_default</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" backend
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.HTMLFormatOption.backend)" href="#docling.document_converter.HTMLFormatOption.backend">backend</a></code></b>
|
||
(<code><span title="typing.Type">Type</span>[<span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" model_config
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.HTMLFormatOption.model_config)" href="#docling.document_converter.HTMLFormatOption.model_config">model_config</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_cls
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.HTMLFormatOption.pipeline_cls)" href="#docling.document_converter.HTMLFormatOption.pipeline_cls">pipeline_cls</a></code></b>
|
||
(<code><span title="typing.Type">Type</span></code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
class-attribute
|
||
instance-attribute
|
||
(docling.document_converter.HTMLFormatOption.pipeline_options)" href="#docling.document_converter.HTMLFormatOption.pipeline_options">pipeline_options</a></code></b>
|
||
(<code><span title="typing.Optional">Optional</span>[<a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.HTMLFormatOption.backend" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">backend</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span><span class="p">[</span><span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">]</span> <span class="o">=</span> <span class="n"><span title="docling.backend.html_backend.HTMLDocumentBackend">HTMLDocumentBackend</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.HTMLFormatOption.model_config" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">model_config</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">model_config</span> <span class="o">=</span> <span class="n"><span title="pydantic.ConfigDict">ConfigDict</span></span><span class="p">(</span><span class="n"><span title="pydantic.ConfigDict(arbitrary_types_allowed)">arbitrary_types_allowed</span></span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.HTMLFormatOption.pipeline_cls" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_cls</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_cls</span><span class="p">:</span> <span class="n"><span title="typing.Type">Type</span></span> <span class="o">=</span> <span class="n"><a class="autorefs autorefs-internal" title=" SimplePipeline (docling.pipeline.simple_pipeline.SimplePipeline)" href="#docling.document_converter.SimplePipeline">SimplePipeline</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.HTMLFormatOption.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><span title="typing.Optional">Optional</span></span><span class="p">[</span><span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.HTMLFormatOption.set_optional_field_default" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">set_optional_field_default</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">set_optional_field_default</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" FormatOption (docling.document_converter.FormatOption)" href="#docling.document_converter.FormatOption">FormatOption</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-class">
|
||
|
||
|
||
|
||
<h3 id="docling.document_converter.SimplePipeline" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SimplePipeline</span>
|
||
|
||
|
||
</h3>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">SimplePipeline</span><span class="p">(</span><span class="n">pipeline_options</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
<p class="doc doc-class-bases">
|
||
Bases: <code><span title="docling.pipeline.base_pipeline.BasePipeline">BasePipeline</span></code></p>
|
||
|
||
|
||
<p>SimpleModelPipeline.</p>
|
||
<p>This class is used at the moment for formats / backends
|
||
which produce straight DoclingDocument output.</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Methods:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" execute (docling.document_converter.SimplePipeline.execute)" href="#docling.document_converter.SimplePipeline.execute">execute</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" get_default_options
|
||
|
||
|
||
|
||
classmethod
|
||
(docling.document_converter.SimplePipeline.get_default_options)" href="#docling.document_converter.SimplePipeline.get_default_options">get_default_options</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" is_backend_supported
|
||
|
||
|
||
|
||
classmethod
|
||
(docling.document_converter.SimplePipeline.is_backend_supported)" href="#docling.document_converter.SimplePipeline.is_backend_supported">is_backend_supported</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<p><span class="doc-section-title">Attributes:</span></p>
|
||
<ul>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" build_pipe
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.SimplePipeline.build_pipe)" href="#docling.document_converter.SimplePipeline.build_pipe">build_pipe</a></code></b>
|
||
(<code><span title="typing.List">List</span>[<span title="typing.Callable">Callable</span>]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" enrichment_pipe
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.SimplePipeline.enrichment_pipe)" href="#docling.document_converter.SimplePipeline.enrichment_pipe">enrichment_pipe</a></code></b>
|
||
(<code><span title="typing.List">List</span>[<span title="docling.models.base_model.GenericEnrichmentModel">GenericEnrichmentModel</span>[<span title="typing.Any">Any</span>]]</code>)
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" keep_images
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.SimplePipeline.keep_images)" href="#docling.document_converter.SimplePipeline.keep_images">keep_images</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
<li class="doc-section-item field-body">
|
||
<b><code><a class="autorefs autorefs-internal" title=" pipeline_options
|
||
|
||
|
||
|
||
instance-attribute
|
||
(docling.document_converter.SimplePipeline.pipeline_options)" href="#docling.document_converter.SimplePipeline.pipeline_options">pipeline_options</a></code></b>
|
||
–
|
||
<div class="doc-md-description">
|
||
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-children">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.build_pipe" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">build_pipe</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">build_pipe</span><span class="p">:</span> <span class="n"><span title="typing.List">List</span></span><span class="p">[</span><span class="n"><span title="typing.Callable">Callable</span></span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.enrichment_pipe" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">enrichment_pipe</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">enrichment_pipe</span><span class="p">:</span> <span class="n"><span title="typing.List">List</span></span><span class="p">[</span><span class="n"><span title="docling.models.base_model.GenericEnrichmentModel">GenericEnrichmentModel</span></span><span class="p">[</span><span class="n"><span title="typing.Any">Any</span></span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.keep_images" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">keep_images</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">keep_images</span> <span class="o">=</span> <span class="kc">False</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-attribute">
|
||
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.pipeline_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code> <span class="doc doc-object-name doc-attribute-name">pipeline_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="n">pipeline_options</span> <span class="o">=</span> <span class="n"><span title="docling.pipeline.base_pipeline.BasePipeline(pipeline_options)">pipeline_options</span></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.execute" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">execute</span>
|
||
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">execute</span><span class="p">(</span><span class="n">in_doc</span><span class="p">:</span> <span class="n"><span title="docling.datamodel.document.InputDocument">InputDocument</span></span><span class="p">,</span> <span class="n">raises_on_error</span><span class="p">:</span> <span class="n"><span title="bool">bool</span></span><span class="p">)</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" ConversionResult (docling.datamodel.document.ConversionResult)" href="#docling.document_converter.ConversionResult">ConversionResult</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.get_default_options" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_default_options</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">get_default_options</span><span class="p">()</span> <span class="o">-></span> <span class="n"><a class="autorefs autorefs-internal" title=" PipelineOptions (docling.datamodel.pipeline_options.PipelineOptions)" href="../pipeline_options/#docling.datamodel.pipeline_options.PipelineOptions">PipelineOptions</a></span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="doc doc-object doc-function">
|
||
|
||
|
||
<h4 id="docling.document_converter.SimplePipeline.is_backend_supported" class="doc doc-heading">
|
||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">is_backend_supported</span>
|
||
|
||
|
||
<span class="doc doc-labels">
|
||
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
||
</span>
|
||
|
||
</h4>
|
||
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">is_backend_supported</span><span class="p">(</span><span class="n">backend</span><span class="p">:</span> <span class="n"><span title="docling.backend.abstract_backend.AbstractDocumentBackend">AbstractDocumentBackend</span></span><span class="p">)</span>
|
||
</code></pre></div>
|
||
|
||
<div class="doc doc-contents ">
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||
Back to top
|
||
</button>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
|
||
|
||
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
||
|
||
|
||
<a href="../../integrations/vectara/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Vectara">
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</div>
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Previous
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
Vectara
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
|
||
<a href="../pipeline_options/" class="md-footer__link md-footer__link--next" aria-label="Next: Pipeline options">
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Next
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
Pipeline options
|
||
</div>
|
||
</div>
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
||
</div>
|
||
</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="md-footer-meta md-typeset">
|
||
<div class="md-footer-meta__inner md-grid">
|
||
<div class="md-copyright">
|
||
|
||
|
||
Made with
|
||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||
Material for MkDocs
|
||
</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div class="md-dialog" data-md-component="dialog">
|
||
<div class="md-dialog__inner md-typeset"></div>
|
||
</div>
|
||
|
||
<div class="md-progress" data-md-component="progress" role="progressbar"></div>
|
||
|
||
|
||
|
||
|
||
<script id="__config" type="application/json">{"base": "../..", "features": ["content.tabs.link", "content.code.annotate", "content.code.copy", "announce.dismiss", "navigation.footer", "navigation.tabs", "navigation.indexes", "navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.path", "navigation.sections", "navigation.top", "navigation.tracking", "search.suggest", "toc.follow"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||
|
||
|
||
<script src="../../assets/javascripts/bundle.56ea9cef.min.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |