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

Class BatchConvertDocumentRequest

java.lang.Object

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

public class BatchConvertDocumentRequest
extends Object

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.

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.Builder	Builder for creating BatchConvertDocumentRequest instances.

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.
List<Source>	getSources()	List of document sources to be converted.
@NonNull Target	getTarget()	Target specification for where the converted documents should be delivered.
@NonNull BatchConvertDocumentRequest.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static @NonNull BatchConvertDocumentRequest.Builder builder()

toBuilder

public @NonNull BatchConvertDocumentRequest.Builder toBuilder()

getSources

public List<Source> getSources()

List of document sources to be converted. Each source can be an HTTP URL or S3 reference.

Returns:

the list of document sources

getTarget

@NonNull
public @NonNull Target getTarget()

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

Returns:

the output target

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 Object