Module ai.docling.serve.client

Package ai.docling.serve.client

Class DoclingServeClient

java.lang.Object

ai.docling.serve.client.DoclingServeClient

All Implemented Interfaces:

ai.docling.serve.api.DoclingServeApi

Direct Known Subclasses:

DoclingServeJackson2Client, DoclingServeJackson3Client

public abstract class DoclingServeClient
extends Object
implements ai.docling.serve.api.DoclingServeApi

Abstract class representing a client for interacting with the Docling API.

This class handles the foundational functionality needed to perform HTTP requests to the Docling API, with customizable base URL and HTTP client configurations. It provides abstract methods for JSON serialization and deserialization, allowing implementation-specific customization.

Concrete subclasses must implement readValue(String, Class) and writeValueAsString(Object) for serialization and deserialization behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DoclingServeClient.DoclingServeClientBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>>	Abstract base class for building instances of DoclingServeClient.

Nested classes/interfaces inherited from interface ai.docling.serve.api.DoclingServeApi

ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<T extends ai.docling.serve.api.DoclingServeApi,B extends ai.docling.serve.api.DoclingServeApi.DoclingApiBuilder<T,B>>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final URI	DEFAULT_BASE_URL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DoclingServeClient(DoclingServeClient.DoclingServeClientBuilder builder)

Method Summary

Modifier and Type	Method	Description
ai.docling.serve.api.chunk.response.ChunkDocumentResponse	chunkSourceWithHierarchicalChunker(ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest request)
ai.docling.serve.api.chunk.response.ChunkDocumentResponse	chunkSourceWithHybridChunker(ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest request)
ai.docling.serve.api.convert.response.ConvertDocumentResponse	convertSource(ai.docling.serve.api.convert.request.ConvertDocumentRequest request)
protected HttpRequest.Builder	createRequestBuilder(String uri)
protected <T> T	execute(HttpRequest request, Class<T> expectedValueType)
protected <O> O	executeGet(String uri, Class<O> expectedReturnType)
protected <I, O> O	executePost(String uri, I request, Class<O> expectedReturnType)
protected <T> T	getResponse(HttpResponse<String> response, Class<T> expectedReturnType)
ai.docling.serve.api.health.HealthCheckResponse	health()
protected void	logRequest(HttpRequest request)
protected void	logResponse(HttpResponse<String> response, Optional<String> responseBody)
protected abstract <T> T	readValue(String json, Class<T> valueType)	Reads and deserializes the given JSON string into an instance of the specified type.
protected abstract <T> String	writeValueAsString(T value)	Serializes the given object into its JSON string representation.

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

toBuilder

Field Details

DEFAULT_BASE_URL

protected static final URI DEFAULT_BASE_URL

Constructor Details

DoclingServeClient

protected DoclingServeClient(DoclingServeClient.DoclingServeClientBuilder builder)

Method Details

readValue

protected abstract <T> T readValue(String json,
 Class<T> valueType)

Reads and deserializes the given JSON string into an instance of the specified type.

Type Parameters:

T - the type of the object to be deserialized

Parameters:

json - the JSON string to deserialize; must not be null

valueType - the Class of the target type; must not be null

Returns:

an instance of T deserialized from the provided JSON

Throws:

RuntimeException - if the JSON parsing fails

writeValueAsString

protected abstract <T> String writeValueAsString(T value)

Serializes the given object into its JSON string representation.

Type Parameters:

T - the type of the object to serialize

Parameters:

value - the object to serialize; must not be null

Returns:

the JSON string representation of the given object

Throws:

RuntimeException - if serialization fails

logRequest

protected void logRequest(HttpRequest request)

logResponse

protected void logResponse(HttpResponse<String> response,
 Optional<String> responseBody)

execute

protected <T> T execute(HttpRequest request,
 Class<T> expectedValueType)

executePost

protected <I,
O> O executePost(String uri,
 I request,
 Class<O> expectedReturnType)

executeGet

protected <O> O executeGet(String uri,
 Class<O> expectedReturnType)

createRequestBuilder

protected HttpRequest.Builder createRequestBuilder(String uri)

getResponse

protected <T> T getResponse(HttpResponse<String> response,
 Class<T> expectedReturnType)

health

public ai.docling.serve.api.health.HealthCheckResponse health()

Specified by:

health in interface ai.docling.serve.api.DoclingServeApi

convertSource

public ai.docling.serve.api.convert.response.ConvertDocumentResponse convertSource(ai.docling.serve.api.convert.request.ConvertDocumentRequest request)

Specified by:

convertSource in interface ai.docling.serve.api.DoclingServeApi

chunkSourceWithHierarchicalChunker

public ai.docling.serve.api.chunk.response.ChunkDocumentResponse chunkSourceWithHierarchicalChunker(ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest request)

Specified by:

chunkSourceWithHierarchicalChunker in interface ai.docling.serve.api.DoclingServeApi

chunkSourceWithHybridChunker

public ai.docling.serve.api.chunk.response.ChunkDocumentResponse chunkSourceWithHybridChunker(ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest request)

Specified by:

chunkSourceWithHybridChunker in interface ai.docling.serve.api.DoclingServeApi