Package software.amazon.awscdk.services.bedrock

Interface CfnDataSource.ChunkingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ChunkingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(Stable)
public static interface CfnDataSource.ChunkingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 ChunkingConfigurationProperty chunkingConfigurationProperty = ChunkingConfigurationProperty.builder()
         .chunkingStrategy("chunkingStrategy")
         // the properties below are optional
         .fixedSizeChunkingConfiguration(FixedSizeChunkingConfigurationProperty.builder()
                 .maxTokens(123)
                 .overlapPercentage(123)
                 .build())
         .hierarchicalChunkingConfiguration(HierarchicalChunkingConfigurationProperty.builder()
                 .levelConfigurations(List.of(HierarchicalChunkingLevelConfigurationProperty.builder()
                         .maxTokens(123)
                         .build()))
                 .overlapTokens(123)
                 .build())
         .semanticChunkingConfiguration(SemanticChunkingConfigurationProperty.builder()
                 .breakpointPercentileThreshold(123)
                 .bufferSize(123)
                 .maxTokens(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSource.ChunkingConfigurationProperty.Builder	A builder for CfnDataSource.ChunkingConfigurationProperty
static final class	CfnDataSource.ChunkingConfigurationProperty.Jsii$Proxy	An implementation for CfnDataSource.ChunkingConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSource.ChunkingConfigurationProperty.Builder	builder()
String	getChunkingStrategy()	Knowledge base can split your source data into chunks.
default Object	getFixedSizeChunkingConfiguration()	Configurations for when you choose fixed-size chunking.
default Object	getHierarchicalChunkingConfiguration()	Settings for hierarchical document chunking for a data source.
default Object	getSemanticChunkingConfiguration()	Settings for semantic document chunking for a data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChunkingStrategy

@Stability(Stable)
@NotNull
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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-chunkingstrategy

getFixedSizeChunkingConfiguration

@Stability(Stable)
@Nullable
default Object getFixedSizeChunkingConfiguration()

Configurations for when you choose fixed-size chunking.

If you set the chunkingStrategy as NONE , exclude this field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-fixedsizechunkingconfiguration

getHierarchicalChunkingConfiguration

@Stability(Stable)
@Nullable
default Object 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-hierarchicalchunkingconfiguration

getSemanticChunkingConfiguration

@Stability(Stable)
@Nullable
default Object 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-datasource-chunkingconfiguration.html#cfn-bedrock-datasource-chunkingconfiguration-semanticchunkingconfiguration

builder

@Stability(Stable)
static CfnDataSource.ChunkingConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ChunkingConfigurationProperty.Builder of CfnDataSource.ChunkingConfigurationProperty