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

Class ConvertDocumentRequest.Builder

java.lang.Object

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

Enclosing class:

ConvertDocumentRequest

public static class ConvertDocumentRequest.Builder
extends Object

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

Builder methods:

• source(Source) - Add a single document source (use with @Singular)
• sources(List<Source>) - Set the list of document sources
• options(ConvertDocumentOptions) - Set the conversion options
• target(Target) - Set the output target

Method Summary

Modifier and Type	Method	Description
@NonNull ConvertDocumentRequest	build()
@NonNull ConvertDocumentRequest.Builder	clearSources()
@NonNull ConvertDocumentRequest.Builder	options(@NonNull ConvertDocumentOptions options)	Options controlling the document conversion process.
@NonNull ConvertDocumentRequest.Builder	source(Source source)
@NonNull ConvertDocumentRequest.Builder	sources(@NonNull Collection<? extends Source> sources)
@NonNull ConvertDocumentRequest.Builder	target(@Nullable Target target)	Target specification for where the converted document 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 ConvertDocumentRequest.Builder source(Source source)

sources

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

clearSources

public @NonNull ConvertDocumentRequest.Builder clearSources()

options

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

target

public @NonNull ConvertDocumentRequest.Builder target(@Nullable Target target)

Target specification for where the converted document should be delivered. If not specified, the result is returned in the response body.

Parameters:

target - the output target, or null if not specified

Returns:

this.

build

public @NonNull ConvertDocumentRequest build()

toString

public @NonNull String toString()

Overrides:

toString in class Object