Index (docling-serve-api 0.1.4 API)

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

A

abortOnError(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
ACCURATE - Enum constant in enum class ai.docling.api.serve.convert.request.options.TableFormerMode
ai.docling.api.serve - package ai.docling.api.serve: Docling Java API.
ai.docling.api.serve.convert.request - package ai.docling.api.serve.convert.request
ai.docling.api.serve.convert.request.options - package ai.docling.api.serve.convert.request.options
ai.docling.api.serve.convert.request.source - package ai.docling.api.serve.convert.request.source
ai.docling.api.serve.convert.request.target - package ai.docling.api.serve.convert.request.target
ai.docling.api.serve.convert.response - package ai.docling.api.serve.convert.response
ai.docling.api.serve.health - package ai.docling.api.serve.health: Docling Serve - Health APIs.
ai.docling.api.serve.util - package ai.docling.api.serve.util
ASCIIDOC - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
ASR - Enum constant in enum class ai.docling.api.serve.convert.request.options.ProcessingPipeline
AUDIO - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
AUTOMODEL - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_CAUSALLM - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_IMAGETEXTTOTEXT - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.TransformersModelType
AUTOMODEL_VISION2SEQ - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.TransformersModelType

B

base64String(String) - Method in class ai.docling.api.serve.convert.request.source.FileSource.Builder
build() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
build() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
build() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
build() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
build() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
build() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
build() - Method in class ai.docling.api.serve.convert.request.source.FileSource.Builder
build() - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
build() - Method in class ai.docling.api.serve.convert.request.target.InBodyTarget.Builder
build() - Method in class ai.docling.api.serve.convert.request.target.PutTarget.Builder
build() - Method in class ai.docling.api.serve.convert.request.target.ZipTarget.Builder
build() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
build() - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
build() - Method in class ai.docling.api.serve.convert.response.ErrorItem.Builder
build() - Method in interface ai.docling.api.serve.DoclingServeApi.DoclingApiBuilder: Builds and returns an instance of the specified type, representing the completed configuration of the builder.
build() - Method in class ai.docling.api.serve.health.HealthCheckResponse.Builder
builder() - Static method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
builder() - Static method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
builder() - Static method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
builder() - Static method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
builder() - Static method in class ai.docling.api.serve.convert.request.options.VlmModelApi
builder() - Static method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
builder() - Static method in class ai.docling.api.serve.convert.request.source.FileSource
builder() - Static method in class ai.docling.api.serve.convert.request.source.HttpSource
builder() - Static method in class ai.docling.api.serve.convert.request.target.InBodyTarget
builder() - Static method in class ai.docling.api.serve.convert.request.target.PutTarget
builder() - Static method in class ai.docling.api.serve.convert.request.target.ZipTarget
builder() - Static method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
builder() - Static method in class ai.docling.api.serve.convert.response.DocumentResponse
builder() - Static method in class ai.docling.api.serve.convert.response.ErrorItem
builder() - Static method in class ai.docling.api.serve.health.HealthCheckResponse

C

clearErrors() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
clearExtraGenerationConfig() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
clearFromFormats() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
clearGenerationConfig() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
clearHeaders() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
clearHeaders() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
clearHeaders() - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
clearJsonContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
clearOcrLang() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
clearPageRange() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
clearParams() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
clearParams() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
clearSources() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
clearTimings() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
clearToFormats() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
componentType(String) - Method in class ai.docling.api.serve.convert.response.ErrorItem.Builder
concurrency(Integer) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
concurrency(Integer) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
ConvertDocumentOptions - Class in ai.docling.api.serve.convert.request.options: Options for configuring the document conversion process with Docling.
ConvertDocumentOptions.Builder - Class in ai.docling.api.serve.convert.request.options
ConvertDocumentRequest - Class in ai.docling.api.serve.convert.request: Represents a request to convert a document.
ConvertDocumentRequest.Builder - Class in ai.docling.api.serve.convert.request
ConvertDocumentResponse - Class in ai.docling.api.serve.convert.response: Response returned by the Convert API for a single conversion request.
ConvertDocumentResponse.Builder - Class in ai.docling.api.serve.convert.response
convertSource(ConvertDocumentRequest) - Method in interface ai.docling.api.serve.DoclingServeApi: Converts the provided document source(s) into a processed document based on the specified options.
CSV - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat

D

DLPARSE_V1 - Enum constant in enum class ai.docling.api.serve.convert.request.options.PdfBackend
DLPARSE_V2 - Enum constant in enum class ai.docling.api.serve.convert.request.options.PdfBackend
DLPARSE_V4 - Enum constant in enum class ai.docling.api.serve.convert.request.options.PdfBackend
DoclingServeApi - Interface in ai.docling.api.serve: Docling Serve API interface.
DoclingServeApi.DoclingApiBuilder<T extends DoclingServeApi,B extends DoclingServeApi.DoclingApiBuilder<T,B>> - Interface in ai.docling.api.serve: A builder interface for constructing implementations of DoclingServeApi.
doCodeEnrichment(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
DOCTAGS - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
DOCTAGS - Enum constant in enum class ai.docling.api.serve.convert.request.options.ResponseFormat
doctagsContent(String) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
document(DocumentResponse) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
DocumentResponse - Class in ai.docling.api.serve.convert.response: A simple mutable POJO representing the converted document returned by the Docling Convert API.
DocumentResponse.Builder - Class in ai.docling.api.serve.convert.response
documentTimeout(Duration) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
DOCX - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
doFormulaEnrichment(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
doOcr(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
doPictureClassification(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
doPictureDescription(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
doTableStructure(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder

E

EASYOCR - Enum constant in enum class ai.docling.api.serve.convert.request.options.OcrEngine
EMBEDDED - Enum constant in enum class ai.docling.api.serve.convert.request.options.ImageRefMode
ensureBetween(Double, double, double, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given Double value is in [min, max].
ensureBetween(Integer, int, int, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given Integer value is in [min, max].
ensureBetween(Long, long, long, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given Long value is in [min, max].
ensureEq(Object, Object, String, Object...) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensure that the two values are equal.
ensureGreaterThanZero(Double, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given expression is true.
ensureGreaterThanZero(Integer, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given expression is true.
ensureNotBlank(String, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given string is not null and not blank.
ensureNotBlank(String, String, Object...) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given string is not null and not blank.
ensureNotEmpty(String, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given string is not null and not empty.
ensureNotEmpty(String, String, Object...) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given string is not null and not empty.
ensureNotEmpty(Collection<T>, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given collection is not null and not empty.
ensureNotEmpty(Map<K, V>, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given map is not null and not empty.
ensureNotEmpty(T[], String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given array is not null and not empty.
ensureNotEmpty(T[], String, Object...) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given array is not null and not empty.
ensureNotNegative(Integer, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given integer is not negative.
ensureNotNull(T, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given object is not null.
ensureNotNull(T, String, Object...) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given object is not null.
ensureTrue(boolean, String) - Static method in class ai.docling.api.serve.util.ValidationUtils: Ensures that the given expression is true.
error(ErrorItem) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
ErrorItem - Class in ai.docling.api.serve.convert.response: Represents an individual error produced during document conversion.
ErrorItem.Builder - Class in ai.docling.api.serve.convert.response
errorMessage(String) - Method in class ai.docling.api.serve.convert.response.ErrorItem.Builder
errors(Collection<? extends ErrorItem>) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
extraGenerationConfig(String, Object) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
extraGenerationConfig(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder

F

FAST - Enum constant in enum class ai.docling.api.serve.convert.request.options.TableFormerMode
filename(String) - Method in class ai.docling.api.serve.convert.request.source.FileSource.Builder
filename(String) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
FileSource - Class in ai.docling.api.serve.convert.request.source: Represents a file-based data source.
FileSource.Builder - Class in ai.docling.api.serve.convert.request.source
firstNotNull(String, T...) - Static method in class ai.docling.api.serve.util.Utils: Returns the first non-null value from the provided array of values.
forceOcr(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
fromFormat(InputFormat) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
fromFormats(Collection<? extends InputFormat>) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder

G

generationConfig(String, Object) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
generationConfig(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
getAbortOnError() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getBase64String() - Method in class ai.docling.api.serve.convert.request.source.FileSource
getComponentType() - Method in class ai.docling.api.serve.convert.response.ErrorItem
getConcurrency() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getConcurrency() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getDoCodeEnrichment() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoctagsContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getDocument() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
getDocumentTimeout() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoFormulaEnrichment() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoOcr() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoPictureClassification() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoPictureDescription() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getDoTableStructure() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getErrorMessage() - Method in class ai.docling.api.serve.convert.response.ErrorItem
getErrors() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
getExtraGenerationConfig() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getFilename() - Method in class ai.docling.api.serve.convert.request.source.FileSource
getFilename() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getForceOcr() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getFromFormats() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getGenerationConfig() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
getHeaders() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getHeaders() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getHeaders() - Method in class ai.docling.api.serve.convert.request.source.HttpSource
getHtmlContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getImageExportMode() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getImagesScale() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getIncludeImages() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getInferenceFramework() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getJsonContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getMarkdownContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getMdPageBreakPlaceholder() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getModuleName() - Method in class ai.docling.api.serve.convert.response.ErrorItem
getOcrEngine() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getOcrLang() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getOptions() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
getOrDefault(T, Supplier<T>) - Static method in class ai.docling.api.serve.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.api.serve.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.api.serve.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.api.serve.util.Utils: Returns the given value if it is not null, otherwise returns the given default value.
getPageRange() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getParams() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getParams() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getPdfBackend() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getPictureDescriptionApi() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getPictureDescriptionAreaThreshold() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getPictureDescriptionLocal() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getPipeline() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getProcessingTime() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
getPrompt() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getPrompt() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
getPrompt() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getPrompt() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getRepoId() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
getRepoId() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getResponseFormat() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getResponseFormat() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getScale() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getScale() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getSources() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
getStatus() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
getStatus() - Method in class ai.docling.api.serve.health.HealthCheckResponse
getTableCellMatching() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getTableMode() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getTarget() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
getTextContent() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
getTimeout() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getTimeout() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getTimings() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
getToFormats() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getTransformersModelType() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
getUrl() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
getUrl() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
getUrl() - Method in class ai.docling.api.serve.convert.request.source.HttpSource
getUrl() - Method in class ai.docling.api.serve.convert.request.target.PutTarget
getVlmPipelineModel() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getVlmPipelineModelApi() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
getVlmPipelineModelLocal() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
GOT_OCR_2 - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType
GRANITE_VISION - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType
GRANITE_VISION_OLLAMA - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType
GRANITE_VISION_VLLM - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType

H

header(String, Object) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
header(String, Object) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
header(String, Object) - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
headers(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
health() - Method in interface ai.docling.api.serve.DoclingServeApi: Executes a health check for the API and retrieves the health status of the service.
HealthCheckResponse - Class in ai.docling.api.serve.health: Simple health check response returned by the API.
HealthCheckResponse.Builder - Class in ai.docling.api.serve.health
HTML - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
HTML - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
HTML - Enum constant in enum class ai.docling.api.serve.convert.request.options.ResponseFormat
HTML_SPLIT_PAGE - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
htmlContent(String) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
HttpSource - Class in ai.docling.api.serve.convert.request.source: Represents an HTTP-based data source.
HttpSource.Builder - Class in ai.docling.api.serve.convert.request.source

I

IMAGE - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
imageExportMode(ImageRefMode) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
ImageRefMode - Enum Class in ai.docling.api.serve.convert.request.options: The mode for how to handle image references in the document.
imagesScale(Double) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
InBodyTarget - Class in ai.docling.api.serve.convert.request.target: Target for including the converted document in the response body.
InBodyTarget.Builder - Class in ai.docling.api.serve.convert.request.target
includeImages(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
inferenceFramework(VlmModelLocal.InferenceFramework) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
InputFormat - Enum Class in ai.docling.api.serve.convert.request.options: A document format supported by document backend parsers.
isNotNullOrBlank(String) - Static method in class ai.docling.api.serve.util.Utils: Is the given string not null and not blank?
isNotNullOrEmpty(String) - Static method in class ai.docling.api.serve.util.Utils: Is the given string not null and not empty ("")?
isNullOrBlank(String) - Static method in class ai.docling.api.serve.util.Utils: Is the given string null or blank?
isNullOrEmpty(Map<K, V>) - Static method in class ai.docling.api.serve.util.Utils: Is the map object null or empty?
isNullOrEmpty(Iterable<T>) - Static method in class ai.docling.api.serve.util.Utils: Is the iterable object null or empty?
isNullOrEmpty(String) - Static method in class ai.docling.api.serve.util.Utils: Is the given string null or empty ("")?
isNullOrEmpty(Collection<T>) - Static method in class ai.docling.api.serve.util.Utils: Is the collection null or empty?
isNullOrEmpty(T[]) - Static method in class ai.docling.api.serve.util.Utils: Utility method to check if an array is null or has no elements.

J

JSON - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
JSON_DOCLING - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
jsonContent(String, Object) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
jsonContent(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder

L

logRequests() - Method in interface ai.docling.api.serve.DoclingServeApi.DoclingApiBuilder: Enables logging of requests for the API client being built.
logRequests(boolean) - Method in interface ai.docling.api.serve.DoclingServeApi.DoclingApiBuilder: Configures whether logging of API requests is enabled or not.
logResponses() - Method in interface ai.docling.api.serve.DoclingServeApi.DoclingApiBuilder: Enables logging of responses for the API client being built.
logResponses(boolean) - Method in interface ai.docling.api.serve.DoclingServeApi.DoclingApiBuilder: Configures whether logging of API responses is enabled or not.

M

MARKDOWN - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
MARKDOWN - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
MARKDOWN - Enum constant in enum class ai.docling.api.serve.convert.request.options.ResponseFormat
markdownContent(String) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
mdPageBreakPlaceholder(String) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
METS_GBS - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
MLX - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.InferenceFramework
moduleName(String) - Method in class ai.docling.api.serve.convert.response.ErrorItem.Builder

O

ocrEngine(OcrEngine) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
OcrEngine - Enum Class in ai.docling.api.serve.convert.request.options: OCR engines supported by Docling.
ocrLang(String) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
ocrLang(Collection<? extends String>) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
OCRMAC - Enum constant in enum class ai.docling.api.serve.convert.request.options.OcrEngine
options(ConvertDocumentOptions) - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
OTSL - Enum constant in enum class ai.docling.api.serve.convert.request.options.ResponseFormat
OutputFormat - Enum Class in ai.docling.api.serve.convert.request.options: Document formats supported for output in Docling.

P

pageRange(Integer) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
pageRange(Collection<? extends Integer>) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
param(String, Object) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
param(String, Object) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
params(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
params(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
PDF - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
pdfBackend(PdfBackend) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
PdfBackend - Enum Class in ai.docling.api.serve.convert.request.options: PDF backends supported by Docling.
pictureDescriptionApi(PictureDescriptionApi) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
PictureDescriptionApi - Class in ai.docling.api.serve.convert.request.options: Configuration options for picture description API integration.
PictureDescriptionApi.Builder - Class in ai.docling.api.serve.convert.request.options
pictureDescriptionAreaThreshold(Double) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
pictureDescriptionLocal(PictureDescriptionLocal) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
PictureDescriptionLocal - Class in ai.docling.api.serve.convert.request.options: Configuration for local picture description generation.
PictureDescriptionLocal.Builder - Class in ai.docling.api.serve.convert.request.options
pipeline(ProcessingPipeline) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
PLACEHOLDER - Enum constant in enum class ai.docling.api.serve.convert.request.options.ImageRefMode
PLAINTEXT - Enum constant in enum class ai.docling.api.serve.convert.request.options.ResponseFormat
PPTX - Enum constant in enum class ai.docling.api.serve.convert.request.options.InputFormat
ProcessingPipeline - Enum Class in ai.docling.api.serve.convert.request.options: Pipelines used by Docling to process documents.
processingTime(Double) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
prompt(String) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
prompt(String) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
prompt(String) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
prompt(String) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
PutTarget - Class in ai.docling.api.serve.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.api.serve.convert.request.target
PYPDFIUM2 - Enum constant in enum class ai.docling.api.serve.convert.request.options.PdfBackend

R

RAPIDOCR - Enum constant in enum class ai.docling.api.serve.convert.request.options.OcrEngine
REFERENCED - Enum constant in enum class ai.docling.api.serve.convert.request.options.ImageRefMode
repoId(String) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
repoId(String) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
responseFormat(ResponseFormat) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
responseFormat(ResponseFormat) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
ResponseFormat - Enum Class in ai.docling.api.serve.convert.request.options: Type of response generated by the model.

S

scale(Integer) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
scale(Integer) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
SMOLDOCLING - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType
SMOLDOCLING_VLLM - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelType
source(Source) - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
Source - Class in ai.docling.api.serve.convert.request.source: Source of the document.
Source() - Constructor for class ai.docling.api.serve.convert.request.source.Source
sources(Collection<? extends Source>) - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
STANDARD - Enum constant in enum class ai.docling.api.serve.convert.request.options.ProcessingPipeline
status(String) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
status(String) - Method in class ai.docling.api.serve.health.HealthCheckResponse.Builder

T

tableCellMatching(Boolean) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
TableFormerMode - Enum Class in ai.docling.api.serve.convert.request.options: Modes for the TableFormer model.
tableMode(TableFormerMode) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
target(Target) - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
Target - Class in ai.docling.api.serve.convert.request.target: Represents an abstract target for defining where and how the converted document should be delivered.
Target() - Constructor for class ai.docling.api.serve.convert.request.target.Target
TESSERACT - Enum constant in enum class ai.docling.api.serve.convert.request.options.OcrEngine
TESSEROCR - Enum constant in enum class ai.docling.api.serve.convert.request.options.OcrEngine
TEXT - Enum constant in enum class ai.docling.api.serve.convert.request.options.OutputFormat
textContent(String) - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
timeout(Duration) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
timeout(Duration) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
timing(String, Object) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
timings(Map<? extends String, ? extends Object>) - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
toBuilder() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
toBuilder() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
toBuilder() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
toBuilder() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
toBuilder() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
toBuilder() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
toBuilder() - Method in class ai.docling.api.serve.convert.request.source.FileSource
toBuilder() - Method in class ai.docling.api.serve.convert.request.source.HttpSource
toBuilder() - Method in class ai.docling.api.serve.convert.request.target.InBodyTarget
toBuilder() - Method in class ai.docling.api.serve.convert.request.target.PutTarget
toBuilder() - Method in class ai.docling.api.serve.convert.request.target.ZipTarget
toBuilder() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
toBuilder() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
toBuilder() - Method in class ai.docling.api.serve.convert.response.ErrorItem
toBuilder() - Method in interface ai.docling.api.serve.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.api.serve.health.HealthCheckResponse
toFormat(OutputFormat) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
toFormats(Collection<? extends OutputFormat>) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
toString() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest.Builder
toString() - Method in class ai.docling.api.serve.convert.request.ConvertDocumentRequest
toString() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
toString() - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions
toString() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
toString() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi
toString() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal.Builder
toString() - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionLocal
toString() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
toString() - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi
toString() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder
toString() - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal
toString() - Method in class ai.docling.api.serve.convert.request.source.FileSource.Builder
toString() - Method in class ai.docling.api.serve.convert.request.source.FileSource
toString() - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
toString() - Method in class ai.docling.api.serve.convert.request.source.HttpSource
toString() - Method in class ai.docling.api.serve.convert.request.source.Source
toString() - Method in class ai.docling.api.serve.convert.request.target.InBodyTarget.Builder
toString() - Method in class ai.docling.api.serve.convert.request.target.InBodyTarget
toString() - Method in class ai.docling.api.serve.convert.request.target.PutTarget.Builder
toString() - Method in class ai.docling.api.serve.convert.request.target.PutTarget
toString() - Method in class ai.docling.api.serve.convert.request.target.Target
toString() - Method in class ai.docling.api.serve.convert.request.target.ZipTarget.Builder
toString() - Method in class ai.docling.api.serve.convert.request.target.ZipTarget
toString() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse.Builder
toString() - Method in class ai.docling.api.serve.convert.response.ConvertDocumentResponse
toString() - Method in class ai.docling.api.serve.convert.response.DocumentResponse.Builder
toString() - Method in class ai.docling.api.serve.convert.response.DocumentResponse
toString() - Method in class ai.docling.api.serve.convert.response.ErrorItem.Builder
toString() - Method in class ai.docling.api.serve.convert.response.ErrorItem
toString() - Method in class ai.docling.api.serve.health.HealthCheckResponse.Builder
toString() - Method in class ai.docling.api.serve.health.HealthCheckResponse
TRANSFORMERS - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.InferenceFramework
transformersModelType(VlmModelLocal.TransformersModelType) - Method in class ai.docling.api.serve.convert.request.options.VlmModelLocal.Builder

U

url(URI) - Method in class ai.docling.api.serve.convert.request.options.PictureDescriptionApi.Builder
url(URI) - Method in class ai.docling.api.serve.convert.request.source.HttpSource.Builder
url(URI) - Method in class ai.docling.api.serve.convert.request.target.PutTarget.Builder
url(URI) - Method in class ai.docling.api.serve.convert.request.options.VlmModelApi.Builder
Utils - Class in ai.docling.api.serve.util: Utility methods.

V

ValidationUtils - Class in ai.docling.api.serve.util: Utility class for validating method arguments.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.ImageRefMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.InputFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.OcrEngine: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.OutputFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.PdfBackend: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.ProcessingPipeline: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.ResponseFormat: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.convert.request.options.TableFormerMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class ai.docling.api.serve.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.api.serve.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.api.serve.convert.request.options.VlmModelType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class ai.docling.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.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.api.serve.convert.request.options.VlmModelType: Returns an array containing the constants of this enum class, in the order they are declared.
VLLM - Enum constant in enum class ai.docling.api.serve.convert.request.options.VlmModelLocal.InferenceFramework
VLM - Enum constant in enum class ai.docling.api.serve.convert.request.options.ProcessingPipeline
VlmModelApi - Class in ai.docling.api.serve.convert.request.options: API details for using a vision-language model for the VLM pipeline.
VlmModelApi.Builder - Class in ai.docling.api.serve.convert.request.options
VlmModelLocal - Class in ai.docling.api.serve.convert.request.options: Options for running a local vision-language model for the VLM pipeline.
VlmModelLocal.Builder - Class in ai.docling.api.serve.convert.request.options
VlmModelLocal.InferenceFramework - Enum Class in ai.docling.api.serve.convert.request.options: Inference framework to use.
VlmModelLocal.TransformersModelType - Enum Class in ai.docling.api.serve.convert.request.options: Type of transformers auto-model to use.
VlmModelType - Enum Class in ai.docling.api.serve.convert.request.options: Local and API models for the VLM pipeline.
vlmPipelineModel(VlmModelType) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
vlmPipelineModelApi(String) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder
vlmPipelineModelLocal(String) - Method in class ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder

X

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

Z

ZipTarget - Class in ai.docling.api.serve.convert.request.target: Represents a specific Target that delivers the converted document as a zipped resource.
ZipTarget.Builder - Class in ai.docling.api.serve.convert.request.target

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