VectorIngestionConfigurationProperty Struct
Contains details about how to ingest the documents in a data source.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const vectorIngestionConfigurationProperty: wisdom.CfnKnowledgeBase.VectorIngestionConfigurationProperty = {
chunkingConfiguration: {
chunkingStrategy: 'chunkingStrategy',
// the properties below are optional
fixedSizeChunkingConfiguration: {
maxTokens: 123,
overlapPercentage: 123,
},
hierarchicalChunkingConfiguration: {
levelConfigurations: [{
maxTokens: 123,
}],
overlapTokens: 123,
},
semanticChunkingConfiguration: {
breakpointPercentileThreshold: 123,
bufferSize: 123,
maxTokens: 123,
},
},
parsingConfiguration: {
parsingStrategy: 'parsingStrategy',
// the properties below are optional
bedrockFoundationModelConfiguration: {
modelArn: 'modelArn',
// the properties below are optional
parsingPrompt: {
parsingPromptText: 'parsingPromptText',
},
},
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wisdom as wisdom
vector_ingestion_configuration_property = wisdom.CfnKnowledgeBase.VectorIngestionConfigurationProperty(
chunking_configuration=wisdom.CfnKnowledgeBase.ChunkingConfigurationProperty(
chunking_strategy="chunkingStrategy",
# the properties below are optional
fixed_size_chunking_configuration=wisdom.CfnKnowledgeBase.FixedSizeChunkingConfigurationProperty(
max_tokens=123,
overlap_percentage=123
),
hierarchical_chunking_configuration=wisdom.CfnKnowledgeBase.HierarchicalChunkingConfigurationProperty(
level_configurations=[wisdom.CfnKnowledgeBase.HierarchicalChunkingLevelConfigurationProperty(
max_tokens=123
)],
overlap_tokens=123
),
semantic_chunking_configuration=wisdom.CfnKnowledgeBase.SemanticChunkingConfigurationProperty(
breakpoint_percentile_threshold=123,
buffer_size=123,
max_tokens=123
)
),
parsing_configuration=wisdom.CfnKnowledgeBase.ParsingConfigurationProperty(
parsing_strategy="parsingStrategy",
# the properties below are optional
bedrock_foundation_model_configuration=wisdom.CfnKnowledgeBase.BedrockFoundationModelConfigurationProperty(
model_arn="modelArn",
# the properties below are optional
parsing_prompt=wisdom.CfnKnowledgeBase.ParsingPromptProperty(
parsing_prompt_text="parsingPromptText"
)
)
)
)
java
// 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.*;
VectorIngestionConfigurationProperty vectorIngestionConfigurationProperty = VectorIngestionConfigurationProperty.builder()
.chunkingConfiguration(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())
.parsingConfiguration(ParsingConfigurationProperty.builder()
.parsingStrategy("parsingStrategy")
// the properties below are optional
.bedrockFoundationModelConfiguration(BedrockFoundationModelConfigurationProperty.builder()
.modelArn("modelArn")
// the properties below are optional
.parsingPrompt(ParsingPromptProperty.builder()
.parsingPromptText("parsingPromptText")
.build())
.build())
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Wisdom;
var vectorIngestionConfigurationProperty = new VectorIngestionConfigurationProperty {
ChunkingConfiguration = new ChunkingConfigurationProperty {
ChunkingStrategy = "chunkingStrategy",
// the properties below are optional
FixedSizeChunkingConfiguration = new FixedSizeChunkingConfigurationProperty {
MaxTokens = 123,
OverlapPercentage = 123
},
HierarchicalChunkingConfiguration = new HierarchicalChunkingConfigurationProperty {
LevelConfigurations = new [] { new HierarchicalChunkingLevelConfigurationProperty {
MaxTokens = 123
} },
OverlapTokens = 123
},
SemanticChunkingConfiguration = new SemanticChunkingConfigurationProperty {
BreakpointPercentileThreshold = 123,
BufferSize = 123,
MaxTokens = 123
}
},
ParsingConfiguration = new ParsingConfigurationProperty {
ParsingStrategy = "parsingStrategy",
// the properties below are optional
BedrockFoundationModelConfiguration = new BedrockFoundationModelConfigurationProperty {
ModelArn = "modelArn",
// the properties below are optional
ParsingPrompt = new ParsingPromptProperty {
ParsingPromptText = "parsingPromptText"
}
}
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
vectorIngestionConfigurationProperty := &VectorIngestionConfigurationProperty{
ChunkingConfiguration: &ChunkingConfigurationProperty{
ChunkingStrategy: jsii.String("chunkingStrategy"),
// the properties below are optional
FixedSizeChunkingConfiguration: &FixedSizeChunkingConfigurationProperty{
MaxTokens: jsii.Number(123),
OverlapPercentage: jsii.Number(123),
},
HierarchicalChunkingConfiguration: &HierarchicalChunkingConfigurationProperty{
LevelConfigurations: []interface{}{
&HierarchicalChunkingLevelConfigurationProperty{
MaxTokens: jsii.Number(123),
},
},
OverlapTokens: jsii.Number(123),
},
SemanticChunkingConfiguration: &SemanticChunkingConfigurationProperty{
BreakpointPercentileThreshold: jsii.Number(123),
BufferSize: jsii.Number(123),
MaxTokens: jsii.Number(123),
},
},
ParsingConfiguration: &ParsingConfigurationProperty{
ParsingStrategy: jsii.String("parsingStrategy"),
// the properties below are optional
BedrockFoundationModelConfiguration: &BedrockFoundationModelConfigurationProperty{
ModelArn: jsii.String("modelArn"),
// the properties below are optional
ParsingPrompt: &ParsingPromptProperty{
ParsingPromptText: jsii.String("parsingPromptText"),
},
},
},
}
Properties
chunkingConfigurationoptionalIResolvable | CfnKnowledgeBase.ChunkingConfigurationPropertychunking_configurationoptionaltyping.Union[IResolvable, ChunkingConfigurationProperty]chunkingConfigurationoptionalIResolvableChunkingConfigurationoptionalIResolvableChunkingConfigurationoptionalinterface{}#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.
parsingConfigurationoptionalIResolvable | CfnKnowledgeBase.ParsingConfigurationPropertyparsing_configurationoptionaltyping.Union[IResolvable, ParsingConfigurationProperty]parsingConfigurationoptionalIResolvableParsingConfigurationoptionalIResolvableParsingConfigurationoptionalinterface{}#A custom parser for data source documents.