Class CfnKnowledgeBasePropsMixin.VectorIngestionConfigurationProperty

Contains details about how to ingest the documents in a data source.

Inheritance

object

CfnKnowledgeBasePropsMixin.VectorIngestionConfigurationProperty

Implements

CfnKnowledgeBasePropsMixin.IVectorIngestionConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Wisdom

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnKnowledgeBasePropsMixin.VectorIngestionConfigurationProperty : CfnKnowledgeBasePropsMixin.IVectorIngestionConfigurationProperty

Syntax (vb)

Public Class CfnKnowledgeBasePropsMixin.VectorIngestionConfigurationProperty Implements CfnKnowledgeBasePropsMixin.IVectorIngestionConfigurationProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-vectoringestionconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Wisdom;

             var vectorIngestionConfigurationProperty = new VectorIngestionConfigurationProperty {
                 ChunkingConfiguration = new ChunkingConfigurationProperty {
                     ChunkingStrategy = "chunkingStrategy",
                     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 {
                     BedrockFoundationModelConfiguration = new BedrockFoundationModelConfigurationProperty {
                         ModelArn = "modelArn",
                         ParsingPrompt = new ParsingPromptProperty {
                             ParsingPromptText = "parsingPromptText"
                         }
                     },
                     ParsingStrategy = "parsingStrategy"
                 }
             };

Synopsis

Constructors

VectorIngestionConfigurationProperty()

Contains details about how to ingest the documents in a data source.

Properties

ChunkingConfiguration	Details about how to chunk the documents in the data source.
ParsingConfiguration	A custom parser for data source documents.

Constructors

VectorIngestionConfigurationProperty()

Contains details about how to ingest the documents in a data source.

public VectorIngestionConfigurationProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-knowledgebase-vectoringestionconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Wisdom;

             var vectorIngestionConfigurationProperty = new VectorIngestionConfigurationProperty {
                 ChunkingConfiguration = new ChunkingConfigurationProperty {
                     ChunkingStrategy = "chunkingStrategy",
                     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 {
                     BedrockFoundationModelConfiguration = new BedrockFoundationModelConfigurationProperty {
                         ModelArn = "modelArn",
                         ParsingPrompt = new ParsingPromptProperty {
                             ParsingPromptText = "parsingPromptText"
                         }
                     },
                     ParsingStrategy = "parsingStrategy"
                 }
             };

Properties

ChunkingConfiguration

Details about how to chunk the documents in the data source.

public object? ChunkingConfiguration { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or CfnKnowledgeBasePropsMixin.IChunkingConfigurationProperty

ParsingConfiguration

A custom parser for data source documents.

public object? ParsingConfiguration { get; set; }