com.amazonaws.services.bedrockagent.model

Class ChunkingConfiguration

java.lang.Object

com.amazonaws.services.bedrockagent.model.ChunkingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChunkingConfiguration()

Method Summary

Modifier and Type	Method and Description
ChunkingConfiguration	clone()
boolean	equals(Object obj)
String	getChunkingStrategy() Knowledge base can split your source data into chunks.
FixedSizeChunkingConfiguration	getFixedSizeChunkingConfiguration() Configurations for when you choose fixed-size chunking.
HierarchicalChunkingConfiguration	getHierarchicalChunkingConfiguration() Settings for hierarchical document chunking for a data source.
SemanticChunkingConfiguration	getSemanticChunkingConfiguration() Settings for semantic document chunking for a data source.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setChunkingStrategy(String chunkingStrategy) Knowledge base can split your source data into chunks.
void	setFixedSizeChunkingConfiguration(FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration) Configurations for when you choose fixed-size chunking.
void	setHierarchicalChunkingConfiguration(HierarchicalChunkingConfiguration hierarchicalChunkingConfiguration) Settings for hierarchical document chunking for a data source.
void	setSemanticChunkingConfiguration(SemanticChunkingConfiguration semanticChunkingConfiguration) Settings for semantic document chunking for a data source.
String	toString() Returns a string representation of this object.
ChunkingConfiguration	withChunkingStrategy(ChunkingStrategy chunkingStrategy) Knowledge base can split your source data into chunks.
ChunkingConfiguration	withChunkingStrategy(String chunkingStrategy) Knowledge base can split your source data into chunks.
ChunkingConfiguration	withFixedSizeChunkingConfiguration(FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration) Configurations for when you choose fixed-size chunking.
ChunkingConfiguration	withHierarchicalChunkingConfiguration(HierarchicalChunkingConfiguration hierarchicalChunkingConfiguration) Settings for hierarchical document chunking for a data source.
ChunkingConfiguration	withSemanticChunkingConfiguration(SemanticChunkingConfiguration semanticChunkingConfiguration) Settings for semantic document chunking for a data source.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChunkingConfiguration

public ChunkingConfiguration()

Method Detail

setChunkingStrategy

public void setChunkingStrategy(String chunkingStrategy)

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Parameters:

chunkingStrategy - Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

See Also:

ChunkingStrategy

getChunkingStrategy

public String getChunkingStrategy()

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Returns:

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

See Also:

ChunkingStrategy

withChunkingStrategy

public ChunkingConfiguration withChunkingStrategy(String chunkingStrategy)

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Parameters:

chunkingStrategy - Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Returns:

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

See Also:

ChunkingStrategy

withChunkingStrategy

public ChunkingConfiguration withChunkingStrategy(ChunkingStrategy chunkingStrategy)

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Parameters:

chunkingStrategy - Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

• FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

• HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

• SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

• NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

Returns:

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

See Also:

ChunkingStrategy

setFixedSizeChunkingConfiguration

public void setFixedSizeChunkingConfiguration(FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Parameters:

fixedSizeChunkingConfiguration - Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

getFixedSizeChunkingConfiguration

public FixedSizeChunkingConfiguration getFixedSizeChunkingConfiguration()

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Returns:

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

withFixedSizeChunkingConfiguration

public ChunkingConfiguration withFixedSizeChunkingConfiguration(FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration)

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Parameters:

fixedSizeChunkingConfiguration - Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

Returns:

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

setHierarchicalChunkingConfiguration

public void setHierarchicalChunkingConfiguration(HierarchicalChunkingConfiguration 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.

Parameters:

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.

getHierarchicalChunkingConfiguration

public HierarchicalChunkingConfiguration getHierarchicalChunkingConfiguration()

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.

Returns:

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.

withHierarchicalChunkingConfiguration

public ChunkingConfiguration withHierarchicalChunkingConfiguration(HierarchicalChunkingConfiguration 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.

Parameters:

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.

Returns:

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

setSemanticChunkingConfiguration

public void setSemanticChunkingConfiguration(SemanticChunkingConfiguration semanticChunkingConfiguration)

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

Parameters:

semanticChunkingConfiguration - Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

getSemanticChunkingConfiguration

public SemanticChunkingConfiguration getSemanticChunkingConfiguration()

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

Returns:

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

withSemanticChunkingConfiguration

public ChunkingConfiguration withSemanticChunkingConfiguration(SemanticChunkingConfiguration semanticChunkingConfiguration)

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

Parameters:

semanticChunkingConfiguration - Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

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 ChunkingConfiguration 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.