Package ai.docling.api.serve.convert.request.options

Class ConvertDocumentOptions.Builder

java.lang.Object

ai.docling.api.serve.convert.request.options.ConvertDocumentOptions.Builder

Enclosing class:

ConvertDocumentOptions

public static class ConvertDocumentOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ConvertDocumentOptions.Builder	abortOnError(@Nullable Boolean abortOnError)
ConvertDocumentOptions	build()
ConvertDocumentOptions.Builder	clearFromFormats()
ConvertDocumentOptions.Builder	clearOcrLang()
ConvertDocumentOptions.Builder	clearPageRange()
ConvertDocumentOptions.Builder	clearToFormats()
ConvertDocumentOptions.Builder	doCodeEnrichment(@Nullable Boolean doCodeEnrichment)
ConvertDocumentOptions.Builder	documentTimeout(@Nullable Duration documentTimeout)
ConvertDocumentOptions.Builder	doFormulaEnrichment(@Nullable Boolean doFormulaEnrichment)
ConvertDocumentOptions.Builder	doOcr(@Nullable Boolean doOcr)
ConvertDocumentOptions.Builder	doPictureClassification(@Nullable Boolean doPictureClassification)
ConvertDocumentOptions.Builder	doPictureDescription(@Nullable Boolean doPictureDescription)
ConvertDocumentOptions.Builder	doTableStructure(@Nullable Boolean doTableStructure)
ConvertDocumentOptions.Builder	forceOcr(@Nullable Boolean forceOcr)
ConvertDocumentOptions.Builder	fromFormat(InputFormat fromFormat)
ConvertDocumentOptions.Builder	fromFormats(Collection<? extends InputFormat> fromFormats)
ConvertDocumentOptions.Builder	imageExportMode(@Nullable ImageRefMode imageExportMode)
ConvertDocumentOptions.Builder	imagesScale(@Nullable Double imagesScale)
ConvertDocumentOptions.Builder	includeImages(@Nullable Boolean includeImages)
ConvertDocumentOptions.Builder	mdPageBreakPlaceholder(@Nullable String mdPageBreakPlaceholder)
ConvertDocumentOptions.Builder	ocrEngine(@Nullable OcrEngine ocrEngine)
ConvertDocumentOptions.Builder	ocrLang(String ocrLang)
ConvertDocumentOptions.Builder	ocrLang(Collection<? extends String> ocrLang)
ConvertDocumentOptions.Builder	pageRange(Integer pageRange)
ConvertDocumentOptions.Builder	pageRange(Collection<? extends Integer> pageRange)
ConvertDocumentOptions.Builder	pdfBackend(@Nullable PdfBackend pdfBackend)
ConvertDocumentOptions.Builder	pictureDescriptionApi(@Nullable PictureDescriptionApi pictureDescriptionApi)
ConvertDocumentOptions.Builder	pictureDescriptionAreaThreshold(@Nullable Double pictureDescriptionAreaThreshold)
ConvertDocumentOptions.Builder	pictureDescriptionLocal(@Nullable PictureDescriptionLocal pictureDescriptionLocal)
ConvertDocumentOptions.Builder	pipeline(@Nullable ProcessingPipeline pipeline)
ConvertDocumentOptions.Builder	tableCellMatching(@Nullable Boolean tableCellMatching)
ConvertDocumentOptions.Builder	tableMode(@Nullable TableFormerMode tableMode)
ConvertDocumentOptions.Builder	toFormat(OutputFormat toFormat)
ConvertDocumentOptions.Builder	toFormats(Collection<? extends OutputFormat> toFormats)
String	toString()
ConvertDocumentOptions.Builder	vlmPipelineModel(@Nullable VlmModelType vlmPipelineModel)
ConvertDocumentOptions.Builder	vlmPipelineModelApi(@Nullable String vlmPipelineModelApi)
ConvertDocumentOptions.Builder	vlmPipelineModelLocal(@Nullable String vlmPipelineModelLocal)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

fromFormat

public ConvertDocumentOptions.Builder fromFormat(InputFormat fromFormat)

fromFormats

public ConvertDocumentOptions.Builder fromFormats(Collection<? extends InputFormat> fromFormats)

clearFromFormats

public ConvertDocumentOptions.Builder clearFromFormats()

toFormat

public ConvertDocumentOptions.Builder toFormat(OutputFormat toFormat)

toFormats

public ConvertDocumentOptions.Builder toFormats(Collection<? extends OutputFormat> toFormats)

