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

Enum Class ChunkType

java.lang.Object

java.lang.Enum<ChunkType>

ai.docling.serve.api.chunk.request.ChunkType

All Implemented Interfaces:

Serializable, Comparable<ChunkType>, Constable

public enum ChunkType
extends Enum<ChunkType>

Defines the types of chunking mechanisms supported for document processing. The enum provides options for selecting distinct strategies to parse and divide documents into manageable segments for further processing or analysis.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIERARCHICAL	Represents a hierarchical chunking type, which processes documents by breaking them into a nested structure of smaller chunks.
HYBRID	Represents a hybrid chunking type, which combines features of multiple chunking strategies to process documents in a flexible manner.

Method Summary

Modifier and Type	Method	Description
static ChunkType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChunkType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HYBRID

public static final ChunkType HYBRID

Represents a hybrid chunking type, which combines features of multiple chunking strategies to process documents in a flexible manner. Used in scenarios where the benefits of both sequential and hierarchical chunking approaches are desired, enabling customization based on specific processing requirements.

HIERARCHICAL

public static final ChunkType HIERARCHICAL

Represents a hierarchical chunking type, which processes documents by breaking them into a nested structure of smaller chunks. Used in scenarios where maintaining a clear hierarchy within the document structure is critical, enabling processing at multiple levels of granularity.

Method Details

values

public static ChunkType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ChunkType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null