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

Class ConvertDocumentRequest

java.lang.Object

ai.docling.serve.api.request.DocumentRequest

ai.docling.serve.api.convert.request.ConvertDocumentRequest

public final class ConvertDocumentRequest
extends DocumentRequest

Represents a request to convert a document. The request includes the source(s) of the document, options for the conversion process, and the target specification for the converted output.

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	ConvertDocumentRequest.Builder<C extends ConvertDocumentRequest,B extends ConvertDocumentRequest.Builder<C,B>>
static class	ConvertDocumentRequest.ConvertDocumentRequestBuilder<C extends ConvertDocumentRequest,B extends ConvertDocumentRequest.ConvertDocumentRequestBuilder<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	ConvertDocumentRequest(ConvertDocumentRequest.Builder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static @NonNull ConvertDocumentRequest.Builder<?,?>	builder()
@NonNull ConvertDocumentOptions	getOptions()	Options controlling the document conversion process.
@NonNull ConvertDocumentRequest.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, getTarget

Methods inherited from class java.lang.Object

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

Constructor Details

ConvertDocumentRequest

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

Method Details

builder

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

toBuilder

public @NonNull ConvertDocumentRequest.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

toString

public @NonNull String toString()

Overrides:

toString in class DocumentRequest