Skip to content

feat(API): expose PDF heading-level inference in the service API #3874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanielNg0729 wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

feat(API): expose PDF heading-level inference in the service API #3874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docling/datamodel/service/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
# Import new engine system (available in docling>=2.73.0)
from docling.datamodel.pipeline_options import (
CodeFormulaVlmOptions,
HeadingHierarchyOptions,
PdfBackend,
PictureDescriptionBaseOptions,
PictureDescriptionVlmEngineOptions,
Expand Down Expand Up @@ -489,6 +490,23 @@ class ConvertDocumentsOptions(BaseModel):
),
] = True

heading_hierarchy_options: Annotated[
HeadingHierarchyOptions,
Field(
description=(
"Options for inferring section-header levels, for PDF and image inputs "
"processed by the standard pipeline. Disabled by default, in which case "
"every detected heading stays at level 1 and the document hierarchy is "
"flat. When enabled, levels are inferred from the PDF bookmarks / table "
"of contents, from outline numbering and from font style."
),
examples=[
HeadingHierarchyOptions(enabled=True),
HeadingHierarchyOptions(enabled=True, use_bookmarks=False, max_level=4),
],
),
] = HeadingHierarchyOptions()

include_images: Annotated[
bool,
Field(
Expand Down