docling

package module

Go to main page

Versions in this module

v1

v1.2.0

Sep 21, 2026

Changes in this version

+ var ErrPDFResourceLimit = errors.New("pdf resource limit exceeded")

type OCRRequest

+ PageData []byte

+ type PDFLimits struct

+ MaxFileBytes int64

+ MaxPages int

+ func DefaultPDFLimits() PDFLimits

type PDFOptions

+ Limits PDFLimits

+ type PDFResourceLimitError struct

+ Actual int64

+ Cause error

+ Limit int64

+ Resource string

+ func (e *PDFResourceLimitError) Error() string

+ func (e *PDFResourceLimitError) Unwrap() []error

type PDFVisualRequest

+ PageData []byte

type ParseOptions

+ PDFLimits PDFLimits

v1.1.1

Sep 17, 2026

v1.1.0

Sep 17, 2026

v1.0.0

Sep 14, 2026

Changes in this version

+ const DefaultContentChunkMaxRunes

+ const DefaultContentTableMaxRows

+ const DefaultHybridMaxTokens

+ const DocChunkMetaSchemaName

+ const DocChunkMetaVersion

+ const DoclingSchemaName

+ const DoclingSchemaVersion

+ const PDFStructuredVisualPrompt

+ const SourceDocling

+ const SourceGolight

+ func ContextualizeDocChunk(chunk DocChunk) string

+ func ExportHTML(doc *DoclingDocument) string

+ func ExportHTMLWithOptions(doc *DoclingDocument, options ExportOptions) string

+ func ExportMarkdown(doc *DoclingDocument) string

+ func ExportMarkdownWithOptions(doc *DoclingDocument, options ExportOptions) string

+ func HealthCheckDoclingService(ctx context.Context, opts DoclingServiceOptions) error

+ func ItemHeadingPath(item Item) string

+ func ItemToText(item Item) string

+ func JoinItemTexts(items []Item) string

+ func ParseByExtToMarkdown(name string, data []byte) (string, error)

+ func ParseMarkdownTable(md string) [][]string

+ func ParseWithDoclingService(ctx context.Context, docName string, data []byte, opts DoclingServiceOptions) (*DoclingDocument, *DoclingServeResult, error)

+ func RenderMarkdownTable(rows [][]string) string

+ type BBox struct

+ Bottom float64

+ Left float64

+ Right float64

+ Top float64

+ type BaseMeta map[string]json.RawMessage

+ type ContentChunk struct

+ BBox *BBox

+ CharEnd int64

+ CharStart int64

+ ChunkIndex int64

+ Content string

+ HeadingPath string

+ OrderIndex int64

+ PageIdx int64

+ TokenEstimate int64

+ func ChunkContentList(items []Item, options ContentChunkOptions) []ContentChunk

+ type ContentChunkOptions struct

+ IncludeDoclingMultimodal bool

+ MaxRunes int

+ NoiseLabels []string

+ TableMaxRows int

+ type ContentLayer string

+ const LayerBackground

+ const LayerBody

+ const LayerFurniture

+ const LayerInvisible

+ const LayerNotes

+ type CoordOrigin string

+ const CoordOriginBottomLeft

+ const CoordOriginTopLeft

+ type DocChunk struct

+ Meta DocChunkMeta

+ Text string

+ func HierarchicalChunks(doc *DoclingDocument) []DocChunk

+ func HybridChunks(doc *DoclingDocument, options HybridChunkOptions) []DocChunk

+ type DocChunkMeta struct

+ DocItems []json.RawMessage

+ DocRefs []string

+ Headings []string

+ Origin *DocumentOrigin

+ Provenance []ProvenanceItem

+ SchemaName string

+ Version string

+ type DocItemLabel string

+ const LabelCaption

+ const LabelChart

+ const LabelCheckboxSelected

+ const LabelCheckboxUnselected

+ const LabelCode

+ const LabelDocumentIndex

+ const LabelEmptyValue

+ const LabelFieldHeading

+ const LabelFieldHint

+ const LabelFieldItem

+ const LabelFieldKey

+ const LabelFieldRegion

+ const LabelFieldValue

+ const LabelFootnote

+ const LabelForm

+ const LabelFormula

+ const LabelGradingScale

+ const LabelHandwrittenText

+ const LabelKeyValueRegion

+ const LabelListItem

+ const LabelMarker

+ const LabelPageFooter

