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

Class HybridChunkDocumentRequest

java.lang.Object

ai.docling.serve.api.chunk.request.HybridChunkDocumentRequest

public class HybridChunkDocumentRequest
extends Object

Represents a request to convert a document and chunk it into smaller documents using the Docling hybrid chunker.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HybridChunkDocumentRequest.Builder	Builder for creating HybridChunkDocumentRequest instances.

Method Summary

Modifier and Type	Method	Description
static @NonNull HybridChunkDocumentRequest.Builder	builder()
@NonNull HybridChunkerOptions	getChunkingOptions()	Options specific to the chunker.
@NonNull ConvertDocumentOptions	getOptions()	Conversion options.
List<Source>	getSources()	List of input document sources to process.
@Nullable Target	getTarget()	Specification for the type of output target.
boolean	isIncludeConvertedDoc()	If true, the output will include both the chunks and the converted document.
@NonNull HybridChunkDocumentRequest.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static @NonNull HybridChunkDocumentRequest.Builder builder()

toBuilder

public @NonNull HybridChunkDocumentRequest.Builder toBuilder()

getSources

public List<Source> getSources()

List of input document sources to process.

Returns:

the list of document sources

getOptions

@NonNull
public @NonNull ConvertDocumentOptions getOptions()

Conversion options.

Returns:

the conversion options

getTarget

public @Nullable Target getTarget()

Specification for the type of output target.

Returns:

the output target specification, or null if not specified

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

getChunkingOptions

@NonNull
public @NonNull HybridChunkerOptions getChunkingOptions()

Options specific to the chunker.

Returns:

the hybrid chunker options

toString

public @NonNull String toString()

Overrides:

toString in class Object