Index (docling-serve-api 0.5.3 API)

$ A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Serialized Form

$

$fillValuesFrom(C) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
$fillValuesFrom(C) - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder
$fillValuesFrom(C) - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder

A

abortOnError(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Abort on error if enabled.
accessKey(String) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: S3 access key
accessKey(String) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: S3 access key
ACCURATE - Enum constant in enum class ai.docling.serve.api.convert.request.options.TableFormerMode
ai.docling.serve.api - package ai.docling.serve.api: Docling Java API.
ai.docling.serve.api.chunk.request - package ai.docling.serve.api.chunk.request
ai.docling.serve.api.chunk.request.options - package ai.docling.serve.api.chunk.request.options
ai.docling.serve.api.chunk.response - package ai.docling.serve.api.chunk.response
ai.docling.serve.api.clear.request - package ai.docling.serve.api.clear.request
ai.docling.serve.api.clear.response - package ai.docling.serve.api.clear.response
ai.docling.serve.api.convert.request - package ai.docling.serve.api.convert.request
ai.docling.serve.api.convert.request.options - package ai.docling.serve.api.convert.request.options
ai.docling.serve.api.convert.request.source - package ai.docling.serve.api.convert.request.source
ai.docling.serve.api.convert.request.target - package ai.docling.serve.api.convert.request.target
ai.docling.serve.api.convert.response - package ai.docling.serve.api.convert.response
ai.docling.serve.api.health - package ai.docling.serve.api.health: Docling Serve - Health APIs.
ai.docling.serve.api.serialization - package ai.docling.serve.api.serialization: Serialization helpers
ai.docling.serve.api.spi - package ai.docling.serve.api.spi
ai.docling.serve.api.task.request - package ai.docling.serve.api.task.request: The Docling task api
ai.docling.serve.api.task.response - package ai.docling.serve.api.task.response: The Docling task api
ai.docling.serve.api.util - package ai.docling.serve.api.util
ai.docling.serve.api.validation - package ai.docling.serve.api.validation
apiKey(String) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Sets the API key for authenticating requests made by the client being built.
ASCIIDOC - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
ASR - Enum constant in enum class ai.docling.serve.api.convert.request.options.ProcessingPipeline
asyncPollInterval(Duration) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Sets the polling interval for async operations.
asyncTimeout(Duration) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Sets the timeout for async operations.
AUDIO - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
AUTO - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
AUTOMODEL - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_CAUSALLM - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_IMAGETEXTTOTEXT - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_VISION2SEQ - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType

B

base64String(String) - Method in class ai.docling.serve.api.convert.request.source.FileSource.Builder: Content of the file serialized in base64.
baseUrl(String) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Sets the base URL for the client.
baseUrl(URI) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Sets the base URL for the client.
bucket(String) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: S3 bucket name
bucket(String) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: S3 bucket name
build() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
build() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder
build() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder
build() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions.Builder
build() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder
build() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
build() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
build() - Method in class ai.docling.serve.api.chunk.response.Document.Builder
build() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder
build() - Method in class ai.docling.serve.api.clear.request.ClearConvertersRequest.Builder
build() - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest.Builder
build() - Method in class ai.docling.serve.api.clear.response.ClearResponse.Builder
build() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder
build() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
build() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
build() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder
build() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
build() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder
build() - Method in class ai.docling.serve.api.convert.request.source.FileSource.Builder
build() - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder
build() - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder
build() - Method in class ai.docling.serve.api.convert.request.target.InBodyTarget.Builder
build() - Method in class ai.docling.serve.api.convert.request.target.PutTarget.Builder
build() - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder
build() - Method in class ai.docling.serve.api.convert.request.target.ZipTarget.Builder
build() - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder
build() - Method in class ai.docling.serve.api.convert.response.ErrorItem.Builder
build() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
build() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder
build() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse.Builder
build() - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Builds and returns an instance of the specified type, representing the completed configuration of the builder.
build() - Method in class ai.docling.serve.api.health.HealthCheckResponse.Builder
build() - Method in class ai.docling.serve.api.task.request.TaskResultRequest.Builder
build() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest.Builder
build() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder
build() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder
build() - Method in class ai.docling.serve.api.validation.ValidationError.Builder
build() - Method in class ai.docling.serve.api.validation.ValidationErrorContext.Builder
build() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder
builder() - Static method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest
builder() - Static method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest
builder() - Static method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions
builder() - Static method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions
builder() - Static method in class ai.docling.serve.api.chunk.response.Chunk
builder() - Static method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse
builder() - Static method in class ai.docling.serve.api.chunk.response.Document
builder() - Static method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse
builder() - Static method in class ai.docling.serve.api.clear.request.ClearConvertersRequest
builder() - Static method in class ai.docling.serve.api.clear.request.ClearResultsRequest
builder() - Static method in class ai.docling.serve.api.clear.response.ClearResponse
builder() - Static method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest
builder() - Static method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions
builder() - Static method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi
builder() - Static method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal
builder() - Static method in class ai.docling.serve.api.convert.request.options.VlmModelApi
builder() - Static method in class ai.docling.serve.api.convert.request.options.VlmModelLocal
builder() - Static method in class ai.docling.serve.api.convert.request.source.FileSource
builder() - Static method in class ai.docling.serve.api.convert.request.source.HttpSource
builder() - Static method in class ai.docling.serve.api.convert.request.source.S3Source
builder() - Static method in class ai.docling.serve.api.convert.request.target.InBodyTarget
builder() - Static method in class ai.docling.serve.api.convert.request.target.PutTarget
builder() - Static method in class ai.docling.serve.api.convert.request.target.S3Target
builder() - Static method in class ai.docling.serve.api.convert.request.target.ZipTarget
builder() - Static method in class ai.docling.serve.api.convert.response.DocumentResponse
builder() - Static method in class ai.docling.serve.api.convert.response.ErrorItem
builder() - Static method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse
builder() - Static method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse
builder() - Static method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse
builder() - Static method in interface ai.docling.serve.api.DoclingServeApi: Creates and returns a builder instance capable of constructing implementations of DoclingServeApi.
builder() - Static method in class ai.docling.serve.api.health.HealthCheckResponse
builder() - Static method in class ai.docling.serve.api.task.request.TaskResultRequest
builder() - Static method in class ai.docling.serve.api.task.request.TaskStatusPollRequest
builder() - Static method in class ai.docling.serve.api.task.response.TaskStatusMetadata
builder() - Static method in class ai.docling.serve.api.task.response.TaskStatusPollResponse
builder() - Static method in class ai.docling.serve.api.validation.ValidationError
builder() - Static method in class ai.docling.serve.api.validation.ValidationErrorContext
builder() - Static method in class ai.docling.serve.api.validation.ValidationErrorDetail
Builder() - Constructor for class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
Builder() - Constructor for class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder
Builder() - Constructor for class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder

C

caption(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
captions(Collection<? extends String>) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
chunk(Chunk) - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
Chunk - Class in ai.docling.serve.api.chunk.response: Represents a chunk of a document after it has been processed by a Docling chunker.
Chunk.Builder - Class in ai.docling.serve.api.chunk.response: Builder for creating Chunk instances.
ChunkDocumentRequest - Class in ai.docling.serve.api.chunk.request
ChunkDocumentRequest(ChunkDocumentRequest.Builder<?, ?>) - Constructor for class ai.docling.serve.api.chunk.request.ChunkDocumentRequest
ChunkDocumentRequest.Builder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.Builder<C,B>> - Class in ai.docling.serve.api.chunk.request
ChunkDocumentRequest.ChunkDocumentRequestBuilder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.ChunkDocumentRequestBuilder<C,B>> - Class in ai.docling.serve.api.chunk.request
ChunkDocumentRequestBuilder() - Constructor for class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.ChunkDocumentRequestBuilder
ChunkDocumentResponse - Class in ai.docling.serve.api.chunk.response: Response returned by the Chunk API for a single conversion request.
ChunkDocumentResponse.Builder - Class in ai.docling.serve.api.chunk.response: Builder for creating ChunkDocumentResponse instances.
ChunkerOptions - Class in ai.docling.serve.api.chunk.request.options: Abstract options for configuring a document chunker.
ChunkerOptions() - Constructor for class ai.docling.serve.api.chunk.request.options.ChunkerOptions
chunkFiles(ChunkType, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Splits the given files into smaller chunks based on the specified chunking type.
chunkFilesAsync(ChunkType, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously chunks the provided files based on the specified chunk type.
chunkFilesWithHierarchicalChunker(HierarchicalChunkDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Processes and chunks the specified files into smaller, structured pieces using a hierarchical chunker.
chunkFilesWithHierarchicalChunker(Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Processes and chunks the specified files into smaller, structured pieces using a hierarchical chunker.
chunkFilesWithHierarchicalChunkerAsync(HierarchicalChunkDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes and chunks the specified files into smaller, structured pieces using a hierarchical chunker.
chunkFilesWithHierarchicalChunkerAsync(Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes and chunks the specified files into smaller, structured pieces using a hierarchical chunker.
chunkFilesWithHybridChunker(HybridChunkDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Processes and chunks the specified files into smaller, structured pieces using a hybrid chunking strategy.
chunkFilesWithHybridChunker(Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Processes and chunks the specified files into smaller, structured pieces using a hybrid chunking strategy.
chunkFilesWithHybridChunkerAsync(HybridChunkDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes and chunks the given files using a hybrid chunking mechanism.
chunkFilesWithHybridChunkerAsync(Path...) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes and chunks the provided files using a hybrid chunking strategy.
chunkIndex(int) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder: Index of this chunk within the document.
chunkingOptions(HierarchicalChunkerOptions) - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder: Options specific to the chunker.
chunkingOptions(HybridChunkerOptions) - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder: Options specific to the chunker.
chunks(Collection<? extends Chunk>) - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
chunkSourceWithHierarchicalChunker(HierarchicalChunkDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Converts and chunks the provided document source(s) into a processed document based on the specified options and using a hierarchical chunker for splitting the document into smaller chunks.
chunkSourceWithHierarchicalChunkerAsync(HierarchicalChunkDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes the provided document source(s) by converting and chunking them into smaller documents using the hierarchical chunker.
chunkSourceWithHybridChunker(HybridChunkDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Processes and chunks the provided document source(s) into smaller documents using a hybrid chunking strategy.
chunkSourceWithHybridChunkerAsync(HybridChunkDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeChunkApi: Asynchronously processes the provided document source(s) by converting and chunking them into smaller documents using the hybrid chunker.
chunkTaskResult(TaskResultRequest) - Method in interface ai.docling.serve.api.DoclingServeTaskApi: Processes the result of a completed task and splits it into smaller chunks as per the provided request specifications.
ChunkType - Enum Class in ai.docling.serve.api.chunk.request: Defines the types of chunking mechanisms supported for document processing.
clearCaptions() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
clearChunks() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
clearConverters(ClearConvertersRequest) - Method in interface ai.docling.serve.api.DoclingServeClearApi: Clears all currently configured converters within the Docling Serve API.
ClearConvertersRequest - Class in ai.docling.serve.api.clear.request: Represents a request to clear or reset configured converters using the Docling Serve API.
ClearConvertersRequest.Builder - Class in ai.docling.serve.api.clear.request
ClearConvertersRequest.ClearConvertersRequestBuilder - Class in ai.docling.serve.api.clear.request: Builder for creating ClearConvertersRequest instances.
ClearConvertersRequestBuilder() - Constructor for class ai.docling.serve.api.clear.request.ClearConvertersRequest.ClearConvertersRequestBuilder
clearDocItems() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
clearDocuments() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
clearErrorDetails() - Method in class ai.docling.serve.api.validation.ValidationError.Builder
clearErrors() - Method in class ai.docling.serve.api.chunk.response.Document.Builder
clearErrors() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
clearExtraGenerationConfig() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder
clearFromFormats() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
clearGenerationConfig() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder
clearHeaders() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
clearHeaders() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
clearHeaders() - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder
clearHeadings() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
clearLocations() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder
clearMetadata() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
clearOcrLang() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
clearPageNumbers() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
clearPageRange() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
clearParams() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
clearParams() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
ClearResponse - Class in ai.docling.serve.api.clear.response: Represents the response returned when performing a "clear" operation within the Docling API.
ClearResponse.Builder - Class in ai.docling.serve.api.clear.response: Builder for creating ClearResponse instances.
clearResults(ClearResultsRequest) - Method in interface ai.docling.serve.api.DoclingServeClearApi: Clears stored results based on the specified ClearResultsRequest.
ClearResultsRequest - Class in ai.docling.serve.api.clear.request: Represents a request to clear stale data via the Docling Serve Clear API.
ClearResultsRequest.Builder - Class in ai.docling.serve.api.clear.request
ClearResultsRequest.ClearResultsRequestBuilder - Class in ai.docling.serve.api.clear.request: Builder for creating ClearResultsRequest instances.
ClearResultsRequestBuilder() - Constructor for class ai.docling.serve.api.clear.request.ClearResultsRequest.ClearResultsRequestBuilder
clearSources() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
clearSources() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder
clearTimings() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
clearToFormats() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
componentType(String) - Method in class ai.docling.serve.api.convert.response.ErrorItem.Builder: Type of Docling component that encountered the error.
concurrency(Integer) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder: Maximum number of concurrent requests to the API.
concurrency(Integer) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Maximum number of concurrent requests to the API.
connectTimeout(Duration) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Timeout to establish a connection to the Docling Serve API.
content(ExportDocumentResponse) - Method in class ai.docling.serve.api.chunk.response.Document.Builder: The converted document content in various export formats.
context(ValidationErrorContext) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder: Represents the context information associated with a validation error.
ConvertDocumentOptions - Class in ai.docling.serve.api.convert.request.options: Options for configuring the document conversion process with Docling.
ConvertDocumentOptions.Builder - Class in ai.docling.serve.api.convert.request.options
ConvertDocumentRequest - Class in ai.docling.serve.api.convert.request: Represents a request to convert a document.
ConvertDocumentRequest.Builder - Class in ai.docling.serve.api.convert.request: Builder for creating ConvertDocumentRequest instances.
ConvertDocumentResponse - Class in ai.docling.serve.api.convert.response: Abstract response returned by the Convert API for a single conversion request.
ConvertDocumentResponse() - Constructor for class ai.docling.serve.api.convert.response.ConvertDocumentResponse
convertFiles(ConvertDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Converts the specified files into a processed document based on the options provided in the request.
convertFiles(Path...) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Converts the specified files into a processed document using default options.
convertFilesAsync(ConvertDocumentRequest, Path...) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Initiates an asynchronous conversion of the specified files into a processed document using the provided conversion request options.
convertFilesAsync(Path...) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Initiates an asynchronous conversion of the provided files into a processed document using default conversion options.
convertSource(ConvertDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Converts the provided document source(s) into a processed document based on the specified options.
convertSourceAsync(ConvertDocumentRequest) - Method in interface ai.docling.serve.api.DoclingServeConvertApi: Initiates an asynchronous conversion of the provided document source(s) and returns a CompletionStage that completes when the conversion is done.
convertTaskResult(TaskResultRequest) - Method in interface ai.docling.serve.api.DoclingServeTaskApi: Returns the result of a completed convert task.
convertToBase64(byte[]) - Static method in class ai.docling.serve.api.util.FileUtils: Converts the given byte array to a Base64-encoded string.
convertToBase64(Path) - Static method in class ai.docling.serve.api.util.FileUtils: Converts the contents of the specified file to a Base64-encoded string.
createContextual(SerializerProvider, BeanProperty) - Method in class ai.docling.serve.api.serialization.Jackson2DurationSerializer
createContextual(SerializationContext, BeanProperty) - Method in class ai.docling.serve.api.serialization.Jackson3DurationSerializer
createFileSources(Path...) - Static method in class ai.docling.serve.api.util.FileUtils: Creates a Stream of FileSource instances based on the provided file paths.
CSV - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat

D

DEFAULT_OLDER_THAN - Static variable in class ai.docling.serve.api.clear.request.ClearResultsRequest: Represents the default duration used as a threshold for clearing stale results or data in the Docling Serve Clear API.
DEFAULT_STATUS_POLL_WAIT_TIME - Static variable in class ai.docling.serve.api.task.request.TaskStatusPollRequest: The default wait time between status polling attempts for a task.
DLPARSE_V1 - Enum constant in enum class ai.docling.serve.api.convert.request.options.PdfBackend
DLPARSE_V2 - Enum constant in enum class ai.docling.serve.api.convert.request.options.PdfBackend
DLPARSE_V4 - Enum constant in enum class ai.docling.serve.api.convert.request.options.PdfBackend
docItem(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
docItems(Collection<? extends String>) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
DoclingServeApi - Interface in ai.docling.serve.api: Docling Serve API interface.
DoclingServeApi.DoclingApiBuilder<T extends DoclingServeApi,B extends DoclingServeApi.DoclingApiBuilder<T,B>> - Interface in ai.docling.serve.api: A builder interface for constructing implementations of DoclingServeApi.
DoclingServeApiBuilderFactory - Interface in ai.docling.serve.api.spi: Factory interface for creating builder instances to construct implementations of DoclingServeApi.
DoclingServeChunkApi - Interface in ai.docling.serve.api: Represents the Docling Serve Chunk API, providing methods for processing document sources by splitting them into smaller chunks using various chunking strategies.
DoclingServeClearApi - Interface in ai.docling.serve.api: Interface representing the Docling Serve Clear API.
DoclingServeConvertApi - Interface in ai.docling.serve.api: Interface representing the Docling Serve Convert API.
DoclingServeHealthApi - Interface in ai.docling.serve.api: Interface for performing health checks on the Docling service API.
DoclingServeTaskApi - Interface in ai.docling.serve.api: Defines the interface for the Docling Task API, which provides operations for managing and querying the status of asynchronous tasks.
doCodeEnrichment(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, perform OCR code enrichment.
DOCTAGS - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
DOCTAGS - Enum constant in enum class ai.docling.serve.api.convert.request.options.ResponseFormat
doctagsContent(String) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The document content in DocTags format.
doctagsContent(String) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Document content in DocTags format (if requested).
document(Document) - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
document(DocumentResponse) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder: Converted document content.
Document - Class in ai.docling.serve.api.chunk.response: Represents the document being processed by a Docling chunker.
Document.Builder - Class in ai.docling.serve.api.chunk.response: Builder for creating Document instances.
DocumentResponse - Class in ai.docling.serve.api.convert.response: A simple mutable POJO representing the converted document returned by the Docling Convert API.
DocumentResponse.Builder - Class in ai.docling.serve.api.convert.response: Builder for creating DocumentResponse instances.
documents(Collection<? extends Document>) - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
documentTimeout(Duration) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: The timeout for processing each document, in seconds.
DOCX - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
doFormulaEnrichment(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, perform formula OCR, return LaTeX code.
doOcr(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, the bitmap content will be processed using OCR.
doPictureClassification(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, classify pictures in documents.
doPictureDescription(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, describe pictures in documents.
doTableStructure(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, the table structure will be extracted.
DurationSerializationFormat - Annotation Interface in ai.docling.serve.api.serialization: Annotation to specify the formatting unit for durations.

E

EASYOCR - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
EMBEDDED - Enum constant in enum class ai.docling.serve.api.convert.request.options.ImageRefMode
endpoint(String) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: S3 service endpoint, without protocol.
endpoint(String) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: S3 service endpoint, without protocol.
ensureBetween(Double, double, double, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given Double value is in [min, max].
ensureBetween(Integer, int, int, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given Integer value is in [min, max].
ensureBetween(Long, long, long, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given Long value is in [min, max].
ensureEq(Object, Object, String, Object...) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensure that the two values are equal.
ensureGreaterThanZero(Double, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given expression is true.
ensureGreaterThanZero(Integer, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given expression is true.
ensureNotBlank(String, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given string is not null and not blank.
ensureNotBlank(String, String, Object...) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given string is not null and not blank.
ensureNotEmpty(String, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given string is not null and not empty.
ensureNotEmpty(String, String, Object...) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given string is not null and not empty.
ensureNotEmpty(Collection<T>, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given collection is not null and not empty.
ensureNotEmpty(Map<K, V>, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given map is not null and not empty.
ensureNotEmpty(T[], String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given array is not null and not empty.
ensureNotEmpty(T[], String, Object...) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given array is not null and not empty.
ensureNotNegative(Integer, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given integer is not negative.
ensureNotNull(T, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given object is not null.
ensureNotNull(T, String, Object...) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given object is not null.
ensurePositiveDuration(Duration, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given duration is positive.
ensureTrue(boolean, String) - Static method in class ai.docling.serve.api.util.ValidationUtils: Ensures that the given expression is true.
error(ErrorItem) - Method in class ai.docling.serve.api.chunk.response.Document.Builder
error(ErrorItem) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
errorDetail(ValidationErrorDetail) - Method in class ai.docling.serve.api.validation.ValidationError.Builder
errorDetails(Collection<? extends ValidationErrorDetail>) - Method in class ai.docling.serve.api.validation.ValidationError.Builder
ErrorItem - Class in ai.docling.serve.api.convert.response: Represents an individual error produced during document conversion.
ErrorItem.Builder - Class in ai.docling.serve.api.convert.response: Builder for creating ErrorItem instances.
errorMessage(String) - Method in class ai.docling.serve.api.convert.response.ErrorItem.Builder: Error message describing what went wrong.
errors(Collection<? extends ErrorItem>) - Method in class ai.docling.serve.api.chunk.response.Document.Builder
errors(Collection<? extends ErrorItem>) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
expectedSchemes(String) - Method in class ai.docling.serve.api.validation.ValidationErrorContext.Builder: Specifies the expected schemes relevant to a validation process.
ExportDocumentResponse - Class in ai.docling.serve.api.chunk.response: Content of the original converted document, before getting chunked.
ExportDocumentResponse.Builder - Class in ai.docling.serve.api.chunk.response: Builder for creating ExportDocumentResponse instances.
extraGenerationConfig(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder
extraGenerationConfig(String, Object) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder

F

FAILURE - Enum constant in enum class ai.docling.serve.api.task.response.TaskStatus
FAST - Enum constant in enum class ai.docling.serve.api.convert.request.options.TableFormerMode
filename(String) - Method in class ai.docling.serve.api.convert.request.source.FileSource.Builder: Filename of the uploaded document.
filename(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder: Filename of the source document.
filename(String) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The name of the original document file.
filename(String) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Filename of the source document.
fileName(String) - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse.Builder: Name of the ZIP archive file containing the converted documents.
FileSource - Class in ai.docling.serve.api.convert.request.source: Represents a file-based data source.
FileSource.Builder - Class in ai.docling.serve.api.convert.request.source: Builder for creating FileSource instances.
FileUtils - Class in ai.docling.serve.api.util: Utility class that provides file-related operations such as reading files and encoding file contents to Base64.
firstNotNull(String, T...) - Static method in class ai.docling.serve.api.util.Utils: Returns the first non-null value from the provided array of values.
forceOcr(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, replace existing text with OCR-generated text over content.
fromFormat(InputFormat) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
fromFormats(Collection<? extends InputFormat>) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder

G

generationConfig(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder
generationConfig(String, Object) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder
getAbortOnError() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Abort on error if enabled.
getAccessKey() - Method in class ai.docling.serve.api.convert.request.source.S3Source: S3 access key
getAccessKey() - Method in class ai.docling.serve.api.convert.request.target.S3Target: S3 access key
getBase64String() - Method in class ai.docling.serve.api.convert.request.source.FileSource: Content of the file serialized in base64.
getBucket() - Method in class ai.docling.serve.api.convert.request.source.S3Source: S3 bucket name
getBucket() - Method in class ai.docling.serve.api.convert.request.target.S3Target: S3 bucket name
getBuilder() - Method in interface ai.docling.serve.api.spi.DoclingServeApiBuilderFactory: Retrieves a builder instance for constructing implementations of DoclingServeApi.
getBytes(Path) - Static method in class ai.docling.serve.api.util.FileUtils: Reads the contents of the specified file and returns them as a byte array.
getCaptions() - Method in class ai.docling.serve.api.chunk.response.Chunk: List of captions for this chunk (e.g.
getChunkIndex() - Method in class ai.docling.serve.api.chunk.response.Chunk: Index of this chunk within the document.
getChunkingOptions() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest: Options specific to the chunker.
getChunkingOptions() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest: Options specific to the chunker.
getChunks() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse: List of document chunks.
getComponentType() - Method in class ai.docling.serve.api.convert.response.ErrorItem: Type of Docling component that encountered the error.
getConcurrency() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Maximum number of concurrent requests to the API.
getConcurrency() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Maximum number of concurrent requests to the API.
getContent() - Method in class ai.docling.serve.api.chunk.response.Document: The converted document content in various export formats.
getContext() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail: Represents the context information associated with a validation error.
getDocItems() - Method in class ai.docling.serve.api.chunk.response.Chunk: List of doc items references.
getDoCodeEnrichment() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, perform OCR code enrichment.
getDoctagsContent() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The document content in DocTags format.
getDoctagsContent() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Document content in DocTags format (if requested).
getDocument() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse: Converted document content.
getDocuments() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse: List of converted documents (if include_converted_doc was true).
getDocumentTimeout() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: The timeout for processing each document, in seconds.
getDoFormulaEnrichment() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, perform formula OCR, return LaTeX code.
getDoOcr() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, the bitmap content will be processed using OCR.
getDoPictureClassification() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, classify pictures in documents.
getDoPictureDescription() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, describe pictures in documents.
getDoTableStructure() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, the table structure will be extracted.
getEndpoint() - Method in class ai.docling.serve.api.convert.request.source.S3Source: S3 service endpoint, without protocol.
getEndpoint() - Method in class ai.docling.serve.api.convert.request.target.S3Target: S3 service endpoint, without protocol.
getErrorDetails() - Method in class ai.docling.serve.api.validation.ValidationError: A collection of validation error details associated with the validation error.
getErrorMessage() - Method in class ai.docling.serve.api.convert.response.ErrorItem: Error message describing what went wrong.
getErrors() - Method in class ai.docling.serve.api.chunk.response.Document: List of errors that occurred during document processing.
getErrors() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse: List of errors that occurred during conversion.
getExpectedSchemes() - Method in class ai.docling.serve.api.validation.ValidationErrorContext: Specifies the expected schemes relevant to a validation process.
getExtraGenerationConfig() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Config from https://huggingface.co/docs/transformers/en/main_classes/text_generation#transformers.GenerationConfig
getFilename() - Method in class ai.docling.serve.api.chunk.response.Chunk: Filename of the source document.
getFilename() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The name of the original document file.
getFilename() - Method in class ai.docling.serve.api.convert.request.source.FileSource: Filename of the uploaded document.
getFilename() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Filename of the source document.
getFileName() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse: Name of the ZIP archive file containing the converted documents.
getForceOcr() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, replace existing text with OCR-generated text over content.
getFromFormats() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Input format(s) to convert from.
getGenerationConfig() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal: Config from https://huggingface.co/docs/transformers/en/main_classes/text_generation#transformers.GenerationConfig
getHeaders() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Headers used for calling the API endpoint.
getHeaders() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Headers used for calling the API endpoint.
getHeaders() - Method in class ai.docling.serve.api.convert.request.source.HttpSource: Additional headers used to fetch the urls, e.g.
getHeadings() - Method in class ai.docling.serve.api.chunk.response.Chunk: List of headings for this chunk.
getHtmlContent() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The document content exported in HTML format.
getHtmlContent() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Document content in HTML format (if requested).
getImageExportMode() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Image export mode for the document (in case of JSON, Markdown or HTML).
getImagesScale() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Scale factor for images.
getIncludeImages() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If enabled, images will be extracted from the document.
getInferenceFramework() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Inference framework to use.
getInput() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail: Represents the input causing the validation error.
getInputStream() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse: Input stream for reading the ZIP archive contents.
getJsonContent() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The document content as a structured DoclingDocument JSON object.
getJsonContent() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Document content as DoclingDocument JSON (if requested).
getKeyPrefix() - Method in class ai.docling.serve.api.convert.request.source.S3Source: Prefix for the object keys on s3
getKeyPrefix() - Method in class ai.docling.serve.api.convert.request.target.S3Target: Prefix for the object keys on s3
getKind() - Method in class ai.docling.serve.api.chunk.response.Document: The type or kind of document.
getLocations() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail: Represents the specific locations associated with a validation error.
getMarkdownContent() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The document content exported in Markdown format.
getMarkdownContent() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Document content in Markdown format (if requested).
getMaxTokens() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions: Maximum number of tokens per chunk.
getMdPageBreakPlaceholder() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Add this placeholder between pages in the markdown output.
getMergePeers() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions: Merge undersized successive chunks with same headings.
getMessage() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail: Represents an optional validation error message.
getMetadata() - Method in class ai.docling.serve.api.chunk.response.Chunk: Additional metadata associated with this chunk.
getModuleName() - Method in class ai.docling.serve.api.convert.response.ErrorItem: Name of the module where the error occurred.
getNumConverted() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse: Number of attempted conversions
getNumDocs() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata: Total number of documents in the task.
getNumFailed() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse: Number of failed conversions
getNumFailed() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata: Number of documents that failed.
getNumProcessed() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata: Number of documents processed so far.
getNumSucceeded() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse: Number of successful conversions
getNumSucceeded() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata: Number of documents that succeeded.
getNumTokens() - Method in class ai.docling.serve.api.chunk.response.Chunk: Number of tokens in the text, if the chunker is aware of tokens.
getOcrEngine() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: The OCR engine to use.
getOcrLang() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: List of languages used by the OCR engine.
getOlderThen() - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest: The duration threshold after which data is considered stale and eligible for cleanup.
getOptions() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest: Conversion options.
getOptions() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest: Options controlling the document conversion process.
getOrDefault(T, Supplier<T>) - Static method in class ai.docling.serve.api.util.Utils: Returns the given value if it is not null, otherwise returns the value returned by the given supplier.
getOrDefault(List<T>, List<T>) - Static method in class ai.docling.serve.api.util.Utils: Returns the given list if it is not null and not empty, otherwise returns the given default list.
getOrDefault(Map<K, V>, Map<K, V>) - Static method in class ai.docling.serve.api.util.Utils: Returns the given map if it is not null and not empty, otherwise returns the given default map.
getOrDefault(T, T) - Static method in class ai.docling.serve.api.util.Utils: Returns the given value if it is not null, otherwise returns the given default value.
getPageNumbers() - Method in class ai.docling.serve.api.chunk.response.Chunk: Page numbers where this chunk content appears.
getPageRange() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Only convert a range of pages.
getParams() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Model parameters.
getParams() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Model parameters.
getPdfBackend() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: The PDF backend to use.
getPictureDescriptionApi() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: API details for using a vision-language model in the picture description.
getPictureDescriptionAreaThreshold() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Minimum percentage of the area for a picture to be processed with the models.
getPictureDescriptionLocal() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Options for running a local vision-language model in the picture description.
getPipeline() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Choose the pipeline to process PDF or image files.
getProcessingTime() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse: Total processing time in seconds.
getProcessingTime() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse: Total processing time in seconds.
getProcessingTime() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse: Total processing time in seconds.
getPrompt() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Prompt used when calling the vision-language model.
getPrompt() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal: Prompt used when calling the vision-language model.
getPrompt() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Prompt used when calling the vision-language model.
getPrompt() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Prompt used when calling the vision-language model.
getRawText() - Method in class ai.docling.serve.api.chunk.response.Chunk: Raw chunk text without additional formatting or context.
getRepoId() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal: Repository id from the Hugging Face Hub.
getRepoId() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Repository id from the Hugging Face Hub.
getResponseFormat() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Type of response generated by the model.
getResponseFormat() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Type of response generated by the model.
getResponseType() - Method in class ai.docling.serve.api.convert.response.ConvertDocumentResponse: Type of response
getResponseType() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse
getResponseType() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse
getResponseType() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse
getScale() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Scale factor of the images used.
getScale() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Scale factor of the images used.
getSecretKey() - Method in class ai.docling.serve.api.convert.request.source.S3Source: S3 secret key
getSecretKey() - Method in class ai.docling.serve.api.convert.request.target.S3Target: S3 secret key
getSources() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest: List of input document sources to process.
getSources() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest: List of document sources to be converted.
getStatus() - Method in class ai.docling.serve.api.chunk.response.Document: Processing status of the document.
getStatus() - Method in class ai.docling.serve.api.clear.response.ClearResponse: Status of the clear operation.
getStatus() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse: Conversion status (success, failure, partial_success, etc.).
getStatus() - Method in class ai.docling.serve.api.health.HealthCheckResponse: Health status of the API.
getTableCellMatching() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: If true, matches table cells predictions back to PDF cells.
getTableMode() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Mode to use for table structure, String.
getTarget() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest: Specification for the type of output target.
getTarget() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest: Target specification for where the converted document should be delivered.
getTaskId() - Method in class ai.docling.serve.api.task.request.TaskResultRequest: The unique identifier of the task whose result is being requested.
getTaskId() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest: The unique identifier of the task whose status is being polled.
getTaskId() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse: Unique task identifier.
getTaskPosition() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse: Position of task in the processing queue (if queued).
getTaskStatus() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse: Current status of the task.
getTaskStatusMetadata() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse: Metadata about task processing progress.
getTaskType() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse: Type of task (convert or chunk).
getText() - Method in class ai.docling.serve.api.chunk.response.Chunk: The chunk text with structural context (headers, formatting).
getTextContent() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse: The document content as plain text.
getTextContent() - Method in class ai.docling.serve.api.convert.response.DocumentResponse: Document content as plain text (if requested).
getTimeout() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Timeout for the API request.
getTimeout() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Timeout for the API request.
getTimings() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse: Detailed timing information for processing stages.
getToFormats() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Output format(s) to convert to.
getTokenizer() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions: HuggingFace model name for custom tokenization.
getTransformersModelType() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal: Type of transformers auto-model to use.
getType() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail: Represents the type of validation error.
getUrl() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi: Endpoint which accepts openai-api compatible requests.
getUrl() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi: Endpoint which accepts openai-api compatible requests.
getUrl() - Method in class ai.docling.serve.api.convert.request.source.HttpSource: HTTP url to process.
getUrl() - Method in class ai.docling.serve.api.convert.request.target.PutTarget: The URL to which the converted document should be uploaded via HTTP PUT.
getValidationError() - Method in exception ai.docling.serve.api.validation.ValidationException: Retrieves the ValidationError associated with this exception.
getVlmPipelineModel() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Preset of local and API models for the vlm pipeline.
getVlmPipelineModelApi() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: API details for using a vision-language model for the vlm pipeline.
getVlmPipelineModelLocal() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions: Options for running a local vision-language model for the vlm pipeline.
getWaitTime() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest: The duration to wait between consecutive polling attempts.
GOT_OCR_2 - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType
GRANITE_VISION - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType
GRANITE_VISION_OLLAMA - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType
GRANITE_VISION_VLLM - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType

H

header(String, Object) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
header(String, Object) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
header(String, Object) - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder
heading(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
headings(Collection<? extends String>) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
health() - Method in interface ai.docling.serve.api.DoclingServeHealthApi: Executes a health check for the API and retrieves the health status of the service.
HealthCheckResponse - Class in ai.docling.serve.api.health: Simple health check response returned by the API.
HealthCheckResponse.Builder - Class in ai.docling.serve.api.health: Builder for creating HealthCheckResponse instances.
HIERARCHICAL - Enum constant in enum class ai.docling.serve.api.chunk.request.ChunkType: Represents a hierarchical chunking type, which processes documents by breaking them into a nested structure of smaller chunks.
HierarchicalChunkDocumentRequest - Class in ai.docling.serve.api.chunk.request: Represents a request to convert a document and chunk it into smaller documents using the Docling hierarchical chunker.
HierarchicalChunkDocumentRequest(HierarchicalChunkDocumentRequest.Builder<?, ?>) - Constructor for class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest
HierarchicalChunkDocumentRequest.Builder<C extends HierarchicalChunkDocumentRequest,B extends HierarchicalChunkDocumentRequest.Builder<C,B>> - Class in ai.docling.serve.api.chunk.request
HierarchicalChunkDocumentRequest.HierarchicalChunkDocumentRequestBuilder - Class in ai.docling.serve.api.chunk.request: Builder for creating HierarchicalChunkDocumentRequest instances.
HierarchicalChunkDocumentRequestBuilder() - Constructor for class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.HierarchicalChunkDocumentRequestBuilder
HierarchicalChunkerOptions - Class in ai.docling.serve.api.chunk.request.options: Options for configuring the hierarchical chunker.
HierarchicalChunkerOptions.Builder - Class in ai.docling.serve.api.chunk.request.options: Builder for creating HierarchicalChunkerOptions instances.
HTML - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
HTML - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
HTML - Enum constant in enum class ai.docling.serve.api.convert.request.options.ResponseFormat
HTML_SPLIT_PAGE - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
htmlContent(String) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The document content exported in HTML format.
htmlContent(String) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Document content in HTML format (if requested).
HttpSource - Class in ai.docling.serve.api.convert.request.source: Represents an HTTP-based data source.
HttpSource.Builder - Class in ai.docling.serve.api.convert.request.source: Builder for creating HttpSource instances.
HYBRID - Enum constant in enum class ai.docling.serve.api.chunk.request.ChunkType: Represents a hybrid chunking type, which combines features of multiple chunking strategies to process documents in a flexible manner.
HybridChunkDocumentRequest - Class in ai.docling.serve.api.chunk.request: Represents a request to convert a document and chunk it into smaller documents using the Docling hybrid chunker.
HybridChunkDocumentRequest(HybridChunkDocumentRequest.Builder<?, ?>) - Constructor for class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest
HybridChunkDocumentRequest.Builder<C extends HybridChunkDocumentRequest,B extends HybridChunkDocumentRequest.Builder<C,B>> - Class in ai.docling.serve.api.chunk.request
HybridChunkDocumentRequest.HybridChunkDocumentRequestBuilder - Class in ai.docling.serve.api.chunk.request: Builder for creating HybridChunkDocumentRequest instances.
HybridChunkDocumentRequestBuilder() - Constructor for class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.HybridChunkDocumentRequestBuilder
HybridChunkerOptions - Class in ai.docling.serve.api.chunk.request.options: Options for configuring the hybrid chunker.
HybridChunkerOptions.Builder - Class in ai.docling.serve.api.chunk.request.options: Builder for creating HybridChunkerOptions instances.

I

IMAGE - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
imageExportMode(ImageRefMode) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Image export mode for the document (in case of JSON, Markdown or HTML).
ImageRefMode - Enum Class in ai.docling.serve.api.convert.request.options: The mode for how to handle image references in the document.
imagesScale(Double) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Scale factor for images.
IN_BODY - Enum constant in enum class ai.docling.serve.api.convert.response.ResponseType: Represents response type - InBodyConvertDocumentResponse
InBodyConvertDocumentResponse - Class in ai.docling.serve.api.convert.response: Response for single document conversions with in-body content delivery.
InBodyConvertDocumentResponse.Builder - Class in ai.docling.serve.api.convert.response: Builder for creating InBodyConvertDocumentResponse instances.
InBodyTarget - Class in ai.docling.serve.api.convert.request.target: Target for including the converted document in the response body.
InBodyTarget.Builder - Class in ai.docling.serve.api.convert.request.target: Builder for creating InBodyTarget instances.
includeConvertedDoc(boolean) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder: If true, the output will include both the chunks and the converted document.
includeImages(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If enabled, images will be extracted from the document.
includeRawText(boolean) - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions.Builder: Include both raw_text and text (contextualized) in response.
includeRawText(boolean) - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder: Include both raw_text and text (contextualized) in response.
inferenceFramework(VlmModelLocal.InferenceFramework) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Inference framework to use.
input(Object) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder: Represents the input causing the validation error.
InputFormat - Enum Class in ai.docling.serve.api.convert.request.options: A document format supported by document backend parsers.
inputStream(InputStream) - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse.Builder: Input stream for reading the ZIP archive contents.
isIncludeConvertedDoc() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest: If true, the output will include both the chunks and the converted document.
isIncludeRawText() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions: Include both raw_text and text (contextualized) in response.
isIncludeRawText() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions: Include both raw_text and text (contextualized) in response.
isNotNullOrBlank(String) - Static method in class ai.docling.serve.api.util.Utils: Is the given string not null and not blank?
isNotNullOrEmpty(String) - Static method in class ai.docling.serve.api.util.Utils: Is the given string not null and not empty ("")?
isNullOrBlank(String) - Static method in class ai.docling.serve.api.util.Utils: Is the given string null or blank?
isNullOrEmpty(Map<K, V>) - Static method in class ai.docling.serve.api.util.Utils: Is the map object null or empty?
isNullOrEmpty(Iterable<T>) - Static method in class ai.docling.serve.api.util.Utils: Is the iterable object null or empty?
isNullOrEmpty(String) - Static method in class ai.docling.serve.api.util.Utils: Is the given string null or empty ("")?
isNullOrEmpty(Collection<T>) - Static method in class ai.docling.serve.api.util.Utils: Is the collection null or empty?
isNullOrEmpty(T[]) - Static method in class ai.docling.serve.api.util.Utils: Utility method to check if an array is null or has no elements.
isUseMarkdownTables() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions: Use markdown table format instead of triplets for table serialization.
isUseMarkdownTables() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions: Use markdown table format instead of triplets for table serialization.
isVerifySsl() - Method in class ai.docling.serve.api.convert.request.source.S3Source: If enabled, SSL will be used to connect to s3.
isVerifySsl() - Method in class ai.docling.serve.api.convert.request.target.S3Target: If enabled, SSL will be used to connect to s3.

J

Jackson2DurationSerializer - Class in ai.docling.serve.api.serialization
Jackson2DurationSerializer() - Constructor for class ai.docling.serve.api.serialization.Jackson2DurationSerializer
Jackson2DurationSerializer(ChronoUnit) - Constructor for class ai.docling.serve.api.serialization.Jackson2DurationSerializer
Jackson3DurationSerializer - Class in ai.docling.serve.api.serialization
Jackson3DurationSerializer() - Constructor for class ai.docling.serve.api.serialization.Jackson3DurationSerializer
Jackson3DurationSerializer(ChronoUnit) - Constructor for class ai.docling.serve.api.serialization.Jackson3DurationSerializer
JSON - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
JSON_DOCLING - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
jsonContent(DoclingDocument) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The document content as a structured DoclingDocument JSON object.
jsonContent(DoclingDocument) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Document content as DoclingDocument JSON (if requested).

K

keyPrefix(String) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: Prefix for the object keys on s3
keyPrefix(String) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: Prefix for the object keys on s3
kind(String) - Method in class ai.docling.serve.api.chunk.response.Document.Builder: The type or kind of document.

L

loadFactories(Class<T>) - Static method in class ai.docling.serve.api.spi.ServiceLoaderHelper: Load all the services of a given type.
loadFactories(Class<T>, ClassLoader) - Static method in class ai.docling.serve.api.spi.ServiceLoaderHelper: Load all the services of a given type.
loadFactory(Class<T>) - Static method in class ai.docling.serve.api.spi.ServiceLoaderHelper: Load the first available service of a given type.
location(Object) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder
locations(Collection<? extends Object>) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder
logRequests() - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Enables logging of requests for the API client being built.
logRequests(boolean) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Configures whether logging of API requests is enabled or not.
logResponses() - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Enables logging of responses for the API client being built.
logResponses(boolean) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Configures whether logging of API responses is enabled or not.

M

MARKDOWN - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
MARKDOWN - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
MARKDOWN - Enum constant in enum class ai.docling.serve.api.convert.request.options.ResponseFormat
markdownContent(String) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The document content exported in Markdown format.
markdownContent(String) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Document content in Markdown format (if requested).
maxTokens(Integer) - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder: Maximum number of tokens per chunk.
mdPageBreakPlaceholder(String) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Add this placeholder between pages in the markdown output.
mergePeers(Boolean) - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder: Merge undersized successive chunks with same headings.
message(String) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder: Represents an optional validation error message.
metadata(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
metadata(String, Object) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
METS_GBS - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
MLX - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.InferenceFramework
moduleName(String) - Method in class ai.docling.serve.api.convert.response.ErrorItem.Builder: Name of the module where the error occurred.

N

numConverted(Integer) - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder: Number of attempted conversions
numDocs(Long) - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder: Total number of documents in the task.
numFailed(Integer) - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder: Number of failed conversions
numFailed(Long) - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder: Number of documents that failed.
numProcessed(Long) - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder: Number of documents processed so far.
numSucceeded(Integer) - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder: Number of successful conversions
numSucceeded(Long) - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder: Number of documents that succeeded.
numTokens(Integer) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder: Number of tokens in the text, if the chunker is aware of tokens.

O

ocrEngine(OcrEngine) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: The OCR engine to use.
OcrEngine - Enum Class in ai.docling.serve.api.convert.request.options: OCR engines supported by Docling.
ocrLang(Collection<? extends String>) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
ocrLang(String) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
OCRMAC - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
olderThen(Duration) - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest.Builder: The duration threshold after which data is considered stale and eligible for cleanup.
options(ConvertDocumentOptions) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder: Conversion options.
options(ConvertDocumentOptions) - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder: Options controlling the document conversion process.
OTSL - Enum constant in enum class ai.docling.serve.api.convert.request.options.ResponseFormat
OutputFormat - Enum Class in ai.docling.serve.api.convert.request.options: Document formats supported for output in Docling.

P

pageNumber(Integer) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
pageNumbers(Collection<? extends Integer>) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
pageRange(Collection<? extends Integer>) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
pageRange(Integer) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
param(String, Object) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
param(String, Object) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
params(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
params(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
PDF - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
pdfBackend(PdfBackend) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: The PDF backend to use.
PdfBackend - Enum Class in ai.docling.serve.api.convert.request.options: PDF backends supported by Docling.
PENDING - Enum constant in enum class ai.docling.serve.api.task.response.TaskStatus
pictureDescriptionApi(PictureDescriptionApi) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: API details for using a vision-language model in the picture description.
PictureDescriptionApi - Class in ai.docling.serve.api.convert.request.options: Configuration options for picture description API integration.
PictureDescriptionApi.Builder - Class in ai.docling.serve.api.convert.request.options: Builder for creating PictureDescriptionApi instances.
pictureDescriptionAreaThreshold(Double) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Minimum percentage of the area for a picture to be processed with the models.
pictureDescriptionLocal(PictureDescriptionLocal) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Options for running a local vision-language model in the picture description.
PictureDescriptionLocal - Class in ai.docling.serve.api.convert.request.options: Configuration for local picture description generation.
PictureDescriptionLocal.Builder - Class in ai.docling.serve.api.convert.request.options: Builder for creating PictureDescriptionLocal instances.
pipeline(ProcessingPipeline) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Choose the pipeline to process PDF or image files.
PLACEHOLDER - Enum constant in enum class ai.docling.serve.api.convert.request.options.ImageRefMode
PLAINTEXT - Enum constant in enum class ai.docling.serve.api.convert.request.options.ResponseFormat
pollTaskStatus(TaskStatusPollRequest) - Method in interface ai.docling.serve.api.DoclingServeTaskApi: Polls the status of an asynchronous task based on the provided request.
PPTX - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
PRE_SIGNED_URL - Enum constant in enum class ai.docling.serve.api.convert.response.ResponseType: Represents response type - PreSignedUrlConvertDocumentResponse
PreSignedUrlConvertDocumentResponse - Class in ai.docling.serve.api.convert.response: Response for document conversions with S3 or PUT target types.
PreSignedUrlConvertDocumentResponse.Builder - Class in ai.docling.serve.api.convert.response: Builder for creating PreSignedUrlConvertDocumentResponse instances.
prettyPrint() - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Configures the API client to format JSON requests and responses in a "pretty" format.
prettyPrint(boolean) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Configures whether the API client should format JSON requests and responses in a "pretty" format.
ProcessingPipeline - Enum Class in ai.docling.serve.api.convert.request.options: Pipelines used by Docling to process documents.
processingTime(Double) - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder: Total processing time in seconds.
processingTime(Double) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder: Total processing time in seconds.
processingTime(Double) - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder: Total processing time in seconds.
prompt(String) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder: Prompt used when calling the vision-language model.
prompt(String) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder: Prompt used when calling the vision-language model.
prompt(String) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Prompt used when calling the vision-language model.
prompt(String) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Prompt used when calling the vision-language model.
PutTarget - Class in ai.docling.serve.api.convert.request.target: A concrete Target implementation for delivering a converted document to a specified URI via an HTTP PUT operation.
PutTarget.Builder - Class in ai.docling.serve.api.convert.request.target: Builder for creating PutTarget instances.
PYPDFIUM2 - Enum constant in enum class ai.docling.serve.api.convert.request.options.PdfBackend

R

RAPIDOCR - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
rawText(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder: Raw chunk text without additional formatting or context.
readTimeout(Duration) - Method in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder: Timeout for receiving a response from the Docling Serve API.
REFERENCED - Enum constant in enum class ai.docling.serve.api.convert.request.options.ImageRefMode
repoId(String) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder: Repository id from the Hugging Face Hub.
repoId(String) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Repository id from the Hugging Face Hub.
responseFormat(ResponseFormat) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Type of response generated by the model.
responseFormat(ResponseFormat) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Type of response generated by the model.
ResponseFormat - Enum Class in ai.docling.serve.api.convert.request.options: Type of response generated by the model.
ResponseType - Enum Class in ai.docling.serve.api.convert.response: Defines the response type for document conversion operations.

S

S3Source - Class in ai.docling.serve.api.convert.request.source: Represents a data source located in S3.
S3Source.Builder - Class in ai.docling.serve.api.convert.request.source
S3Target - Class in ai.docling.serve.api.convert.request.target
S3Target.Builder - Class in ai.docling.serve.api.convert.request.target
scale(Integer) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Scale factor of the images used.
scale(Integer) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Scale factor of the images used.
secretKey(String) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: S3 secret key
secretKey(String) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: S3 secret key
self() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
self() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder
self() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder
serialize(Duration, JsonGenerator, SerializerProvider) - Method in class ai.docling.serve.api.serialization.Jackson2DurationSerializer
serialize(Duration, JsonGenerator, SerializationContext) - Method in class ai.docling.serve.api.serialization.Jackson3DurationSerializer
ServiceLoaderHelper - Class in ai.docling.serve.api.spi: Utility wrapper around ServiceLoader.load().
SMOLDOCLING - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType
SMOLDOCLING_VLLM - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelType
source(Source) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
source(Source) - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder
Source - Class in ai.docling.serve.api.convert.request.source: Source of the document.
Source() - Constructor for class ai.docling.serve.api.convert.request.source.Source
sources(Collection<? extends Source>) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
sources(Collection<? extends Source>) - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder
STANDARD - Enum constant in enum class ai.docling.serve.api.convert.request.options.ProcessingPipeline
STARTED - Enum constant in enum class ai.docling.serve.api.task.response.TaskStatus
status(String) - Method in class ai.docling.serve.api.clear.response.ClearResponse.Builder: Status of the clear operation.
status(String) - Method in class ai.docling.serve.api.health.HealthCheckResponse.Builder: Health status of the API.
status(String) - Method in class ai.docling.serve.api.chunk.response.Document.Builder: Processing status of the document.
status(String) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder: Conversion status (success, failure, partial_success, etc.).
SUCCESS - Enum constant in enum class ai.docling.serve.api.task.response.TaskStatus

T

tableCellMatching(Boolean) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: If true, matches table cells predictions back to PDF cells.
TableFormerMode - Enum Class in ai.docling.serve.api.convert.request.options: Modes for the TableFormer model.
tableMode(TableFormerMode) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Mode to use for table structure, String.
target(Target) - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder: Specification for the type of output target.
target(Target) - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder: Target specification for where the converted document should be delivered.
Target - Class in ai.docling.serve.api.convert.request.target: Represents an abstract target for defining where and how the converted document should be delivered.
Target() - Constructor for class ai.docling.serve.api.convert.request.target.Target
taskId(String) - Method in class ai.docling.serve.api.task.request.TaskResultRequest.Builder: The unique identifier of the task whose result is being requested.
taskId(String) - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest.Builder: The unique identifier of the task whose status is being polled.
taskId(String) - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder: Unique task identifier.
taskPosition(Long) - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder: Position of task in the processing queue (if queued).
TaskResultRequest - Class in ai.docling.serve.api.task.request: Represents a request to retrieve the result of a task.
TaskResultRequest.Builder - Class in ai.docling.serve.api.task.request
TaskResultRequest.TaskResultRequestBuilder - Class in ai.docling.serve.api.task.request: Builder for creating TaskResultRequest instances.
TaskResultRequestBuilder() - Constructor for class ai.docling.serve.api.task.request.TaskResultRequest.TaskResultRequestBuilder
taskStatus(TaskStatus) - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder: Current status of the task.
TaskStatus - Enum Class in ai.docling.serve.api.task.response: Represents the possible statuses of a Task within the system.
taskStatusMetadata(TaskStatusMetadata) - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder: Metadata about task processing progress.
TaskStatusMetadata - Class in ai.docling.serve.api.task.response: Represents metadata for the status of a task, providing detailed information about the task's progress and outcomes.
TaskStatusMetadata.Builder - Class in ai.docling.serve.api.task.response: Builder for creating TaskStatusMetadata instances.
TaskStatusPollRequest - Class in ai.docling.serve.api.task.request: Represents a request for polling the status of a task.
TaskStatusPollRequest.Builder - Class in ai.docling.serve.api.task.request
TaskStatusPollRequest.TaskStatusPollRequestBuilder - Class in ai.docling.serve.api.task.request: Builder for creating TaskStatusPollRequest instances.
TaskStatusPollRequestBuilder() - Constructor for class ai.docling.serve.api.task.request.TaskStatusPollRequest.TaskStatusPollRequestBuilder
TaskStatusPollResponse - Class in ai.docling.serve.api.task.response: Represents the response for polling the status of a task.
TaskStatusPollResponse.Builder - Class in ai.docling.serve.api.task.response: Builder for creating TaskStatusPollResponse instances.
taskType(String) - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder: Type of task (convert or chunk).
TESSERACT - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
TESSEROCR - Enum constant in enum class ai.docling.serve.api.convert.request.options.OcrEngine
text(String) - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder: The chunk text with structural context (headers, formatting).
TEXT - Enum constant in enum class ai.docling.serve.api.convert.request.options.OutputFormat
textContent(String) - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder: The document content as plain text.
textContent(String) - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder: Document content as plain text (if requested).
timeout(Duration) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder: Timeout for the API request.
timeout(Duration) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Timeout for the API request.
timing(String, Object) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
timings(Map<? extends String, ? extends Object>) - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
toBuilder() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest
toBuilder() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest
toBuilder() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions
toBuilder() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions
toBuilder() - Method in class ai.docling.serve.api.chunk.response.Chunk
toBuilder() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse
toBuilder() - Method in class ai.docling.serve.api.chunk.response.Document
toBuilder() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse
toBuilder() - Method in class ai.docling.serve.api.clear.request.ClearConvertersRequest
toBuilder() - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest
toBuilder() - Method in class ai.docling.serve.api.clear.response.ClearResponse
toBuilder() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest
toBuilder() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions
toBuilder() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi
toBuilder() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal
toBuilder() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi
toBuilder() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal
toBuilder() - Method in class ai.docling.serve.api.convert.request.source.FileSource
toBuilder() - Method in class ai.docling.serve.api.convert.request.source.HttpSource
toBuilder() - Method in class ai.docling.serve.api.convert.request.source.S3Source
toBuilder() - Method in class ai.docling.serve.api.convert.request.target.InBodyTarget
toBuilder() - Method in class ai.docling.serve.api.convert.request.target.PutTarget
toBuilder() - Method in class ai.docling.serve.api.convert.request.target.S3Target
toBuilder() - Method in class ai.docling.serve.api.convert.request.target.ZipTarget
toBuilder() - Method in class ai.docling.serve.api.convert.response.DocumentResponse
toBuilder() - Method in class ai.docling.serve.api.convert.response.ErrorItem
toBuilder() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse
toBuilder() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse
toBuilder() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse
toBuilder() - Method in interface ai.docling.serve.api.DoclingServeApi: Creates and returns a builder instance capable of constructing a duplicate or modified version of the current API instance.
toBuilder() - Method in class ai.docling.serve.api.health.HealthCheckResponse
toBuilder() - Method in class ai.docling.serve.api.task.request.TaskResultRequest
toBuilder() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest
toBuilder() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata
toBuilder() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse
toBuilder() - Method in class ai.docling.serve.api.validation.ValidationError
toBuilder() - Method in class ai.docling.serve.api.validation.ValidationErrorContext
toBuilder() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail
toFormat(OutputFormat) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
toFormats(Collection<? extends OutputFormat>) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
tokenizer(String) - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder: HuggingFace model name for custom tokenization.
toString() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest.Builder
toString() - Method in class ai.docling.serve.api.chunk.request.ChunkDocumentRequest
toString() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder
toString() - Method in class ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest
toString() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest.Builder
toString() - Method in class ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest
toString() - Method in class ai.docling.serve.api.chunk.request.options.ChunkerOptions
toString() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions.Builder
toString() - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions
toString() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder
toString() - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions
toString() - Method in class ai.docling.serve.api.chunk.response.Chunk.Builder
toString() - Method in class ai.docling.serve.api.chunk.response.Chunk
toString() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.chunk.response.ChunkDocumentResponse
toString() - Method in class ai.docling.serve.api.chunk.response.Document.Builder
toString() - Method in class ai.docling.serve.api.chunk.response.Document
toString() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.chunk.response.ExportDocumentResponse
toString() - Method in class ai.docling.serve.api.clear.request.ClearConvertersRequest.Builder
toString() - Method in class ai.docling.serve.api.clear.request.ClearConvertersRequest
toString() - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest.Builder
toString() - Method in class ai.docling.serve.api.clear.request.ClearResultsRequest
toString() - Method in class ai.docling.serve.api.clear.response.ClearResponse.Builder
toString() - Method in class ai.docling.serve.api.clear.response.ClearResponse
toString() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest.Builder
toString() - Method in class ai.docling.serve.api.convert.request.ConvertDocumentRequest
toString() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder
toString() - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions
toString() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder
toString() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi
toString() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal.Builder
toString() - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionLocal
toString() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder
toString() - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi
toString() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder
toString() - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal
toString() - Method in class ai.docling.serve.api.convert.request.source.FileSource.Builder
toString() - Method in class ai.docling.serve.api.convert.request.source.FileSource
toString() - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder
toString() - Method in class ai.docling.serve.api.convert.request.source.HttpSource
toString() - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder
toString() - Method in class ai.docling.serve.api.convert.request.source.S3Source
toString() - Method in class ai.docling.serve.api.convert.request.source.Source
toString() - Method in class ai.docling.serve.api.convert.request.target.InBodyTarget.Builder
toString() - Method in class ai.docling.serve.api.convert.request.target.InBodyTarget
toString() - Method in class ai.docling.serve.api.convert.request.target.PutTarget.Builder
toString() - Method in class ai.docling.serve.api.convert.request.target.PutTarget
toString() - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder
toString() - Method in class ai.docling.serve.api.convert.request.target.S3Target
toString() - Method in class ai.docling.serve.api.convert.request.target.Target
toString() - Method in class ai.docling.serve.api.convert.request.target.ZipTarget.Builder
toString() - Method in class ai.docling.serve.api.convert.request.target.ZipTarget
toString() - Method in class ai.docling.serve.api.convert.response.DocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.convert.response.DocumentResponse
toString() - Method in class ai.docling.serve.api.convert.response.ErrorItem.Builder
toString() - Method in class ai.docling.serve.api.convert.response.ErrorItem
toString() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.convert.response.InBodyConvertDocumentResponse
toString() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.convert.response.PreSignedUrlConvertDocumentResponse
toString() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse.Builder
toString() - Method in class ai.docling.serve.api.convert.response.ZipArchiveConvertDocumentResponse
toString() - Method in class ai.docling.serve.api.health.HealthCheckResponse.Builder
toString() - Method in class ai.docling.serve.api.health.HealthCheckResponse
toString() - Method in class ai.docling.serve.api.task.request.TaskResultRequest.Builder
toString() - Method in class ai.docling.serve.api.task.request.TaskResultRequest
toString() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest.Builder
toString() - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest
toString() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata.Builder
toString() - Method in class ai.docling.serve.api.task.response.TaskStatusMetadata
toString() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse.Builder
toString() - Method in class ai.docling.serve.api.task.response.TaskStatusPollResponse
toString() - Method in class ai.docling.serve.api.validation.ValidationError.Builder
toString() - Method in class ai.docling.serve.api.validation.ValidationError
toString() - Method in class ai.docling.serve.api.validation.ValidationErrorContext.Builder
toString() - Method in class ai.docling.serve.api.validation.ValidationErrorContext
toString() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder
toString() - Method in class ai.docling.serve.api.validation.ValidationErrorDetail
TRANSFORMERS - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.InferenceFramework
transformersModelType(VlmModelLocal.TransformersModelType) - Method in class ai.docling.serve.api.convert.request.options.VlmModelLocal.Builder: Type of transformers auto-model to use.
type(String) - Method in class ai.docling.serve.api.validation.ValidationErrorDetail.Builder: Represents the type of validation error.

U

url(URI) - Method in class ai.docling.serve.api.convert.request.options.PictureDescriptionApi.Builder: Endpoint which accepts openai-api compatible requests.
url(URI) - Method in class ai.docling.serve.api.convert.request.source.HttpSource.Builder: HTTP url to process.
url(URI) - Method in class ai.docling.serve.api.convert.request.target.PutTarget.Builder: The URL to which the converted document should be uploaded via HTTP PUT.
url(URI) - Method in class ai.docling.serve.api.convert.request.options.VlmModelApi.Builder: Endpoint which accepts openai-api compatible requests.
useMarkdownTables(boolean) - Method in class ai.docling.serve.api.chunk.request.options.HierarchicalChunkerOptions.Builder: Use markdown table format instead of triplets for table serialization.
useMarkdownTables(boolean) - Method in class ai.docling.serve.api.chunk.request.options.HybridChunkerOptions.Builder: Use markdown table format instead of triplets for table serialization.
Utils - Class in ai.docling.serve.api.util: Utility methods.

V

ValidationError - Class in ai.docling.serve.api.validation: Represents a validation error with customizable serialization and deserialization behavior.
ValidationError.Builder - Class in ai.docling.serve.api.validation: Builder class for constructing instances of the enclosing class.
ValidationErrorContext - Class in ai.docling.serve.api.validation: Represents the context information associated with a validation error.
ValidationErrorContext.Builder - Class in ai.docling.serve.api.validation: Builder class for constructing instances of the enclosing class.
ValidationErrorDetail - Class in ai.docling.serve.api.validation: Represents detailed information about a validation error.
ValidationErrorDetail.Builder - Class in ai.docling.serve.api.validation: Builder class for constructing instances of the enclosing class.
ValidationException - Exception in ai.docling.serve.api.validation: Represents an exception that is thrown when validation errors occur.
ValidationException(ValidationError) - Constructor for exception ai.docling.serve.api.validation.ValidationException: Constructs a new ValidationException with the specified ValidationError.
ValidationException(ValidationError, String) - Constructor for exception ai.docling.serve.api.validation.ValidationException: Constructs a new ValidationException with the specified ValidationError and message.
ValidationException(ValidationError, Throwable) - Constructor for exception ai.docling.serve.api.validation.ValidationException: Constructs a new ValidationException with the specified ValidationError and cause.
ValidationException(ValidationError, Throwable, String) - Constructor for exception ai.docling.serve.api.validation.ValidationException: Constructs a new ValidationException with the specified ValidationError, cause, and message.
ValidationUtils - Class in ai.docling.serve.api.util: Utility class for validating method arguments.
value() - Element in annotation interface ai.docling.serve.api.serialization.DurationSerializationFormat: Specifies the unit of time to be used for formatting durations.
valueOf(String) - Static method in enum class ai.docling.serve.api.chunk.request.ChunkType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.ImageRefMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.InputFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.OcrEngine: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.OutputFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.PdfBackend: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.ProcessingPipeline: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.ResponseFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.TableFormerMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.InferenceFramework: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.convert.response.ResponseType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.serve.api.task.response.TaskStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class ai.docling.serve.api.chunk.request.ChunkType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.ImageRefMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.InputFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.OcrEngine: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.OutputFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.PdfBackend: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.ProcessingPipeline: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.ResponseFormat: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.TableFormerMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.InferenceFramework: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.TransformersModelType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.request.options.VlmModelType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.convert.response.ResponseType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class ai.docling.serve.api.task.response.TaskStatus: Returns an array containing the constants of this enum class, in the order they are declared.
verifySsl(boolean) - Method in class ai.docling.serve.api.convert.request.source.S3Source.Builder: If enabled, SSL will be used to connect to s3.
verifySsl(boolean) - Method in class ai.docling.serve.api.convert.request.target.S3Target.Builder: If enabled, SSL will be used to connect to s3.
VLLM - Enum constant in enum class ai.docling.serve.api.convert.request.options.VlmModelLocal.InferenceFramework
VLM - Enum constant in enum class ai.docling.serve.api.convert.request.options.ProcessingPipeline
VlmModelApi - Class in ai.docling.serve.api.convert.request.options: API details for using a vision-language model for the VLM pipeline.
VlmModelApi.Builder - Class in ai.docling.serve.api.convert.request.options: Builder for creating VlmModelApi instances.
VlmModelLocal - Class in ai.docling.serve.api.convert.request.options: Options for running a local vision-language model for the VLM pipeline.
VlmModelLocal.Builder - Class in ai.docling.serve.api.convert.request.options: Builder for creating VlmModelLocal instances.
VlmModelLocal.InferenceFramework - Enum Class in ai.docling.serve.api.convert.request.options: Inference framework to use.
VlmModelLocal.TransformersModelType - Enum Class in ai.docling.serve.api.convert.request.options: Type of transformers auto-model to use.
VlmModelType - Enum Class in ai.docling.serve.api.convert.request.options: Local and API models for the VLM pipeline.
vlmPipelineModel(VlmModelType) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Preset of local and API models for the vlm pipeline.
vlmPipelineModelApi(String) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: API details for using a vision-language model for the vlm pipeline.
vlmPipelineModelLocal(String) - Method in class ai.docling.serve.api.convert.request.options.ConvertDocumentOptions.Builder: Options for running a local vision-language model for the vlm pipeline.

W

waitTime(Duration) - Method in class ai.docling.serve.api.task.request.TaskStatusPollRequest.Builder: The duration to wait between consecutive polling attempts.

X

XLSX - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
XML_JATS - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat
XML_USPTO - Enum constant in enum class ai.docling.serve.api.convert.request.options.InputFormat

Z

ZIP_ARCHIVE - Enum constant in enum class ai.docling.serve.api.convert.response.ResponseType: Represents response type - ZipArchiveConvertDocumentResponse
ZipArchiveConvertDocumentResponse - Class in ai.docling.serve.api.convert.response: Response for document conversions delivered as a ZIP archive.
ZipArchiveConvertDocumentResponse.Builder - Class in ai.docling.serve.api.convert.response: Builder for creating ZipArchiveConvertDocumentResponse instances.
ZipTarget - Class in ai.docling.serve.api.convert.request.target: Represents a specific Target that delivers the converted document as a zipped resource.
ZipTarget.Builder - Class in ai.docling.serve.api.convert.request.target: Builder for creating ZipTarget instances.

$ A B C D E F G H I J K L M N O P R S T U V W X Z
All Classes and Interfaces|All Packages|Serialized Form