+ const LabelPageHeader

+ const LabelParagraph

+ const LabelPicture

+ const LabelReference

+ const LabelSectionHeader

+ const LabelTable

+ const LabelText

+ const LabelTitle

+ type DocMeta struct

+ Author string

+ CreatedAt string

+ Language string

+ PageCount int

+ Subject string

+ Title string

+ type DoclingBBox struct

+ B float64

+ CoordOrigin CoordOrigin

+ L float64

+ R float64

+ T float64

+ func (b DoclingBBox) MarshalJSON() ([]byte, error)

+ type DoclingDocument struct

+ Body *GroupItem

+ FieldItems []json.RawMessage

+ FieldRegions []json.RawMessage

+ FormItems []json.RawMessage

+ Furniture *GroupItem

+ Groups []GroupItem

+ KeyValueItems []json.RawMessage

+ Meta *DocMeta

+ Name string

+ Origin *DocumentOrigin

+ Pages map[string]PageItem

+ Pictures []PictureItem

+ SchemaName string

+ Tables []TableItem

+ Texts []TextItem

+ Version string

+ func NewDoclingDocument(name string) *DoclingDocument

+ func ParseAsciiDoc(data []byte) (*DoclingDocument, error)

+ func ParseByExt(name string, data []byte) (*DoclingDocument, error)

+ func ParseByExtWithOptions(name string, data []byte, options ParseOptions) (*DoclingDocument, error)

+ func ParseCSV(data []byte) (*DoclingDocument, error)

+ func ParseDoclingDocument(raw json.RawMessage) (*DoclingDocument, error)

+ func ParseDocx(data []byte) (*DoclingDocument, error)

+ func ParseEML(data []byte) (*DoclingDocument, error)

+ func ParseHTML(data []byte) (*DoclingDocument, error)

+ func ParseImage(data []byte) (*DoclingDocument, error)

+ func ParseImageWithOptions(data []byte, opt PDFOptions) (*DoclingDocument, error)

+ func ParseMarkdown(data []byte) (*DoclingDocument, error)

+ func ParsePDF(data []byte) (*DoclingDocument, error)

+ func ParsePDFWithOptions(data []byte, opt PDFOptions) (*DoclingDocument, error)

+ func ParsePPTX(data []byte) (*DoclingDocument, error)

+ func ParseText(data []byte) (*DoclingDocument, error)

+ func ParseXLSX(data []byte) (*DoclingDocument, error)

