Package ai.docling.serve.api

Interface DoclingServeApi

public interface DoclingServeApi

Docling Serve API interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DoclingServeApi.DoclingApiBuilder<T extends DoclingServeApi,B extends DoclingServeApi.DoclingApiBuilder<T,B>>	A builder interface for constructing implementations of DoclingServeApi.

Method Summary

Modifier and Type	Method	Description
ChunkDocumentResponse	chunkSourceWithHierarchicalChunker(HierarchicalChunkDocumentRequest request)	Converts and chunks the provided document source(s) into a processed document based on the specified options and using a hierarchical chunker for splitting the document into smaller chunks.
ChunkDocumentResponse	chunkSourceWithHybridChunker(HybridChunkDocumentRequest request)	Converts and chunks the provided document source(s) into a processed document based on the specified options and using a hybrid chunker for splitting the document into smaller chunks.
ConvertDocumentResponse	convertSource(ConvertDocumentRequest request)	Converts the provided document source(s) into a processed document based on the specified options.
HealthCheckResponse	health()	Executes a health check for the API and retrieves the health status of the service.
<T extends DoclingServeApi, B extends DoclingServeApi.DoclingApiBuilder<T, B>> DoclingServeApi.DoclingApiBuilder<T,B>	toBuilder()	Creates and returns a builder instance capable of constructing a duplicate or modified version of the current API instance.

Method Details

health

HealthCheckResponse health()

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

Returns:

a HealthCheckResponse object containing the health status of the API.

convertSource

ConvertDocumentResponse convertSource(ConvertDocumentRequest request)

Converts the provided document source(s) into a processed document based on the specified options.

Parameters:

request - the ConvertDocumentRequest containing the source(s), conversion options, and optional target.

Returns:

a ConvertDocumentResponse containing the processed document data, processing details, and any errors.

chunkSourceWithHierarchicalChunker

ChunkDocumentResponse chunkSourceWithHierarchicalChunker(HierarchicalChunkDocumentRequest request)

Converts and chunks the provided document source(s) into a processed document based on the specified options and using a hierarchical chunker for splitting the document into smaller chunks.

chunkSourceWithHybridChunker

ChunkDocumentResponse chunkSourceWithHybridChunker(HybridChunkDocumentRequest request)

Converts and chunks the provided document source(s) into a processed document based on the specified options and using a hybrid chunker for splitting the document into smaller chunks.

toBuilder

<T extends DoclingServeApi,
B extends DoclingServeApi.DoclingApiBuilder<T,
B>>
DoclingServeApi.DoclingApiBuilder<T,B> toBuilder()

Creates and returns a builder instance capable of constructing a duplicate or modified version of the current API instance. The builder provides a customizable way to adjust configuration or properties before constructing a new API instance.

Returns:

a DoclingServeApi.DoclingApiBuilder initialized with the state of the current API instance.