CfnKnowledgeBaseProps
- class aws_cdk.aws_bedrock.CfnKnowledgeBaseProps(*, knowledge_base_configuration, name, role_arn, description=None, storage_configuration=None, tags=None)
Bases:
object
Properties for defining a
CfnKnowledgeBase
.- Parameters:
knowledge_base_configuration (
Union
[IResolvable
,KnowledgeBaseConfigurationProperty
,Dict
[str
,Any
]]) – Contains details about the embeddings configuration of the knowledge base.name (
str
) – The name of the knowledge base.role_arn (
str
) – The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.description (
Optional
[str
]) – The description of the knowledge base associated with the inline agent.storage_configuration (
Union
[IResolvable
,StorageConfigurationProperty
,Dict
[str
,Any
],None
]) – Contains details about the storage configuration of the knowledge base.tags (
Optional
[Mapping
[str
,str
]]) – Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. - Tag naming limits and requirements - Tagging best practices
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_bedrock as bedrock cfn_knowledge_base_props = bedrock.CfnKnowledgeBaseProps( knowledge_base_configuration=bedrock.CfnKnowledgeBase.KnowledgeBaseConfigurationProperty( type="type", # the properties below are optional kendra_knowledge_base_configuration=bedrock.CfnKnowledgeBase.KendraKnowledgeBaseConfigurationProperty( kendra_index_arn="kendraIndexArn" ), sql_knowledge_base_configuration=bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty( type="type", # the properties below are optional redshift_configuration=bedrock.CfnKnowledgeBase.RedshiftConfigurationProperty( query_engine_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineConfigurationProperty( type="type", # the properties below are optional provisioned_configuration=bedrock.CfnKnowledgeBase.RedshiftProvisionedConfigurationProperty( auth_configuration=bedrock.CfnKnowledgeBase.RedshiftProvisionedAuthConfigurationProperty( type="type", # the properties below are optional database_user="databaseUser", username_password_secret_arn="usernamePasswordSecretArn" ), cluster_identifier="clusterIdentifier" ), serverless_configuration=bedrock.CfnKnowledgeBase.RedshiftServerlessConfigurationProperty( auth_configuration=bedrock.CfnKnowledgeBase.RedshiftServerlessAuthConfigurationProperty( type="type", # the properties below are optional username_password_secret_arn="usernamePasswordSecretArn" ), workgroup_arn="workgroupArn" ) ), storage_configurations=[bedrock.CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty( type="type", # the properties below are optional aws_data_catalog_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty( table_names=["tableNames"] ), redshift_configuration=bedrock.CfnKnowledgeBase.RedshiftQueryEngineRedshiftStorageConfigurationProperty( database_name="databaseName" ) )], # the properties below are optional query_generation_configuration=bedrock.CfnKnowledgeBase.QueryGenerationConfigurationProperty( execution_timeout_seconds=123, generation_context=bedrock.CfnKnowledgeBase.QueryGenerationContextProperty( curated_queries=[bedrock.CfnKnowledgeBase.CuratedQueryProperty( natural_language="naturalLanguage", sql="sql" )], tables=[bedrock.CfnKnowledgeBase.QueryGenerationTableProperty( name="name", # the properties below are optional columns=[bedrock.CfnKnowledgeBase.QueryGenerationColumnProperty( description="description", inclusion="inclusion", name="name" )], description="description", inclusion="inclusion" )] ) ) ) ), vector_knowledge_base_configuration=bedrock.CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty( embedding_model_arn="embeddingModelArn", # the properties below are optional embedding_model_configuration=bedrock.CfnKnowledgeBase.EmbeddingModelConfigurationProperty( bedrock_embedding_model_configuration=bedrock.CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty( dimensions=123, embedding_data_type="embeddingDataType" ) ), supplemental_data_storage_configuration=bedrock.CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty( supplemental_data_storage_locations=[bedrock.CfnKnowledgeBase.SupplementalDataStorageLocationProperty( supplemental_data_storage_location_type="supplementalDataStorageLocationType", # the properties below are optional s3_location=bedrock.CfnKnowledgeBase.S3LocationProperty( uri="uri" ) )] ) ) ), name="name", role_arn="roleArn", # the properties below are optional description="description", storage_configuration=bedrock.CfnKnowledgeBase.StorageConfigurationProperty( type="type", # the properties below are optional opensearch_serverless_configuration=bedrock.CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty( collection_arn="collectionArn", field_mapping=bedrock.CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty( metadata_field="metadataField", text_field="textField", vector_field="vectorField" ), vector_index_name="vectorIndexName" ), pinecone_configuration=bedrock.CfnKnowledgeBase.PineconeConfigurationProperty( connection_string="connectionString", credentials_secret_arn="credentialsSecretArn", field_mapping=bedrock.CfnKnowledgeBase.PineconeFieldMappingProperty( metadata_field="metadataField", text_field="textField" ), # the properties below are optional namespace="namespace" ), rds_configuration=bedrock.CfnKnowledgeBase.RdsConfigurationProperty( credentials_secret_arn="credentialsSecretArn", database_name="databaseName", field_mapping=bedrock.CfnKnowledgeBase.RdsFieldMappingProperty( metadata_field="metadataField", primary_key_field="primaryKeyField", text_field="textField", vector_field="vectorField" ), resource_arn="resourceArn", table_name="tableName" ) ), tags={ "tags_key": "tags" } )
Attributes
- description
The description of the knowledge base associated with the inline agent.
- knowledge_base_configuration
Contains details about the embeddings configuration of the knowledge base.
- name
The name of the knowledge base.
- role_arn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- storage_configuration
Contains details about the storage configuration of the knowledge base.
- tags
.
- See:
- Type:
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources