Class ChunkingConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.ChunkingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ChunkingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>

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:

  • Method Details

    • chunkingStrategy

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, chunkingStrategy will return ChunkingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chunkingStrategyAsString().

      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:

    • chunkingStrategyAsString

      public final String chunkingStrategyAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, chunkingStrategy will return ChunkingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from chunkingStrategyAsString().

      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:

    • fixedSizeChunkingConfiguration

      public final FixedSizeChunkingConfiguration fixedSizeChunkingConfiguration()

      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.

    • hierarchicalChunkingConfiguration

      public final 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.

      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.

    • semanticChunkingConfiguration

      public final 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.

      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.

    • toBuilder

      public ChunkingConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ChunkingConfiguration.Builder,ChunkingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ChunkingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ChunkingConfiguration.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.