Module ai.docling.serve.client

Package ai.docling.serve.client

Class DoclingServeJackson2Client

java.lang.Object

ai.docling.serve.client.operations.HttpOperations

ai.docling.serve.client.DoclingServeClient

ai.docling.serve.client.DoclingServeJackson2Client

All Implemented Interfaces:

ai.docling.serve.api.DoclingServeApi, ai.docling.serve.api.DoclingServeChunkApi, ai.docling.serve.api.DoclingServeClearApi, ai.docling.serve.api.DoclingServeConvertApi, ai.docling.serve.api.DoclingServeHealthApi, ai.docling.serve.api.DoclingServeTaskApi

public class DoclingServeJackson2Client
extends DoclingServeClient

A specialized implementation of DoclingServeClient that integrates with the Jackson library for JSON serialization and deserialization using JsonMapper.

This client provides methods to convert objects to JSON strings and parse JSON strings into Java objects, leveraging the capabilities of Jackson's JsonMapper.

Instances of this client can be created through the DoclingServeJackson2Client.Builder by configuring properties such as the JsonMapper.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DoclingServeJackson2Client.Builder	A builder class for constructing instances of DoclingServeJackson2Client.

Nested classes/interfaces inherited from class ai.docling.serve.client.DoclingServeClient

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

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 inherited from class ai.docling.serve.client.DoclingServeClient

DEFAULT_BASE_URL

Fields inherited from class ai.docling.serve.client.operations.HttpOperations

API_KEY_HEADER_NAME

Method Summary

Modifier and Type	Method	Description
protected <T> T	readValue(String json, Class<T> valueType)	Reads and deserializes the given JSON string into an instance of the specified type.
DoclingServeJackson2Client.Builder	toBuilder()
protected <T> String	writeValueAsString(T value)	Serializes the given object into its JSON string representation.

Methods inherited from class ai.docling.serve.client.DoclingServeClient

chunkSourceWithHierarchicalChunker, chunkSourceWithHierarchicalChunkerAsync, chunkSourceWithHybridChunker, chunkSourceWithHybridChunkerAsync, chunkTaskResult, clearConverters, clearResults, convertSource, convertSourceAsync, convertTaskResult, createRequestBuilder, execute, executeGet, executePost, getResponse, health, logRequest, logResponse, pollTaskStatus, prettyPrintJson

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.DoclingServeChunkApi

chunkFiles, chunkFilesAsync, chunkFilesWithHierarchicalChunker, chunkFilesWithHierarchicalChunker, chunkFilesWithHierarchicalChunkerAsync, chunkFilesWithHierarchicalChunkerAsync, chunkFilesWithHybridChunker, chunkFilesWithHybridChunker, chunkFilesWithHybridChunkerAsync, chunkFilesWithHybridChunkerAsync

Methods inherited from interface ai.docling.serve.api.DoclingServeConvertApi

convertFiles, convertFiles, convertFilesAsync, convertFilesAsync

Method Details

toBuilder

public DoclingServeJackson2Client.Builder toBuilder()

readValue

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

Description copied from class: DoclingServeClient

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

Specified by:

readValue in class DoclingServeClient

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

writeValueAsString

protected <T> String writeValueAsString(T value)

Description copied from class: DoclingServeClient

Serializes the given object into its JSON string representation.

Specified by:

writeValueAsString in class DoclingServeClient

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