+ func (d *DoclingDocument) AddCheckbox(checked bool, text string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddCode(text, language string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddFormula(text string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddHeading(level int64, text string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddListGroup(name string, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddListItem(group RefItem, text string, enumerated bool, marker string, ...) RefItem

+ func (d *DoclingDocument) AddPage(pageNo int64, width, height float64)

+ func (d *DoclingDocument) AddPicture(img *ImageRef, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddSectionGroup(name string, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddTable(cells []DoclingTableCell, numRows, numCols int64, prov []ProvenanceItem, ...) RefItem

+ func (d *DoclingDocument) AddText(label DocItemLabel, text string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) AddTitle(text string, prov []ProvenanceItem, parent *RefItem) RefItem

+ func (d *DoclingDocument) SortPageNos() []int64

+ func (d *DoclingDocument) Text() string

+ func (d *DoclingDocument) ToHTML() string

+ func (d *DoclingDocument) ToHTMLWithOptions(options ExportOptions) string

+ func (d *DoclingDocument) ToMarkdown() string

+ func (d *DoclingDocument) ToMarkdownWithOptions(options ExportOptions) string

+ func (d *DoclingDocument) UnmarshalJSON(data []byte) error

+ func (d DoclingDocument) MarshalJSON() ([]byte, error)

+ type DoclingPageInfo struct

+ Height float64

+ PageIdx int64

+ Width float64

+ type DoclingServeResult struct

+ Pages []DoclingPageInfo

+ ProcessingTime float64

+ RawJSON json.RawMessage

+ type DoclingServiceOptions struct

+ DoOCR *bool

+ ImageExportMode string

+ Retry int

+ ServiceURL string

+ TableMode string

+ Timeout time.Duration

+ type DoclingTableCell struct

+ BBox *DoclingBBox

+ ColSpan int64

+ ColumnHeader bool

+ EndColOffsetIdx int64

+ EndRowOffsetIdx int64

+ Fillable bool

+ Ref *RefItem

+ RowHeader bool

+ RowSection bool

+ RowSpan int64

+ StartColOffsetIdx int64

+ StartRowOffsetIdx int64

+ Text string

+ func (c DoclingTableCell) MarshalJSON() ([]byte, error)

+ type DocumentOrigin struct

+ BinaryHash uint64

+ Filename string

+ Mimetype string

+ URI string

+ func (o *DocumentOrigin) UnmarshalJSON(data []byte) error

+ type ExportOptions struct

+ Layers []ContentLayer

+ type FineRef struct

+ Range *[2]int64

+ func (r *FineRef) UnmarshalJSON(data []byte) error

+ func (r FineRef) MarshalJSON() ([]byte, error)

+ type Formatting struct

+ Bold bool

+ Italic bool

+ Script ScriptPosition

+ Strikethrough bool

+ Underline bool

+ func (f Formatting) MarshalJSON() ([]byte, error)

+ type GroupItem struct

+ Children []RefItem

+ ContentLayer ContentLayer

+ Label GroupLabel

+ Meta BaseMeta

+ Name string

+ Parent *RefItem

+ SelfRef string

+ type GroupLabel string

+ const GroupLabelChapter

+ const GroupLabelCommentSection

+ const GroupLabelFormArea

+ const GroupLabelInline

+ const GroupLabelKeyValueArea

+ const GroupLabelList

+ const GroupLabelOrderedList

+ const GroupLabelPictureArea

+ const GroupLabelSection

+ const GroupLabelSheet

+ const GroupLabelSlide

+ const GroupLabelUnspecified

+ type HybridChunkOptions struct

+ CountTokens func(text string) int

+ DisablePeerMerge bool

+ DisableTableHeaderRepeat bool

+ MaxTokens int

+ type ImageRef struct

+ Dpi int64

+ Mimetype string

+ Size *ImageSize

+ URI string

+ func (r ImageRef) MarshalJSON() ([]byte, error)

+ type ImageSize struct

+ Height float64

+ Width float64

+ type Item struct

+ BBox *BBox

+ ImageCaption string

+ ImageFootnote string

+ ImgPath string

+ LaTeX string

+ Label string

+ OrderIndex int64

+ PageIdx int64

+ SectionPath []string

+ Source string

+ TableBody string

+ TableCaption string

+ TableFootnote string

+ Text string

+ TextLevel int64

+ Type ItemType

+ func ToContentList(doc *DoclingDocument, source string) []Item

+ type ItemType string

+ const ItemTypeEquation

+ const ItemTypeGeneric

+ const ItemTypeImage

+ const ItemTypeTable

+ const ItemTypeText

+ type OCRHook func(request OCRRequest) (string, error)

+ type OCRRequest struct

+ Attempt int

+ Data []byte

+ ExistingText string

+ Filename string

+ MIMEType string

+ PageNo int64

+ ValidationFeedback string

+ type PDFOptions struct

+ DisableEmbeddedImageExtraction bool

+ DisablePopplerFallback bool

+ Filename string

+ GarbageThreshold float64

+ MIMEType string

+ MaxVisualPages int

+ OCRHook OCRHook

+ PageOCRHook PageOCRHook

+ VisualAlways bool

+ VisualHook PDFVisualHook

+ type PDFPageQuality struct

+ CandidateTableRows int

+ ColumnConfidence float64

+ DetectedTables int

+ FormulaDensity float64

+ GarbageRatio float64

+ ImageCount int

+ ImageCoverage float64

+ LargeImageCount int

+ LineCount int

+ MaxImageCoverage float64

+ NeedsVisual bool

+ PageRotation int

+ Reasons []string

+ Score float64

+ TextRunes int

+ UserUnit float64

+ WordCount int

+ type PDFVisualHook func(request PDFVisualRequest) (PDFVisualResult, error)

+ type PDFVisualImage struct

+ BBox *DoclingBBox

+ Image *ImageRef

+ type PDFVisualItem struct

+ BBox *DoclingBBox

+ Confidence float64

+ Enumerated bool

+ Label DocItemLabel

+ Level int64

+ Marker string

+ TableData *TableData

+ Text string

+ type PDFVisualRequest struct

+ Attempt int

+ Data []byte

+ EmbeddedImages []PDFVisualImage

+ ExistingText string

+ Filename string

+ Height float64

+ MIMEType string

+ PageNo int64

+ Prompt string

+ Quality PDFPageQuality

+ ValidationFeedback string

+ Width float64

+ type PDFVisualResult struct

+ Items []PDFVisualItem

+ type PageItem struct

+ Image *ImageRef

+ PageNo int64

+ Size *ImageSize

+ func (p *PageItem) UnmarshalJSON(data []byte) error

+ func (p PageItem) MarshalJSON() ([]byte, error)

+ type PageOCRHook func(pageNo int64, pdfBytes []byte) (string, error)

+ type ParseOptions struct

+ DisablePDFEmbeddedImageExtraction bool

+ DisablePopplerFallback bool

+ GarbageThreshold float64

+ MaxPDFVisualPages int

+ OCRHook OCRHook

+ OriginURI string

+ PDFVisualAlways bool

+ PDFVisualHook PDFVisualHook

+ PageOCRHook PageOCRHook

+ type PictureClassificationMetaField struct

+ Predictions []PictureClassificationPrediction

+ type PictureClassificationPrediction struct

+ ClassName string

+ type PictureItem struct

+ Annotations []json.RawMessage

+ Caption string

+ Captions []RefItem

+ Children []RefItem

+ Comments []FineRef

+ ContentLayer ContentLayer

+ Footnotes []RefItem

+ Image *ImageRef

+ Label DocItemLabel

+ Meta *PictureMeta

+ Parent *RefItem

+ Prov []ProvenanceItem

+ References []RefItem

+ SelfRef string

+ Source []json.RawMessage

+ func (p *PictureItem) UnmarshalJSON(data []byte) error

+ type PictureMeta struct

+ Classification *PictureClassificationMetaField

+ Code json.RawMessage

+ Description json.RawMessage

+ Extra map[string]json.RawMessage

+ Molecule json.RawMessage

+ TabularChart *TabularChartMetaField

+ func (m *PictureMeta) UnmarshalJSON(data []byte) error

+ func (m PictureMeta) MarshalJSON() ([]byte, error)

+ type PredictionMeta struct

+ Confidence *float64

+ CreatedBy string

+ type ProvenanceItem struct

+ BBox *DoclingBBox

+ CharSpan [2]int64

+ PageNo int64

+ func (p ProvenanceItem) MarshalJSON() ([]byte, error)

+ type RefItem struct

+ Idx int64

+ Kind docRefKind

+ func (r *RefItem) UnmarshalJSON(data []byte) error

+ func (r RefItem) MarshalJSON() ([]byte, error)

+ func (r RefItem) String() string

+ type ScriptPosition string

+ const ScriptBaseline

+ const ScriptSub

+ const ScriptSuper

+ type TableData struct

+ NumCols int64

+ NumRows int64

+ Orientation TableOrientation

+ TableCells []DoclingTableCell

+ func (t TableData) MarshalJSON() ([]byte, error)

+ type TableItem struct

+ Annotations []json.RawMessage

+ Caption string

+ Captions []RefItem

+ Children []RefItem

+ Comments []FineRef

+ ContentLayer ContentLayer

+ Data *TableData

+ Footnotes []RefItem

+ Image *ImageRef

+ Label DocItemLabel

+ Meta BaseMeta

+ Parent *RefItem

+ Prov []ProvenanceItem

+ References []RefItem

+ SelfRef string

+ Source []json.RawMessage

+ func (t *TableItem) UnmarshalJSON(data []byte) error

+ type TableOrientation string

+ const TableOrientation0

+ const TableOrientation180

+ const TableOrientation270

+ const TableOrientation90

+ type TabularChartMetaField struct

+ ChartData *TableData

+ Title string

+ type TextItem struct

+ Captions []RefItem

+ Children []RefItem

+ CodeLanguage string

+ Comments []FineRef

+ ContentLayer ContentLayer

+ Enumerated *bool

+ Footnotes []RefItem

+ Formatting *Formatting

+ Hyperlink string

+ Image *ImageRef

+ Label DocItemLabel

+ Latex string

+ Marker string

+ Meta BaseMeta

+ Orig string

+ Parent *RefItem

+ Prov []ProvenanceItem

+ References []RefItem

+ SelfRef string

+ Source []json.RawMessage

+ Text string

+ TextLevel int64

+ func (t *TextItem) UnmarshalJSON(data []byte) error

+ func (t TextItem) MarshalJSON() ([]byte, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL