Package software.amazon.awssdk.services.bedrockagent.model

Class HierarchicalChunkingConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.HierarchicalChunkingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HierarchicalChunkingConfiguration.Builder,HierarchicalChunkingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class HierarchicalChunkingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HierarchicalChunkingConfiguration.Builder,HierarchicalChunkingConfiguration>

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HierarchicalChunkingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static HierarchicalChunkingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLevelConfigurations()	For responses, this returns true if the service returned a value for the LevelConfigurations property.
List<HierarchicalChunkingLevelConfiguration>	levelConfigurations()	Token settings for each layer.
Integer	overlapTokens()	The number of tokens to repeat across chunks in the same layer.
List<SdkField<?>>	sdkFields()
static Class<? extends HierarchicalChunkingConfiguration.Builder>	serializableBuilderClass()
HierarchicalChunkingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasLevelConfigurations

public final boolean hasLevelConfigurations()

For responses, this returns true if the service returned a value for the LevelConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

levelConfigurations

public final List<HierarchicalChunkingLevelConfiguration> levelConfigurations()

Token settings for each layer.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLevelConfigurations() method.

Returns:

Token settings for each layer.

overlapTokens

public final Integer overlapTokens()

The number of tokens to repeat across chunks in the same layer.

Returns:

The number of tokens to repeat across chunks in the same layer.

toBuilder

public HierarchicalChunkingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HierarchicalChunkingConfiguration.Builder,HierarchicalChunkingConfiguration>

builder

public static HierarchicalChunkingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends HierarchicalChunkingConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo