All Classes and Interfaces
Class
Description
Represents a chunk of a document after it has been processed by a Docling chunker.
Builder for creating
Chunk instances.ChunkDocumentRequest.Builder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.Builder<C,B>>
ChunkDocumentRequest.ChunkDocumentRequestBuilder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.ChunkDocumentRequestBuilder<C,B>>
Response returned by the Chunk API for a single conversion request.
Builder for creating
ChunkDocumentResponse instances.Abstract options for configuring a document chunker.
Defines the types of chunking mechanisms supported for document processing.
Represents a request to clear or reset configured converters using the Docling Serve API.
Builder for creating
ClearConvertersRequest instances.Represents the response returned when performing a "clear" operation
within the Docling API.
Builder for creating
ClearResponse instances.Represents a request to clear stale data via the Docling Serve Clear API.
Builder for creating
ClearResultsRequest instances.Options for configuring the document conversion process with Docling.
Represents a request to convert a document.
Builder for creating
ConvertDocumentRequest instances.Abstract response returned by the Convert API for a single conversion request.
Docling Serve API interface.
DoclingServeApi.DoclingApiBuilder<T extends DoclingServeApi,B extends DoclingServeApi.DoclingApiBuilder<T,B>>
A builder interface for constructing implementations of
DoclingServeApi.Factory interface for creating builder instances to construct implementations of
DoclingServeApi.Represents the Docling Serve Chunk API, providing methods for processing document sources
by splitting them into smaller chunks using various chunking strategies.
Interface representing the Docling Serve Clear API.
Interface representing the Docling Serve Convert API.
Interface for performing health checks on the Docling service API.
Defines the interface for the Docling Task API, which provides operations for
managing and querying the status of asynchronous tasks.
Represents the document being processed by a Docling chunker.
Builder for creating
Document instances.A simple mutable POJO representing the converted document returned by the
Docling Convert API.
Builder for creating
DocumentResponse instances.Annotation to specify the formatting unit for durations.
Represents an individual error produced during document conversion.
Builder for creating
ErrorItem instances.Content of the original converted document, before getting chunked.
Builder for creating
ExportDocumentResponse instances.Represents a file-based data source.
Builder for creating
FileSource instances.Utility class that provides file-related operations such as reading files
and encoding file contents to Base64.
Simple health check response returned by the API.
Builder for creating
HealthCheckResponse instances.Represents a request to convert a document and chunk it into smaller documents
using the Docling hierarchical chunker.
HierarchicalChunkDocumentRequest.Builder<C extends HierarchicalChunkDocumentRequest,B extends HierarchicalChunkDocumentRequest.Builder<C,B>>
Builder for creating
HierarchicalChunkDocumentRequest instances.Options for configuring the hierarchical chunker.
Builder for creating
HierarchicalChunkerOptions instances.Represents an HTTP-based data source.
Builder for creating
HttpSource instances.Represents a request to convert a document and chunk it into smaller documents
using the Docling hybrid chunker.
HybridChunkDocumentRequest.Builder<C extends HybridChunkDocumentRequest,B extends HybridChunkDocumentRequest.Builder<C,B>>
Builder for creating
HybridChunkDocumentRequest instances.Options for configuring the hybrid chunker.
Builder for creating
HybridChunkerOptions instances.The mode for how to handle image references in the document.
Response for single document conversions with in-body content delivery.
Builder for creating
InBodyConvertDocumentResponse instances.Target for including the converted document in the response body.
Builder for creating
InBodyTarget instances.A document format supported by document backend parsers.
OCR engines supported by Docling.
Document formats supported for output in Docling.
PDF backends supported by Docling.
Configuration options for picture description API integration.
Builder for creating
PictureDescriptionApi instances.Configuration for local picture description generation.
Builder for creating
PictureDescriptionLocal instances.Response for document conversions with S3 or PUT target types.
Builder for creating
PreSignedUrlConvertDocumentResponse instances.Pipelines used by Docling to process documents.
A concrete
Target implementation for delivering a converted document to a specified URI via an HTTP PUT operation.Builder for creating
PutTarget instances.Type of response generated by the model.
Defines the response type for document conversion operations.
Represents a data source located in S3.
Utility wrapper around
ServiceLoader.load().Source of the document.
Modes for the TableFormer model.
Represents an abstract target for defining where and how the converted document should be delivered.
Represents a request to retrieve the result of a task.
Builder for creating
TaskResultRequest instances.Represents the possible statuses of a Task within the system.
Represents metadata for the status of a task, providing detailed information
about the task's progress and outcomes.
Builder for creating
TaskStatusMetadata instances.Represents a request for polling the status of a task.
Builder for creating
TaskStatusPollRequest instances.Represents the response for polling the status of a task.
Builder for creating
TaskStatusPollResponse instances.Utility methods.
Represents a validation error with customizable serialization and deserialization behavior.
Builder class for constructing instances of the enclosing class.
Represents the context information associated with a validation error.
Builder class for constructing instances of the enclosing class.
Represents detailed information about a validation error.
Builder class for constructing instances of the enclosing class.
Represents an exception that is thrown when validation errors occur.
Utility class for validating method arguments.
API details for using a vision-language model for the VLM pipeline.
Builder for creating
VlmModelApi instances.Options for running a local vision-language model for the VLM pipeline.
Builder for creating
VlmModelLocal instances.Inference framework to use.
Type of transformers auto-model to use.
Local and API models for the VLM pipeline.
Response for document conversions delivered as a ZIP archive.
Builder for creating
ZipArchiveConvertDocumentResponse instances.Represents a specific
Target that delivers the converted document as a zipped resource.Builder for creating
ZipTarget instances.