Package ai.docling.serve.api.chunk.request

Class ChunkDocumentRequest

java.lang.Object

ai.docling.serve.api.request.DocumentRequest

ai.docling.serve.api.chunk.request.ChunkDocumentRequest

Direct Known Subclasses:

HierarchicalChunkDocumentRequest, HybridChunkDocumentRequest

public abstract sealed class ChunkDocumentRequest
extends DocumentRequest
permits HierarchicalChunkDocumentRequest, HybridChunkDocumentRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChunkDocumentRequest.Builder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.Builder<C,B>>
static class	ChunkDocumentRequest.ChunkDocumentRequestBuilder<C extends ChunkDocumentRequest,B extends ChunkDocumentRequest.ChunkDocumentRequestBuilder<C,B>>

Nested classes/interfaces inherited from class ai.docling.serve.api.request.DocumentRequest

DocumentRequest.DocumentRequestBuilder<C extends DocumentRequest,B extends DocumentRequest.DocumentRequestBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChunkDocumentRequest(ChunkDocumentRequest.Builder<?,?> b)

Method Summary

Modifier and Type	Method	Description
@NonNull ConvertDocumentOptions	getOptions()	Conversion options.
boolean	isIncludeConvertedDoc()	If true, the output will include both the chunks and the converted document.
abstract ChunkDocumentRequest.Builder<?,?>	toBuilder()	Returns a builder pre-populated with this request's current field values, allowing a modified copy to be created.
@NonNull String	toString()

Methods inherited from class ai.docling.serve.api.request.DocumentRequest

getSources, getTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ChunkDocumentRequest

protected ChunkDocumentRequest(ChunkDocumentRequest.Builder<?,?> b)

Method Details

toBuilder

public abstract ChunkDocumentRequest.Builder<?,?> toBuilder()

Description copied from class: DocumentRequest

Returns a builder pre-populated with this request's current field values, allowing a modified copy to be created. Each concrete subtype returns its own builder covariantly.

Specified by:

toBuilder in class DocumentRequest

Returns:

a builder initialized from this request

getOptions

@NonNull
public @NonNull ConvertDocumentOptions getOptions()

Conversion options.

Returns:

the conversion options

isIncludeConvertedDoc

public boolean isIncludeConvertedDoc()

If true, the output will include both the chunks and the converted document.

Returns:

true if the converted document should be included, false otherwise

toString

public @NonNull String toString()

Overrides:

toString in class DocumentRequest