Interface ICfnKnowledgeBaseProps

Properties for defining a CfnKnowledgeBase.

Namespace: Amazon.CDK.AWS.Wisdom

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnKnowledgeBaseProps

Syntax (vb)

Public Interface ICfnKnowledgeBaseProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.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.AWS.Wisdom;

var cfnKnowledgeBaseProps = new CfnKnowledgeBaseProps {
    KnowledgeBaseType = "knowledgeBaseType",
    Name = "name",

    // the properties below are optional
    Description = "description",
    RenderingConfiguration = new RenderingConfigurationProperty {
        TemplateUri = "templateUri"
    },
    ServerSideEncryptionConfiguration = new ServerSideEncryptionConfigurationProperty {
        KmsKeyId = "kmsKeyId"
    },
    SourceConfiguration = new SourceConfigurationProperty {
        AppIntegrations = new AppIntegrationsConfigurationProperty {
            AppIntegrationArn = "appIntegrationArn",

            // the properties below are optional
            ObjectFields = new [] { "objectFields" }
        },
        ManagedSourceConfiguration = new ManagedSourceConfigurationProperty {
            WebCrawlerConfiguration = new WebCrawlerConfigurationProperty {
                UrlConfiguration = new UrlConfigurationProperty {
                    SeedUrls = new [] { new SeedUrlProperty {
                        Url = "url"
                    } }
                },

                // the properties below are optional
                CrawlerLimits = new CrawlerLimitsProperty {
                    RateLimit = 123
                },
                ExclusionFilters = new [] { "exclusionFilters" },
                InclusionFilters = new [] { "inclusionFilters" },
                Scope = "scope"
            }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VectorIngestionConfiguration = 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"
                }
            }
        }
    }
};

Synopsis

Properties

Description	The description.
KnowledgeBaseType	The type of knowledge base.
Name	The name of the knowledge base.
RenderingConfiguration	Information about how to render the content.
ServerSideEncryptionConfiguration	This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom.
SourceConfiguration	The source of the knowledge base content.
Tags	The tags used to organize, track, or control access for this resource.
VectorIngestionConfiguration	Contains details about how to ingest the documents in a data source.

Properties

Description

The description.

virtual string Description { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-description

KnowledgeBaseType

The type of knowledge base.

string KnowledgeBaseType { get; }

Property Value

System.String

Remarks

Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-knowledgebasetype

Name

The name of the knowledge base.

string Name { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-name

RenderingConfiguration

Information about how to render the content.

virtual object RenderingConfiguration { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-renderingconfiguration

ServerSideEncryptionConfiguration

This customer managed key must have a policy that allows kms:CreateGrant and kms:DescribeKey permissions to the IAM identity using the key to invoke Wisdom.

virtual object ServerSideEncryptionConfiguration { get; }

Property Value

System.Object

Remarks

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-serversideencryptionconfiguration

SourceConfiguration

The source of the knowledge base content.

virtual object SourceConfiguration { get; }

Property Value

System.Object

Remarks

Only set this argument for EXTERNAL or Managed knowledge bases.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-sourceconfiguration

VectorIngestionConfiguration

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

virtual object VectorIngestionConfiguration { get; }

Property Value

System.Object

Remarks

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