clearToFormats

public ConvertDocumentOptions.Builder clearToFormats()

imageExportMode

public ConvertDocumentOptions.Builder imageExportMode(@Nullable ImageRefMode imageExportMode)

Returns:

this.

doOcr

public ConvertDocumentOptions.Builder doOcr(@Nullable Boolean doOcr)

Returns:

this.

forceOcr

public ConvertDocumentOptions.Builder forceOcr(@Nullable Boolean forceOcr)

Returns:

this.

ocrEngine

public ConvertDocumentOptions.Builder ocrEngine(@Nullable OcrEngine ocrEngine)

Returns:

this.

ocrLang

public ConvertDocumentOptions.Builder ocrLang(String ocrLang)

ocrLang

public ConvertDocumentOptions.Builder ocrLang(Collection<? extends String> ocrLang)

clearOcrLang

public ConvertDocumentOptions.Builder clearOcrLang()

pdfBackend

public ConvertDocumentOptions.Builder pdfBackend(@Nullable PdfBackend pdfBackend)

Returns:

this.

tableMode

public ConvertDocumentOptions.Builder tableMode(@Nullable TableFormerMode tableMode)

Returns:

this.

tableCellMatching

public ConvertDocumentOptions.Builder tableCellMatching(@Nullable Boolean tableCellMatching)

Returns:

this.

pipeline

public ConvertDocumentOptions.Builder pipeline(@Nullable ProcessingPipeline pipeline)

Returns:

this.

pageRange

public ConvertDocumentOptions.Builder pageRange(Integer pageRange)

pageRange

public ConvertDocumentOptions.Builder pageRange(Collection<? extends Integer> pageRange)

clearPageRange

public ConvertDocumentOptions.Builder clearPageRange()

documentTimeout

public ConvertDocumentOptions.Builder documentTimeout(@Nullable Duration documentTimeout)

Returns:

this.

abortOnError

public ConvertDocumentOptions.Builder abortOnError(@Nullable Boolean abortOnError)

Returns:

this.

doTableStructure

public ConvertDocumentOptions.Builder doTableStructure(@Nullable Boolean doTableStructure)

Returns:

this.

includeImages

public ConvertDocumentOptions.Builder includeImages(@Nullable Boolean includeImages)

Returns:

this.

imagesScale

public ConvertDocumentOptions.Builder imagesScale(@Nullable Double imagesScale)

Returns:

this.

mdPageBreakPlaceholder

public ConvertDocumentOptions.Builder mdPageBreakPlaceholder(@Nullable String mdPageBreakPlaceholder)

Returns:

this.

doCodeEnrichment

public ConvertDocumentOptions.Builder doCodeEnrichment(@Nullable Boolean doCodeEnrichment)

Returns:

this.

doFormulaEnrichment

public ConvertDocumentOptions.Builder doFormulaEnrichment(@Nullable Boolean doFormulaEnrichment)

Returns:

this.

doPictureClassification

public ConvertDocumentOptions.Builder doPictureClassification(@Nullable Boolean doPictureClassification)

Returns:

this.

doPictureDescription

public ConvertDocumentOptions.Builder doPictureDescription(@Nullable Boolean doPictureDescription)

Returns:

this.

pictureDescriptionAreaThreshold

public ConvertDocumentOptions.Builder pictureDescriptionAreaThreshold(@Nullable Double pictureDescriptionAreaThreshold)

Returns:

this.

pictureDescriptionLocal

public ConvertDocumentOptions.Builder pictureDescriptionLocal(@Nullable PictureDescriptionLocal pictureDescriptionLocal)

Returns:

this.

pictureDescriptionApi

public ConvertDocumentOptions.Builder pictureDescriptionApi(@Nullable PictureDescriptionApi pictureDescriptionApi)

Returns:

this.

vlmPipelineModel

public ConvertDocumentOptions.Builder vlmPipelineModel(@Nullable VlmModelType vlmPipelineModel)

Returns:

this.

vlmPipelineModelLocal

public ConvertDocumentOptions.Builder vlmPipelineModelLocal(@Nullable String vlmPipelineModelLocal)

Returns:

this.

vlmPipelineModelApi

public ConvertDocumentOptions.Builder vlmPipelineModelApi(@Nullable String vlmPipelineModelApi)

Returns:

this.

build

public ConvertDocumentOptions build()

toString

public String toString()

Overrides:

toString in class Object