Package ai.docling.serve.api

Interface DoclingServeApi

All Superinterfaces:

DoclingServeChunkApi, DoclingServeClearApi, DoclingServeConvertApi, DoclingServeHealthApi, DoclingServeTaskApi

public interface DoclingServeApi
extends DoclingServeHealthApi, DoclingServeConvertApi, DoclingServeChunkApi, DoclingServeClearApi, DoclingServeTaskApi

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
static <T extends DoclingServeApi, B extends DoclingServeApi.DoclingApiBuilder<T, B>> B	builder()	Creates and returns a builder instance capable of constructing implementations of DoclingServeApi.
<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.

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

chunkFiles, chunkFilesAsync, chunkFilesWithHierarchicalChunker, chunkFilesWithHierarchicalChunker, chunkFilesWithHierarchicalChunkerAsync, chunkFilesWithHierarchicalChunkerAsync, chunkFilesWithHybridChunker, chunkFilesWithHybridChunker, chunkFilesWithHybridChunkerAsync, chunkFilesWithHybridChunkerAsync, chunkSourceWithHierarchicalChunker, chunkSourceWithHierarchicalChunkerAsync, chunkSourceWithHybridChunker, chunkSourceWithHybridChunkerAsync

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

clearConverters, clearResults

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

convertFiles, convertFiles, convertFilesAsync, convertFilesAsync, convertSource, convertSourceAsync

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

health

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

chunkTaskResult, convertTaskResult, pollTaskStatus

Method Details

builder

static <T extends DoclingServeApi,
B extends DoclingServeApi.DoclingApiBuilder<T,
B>>
B builder()

Creates and returns a builder instance capable of constructing implementations of DoclingServeApi. The method ensures that exactly one factory capable of building a builder instance is available via the DoclingServeApiBuilderFactory interface. If no factories are found, or if multiple factories are found, an IllegalStateException is thrown.

Type Parameters:

T - the type of the DoclingServeApi implementation being built

B - the type of the builder implementation for the DoclingServeApi

Returns:

a builder instance of type B constructed using the available factory

Throws:

IllegalStateException - if no factories or more than one factory are found

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.