interface KnowledgeBaseConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBasePropsMixin_KnowledgeBaseConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBasePropsMixin » KnowledgeBaseConfigurationProperty

Configurations to apply to a knowledge base attached to the agent during query.

For more information, see Knowledge base retrieval configurations .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const knowledgeBaseConfigurationProperty: bedrock_mixins.CfnKnowledgeBasePropsMixin.KnowledgeBaseConfigurationProperty = {
  kendraKnowledgeBaseConfiguration: {
    kendraIndexArn: 'kendraIndexArn',
  },
  sqlKnowledgeBaseConfiguration: {
    redshiftConfiguration: {
      queryEngineConfiguration: {
        provisionedConfiguration: {
          authConfiguration: {
            databaseUser: 'databaseUser',
            type: 'type',
            usernamePasswordSecretArn: 'usernamePasswordSecretArn',
          },
          clusterIdentifier: 'clusterIdentifier',
        },
        serverlessConfiguration: {
          authConfiguration: {
            type: 'type',
            usernamePasswordSecretArn: 'usernamePasswordSecretArn',
          },
          workgroupArn: 'workgroupArn',
        },
        type: 'type',
      },
      queryGenerationConfiguration: {
        executionTimeoutSeconds: 123,
        generationContext: {
          curatedQueries: [{
            naturalLanguage: 'naturalLanguage',
            sql: 'sql',
          }],
          tables: [{
            columns: [{
              description: 'description',
              inclusion: 'inclusion',
              name: 'name',
            }],
            description: 'description',
            inclusion: 'inclusion',
            name: 'name',
          }],
        },
      },
      storageConfigurations: [{
        awsDataCatalogConfiguration: {
          tableNames: ['tableNames'],
        },
        redshiftConfiguration: {
          databaseName: 'databaseName',
        },
        type: 'type',
      }],
    },
    type: 'type',
  },
  type: 'type',
  vectorKnowledgeBaseConfiguration: {
    embeddingModelArn: 'embeddingModelArn',
    embeddingModelConfiguration: {
      bedrockEmbeddingModelConfiguration: {
        audio: [{
          segmentationConfiguration: {
            fixedLengthDuration: 123,
          },
        }],
        dimensions: 123,
        embeddingDataType: 'embeddingDataType',
        video: [{
          segmentationConfiguration: {
            fixedLengthDuration: 123,
          },
        }],
      },
    },
    supplementalDataStorageConfiguration: {
      supplementalDataStorageLocations: [{
        s3Location: {
          uri: 'uri',
        },
        supplementalDataStorageLocationType: 'supplementalDataStorageLocationType',
      }],
    },
  },
};

Properties

Name	Type	Description
kendraKnowledgeBaseConfiguration?	IResolvable | KendraKnowledgeBaseConfigurationProperty	Settings for an Amazon Kendra knowledge base.
sqlKnowledgeBaseConfiguration?	IResolvable | SqlKnowledgeBaseConfigurationProperty	Specifies configurations for a knowledge base connected to an SQL database.
type?	string	The type of data that the data source is converted into for the knowledge base.
vectorKnowledgeBaseConfiguration?	IResolvable | VectorKnowledgeBaseConfigurationProperty	Contains details about the model that's used to convert the data source into vector embeddings.

---

kendraKnowledgeBaseConfiguration?

Type: IResolvable | KendraKnowledgeBaseConfigurationProperty (optional)

Settings for an Amazon Kendra knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-kendraknowledgebaseconfiguration

---

sqlKnowledgeBaseConfiguration?

Type: IResolvable | SqlKnowledgeBaseConfigurationProperty (optional)

Specifies configurations for a knowledge base connected to an SQL database.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-sqlknowledgebaseconfiguration

---

type?

Type: string (optional)

The type of data that the data source is converted into for the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-type

---

vectorKnowledgeBaseConfiguration?

Type: IResolvable | VectorKnowledgeBaseConfigurationProperty (optional)

Contains details about the model that's used to convert the data source into vector embeddings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-vectorknowledgebaseconfiguration