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

Class BatchConvertDocumentRequest

java.lang.Object

ai.docling.serve.api.request.DocumentRequest

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

public final class BatchConvertDocumentRequest
extends DocumentRequest

Represents a request to batch convert document sources. The batch endpoint processes multiple documents asynchronously and returns a task ID for tracking progress. Sources can be HTTP URLs or S3 buckets, and results are delivered to a presigned URL or S3 target.

Unlike ConvertDocumentRequest, the target is required for batch requests — it must be either a PresignedUrlTarget or S3Target.

This class is serialized into JSON to conform to the API specification using JsonProperty annotations. Fields with null values or empty collections are omitted from the serialized JSON using JsonInclude.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchConvertDocumentRequest.BatchConvertDocumentRequestBuilder<C extends BatchConvertDocumentRequest,B extends BatchConvertDocumentRequest.BatchConvertDocumentRequestBuilder<C,B>>
static class	BatchConvertDocumentRequest.Builder<C extends BatchConvertDocumentRequest,B extends BatchConvertDocumentRequest.Builder<C,B>>

Nested classes/interfaces inherited from class ai.docling.serve.api.request.DocumentRequest

DocumentRequest.DocumentRequestBuilder<C extends DocumentRequest,B extends DocumentRequest.DocumentRequestBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BatchConvertDocumentRequest(BatchConvertDocumentRequest.Builder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static @NonNull BatchConvertDocumentRequest.Builder<?,?>	builder()
List<CallbackSpec>	getCallbacks()	Webhook callbacks for receiving progress notifications during batch processing.
@NonNull ConvertDocumentOptions	getOptions()	Options controlling the document conversion process.
Target	getTarget()	Returns the output target, which is required for batch requests.
@NonNull BatchConvertDocumentRequest.Builder<?,?>	toBuilder()	Returns a builder pre-populated with this request's current field values, allowing a modified copy to be created.
@NonNull String	toString()

Methods inherited from class ai.docling.serve.api.request.DocumentRequest

getSources

Methods inherited from class java.lang.Object

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

Constructor Details

BatchConvertDocumentRequest

protected BatchConvertDocumentRequest(BatchConvertDocumentRequest.Builder<?,?> b)

Method Details

getTarget

public Target getTarget()

Returns the output target, which is required for batch requests.

Overrides:

getTarget in class DocumentRequest

Returns:

the output target, never null

builder

public static @NonNull BatchConvertDocumentRequest.Builder<?,?> builder()

toBuilder

public @NonNull BatchConvertDocumentRequest.Builder<?,?> toBuilder()

Description copied from class: DocumentRequest

Returns a builder pre-populated with this request's current field values, allowing a modified copy to be created. Each concrete subtype returns its own builder covariantly.

Specified by:

toBuilder in class DocumentRequest

Returns:

a builder initialized from this request

getOptions

@NonNull
public @NonNull ConvertDocumentOptions getOptions()

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

Returns:

the conversion options

getCallbacks

public List<CallbackSpec> getCallbacks()

Webhook callbacks for receiving progress notifications during batch processing.

Returns:

the list of callback specifications

toString

public @NonNull String toString()

Overrides:

toString in class DocumentRequest