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

Class HierarchicalChunkDocumentRequest.Builder

java.lang.Object

ai.docling.serve.api.chunk.request.HierarchicalChunkDocumentRequest.Builder

Enclosing class:

HierarchicalChunkDocumentRequest

public static class HierarchicalChunkDocumentRequest.Builder
extends Object

Builder for creating HierarchicalChunkDocumentRequest instances. Generated by Lombok's @Builder annotation.

Builder methods:

• source(Source) - Add a single document source (use with @Singular)
• sources(List<Source>) - Set the list of document sources
• options(ConvertDocumentOptions) - Set the conversion options
• target(Target) - Set the output target specification
• includeConvertedDoc(boolean) - Set whether to include converted document
• chunkingOptions(HierarchicalChunkerOptions) - Set the hierarchical chunker options

Method Summary

Modifier and Type	Method	Description
@NonNull HierarchicalChunkDocumentRequest	build()
@NonNull HierarchicalChunkDocumentRequest.Builder	chunkingOptions(@NonNull HierarchicalChunkerOptions chunkingOptions)	Options specific to the chunker.
@NonNull HierarchicalChunkDocumentRequest.Builder	clearSources()
@NonNull HierarchicalChunkDocumentRequest.Builder	includeConvertedDoc(boolean includeConvertedDoc)	If true, the output will include both the chunks and the converted document.
@NonNull HierarchicalChunkDocumentRequest.Builder	options(@NonNull ConvertDocumentOptions options)	Conversion options.
@NonNull HierarchicalChunkDocumentRequest.Builder	source(Source source)
@NonNull HierarchicalChunkDocumentRequest.Builder	sources(@NonNull Collection<? extends Source> sources)
@NonNull HierarchicalChunkDocumentRequest.Builder	target(@Nullable Target target)	Specification for the type of output target.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

source

public @NonNull HierarchicalChunkDocumentRequest.Builder source(Source source)

sources

public @NonNull HierarchicalChunkDocumentRequest.Builder sources(@NonNull Collection<? extends Source> sources)

clearSources

public @NonNull HierarchicalChunkDocumentRequest.Builder clearSources()

options

public @NonNull HierarchicalChunkDocumentRequest.Builder options(@NonNull
 @NonNull ConvertDocumentOptions options)

Conversion options.

Parameters:

options - the conversion options

Returns:

this.

target

public @NonNull HierarchicalChunkDocumentRequest.Builder target(@Nullable Target target)

Specification for the type of output target.

Parameters:

target - the output target specification, or null if not specified

Returns:

this.

includeConvertedDoc

public @NonNull HierarchicalChunkDocumentRequest.Builder includeConvertedDoc(boolean includeConvertedDoc)

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

Parameters:

includeConvertedDoc - true if the converted document should be included, false otherwise

Returns:

this.

chunkingOptions

public @NonNull HierarchicalChunkDocumentRequest.Builder chunkingOptions(@NonNull
 @NonNull HierarchicalChunkerOptions chunkingOptions)

Options specific to the chunker.

Parameters:

chunkingOptions - the hierarchical chunker options

Returns:

this.

build

public @NonNull HierarchicalChunkDocumentRequest build()

toString

public @NonNull String toString()

Overrides:

toString in class Object