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

Class BatchConvertDocumentRequest.Builder

java.lang.Object

ai.docling.serve.api.convert.request.BatchConvertDocumentRequest.Builder

Enclosing class:

BatchConvertDocumentRequest

public static class BatchConvertDocumentRequest.Builder
extends Object

Builder for creating BatchConvertDocumentRequest instances. Generated by Lombok's @Builder annotation.

Builder methods:

• source(Source) - Add a single document source
• sources(List<Source>) - Set the list of document sources
• target(Target) - Set the output target
• options(ConvertDocumentOptions) - Set the conversion options
• callback(CallbackSpec) - Add a single callback specification
• callbacks(List<CallbackSpec>) - Set the list of callback specifications

Method Summary

Modifier and Type	Method	Description
@NonNull BatchConvertDocumentRequest	build()
@NonNull BatchConvertDocumentRequest.Builder	callback(CallbackSpec callback)
@NonNull BatchConvertDocumentRequest.Builder	callbacks(@NonNull Collection<? extends CallbackSpec> callbacks)
@NonNull BatchConvertDocumentRequest.Builder	clearCallbacks()
@NonNull BatchConvertDocumentRequest.Builder	clearSources()
@NonNull BatchConvertDocumentRequest.Builder	options(@NonNull ConvertDocumentOptions options)	Options controlling the document conversion process.
@NonNull BatchConvertDocumentRequest.Builder	source(Source source)
@NonNull BatchConvertDocumentRequest.Builder	sources(@NonNull Collection<? extends Source> sources)
@NonNull BatchConvertDocumentRequest.Builder	target(@NonNull Target target)	Target specification for where the converted documents should be delivered.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

source

public @NonNull BatchConvertDocumentRequest.Builder source(Source source)

sources

public @NonNull BatchConvertDocumentRequest.Builder sources(@NonNull Collection<? extends Source> sources)

clearSources

public @NonNull BatchConvertDocumentRequest.Builder clearSources()

target

public @NonNull BatchConvertDocumentRequest.Builder target(@NonNull
 @NonNull Target target)

Target specification for where the converted documents should be delivered. Must be either a PresignedUrlTarget or S3Target.

Parameters:

target - the output target

Returns:

this.

options

public @NonNull BatchConvertDocumentRequest.Builder options(@NonNull
 @NonNull ConvertDocumentOptions options)

Options controlling the document conversion process. Includes settings for OCR, output formats, processing pipelines, and more.

Parameters:

options - the conversion options

Returns:

this.

callback

public @NonNull BatchConvertDocumentRequest.Builder callback(CallbackSpec callback)

callbacks

public @NonNull BatchConvertDocumentRequest.Builder callbacks(@NonNull Collection<? extends CallbackSpec> callbacks)

clearCallbacks

public @NonNull BatchConvertDocumentRequest.Builder clearCallbacks()

build

public @NonNull BatchConvertDocumentRequest build()

toString

public @NonNull String toString()

Overrides:

toString in class Object