Index

A B C D E G H J L N P R T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ai.docling.serve.client - module ai.docling.serve.client

ai.docling.serve.client - package ai.docling.serve.client

ai.docling.serve.client.operations - package ai.docling.serve.client.operations

API_KEY_HEADER_NAME - Static variable in class ai.docling.serve.client.operations.HttpOperations

The header name used to specify the API key in HTTP requests.

apiKey(String) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

AsyncOperations - Class in ai.docling.serve.client.operations

Abstract base class for managing asynchronous operations, providing methods to execute tasks asynchronously and poll for their status until completion.

AsyncOperations(HttpOperations, DoclingServeTaskApi, Duration, Duration) - Constructor for class ai.docling.serve.client.operations.AsyncOperations

asyncPollInterval(Duration) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

Sets the polling interval for async operations.

asyncTimeout(Duration) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

Sets the timeout for async operations.

B

baseUrl(String) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

Sets the base URL for the client.

baseUrl(URI) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

Sets the base URL for the client.

build() - Method in class ai.docling.serve.client.DoclingServeJackson2Client.Builder

Builds and returns a new DoclingServeJackson2Client instance with the configured properties.

build() - Method in class ai.docling.serve.client.DoclingServeJackson3Client.Builder

Builds and returns a new DoclingServeJackson3Client instance with the configured properties.

build() - Method in class ai.docling.serve.client.operations.RequestContext.Builder

Builds and returns a new RequestContext instance with the configured values.

builder() - Static method in class ai.docling.serve.client.operations.RequestContext

Creates a new Builder instance for constructing a RequestContext.

Builder() - Constructor for class ai.docling.serve.client.operations.RequestContext.Builder

Creates a new empty Builder instance.

Builder(RequestContext<I, O>) - Constructor for class ai.docling.serve.client.operations.RequestContext.Builder

Creates a new Builder instance initialized with values from the given RequestContext.

C

ChunkOperations - Class in ai.docling.serve.client.operations

Base class for document chunking API operations.

ChunkOperations(HttpOperations, DoclingServeTaskApi, Duration, Duration) - Constructor for class ai.docling.serve.client.operations.ChunkOperations

chunkSourceWithHierarchicalChunker(HierarchicalChunkDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

chunkSourceWithHierarchicalChunker(HierarchicalChunkDocumentRequest) - Method in class ai.docling.serve.client.operations.ChunkOperations

chunkSourceWithHierarchicalChunkerAsync(HierarchicalChunkDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

chunkSourceWithHierarchicalChunkerAsync(HierarchicalChunkDocumentRequest) - Method in class ai.docling.serve.client.operations.ChunkOperations

chunkSourceWithHybridChunker(HybridChunkDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

chunkSourceWithHybridChunker(HybridChunkDocumentRequest) - Method in class ai.docling.serve.client.operations.ChunkOperations

chunkSourceWithHybridChunkerAsync(HybridChunkDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

chunkSourceWithHybridChunkerAsync(HybridChunkDocumentRequest) - Method in class ai.docling.serve.client.operations.ChunkOperations

chunkTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.DoclingServeClient

chunkTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.operations.TaskOperations

Retrieves the chunked result of a completed task identified by the specified task ID.

clearConverters(ClearConvertersRequest) - Method in class ai.docling.serve.client.DoclingServeClient

clearConverters(ClearConvertersRequest) - Method in class ai.docling.serve.client.operations.ClearOperations

Clears all configured converters using the Docling Serve API.

ClearOperations - Class in ai.docling.serve.client.operations

Base class for clear API operations.

ClearOperations(HttpOperations) - Constructor for class ai.docling.serve.client.operations.ClearOperations

clearResults(ClearResultsRequest) - Method in class ai.docling.serve.client.DoclingServeClient

clearResults(ClearResultsRequest) - Method in class ai.docling.serve.client.operations.ClearOperations

Clears stale results retained by the service, based on the specified threshold duration.

ConvertOperations - Class in ai.docling.serve.client.operations

Base class for document conversion API operations.

ConvertOperations(HttpOperations, DoclingServeTaskApi, Duration, Duration) - Constructor for class ai.docling.serve.client.operations.ConvertOperations

Creates a new ConvertOperations instance.

convertSource(ConvertDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

convertSource(ConvertDocumentRequest) - Method in class ai.docling.serve.client.operations.ConvertOperations

convertSourceAsync(ConvertDocumentRequest) - Method in class ai.docling.serve.client.DoclingServeClient

convertSourceAsync(ConvertDocumentRequest) - Method in class ai.docling.serve.client.operations.ConvertOperations

convertTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.DoclingServeClient

convertTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.operations.TaskOperations

Retrieves the result of a completed task identified by the specified task ID.

createRequestBuilder(RequestContext<I, O>) - Method in class ai.docling.serve.client.DoclingServeClient

D

DEFAULT_BASE_URL - Static variable in class ai.docling.serve.client.DoclingServeClient

DoclingServeClient - Class in ai.docling.serve.client

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

DoclingServeClient(DoclingServeClient.DoclingServeClientBuilder) - Constructor for class ai.docling.serve.client.DoclingServeClient

DoclingServeClient.DoclingServeClientBuilder<C extends DoclingServeClient,B extends DoclingServeClient.DoclingServeClientBuilder<C,B>> - Class in ai.docling.serve.client

Abstract base class for building instances of DoclingServeClient.

DoclingServeClientBuilder() - Constructor for class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

Protected constructor for use by subclasses of DoclingServeClient.DoclingServeClientBuilder.

DoclingServeClientBuilder(DoclingServeClient) - Constructor for class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

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

DoclingServeClientBuilderFactory - Class in ai.docling.serve.client

A factory class for creating instances of DoclingServeClient.DoclingServeClientBuilder.

DoclingServeClientException - Exception in ai.docling.serve.client

Exception thrown when an error occurs during a client request to the Docling Serve API.

DoclingServeClientException(Throwable) - Constructor for exception ai.docling.serve.client.DoclingServeClientException

Constructs a new DoclingServeClientException with an optional cause.

DoclingServeClientException(Throwable, String) - Constructor for exception ai.docling.serve.client.DoclingServeClientException

Constructs a new DoclingServeClientException with the specified detail message.

DoclingServeClientException(String, int, String) - Constructor for exception ai.docling.serve.client.DoclingServeClientException

Constructs a new DoclingServeClientException with the specified detail message, HTTP status code, and response body.

DoclingServeJackson2Client - Class in ai.docling.serve.client

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

DoclingServeJackson2Client.Builder - Class in ai.docling.serve.client

A builder class for constructing instances of DoclingServeJackson2Client.

DoclingServeJackson3Client - Class in ai.docling.serve.client

A client implementation that leverages Jackson 3 for JSON serialization and deserialization.

DoclingServeJackson3Client.Builder - Class in ai.docling.serve.client

A builder class for configuring and constructing instances of DoclingServeJackson3Client.

E

execute(HttpRequest, Class<T>) - Method in class ai.docling.serve.client.DoclingServeClient

executeAsync(I, String) - Method in class ai.docling.serve.client.operations.AsyncOperations

Executes an asynchronous operation by sending a request to the specified URI and polling for the task completion.

executeGet(RequestContext<I, O>) - Method in class ai.docling.serve.client.DoclingServeClient

executeGet(RequestContext<I, O>) - Method in class ai.docling.serve.client.operations.HttpOperations

Executes an HTTP GET request using the details specified in the provided RequestContext.

executePost(RequestContext<I, O>) - Method in class ai.docling.serve.client.DoclingServeClient

executePost(RequestContext<I, O>) - Method in class ai.docling.serve.client.operations.HttpOperations

Executes an HTTP POST request using the details provided in the RequestContext.

G

getRequest() - Method in class ai.docling.serve.client.operations.RequestContext

Returns the request object.

getResponse(HttpRequest, HttpResponse<String>, Class<T>) - Method in class ai.docling.serve.client.DoclingServeClient

getResponseBody() - Method in exception ai.docling.serve.client.DoclingServeClientException

Retrieves the response body associated with this exception.

getResponseType() - Method in class ai.docling.serve.client.operations.RequestContext

Returns the response type class.

getStatusCode() - Method in exception ai.docling.serve.client.DoclingServeClientException

Retrieves the HTTP status code associated with this exception.

getTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.operations.AsyncOperations

Retrieves the result of a task based on the provided task result request.

getTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.operations.ChunkOperations

getTaskResult(TaskResultRequest) - Method in class ai.docling.serve.client.operations.ConvertOperations

getUri() - Method in class ai.docling.serve.client.operations.RequestContext

Returns the URI for the request.

H

health() - Method in class ai.docling.serve.client.DoclingServeClient

health() - Method in class ai.docling.serve.client.operations.HealthOperations

Executes a health check for the API and retrieves the health status of the service.

HealthOperations - Class in ai.docling.serve.client.operations

Base class for health API operations.

HealthOperations(HttpOperations) - Constructor for class ai.docling.serve.client.operations.HealthOperations

httpClientBuilder(HttpClient.Builder) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

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

HttpOperations - Class in ai.docling.serve.client.operations

Abstract base class for HTTP operations.

HttpOperations() - Constructor for class ai.docling.serve.client.operations.HttpOperations

J

jsonParser(JsonMapper.Builder) - Method in class ai.docling.serve.client.DoclingServeJackson2Client.Builder

Sets the JSON mapper builder to be used for creating the JSON mapper.

jsonParser(JsonMapper.Builder) - Method in class ai.docling.serve.client.DoclingServeJackson3Client.Builder

Sets the JSON mapper builder to be used for creating the JSON mapper.

L

logRequest(HttpRequest) - Method in class ai.docling.serve.client.DoclingServeClient

logRequests(boolean) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

logResponse(HttpResponse<String>, Optional<String>) - Method in class ai.docling.serve.client.DoclingServeClient

logResponses(boolean) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

N

newBuilder() - Static method in class ai.docling.serve.client.DoclingServeClientBuilderFactory

Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder that is compatible with the version of Jackson available on the application's classpath.

newBuilder(ClassLoader) - Static method in class ai.docling.serve.client.DoclingServeClientBuilderFactory

Creates and returns a new instance of a DoclingServeClient.DoclingServeClientBuilder compatible with the Jackson version present on the provided classloader's classpath.

P

pollTaskStatus(TaskStatusPollRequest) - Method in class ai.docling.serve.client.DoclingServeClient

pollTaskStatus(TaskStatusPollRequest) - Method in class ai.docling.serve.client.operations.TaskOperations

Polls the current status of a specified task.

prettyPrint(boolean) - Method in class ai.docling.serve.client.DoclingServeClient.DoclingServeClientBuilder

prettyPrintJson() - Method in class ai.docling.serve.client.DoclingServeClient

R

readValue(String, Class<T>) - Method in class ai.docling.serve.client.DoclingServeClient

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

readValue(String, Class<T>) - Method in class ai.docling.serve.client.DoclingServeJackson2Client

readValue(String, Class<T>) - Method in class ai.docling.serve.client.DoclingServeJackson3Client

request(I) - Method in class ai.docling.serve.client.operations.RequestContext.Builder

Sets the request object.

RequestContext<I,O> - Class in ai.docling.serve.client.operations

RequestContext.Builder<I,O> - Class in ai.docling.serve.client.operations

responseType(Class<O>) - Method in class ai.docling.serve.client.operations.RequestContext.Builder

Sets the response type class.

T

TaskOperations - Class in ai.docling.serve.client.operations

Base class for task API operations.

TaskOperations(HttpOperations) - Constructor for class ai.docling.serve.client.operations.TaskOperations

toBuilder() - Method in class ai.docling.serve.client.DoclingServeJackson2Client

toBuilder() - Method in class ai.docling.serve.client.DoclingServeJackson3Client

toBuilder() - Method in class ai.docling.serve.client.operations.RequestContext

Creates a new Builder instance initialized with the values from this RequestContext.

U

uri(String) - Method in class ai.docling.serve.client.operations.RequestContext.Builder

Sets the URI for the request.

W

writeValueAsString(T) - Method in class ai.docling.serve.client.DoclingServeClient

Serializes the given object into its JSON string representation.

writeValueAsString(T) - Method in class ai.docling.serve.client.DoclingServeJackson2Client

writeValueAsString(T) - Method in class ai.docling.serve.client.DoclingServeJackson3Client

A B C D E G H J L N P R T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form