Module ai.docling.serve.client

Package ai.docling.serve.client

Class DoclingServeClient.DoclingServeClientBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

java.lang.Object

ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder<C,B>

Type Parameters:

C - the type of DoclingServeClient being built

B - the type of the builder implementation

All Implemented Interfaces:

ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C,B>

Direct Known Subclasses:

DoclingServeJackson2Client.Builder, DoclingServeJackson3Client.Builder

Enclosing class:

DoclingServeClient

public abstract static class DoclingServeClient.DoclingServeClientBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>
extends Object
implements ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C,B>

Abstract base class for building instances of DoclingServeClient.

This builder class provides methods for configuring shared properties such as the base URL and the HTTP client. Concrete subclasses may extend this builder to add additional configuration options.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DoclingServeClientBuilder()	Protected constructor for use by subclasses of DoclingServeClient.DoclingServeClientBuilder.
protected	DoclingServeClientBuilder(DoclingServeClient doclingClient)	Initializes a new DoclingServeClient.DoclingServeClientBuilder instance using the configuration from the provided DoclingServeClient.

Method Summary

Modifier and Type	Method	Description
B	apiKey(@Nullable String apiKey)
B	asyncPollInterval(Duration asyncPollInterval)	Sets the polling interval for async operations.
B	asyncTimeout(Duration asyncTimeout)	Sets the timeout for async operations.
B	baseUrl(URI baseUrl)	Sets the base URL for the client.
B	connectTimeout(Duration connectTimeout)
B	httpClientBuilder(HttpClient.Builder httpClientBuilder)	Sets the HTTP client builder to be used for creating the underlying HTTP client.
B	logRequests(boolean logRequests)
B	logResponses(boolean logResponses)
B	prettyPrint(boolean prettyPrint)
B	readTimeout(Duration readTimeout)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder

baseUrl, build, logRequests, logResponses, prettyPrint

Constructor Details

DoclingServeClientBuilder

protected DoclingServeClientBuilder()

Protected constructor for use by subclasses of DoclingServeClient.DoclingServeClientBuilder.

Initializes a new instance of the builder with default configuration values. This constructor ensures that the builder cannot be instantiated directly, promoting proper use and extension by subclasses.

DoclingServeClientBuilder

protected DoclingServeClientBuilder(DoclingServeClient doclingClient)

Initializes a new DoclingServeClient.DoclingServeClientBuilder instance using the configuration from the provided DoclingServeClient.

Parameters:

doclingClient - the DoclingServeClient whose configuration (e.g., base URL) will be used to initialize the builder

Method Details

baseUrl

public B baseUrl(URI baseUrl)

Sets the base URL for the client.

This method configures the base URL that will be used for all API requests executed by the client. The provided URL must be non-null.

Specified by:

baseUrl in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

Parameters:

baseUrl - the base URL to use, as a URI

Returns:

this builder instance for method chaining

Throws:

IllegalArgumentException - if baseUrl is null

httpClientBuilder

public B httpClientBuilder(HttpClient.Builder httpClientBuilder)

Sets the HTTP client builder to be used for creating the underlying HTTP client.

This allows customization of HTTP client properties such as timeouts, proxy settings, SSL context, and other connection parameters.

Parameters:

httpClientBuilder - the HttpClient.Builder to use

Returns:

this DoclingServeJackson3Client.Builder instance for method chaining

apiKey

public B apiKey(@Nullable String apiKey)

Specified by:

apiKey in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

logRequests

public B logRequests(boolean logRequests)

Specified by:

logRequests in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

logResponses

public B logResponses(boolean logResponses)

Specified by:

logResponses in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

prettyPrint

public B prettyPrint(boolean prettyPrint)

Specified by:

prettyPrint in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

connectTimeout

public B connectTimeout(Duration connectTimeout)

Specified by:

connectTimeout in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

readTimeout

public B readTimeout(Duration readTimeout)

Specified by:

readTimeout in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

asyncPollInterval

public B asyncPollInterval(Duration asyncPollInterval)

Sets the polling interval for async operations.

This configures how frequently the client will check the status of async conversion tasks when using DoclingServeConvertApi.convertSourceAsync(ConvertDocumentRequest) (ConvertDocumentRequest).

Specified by:

asyncPollInterval in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

Parameters:

asyncPollInterval - the polling interval (must not be null or negative)

Returns:

this builder instance for method chaining

asyncTimeout

public B asyncTimeout(Duration asyncTimeout)

Sets the timeout for async operations.

This configures the maximum time to wait for an async conversion task to complete when using DoclingServeConvertApi.convertSourceAsync(ConvertDocumentRequest) (ConvertDocumentRequest).

Specified by:

asyncTimeout in interface ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>

Parameters:

asyncTimeout - the timeout duration (must not be null or negative)

Returns:

this builder instance for method chaining