com.amazonaws.services.bedrockagent.model

Class HierarchicalChunkingConfiguration

java.lang.Object

com.amazonaws.services.bedrockagent.model.HierarchicalChunkingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HierarchicalChunkingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HierarchicalChunkingConfiguration()

Method Summary

Modifier and Type	Method and Description
HierarchicalChunkingConfiguration	clone()
boolean	equals(Object obj)
List<HierarchicalChunkingLevelConfiguration>	getLevelConfigurations() Token settings for each layer.
Integer	getOverlapTokens() The number of tokens to repeat across chunks in the same layer.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setLevelConfigurations(Collection<HierarchicalChunkingLevelConfiguration> levelConfigurations) Token settings for each layer.
void	setOverlapTokens(Integer overlapTokens) The number of tokens to repeat across chunks in the same layer.
String	toString() Returns a string representation of this object.
HierarchicalChunkingConfiguration	withLevelConfigurations(Collection<HierarchicalChunkingLevelConfiguration> levelConfigurations) Token settings for each layer.
HierarchicalChunkingConfiguration	withLevelConfigurations(HierarchicalChunkingLevelConfiguration... levelConfigurations) Token settings for each layer.
HierarchicalChunkingConfiguration	withOverlapTokens(Integer overlapTokens) The number of tokens to repeat across chunks in the same layer.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchicalChunkingConfiguration

public HierarchicalChunkingConfiguration()

Method Detail

getLevelConfigurations

public List<HierarchicalChunkingLevelConfiguration> getLevelConfigurations()

Token settings for each layer.

Returns:

Token settings for each layer.

setLevelConfigurations

public void setLevelConfigurations(Collection<HierarchicalChunkingLevelConfiguration> levelConfigurations)

Token settings for each layer.

Parameters:

levelConfigurations - Token settings for each layer.

withLevelConfigurations

public HierarchicalChunkingConfiguration withLevelConfigurations(HierarchicalChunkingLevelConfiguration... levelConfigurations)

Token settings for each layer.

NOTE: This method appends the values to the existing list (if any). Use setLevelConfigurations(java.util.Collection) or withLevelConfigurations(java.util.Collection) if you want to override the existing values.

Parameters:

levelConfigurations - Token settings for each layer.

Returns:

Returns a reference to this object so that method calls can be chained together.

withLevelConfigurations

public HierarchicalChunkingConfiguration withLevelConfigurations(Collection<HierarchicalChunkingLevelConfiguration> levelConfigurations)

Token settings for each layer.

Parameters:

levelConfigurations - Token settings for each layer.

Returns:

Returns a reference to this object so that method calls can be chained together.

setOverlapTokens

public void setOverlapTokens(Integer overlapTokens)

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

Parameters:

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

getOverlapTokens

public Integer getOverlapTokens()

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.

withOverlapTokens

public HierarchicalChunkingConfiguration withOverlapTokens(Integer overlapTokens)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HierarchicalChunkingConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.