Package software.amazon.awscdk.services.wisdom

Interface CfnKnowledgeBase.ChunkingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.ChunkingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.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.wisdom.*;
 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-wisdom-knowledgebase-chunkingconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-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.

Returns union: either IResolvable or CfnKnowledgeBase.FixedSizeChunkingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-chunkingconfiguration.html#cfn-wisdom-knowledgebase-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.

Returns union: either IResolvable or CfnKnowledgeBase.HierarchicalChunkingConfigurationProperty

See Also:

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

getSemanticChunkingConfiguration

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

Settings for semantic document chunking for a data source.

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

Returns union: either IResolvable or CfnKnowledgeBase.SemanticChunkingConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnKnowledgeBase.ChunkingConfigurationProperty.Builder of CfnKnowledgeBase.ChunkingConfigurationProperty