diff --git a/apidocs/README.md b/apidocs/README.md index 0f7e8020..f87a9964 100644 --- a/apidocs/README.md +++ b/apidocs/README.md @@ -1,4 +1,4 @@ -**@cdklabs/generative-ai-cdk-constructs** • **Docs** +**@cdklabs/generative-ai-cdk-constructs** *** diff --git a/apidocs/classes/AossCwDashboard.md b/apidocs/classes/AossCwDashboard.md index f9243d0c..d76cd3df 100644 --- a/apidocs/classes/AossCwDashboard.md +++ b/apidocs/classes/AossCwDashboard.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ Constructs a new instance of the AossCwDashboard class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md) +##### props + +[`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md) user provided props for the construct. @@ -74,11 +80,17 @@ The tree node. #### Parameters -• **collectionName**: `string` +##### collectionName -• **collectionId**: `string` +`string` -• **props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md) +##### collectionId + +`string` + +##### props + +[`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md) #### Returns @@ -92,9 +104,13 @@ The tree node. #### Parameters -• **collection**: `CfnCollection` +##### collection + +`CfnCollection` + +##### props -• **props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md) +[`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md) #### Returns @@ -108,15 +124,25 @@ The tree node. #### Parameters -• **collectionName**: `string` +##### collectionName -• **collectionId**: `string` +`string` + +##### collectionId + +`string` + +##### IndexName -• **IndexName**: `string` +`string` + +##### IndexId -• **IndexId**: `string` +`string` -• **props**: [`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md) +##### props + +[`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md) #### Returns @@ -162,7 +188,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/BaseClass.md b/apidocs/classes/BaseClass.md index 18e31c67..0a5599e4 100644 --- a/apidocs/classes/BaseClass.md +++ b/apidocs/classes/BaseClass.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -28,9 +28,13 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` + +##### id + +`string` #### Returns @@ -134,7 +138,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -164,11 +170,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **scope**: `Construct` +##### scope -• **lambdaFunctions**: `DockerImageFunction`[] +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -182,7 +194,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -212,7 +226,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/BedrockCwDashboard.md b/apidocs/classes/BedrockCwDashboard.md index 0a84d8c8..99d18a21 100644 --- a/apidocs/classes/BedrockCwDashboard.md +++ b/apidocs/classes/BedrockCwDashboard.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ Constructs a new instance of the BedrockCwDashboard class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`BedrockCwDashboardProps`](../interfaces/BedrockCwDashboardProps.md) +##### props + +[`BedrockCwDashboardProps`](../interfaces/BedrockCwDashboardProps.md) user provided props for the construct. @@ -74,7 +80,9 @@ The tree node. #### Parameters -• **props**: [`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) +##### props + +[`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) #### Returns @@ -88,11 +96,17 @@ The tree node. #### Parameters -• **modelName**: `string` +##### modelName -• **modelId**: `string` +`string` -• **props**: [`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) +##### modelId + +`string` + +##### props + +[`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) #### Returns @@ -138,7 +152,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/ContainerImage.md b/apidocs/classes/ContainerImage.md index 0767bb43..9b44449d 100644 --- a/apidocs/classes/ContainerImage.md +++ b/apidocs/classes/ContainerImage.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -30,9 +30,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **scope**: `Construct` +##### scope -• **grantable**: `IGrantable` +`Construct` + +##### grantable + +`IGrantable` #### Returns @@ -46,9 +50,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **directory**: `string` +##### directory + +`string` -• **options**: `DockerImageAssetOptions` = `{}` +##### options + +`DockerImageAssetOptions` = `{}` #### Returns @@ -62,9 +70,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **repository**: `IRepository` +##### repository + +`IRepository` + +##### tag -• **tag**: `string` = `'latest'` +`string` = `'latest'` #### Returns diff --git a/apidocs/classes/ContentGenerationAppSyncLambda.md b/apidocs/classes/ContentGenerationAppSyncLambda.md index 7c8fc60f..5de70a94 100644 --- a/apidocs/classes/ContentGenerationAppSyncLambda.md +++ b/apidocs/classes/ContentGenerationAppSyncLambda.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ Constructs a new instance of the ContentGenerationAppSyncLambda class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`ContentGenerationAppSyncLambdaProps`](../interfaces/ContentGenerationAppSyncLambdaProps.md) +##### props + +[`ContentGenerationAppSyncLambdaProps`](../interfaces/ContentGenerationAppSyncLambdaProps.md) user provided props for the construct. @@ -226,7 +232,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -260,11 +268,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -282,7 +296,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -316,7 +332,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/CustomSageMakerEndpoint.md b/apidocs/classes/CustomSageMakerEndpoint.md index fd591fdc..c8a55457 100644 --- a/apidocs/classes/CustomSageMakerEndpoint.md +++ b/apidocs/classes/CustomSageMakerEndpoint.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,11 +22,17 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`CustomSageMakerEndpointProps`](../interfaces/CustomSageMakerEndpointProps.md) +##### id + +`string` + +##### props + +[`CustomSageMakerEndpointProps`](../interfaces/CustomSageMakerEndpointProps.md) #### Returns @@ -248,7 +254,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -266,7 +274,9 @@ Record , maps construct name with number of deployments #### Parameters -• **statement**: `PolicyStatement` +##### statement + +`PolicyStatement` #### Returns @@ -294,7 +304,9 @@ Record , maps construct name with number of deployments #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -324,11 +336,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) + +##### scope -• **scope**: `Construct` +`Construct` -• **lambdaFunctions**: `DockerImageFunction`[] +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -346,7 +364,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -380,7 +400,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/DeepLearningContainerImage.md b/apidocs/classes/DeepLearningContainerImage.md index 3303351c..eae56b7e 100644 --- a/apidocs/classes/DeepLearningContainerImage.md +++ b/apidocs/classes/DeepLearningContainerImage.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -20,11 +20,17 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **repositoryName**: `string` +##### repositoryName -• **tag**: `string` +`string` -• **accountId?**: `string` +##### tag + +`string` + +##### accountId? + +`string` #### Returns @@ -564,9 +570,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **scope**: `Construct` +##### scope -• **grantable**: `IGrantable` +`Construct` + +##### grantable + +`IGrantable` #### Returns @@ -584,9 +594,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **directory**: `string` +##### directory + +`string` -• **options**: `DockerImageAssetOptions` = `{}` +##### options + +`DockerImageAssetOptions` = `{}` #### Returns @@ -604,11 +618,17 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **repositoryName**: `string` +##### repositoryName + +`string` + +##### tag -• **tag**: `string` +`string` -• **accountId?**: `string` +##### accountId? + +`string` #### Returns @@ -622,9 +642,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md #### Parameters -• **repository**: `IRepository` +##### repository + +`IRepository` + +##### tag -• **tag**: `string` = `'latest'` +`string` = `'latest'` #### Returns diff --git a/apidocs/classes/HuggingFaceSageMakerEndpoint.md b/apidocs/classes/HuggingFaceSageMakerEndpoint.md index 2de6ff07..fb4402fa 100644 --- a/apidocs/classes/HuggingFaceSageMakerEndpoint.md +++ b/apidocs/classes/HuggingFaceSageMakerEndpoint.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -24,11 +24,17 @@ The HuggingFaceSageMakerEndpoint class. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`HuggingFaceSageMakerEndpointProps`](../interfaces/HuggingFaceSageMakerEndpointProps.md) +##### id + +`string` + +##### props + +[`HuggingFaceSageMakerEndpointProps`](../interfaces/HuggingFaceSageMakerEndpointProps.md) #### Returns @@ -220,7 +226,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -238,7 +246,9 @@ Record , maps construct name with number of deployments #### Parameters -• **statement**: `PolicyStatement` +##### statement + +`PolicyStatement` #### Returns @@ -266,7 +276,9 @@ Record , maps construct name with number of deployments #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -296,11 +308,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) + +##### scope -• **scope**: `Construct` +`Construct` -• **lambdaFunctions**: `DockerImageFunction`[] +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -318,7 +336,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -352,7 +372,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/JumpStartModel.md b/apidocs/classes/JumpStartModel.md index 9dd3173b..1a82d652 100644 --- a/apidocs/classes/JumpStartModel.md +++ b/apidocs/classes/JumpStartModel.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -14,7 +14,9 @@ #### Parameters -• **name**: `string` +##### name + +`string` #### Returns @@ -22016,7 +22018,9 @@ #### Parameters -• **name**: `string` +##### name + +`string` #### Returns diff --git a/apidocs/classes/JumpStartSageMakerEndpoint.md b/apidocs/classes/JumpStartSageMakerEndpoint.md index 1086eac7..ccb8a8bc 100644 --- a/apidocs/classes/JumpStartSageMakerEndpoint.md +++ b/apidocs/classes/JumpStartSageMakerEndpoint.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -20,11 +20,17 @@ The JumpStartSageMakerEndpoint class. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`JumpStartSageMakerEndpointProps`](../interfaces/JumpStartSageMakerEndpointProps.md) +##### id + +`string` + +##### props + +[`JumpStartSageMakerEndpointProps`](../interfaces/JumpStartSageMakerEndpointProps.md) #### Returns @@ -210,7 +216,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -228,7 +236,9 @@ Record , maps construct name with number of deployments #### Parameters -• **statement**: `PolicyStatement` +##### statement + +`PolicyStatement` #### Returns @@ -256,7 +266,9 @@ Record , maps construct name with number of deployments #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -286,11 +298,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) + +##### scope -• **scope**: `Construct` +`Construct` -• **lambdaFunctions**: `DockerImageFunction`[] +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -308,7 +326,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -342,7 +362,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/LangchainCommonDepsLayer.md b/apidocs/classes/LangchainCommonDepsLayer.md index 4e29b6bf..ed3f3cce 100644 --- a/apidocs/classes/LangchainCommonDepsLayer.md +++ b/apidocs/classes/LangchainCommonDepsLayer.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ This construct creates a lambda layer loaded with relevant libraries to run gena #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`LangchainLayerProps`](../interfaces/LangchainLayerProps.md) +##### props + +[`LangchainLayerProps`](../interfaces/LangchainLayerProps.md) user provided props for the construct. @@ -106,7 +112,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/LlamaIndexDataLoader.md b/apidocs/classes/LlamaIndexDataLoader.md index 6182c12d..aae046d7 100644 --- a/apidocs/classes/LlamaIndexDataLoader.md +++ b/apidocs/classes/LlamaIndexDataLoader.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -18,11 +18,17 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`LlamaIndexDataLoaderProps`](../interfaces/LlamaIndexDataLoaderProps.md) +##### id + +`string` + +##### props + +[`LlamaIndexDataLoaderProps`](../interfaces/LlamaIndexDataLoaderProps.md) #### Returns @@ -166,7 +172,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -200,11 +208,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -222,7 +236,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -256,7 +272,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/QaAppsyncOpensearch.md b/apidocs/classes/QaAppsyncOpensearch.md index 5b6818cb..4ccad90f 100644 --- a/apidocs/classes/QaAppsyncOpensearch.md +++ b/apidocs/classes/QaAppsyncOpensearch.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ Constructs a new instance of the RagAppsyncStepfnOpensearch class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a scope-unique id. -• **props**: [`QaAppsyncOpensearchProps`](../interfaces/QaAppsyncOpensearchProps.md) +##### props + +[`QaAppsyncOpensearchProps`](../interfaces/QaAppsyncOpensearchProps.md) user provided props for the construct. @@ -226,7 +232,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -260,11 +268,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -282,7 +296,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -316,7 +332,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/RagAppsyncStepfnOpensearch.md b/apidocs/classes/RagAppsyncStepfnOpensearch.md index 98b8d5fa..76eeb198 100644 --- a/apidocs/classes/RagAppsyncStepfnOpensearch.md +++ b/apidocs/classes/RagAppsyncStepfnOpensearch.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -22,15 +22,21 @@ Constructs a new instance of the RagAppsyncStepfnOpensearch class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a scope-unique id. -• **props**: [`RagAppsyncStepfnOpensearchProps`](../interfaces/RagAppsyncStepfnOpensearchProps.md) +##### props + +[`RagAppsyncStepfnOpensearchProps`](../interfaces/RagAppsyncStepfnOpensearchProps.md) user provided props for the construct. @@ -268,7 +274,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -302,11 +310,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -324,7 +338,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -358,7 +374,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/SageMakerEndpointBase.md b/apidocs/classes/SageMakerEndpointBase.md index 37d4b5b4..e8e78187 100644 --- a/apidocs/classes/SageMakerEndpointBase.md +++ b/apidocs/classes/SageMakerEndpointBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -24,9 +24,13 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` + +##### id + +`string` #### Returns @@ -158,7 +162,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -202,11 +208,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **scope**: `Construct` +##### scope -• **lambdaFunctions**: `DockerImageFunction`[] +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -224,7 +236,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -258,7 +272,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/SageMakerInstanceType.md b/apidocs/classes/SageMakerInstanceType.md index 635f4877..78dbb852 100644 --- a/apidocs/classes/SageMakerInstanceType.md +++ b/apidocs/classes/SageMakerInstanceType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -16,7 +16,9 @@ Supported instance types for SageMaker instance-based production variants. #### Parameters -• **instanceType**: `string` +##### instanceType + +`string` #### Returns @@ -750,7 +752,9 @@ Builds an InstanceType from a given string or token (such as a CfnParameter). #### Parameters -• **instanceType**: `string` +##### instanceType + +`string` An instance type as string diff --git a/apidocs/classes/SummarizationAppsyncStepfn.md b/apidocs/classes/SummarizationAppsyncStepfn.md index 4845795d..6be59f7a 100644 --- a/apidocs/classes/SummarizationAppsyncStepfn.md +++ b/apidocs/classes/SummarizationAppsyncStepfn.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -20,15 +20,21 @@ Constructs a new instance of the SummarizationAppsyncStepfn class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`SummarizationAppsyncStepfnProps`](../interfaces/SummarizationAppsyncStepfnProps.md) +##### props + +[`SummarizationAppsyncStepfnProps`](../interfaces/SummarizationAppsyncStepfnProps.md) user provided props for the construct. @@ -268,7 +274,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -302,11 +310,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -324,7 +338,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -358,7 +374,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/classes/TextToSql.md b/apidocs/classes/TextToSql.md index 80f3c99c..5fa9198e 100644 --- a/apidocs/classes/TextToSql.md +++ b/apidocs/classes/TextToSql.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** @@ -20,15 +20,21 @@ Constructs a new instance of the TextToSql class. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` represents the scope for all the resources. -• **id**: `string` +##### id + +`string` this is a a scope-unique id. -• **props**: [`TextToSqlProps`](../interfaces/TextToSqlProps.md) +##### props + +[`TextToSqlProps`](../interfaces/TextToSqlProps.md) user provided props for the construct. @@ -246,7 +252,9 @@ Record , maps construct name with number of deployments #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -280,11 +288,17 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props -• **scope**: `Construct` +[`BaseClassProps`](../interfaces/BaseClassProps.md) -• **lambdaFunctions**: `DockerImageFunction`[] +##### scope + +`Construct` + +##### lambdaFunctions + +`DockerImageFunction`[] #### Returns @@ -302,7 +316,9 @@ Returns a string representation of this construct. #### Parameters -• **props**: [`BaseClassProps`](../interfaces/BaseClassProps.md) +##### props + +[`BaseClassProps`](../interfaces/BaseClassProps.md) #### Returns @@ -336,7 +352,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/enumerations/ConstructName.md b/apidocs/enumerations/ConstructName.md index 156e15dc..1861a151 100644 --- a/apidocs/enumerations/ConstructName.md +++ b/apidocs/enumerations/ConstructName.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/enumerations/DbName.md b/apidocs/enumerations/DbName.md index d9b9eed1..32750cc7 100644 --- a/apidocs/enumerations/DbName.md +++ b/apidocs/enumerations/DbName.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/enumerations/MetatdataSource.md b/apidocs/enumerations/MetatdataSource.md index 6cd7bd98..fee72420 100644 --- a/apidocs/enumerations/MetatdataSource.md +++ b/apidocs/enumerations/MetatdataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/AossCwDashboardProps.md b/apidocs/interfaces/AossCwDashboardProps.md index 75d004b5..cae503d0 100644 --- a/apidocs/interfaces/AossCwDashboardProps.md +++ b/apidocs/interfaces/AossCwDashboardProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/AsyncInferenceConfig.md b/apidocs/interfaces/AsyncInferenceConfig.md index c215ad75..7aae3ba7 100644 --- a/apidocs/interfaces/AsyncInferenceConfig.md +++ b/apidocs/interfaces/AsyncInferenceConfig.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/BaseClassProps.md b/apidocs/interfaces/BaseClassProps.md index 1a796407..0f5fc726 100644 --- a/apidocs/interfaces/BaseClassProps.md +++ b/apidocs/interfaces/BaseClassProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/BedrockCwDashboardProps.md b/apidocs/interfaces/BedrockCwDashboardProps.md index 83562fd5..00024d04 100644 --- a/apidocs/interfaces/BedrockCwDashboardProps.md +++ b/apidocs/interfaces/BedrockCwDashboardProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/CollectionMonitoringProps.md b/apidocs/interfaces/CollectionMonitoringProps.md index ba7539db..9a6542c1 100644 --- a/apidocs/interfaces/CollectionMonitoringProps.md +++ b/apidocs/interfaces/CollectionMonitoringProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/ContainerImageConfig.md b/apidocs/interfaces/ContainerImageConfig.md index 7d0a0f18..a684a5ed 100644 --- a/apidocs/interfaces/ContainerImageConfig.md +++ b/apidocs/interfaces/ContainerImageConfig.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/ContentGenerationAppSyncLambdaProps.md b/apidocs/interfaces/ContentGenerationAppSyncLambdaProps.md index fe570b11..a0f9f9b9 100644 --- a/apidocs/interfaces/ContentGenerationAppSyncLambdaProps.md +++ b/apidocs/interfaces/ContentGenerationAppSyncLambdaProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/CustomSageMakerEndpointProps.md b/apidocs/interfaces/CustomSageMakerEndpointProps.md index bc65865c..dc6c6f80 100644 --- a/apidocs/interfaces/CustomSageMakerEndpointProps.md +++ b/apidocs/interfaces/CustomSageMakerEndpointProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/DockerLambdaCustomProps.md b/apidocs/interfaces/DockerLambdaCustomProps.md index 51aa9785..94f22777 100644 --- a/apidocs/interfaces/DockerLambdaCustomProps.md +++ b/apidocs/interfaces/DockerLambdaCustomProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md b/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md index 1d6c2faa..4acdfb8c 100644 --- a/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md +++ b/apidocs/interfaces/HuggingFaceSageMakerEndpointProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/IInstanceAliase.md b/apidocs/interfaces/IInstanceAliase.md index 092e50ac..58198815 100644 --- a/apidocs/interfaces/IInstanceAliase.md +++ b/apidocs/interfaces/IInstanceAliase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/IInstanceValiant.md b/apidocs/interfaces/IInstanceValiant.md index 0dfafcb5..c46010f4 100644 --- a/apidocs/interfaces/IInstanceValiant.md +++ b/apidocs/interfaces/IInstanceValiant.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/IJumpStartModelSpec.md b/apidocs/interfaces/IJumpStartModelSpec.md index e296fe9a..e8f8d0d2 100644 --- a/apidocs/interfaces/IJumpStartModelSpec.md +++ b/apidocs/interfaces/IJumpStartModelSpec.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/IndexMonitoringProps.md b/apidocs/interfaces/IndexMonitoringProps.md index 19d8235d..6df11c63 100644 --- a/apidocs/interfaces/IndexMonitoringProps.md +++ b/apidocs/interfaces/IndexMonitoringProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/JumpStartSageMakerEndpointProps.md b/apidocs/interfaces/JumpStartSageMakerEndpointProps.md index 938731d3..b0ff7292 100644 --- a/apidocs/interfaces/JumpStartSageMakerEndpointProps.md +++ b/apidocs/interfaces/JumpStartSageMakerEndpointProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/LangchainLayerProps.md b/apidocs/interfaces/LangchainLayerProps.md index 435aad19..a6b2bea5 100644 --- a/apidocs/interfaces/LangchainLayerProps.md +++ b/apidocs/interfaces/LangchainLayerProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/LangchainProps.md b/apidocs/interfaces/LangchainProps.md index 944df565..2a19ca9c 100644 --- a/apidocs/interfaces/LangchainProps.md +++ b/apidocs/interfaces/LangchainProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/LlamaIndexDataLoaderProps.md b/apidocs/interfaces/LlamaIndexDataLoaderProps.md index 2a16ced1..b8ddcbe7 100644 --- a/apidocs/interfaces/LlamaIndexDataLoaderProps.md +++ b/apidocs/interfaces/LlamaIndexDataLoaderProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/ModelMonitoringProps.md b/apidocs/interfaces/ModelMonitoringProps.md index 7c48f8e9..132bc967 100644 --- a/apidocs/interfaces/ModelMonitoringProps.md +++ b/apidocs/interfaces/ModelMonitoringProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/QaAppsyncOpensearchProps.md b/apidocs/interfaces/QaAppsyncOpensearchProps.md index 6aeabe38..7479ea91 100644 --- a/apidocs/interfaces/QaAppsyncOpensearchProps.md +++ b/apidocs/interfaces/QaAppsyncOpensearchProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/RagAppsyncStepfnOpensearchProps.md b/apidocs/interfaces/RagAppsyncStepfnOpensearchProps.md index 55954315..696864a9 100644 --- a/apidocs/interfaces/RagAppsyncStepfnOpensearchProps.md +++ b/apidocs/interfaces/RagAppsyncStepfnOpensearchProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/SummarizationAppsyncStepfnProps.md b/apidocs/interfaces/SummarizationAppsyncStepfnProps.md index 10946f94..154c7de1 100644 --- a/apidocs/interfaces/SummarizationAppsyncStepfnProps.md +++ b/apidocs/interfaces/SummarizationAppsyncStepfnProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/interfaces/TextToSqlProps.md b/apidocs/interfaces/TextToSqlProps.md index 706cce15..9f0f024a 100644 --- a/apidocs/interfaces/TextToSqlProps.md +++ b/apidocs/interfaces/TextToSqlProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/README.md b/apidocs/namespaces/amazonaurora/README.md index 7c7e95fb..b3d6bee3 100644 --- a/apidocs/namespaces/amazonaurora/README.md +++ b/apidocs/namespaces/amazonaurora/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/classes/AmazonAuroraVectorStore.md b/apidocs/namespaces/amazonaurora/classes/AmazonAuroraVectorStore.md index c8f95755..5689e429 100644 --- a/apidocs/namespaces/amazonaurora/classes/AmazonAuroraVectorStore.md +++ b/apidocs/namespaces/amazonaurora/classes/AmazonAuroraVectorStore.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -18,11 +18,17 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`AmazonAuroraVectorStoreProps`](../interfaces/AmazonAuroraVectorStoreProps.md) +##### id + +`string` + +##### props + +[`AmazonAuroraVectorStoreProps`](../interfaces/AmazonAuroraVectorStoreProps.md) #### Returns @@ -174,9 +180,13 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **lambdaSecurityGroup**: `SecurityGroup` +##### lambdaSecurityGroup -• **auroraSecurityGroup**: `SecurityGroup` +`SecurityGroup` + +##### auroraSecurityGroup + +`SecurityGroup` #### Returns @@ -194,7 +204,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **clusterIdentifier**: `string` +##### clusterIdentifier + +`string` #### Returns @@ -212,7 +224,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **vpc**: `IVpc` +##### vpc + +`IVpc` #### Returns @@ -230,7 +244,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **clusterIdentifier**: `string` +##### clusterIdentifier + +`string` #### Returns @@ -248,11 +264,17 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **databaseClusterResources**: [`DatabaseClusterResources`](../interfaces/DatabaseClusterResources.md) +##### databaseClusterResources + +[`DatabaseClusterResources`](../interfaces/DatabaseClusterResources.md) + +##### lambdaSecurityGroup + +`SecurityGroup` -• **lambdaSecurityGroup**: `SecurityGroup` +##### auroraPgCRPolicy -• **auroraPgCRPolicy**: `ManagedPolicy` +`ManagedPolicy` #### Returns @@ -270,13 +292,21 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **vpc**: `IVpc` +##### vpc -• **secret**: `ISecret` +`IVpc` -• **clusterIdentifier**: `string` +##### secret + +`ISecret` + +##### clusterIdentifier + +`string` -• **auroraSecurityGroupId**: `string` +##### auroraSecurityGroupId + +`string` #### Returns @@ -317,15 +347,21 @@ used for the database. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` The scope in which to define the construct. -• **id**: `string` +##### id + +`string` The ID of the construct. -• **props**: [`ExistingAmazonAuroraVectorStoreProps`](../interfaces/ExistingAmazonAuroraVectorStoreProps.md) +##### props + +[`ExistingAmazonAuroraVectorStoreProps`](../interfaces/ExistingAmazonAuroraVectorStoreProps.md) The properties of the existing Aurora Vector Store. @@ -359,7 +395,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/amazonaurora/classes/ExistingAmazonAuroraVectorStore.md b/apidocs/namespaces/amazonaurora/classes/ExistingAmazonAuroraVectorStore.md index 25629ce6..65e9e079 100644 --- a/apidocs/namespaces/amazonaurora/classes/ExistingAmazonAuroraVectorStore.md +++ b/apidocs/namespaces/amazonaurora/classes/ExistingAmazonAuroraVectorStore.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -18,11 +18,17 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`ExistingAmazonAuroraVectorStoreProps`](../interfaces/ExistingAmazonAuroraVectorStoreProps.md) +##### id + +`string` + +##### props + +[`ExistingAmazonAuroraVectorStoreProps`](../interfaces/ExistingAmazonAuroraVectorStoreProps.md) #### Returns @@ -174,9 +180,13 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **lambdaSecurityGroup**: `SecurityGroup` +##### lambdaSecurityGroup -• **auroraSecurityGroup**: `SecurityGroup` +`SecurityGroup` + +##### auroraSecurityGroup + +`SecurityGroup` #### Returns @@ -194,7 +204,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **clusterIdentifier**: `string` +##### clusterIdentifier + +`string` #### Returns @@ -212,7 +224,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **vpc**: `IVpc` +##### vpc + +`IVpc` #### Returns @@ -230,7 +244,9 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **clusterIdentifier**: `string` +##### clusterIdentifier + +`string` #### Returns @@ -248,11 +264,17 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **databaseClusterResources**: [`DatabaseClusterResources`](../interfaces/DatabaseClusterResources.md) +##### databaseClusterResources -• **lambdaSecurityGroup**: `SecurityGroup` +[`DatabaseClusterResources`](../interfaces/DatabaseClusterResources.md) + +##### lambdaSecurityGroup + +`SecurityGroup` -• **auroraPgCRPolicy**: `ManagedPolicy` +##### auroraPgCRPolicy + +`ManagedPolicy` #### Returns @@ -270,13 +292,21 @@ The VPC of your Amazon Aurora DB cluster. #### Parameters -• **vpc**: `IVpc` +##### vpc + +`IVpc` -• **secret**: `ISecret` +##### secret -• **clusterIdentifier**: `string` +`ISecret` -• **auroraSecurityGroupId**: `string` +##### clusterIdentifier + +`string` + +##### auroraSecurityGroupId + +`string` #### Returns @@ -326,7 +356,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/amazonaurora/interfaces/AmazonAuroraVectorStoreProps.md b/apidocs/namespaces/amazonaurora/interfaces/AmazonAuroraVectorStoreProps.md index fe5b88da..6added8c 100644 --- a/apidocs/namespaces/amazonaurora/interfaces/AmazonAuroraVectorStoreProps.md +++ b/apidocs/namespaces/amazonaurora/interfaces/AmazonAuroraVectorStoreProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/interfaces/BaseAuroraVectorStoreProps.md b/apidocs/namespaces/amazonaurora/interfaces/BaseAuroraVectorStoreProps.md index 098ab4da..a2184103 100644 --- a/apidocs/namespaces/amazonaurora/interfaces/BaseAuroraVectorStoreProps.md +++ b/apidocs/namespaces/amazonaurora/interfaces/BaseAuroraVectorStoreProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/interfaces/DatabaseClusterResources.md b/apidocs/namespaces/amazonaurora/interfaces/DatabaseClusterResources.md index f0647b18..ef09f402 100644 --- a/apidocs/namespaces/amazonaurora/interfaces/DatabaseClusterResources.md +++ b/apidocs/namespaces/amazonaurora/interfaces/DatabaseClusterResources.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/interfaces/ExistingAmazonAuroraVectorStoreProps.md b/apidocs/namespaces/amazonaurora/interfaces/ExistingAmazonAuroraVectorStoreProps.md index ac17c28e..b3d916e2 100644 --- a/apidocs/namespaces/amazonaurora/interfaces/ExistingAmazonAuroraVectorStoreProps.md +++ b/apidocs/namespaces/amazonaurora/interfaces/ExistingAmazonAuroraVectorStoreProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/type-aliases/SupportedPostgreSQLVersions.md b/apidocs/namespaces/amazonaurora/type-aliases/SupportedPostgreSQLVersions.md index 6c2267ed..55bd2e6b 100644 --- a/apidocs/namespaces/amazonaurora/type-aliases/SupportedPostgreSQLVersions.md +++ b/apidocs/namespaces/amazonaurora/type-aliases/SupportedPostgreSQLVersions.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/amazonaurora/variables/SupportedPostgreSQLVersions.md b/apidocs/namespaces/amazonaurora/variables/SupportedPostgreSQLVersions.md index e9037687..31252866 100644 --- a/apidocs/namespaces/amazonaurora/variables/SupportedPostgreSQLVersions.md +++ b/apidocs/namespaces/amazonaurora/variables/SupportedPostgreSQLVersions.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/README.md b/apidocs/namespaces/bedrock/README.md index 15d762e8..12428e4b 100644 --- a/apidocs/namespaces/bedrock/README.md +++ b/apidocs/namespaces/bedrock/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) *** diff --git a/apidocs/namespaces/bedrock/classes/Agent.md b/apidocs/namespaces/bedrock/classes/Agent.md index c62d2c26..583f3e66 100644 --- a/apidocs/namespaces/bedrock/classes/Agent.md +++ b/apidocs/namespaces/bedrock/classes/Agent.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Deploy a Bedrock Agent. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`AgentProps`](../interfaces/AgentProps.md) +##### id + +`string` + +##### props + +[`AgentProps`](../interfaces/AgentProps.md) #### Returns @@ -152,7 +158,9 @@ Register a dependency for aliases. #### Parameters -• **updatedAt**: `string` +##### updatedAt + +`string` The updatedAt of the resource that will be registered as a dependency. @@ -172,7 +180,9 @@ Add action group to the agent. #### Parameters -• **actionGroup**: [`AgentActionGroup`](AgentActionGroup.md) +##### actionGroup + +[`AgentActionGroup`](AgentActionGroup.md) #### Returns @@ -188,7 +198,9 @@ Add action groups to the agent. #### Parameters -• **actionGroups**: [`AgentActionGroup`](AgentActionGroup.md)[] +##### actionGroups + +[`AgentActionGroup`](AgentActionGroup.md)[] #### Returns @@ -204,7 +216,9 @@ Add an alias to the agent. #### Parameters -• **props**: [`AddAgentAliasProps`](../interfaces/AddAgentAliasProps.md) +##### props + +[`AddAgentAliasProps`](../interfaces/AddAgentAliasProps.md) #### Returns @@ -220,7 +234,9 @@ Add guardrail to the agent. #### Parameters -• **guardrail**: [`IGuardrail`](../interfaces/IGuardrail.md) +##### guardrail + +[`IGuardrail`](../interfaces/IGuardrail.md) #### Returns @@ -236,7 +252,9 @@ Add knowledge base to the agent. #### Parameters -• **knowledgeBase**: [`KnowledgeBase`](KnowledgeBase.md) +##### knowledgeBase + +[`KnowledgeBase`](KnowledgeBase.md) #### Returns @@ -252,7 +270,9 @@ Add knowledge bases to the agent. #### Parameters -• **knowledgeBases**: [`KnowledgeBase`](KnowledgeBase.md)[] +##### knowledgeBases + +[`KnowledgeBase`](KnowledgeBase.md)[] #### Returns @@ -298,7 +318,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/bedrock/classes/AgentActionGroup.md b/apidocs/namespaces/bedrock/classes/AgentActionGroup.md index a4c95536..31c3d37e 100644 --- a/apidocs/namespaces/bedrock/classes/AgentActionGroup.md +++ b/apidocs/namespaces/bedrock/classes/AgentActionGroup.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -18,11 +18,17 @@ #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`AgentActionGroupProps`](../interfaces/AgentActionGroupProps.md) +##### id + +`string` + +##### props + +[`AgentActionGroupProps`](../interfaces/AgentActionGroupProps.md) #### Returns @@ -162,7 +168,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/bedrock/classes/AgentAlias.md b/apidocs/namespaces/bedrock/classes/AgentAlias.md index 10688db6..f463f10c 100644 --- a/apidocs/namespaces/bedrock/classes/AgentAlias.md +++ b/apidocs/namespaces/bedrock/classes/AgentAlias.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -24,11 +24,17 @@ Interface for both Imported and CDK-created Agent Aliases. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`AgentAliasProps`](../interfaces/AgentAliasProps.md) +##### id + +`string` + +##### props + +[`AgentAliasProps`](../interfaces/AgentAliasProps.md) #### Returns @@ -132,11 +138,17 @@ Brings an Agent Alias from an existing one created outside of CDK. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` -• **id**: `string` +##### id -• **aliasArn**: `string` +`string` + +##### aliasArn + +`string` #### Returns @@ -166,7 +178,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/bedrock/classes/ApiSchema.md b/apidocs/namespaces/bedrock/classes/ApiSchema.md index ed6a566d..d9b3e6aa 100644 --- a/apidocs/namespaces/bedrock/classes/ApiSchema.md +++ b/apidocs/namespaces/bedrock/classes/ApiSchema.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -34,7 +34,9 @@ to the stack, add resources and have fun. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope. @@ -53,7 +55,9 @@ Loads the API Schema from a local disk path. #### Parameters -• **path**: `string` +##### path + +`string` Path to the Open API schema file in yaml or JSON @@ -73,11 +77,15 @@ API Schema as an S3 object. #### Parameters -• **bucket**: `IBucket` +##### bucket + +`IBucket` The S3 bucket -• **key**: `string` +##### key + +`string` The object key @@ -97,7 +105,9 @@ Inline code for API Schema #### Parameters -• **schema**: `string` +##### schema + +`string` The actual Open API schema diff --git a/apidocs/namespaces/bedrock/classes/ApplicationInferenceProfile.md b/apidocs/namespaces/bedrock/classes/ApplicationInferenceProfile.md index 9fb34b4f..0c7e4069 100644 --- a/apidocs/namespaces/bedrock/classes/ApplicationInferenceProfile.md +++ b/apidocs/namespaces/bedrock/classes/ApplicationInferenceProfile.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -34,11 +34,17 @@ https://docs.aws.amazon.com/bedrock/latest/userguide/inference-profiles-create.h #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`ApplicationInferenceProfileProps`](../interfaces/ApplicationInferenceProfileProps.md) +##### id + +`string` + +##### props + +[`ApplicationInferenceProfileProps`](../interfaces/ApplicationInferenceProfileProps.md) #### Returns @@ -241,7 +247,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -281,13 +289,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -316,7 +328,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -339,7 +353,9 @@ Gives the appropriate policies to invoke and use the application inference profi #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -360,7 +376,9 @@ Does not grant permissions to use the model/cross-region profile in the AIP. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -396,11 +414,17 @@ Import a ApplicationInferenceProfile given its attributes #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` + +##### id + +`string` -• **id**: `string` +##### attrs -• **attrs**: [`ApplicationInferenceProfileAttributes`](../interfaces/ApplicationInferenceProfileAttributes.md) +[`ApplicationInferenceProfileAttributes`](../interfaces/ApplicationInferenceProfileAttributes.md) #### Returns @@ -416,7 +440,9 @@ Import a low-level L1 Cfn ApplicationInferenceProfile #### Parameters -• **CfnApplicationInferenceProfile**: `CfnApplicationInferenceProfile` +##### CfnApplicationInferenceProfile + +`CfnApplicationInferenceProfile` #### Returns @@ -446,7 +472,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -470,7 +498,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -490,7 +520,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/BedrockFoundationModel.md b/apidocs/namespaces/bedrock/classes/BedrockFoundationModel.md index f272f044..ce861bc0 100644 --- a/apidocs/namespaces/bedrock/classes/BedrockFoundationModel.md +++ b/apidocs/namespaces/bedrock/classes/BedrockFoundationModel.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -23,9 +23,13 @@ can instantiate a `BedrockFoundationModel` object, e.g: `new BedrockFoundationMo #### Parameters -• **value**: `string` +##### value -• **props**: [`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` +`string` + +##### props + +[`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` #### Returns @@ -230,7 +234,9 @@ Returns the ARN of the foundation model in the following format: #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -244,7 +250,9 @@ Returns the ARN of the foundation model in the following format: #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -260,7 +268,9 @@ Gives the appropriate policies to invoke and use the Foundation Model in the sta #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -280,7 +290,9 @@ Gives the appropriate policies to invoke and use the Foundation Model in all reg #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -306,9 +318,13 @@ Returns a string representation of an object. #### Parameters -• **modelId**: `FoundationModel` +##### modelId + +`FoundationModel` + +##### props -• **props**: [`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` +[`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` #### Returns @@ -322,9 +338,13 @@ Returns a string representation of an object. #### Parameters -• **modelId**: `FoundationModelIdentifier` +##### modelId + +`FoundationModelIdentifier` + +##### props -• **props**: [`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` +[`BedrockFoundationModelProps`](../interfaces/BedrockFoundationModelProps.md) = `{}` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/ChunkingStrategy.md b/apidocs/namespaces/bedrock/classes/ChunkingStrategy.md index 5749cdb4..9bac0541 100644 --- a/apidocs/namespaces/bedrock/classes/ChunkingStrategy.md +++ b/apidocs/namespaces/bedrock/classes/ChunkingStrategy.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -84,7 +84,9 @@ Method for customizing a fixed sized chunking strategy. #### Parameters -• **props**: `FixedSizeChunkingConfigurationProperty` +##### props + +`FixedSizeChunkingConfigurationProperty` #### Returns @@ -103,7 +105,9 @@ For custom chunking, the maximum token chunk size depends on the model. #### Parameters -• **props**: [`HierarchicalChunkingProps`](../interfaces/HierarchicalChunkingProps.md) +##### props + +[`HierarchicalChunkingProps`](../interfaces/HierarchicalChunkingProps.md) #### Returns @@ -122,7 +126,9 @@ For custom chunking, the maximum token chunk size depends on the model. #### Parameters -• **props**: `SemanticChunkingConfigurationProperty` +##### props + +`SemanticChunkingConfigurationProperty` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/ConfluenceDataSource.md b/apidocs/namespaces/bedrock/classes/ConfluenceDataSource.md index ab1c8cae..1c916049 100644 --- a/apidocs/namespaces/bedrock/classes/ConfluenceDataSource.md +++ b/apidocs/namespaces/bedrock/classes/ConfluenceDataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -24,11 +24,17 @@ https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-conn #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`ConfluenceDataSourceProps`](../interfaces/ConfluenceDataSourceProps.md) +##### id + +`string` + +##### props + +[`ConfluenceDataSourceProps`](../interfaces/ConfluenceDataSourceProps.md) #### Returns @@ -220,7 +226,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -240,9 +248,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -282,13 +294,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -317,7 +333,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -340,7 +358,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -390,7 +410,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -414,7 +436,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -434,7 +458,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/CrossRegionInferenceProfile.md b/apidocs/namespaces/bedrock/classes/CrossRegionInferenceProfile.md index b798ee90..fd871791 100644 --- a/apidocs/namespaces/bedrock/classes/CrossRegionInferenceProfile.md +++ b/apidocs/namespaces/bedrock/classes/CrossRegionInferenceProfile.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -98,7 +98,9 @@ Gives the appropriate policies to invoke and use the Foundation Model. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -119,7 +121,9 @@ Does not grant permissions to use the model in the profile. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -137,7 +141,9 @@ Does not grant permissions to use the model in the profile. #### Parameters -• **config**: [`CrossRegionInferenceProfileProps`](../interfaces/CrossRegionInferenceProfileProps.md) +##### config + +[`CrossRegionInferenceProfileProps`](../interfaces/CrossRegionInferenceProfileProps.md) #### Returns diff --git a/apidocs/namespaces/bedrock/classes/CustomTransformation.md b/apidocs/namespaces/bedrock/classes/CustomTransformation.md index 374b19f1..51bfd6fd 100644 --- a/apidocs/namespaces/bedrock/classes/CustomTransformation.md +++ b/apidocs/namespaces/bedrock/classes/CustomTransformation.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -38,7 +38,9 @@ The CloudFormation property representation of this custom transformation configu #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` #### Returns @@ -55,7 +57,9 @@ into the knowledge base ingestion process. #### Parameters -• **props**: [`LambdaCustomTransformationProps`](../interfaces/LambdaCustomTransformationProps.md) +##### props + +[`LambdaCustomTransformationProps`](../interfaces/LambdaCustomTransformationProps.md) #### Returns diff --git a/apidocs/namespaces/bedrock/classes/DataSource.md b/apidocs/namespaces/bedrock/classes/DataSource.md index b333233e..26416cfb 100644 --- a/apidocs/namespaces/bedrock/classes/DataSource.md +++ b/apidocs/namespaces/bedrock/classes/DataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -130,7 +130,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -170,13 +172,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -205,7 +211,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -242,11 +250,17 @@ Returns a string representation of this construct. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` -• **id**: `string` +##### id -• **dataSourceId**: `string` +`string` + +##### dataSourceId + +`string` #### Returns @@ -276,7 +290,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -300,7 +316,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -320,7 +338,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/DataSourceBase.md b/apidocs/namespaces/bedrock/classes/DataSourceBase.md index 4967b367..7be71dcb 100644 --- a/apidocs/namespaces/bedrock/classes/DataSourceBase.md +++ b/apidocs/namespaces/bedrock/classes/DataSourceBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -29,11 +29,17 @@ Specifies the base class for all data source resources (imported and new). #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: `ResourceProps` +##### id + +`string` + +##### props? + +`ResourceProps` #### Returns @@ -173,7 +179,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -217,13 +225,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -252,7 +264,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -305,7 +319,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -329,7 +345,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -349,7 +367,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/DataSourceNew.md b/apidocs/namespaces/bedrock/classes/DataSourceNew.md index b333d5b7..091d004c 100644 --- a/apidocs/namespaces/bedrock/classes/DataSourceNew.md +++ b/apidocs/namespaces/bedrock/classes/DataSourceNew.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -28,11 +28,17 @@ Specifies the base class for all NEW data source resources of ANY type. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: `ResourceProps` +##### id + +`string` + +##### props? + +`ResourceProps` #### Returns @@ -192,7 +198,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -212,9 +220,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -250,13 +262,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -285,7 +301,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -308,7 +326,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -354,7 +374,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -378,7 +400,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -398,7 +422,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/Guardrail.md b/apidocs/namespaces/bedrock/classes/Guardrail.md index 603073e5..7b3bf7ff 100644 --- a/apidocs/namespaces/bedrock/classes/Guardrail.md +++ b/apidocs/namespaces/bedrock/classes/Guardrail.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Class to create a Guardrail with CDK. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`GuardrailProps`](../interfaces/GuardrailProps.md) +##### id + +`string` + +##### props + +[`GuardrailProps`](../interfaces/GuardrailProps.md) #### Returns @@ -266,7 +272,9 @@ Adds a content filter to the guardrail. #### Parameters -• **filter**: [`ContentFilter`](../interfaces/ContentFilter.md) +##### filter + +[`ContentFilter`](../interfaces/ContentFilter.md) The content filter to add. @@ -284,7 +292,9 @@ Adds a contextual grounding filter to the guardrail. #### Parameters -• **filter**: [`ContextualGroundingFilter`](../interfaces/ContextualGroundingFilter.md) +##### filter + +[`ContextualGroundingFilter`](../interfaces/ContextualGroundingFilter.md) The contextual grounding filter to add. @@ -302,7 +312,9 @@ Adds a denied topic filter to the guardrail. #### Parameters -• **filter**: [`Topic`](Topic.md) +##### filter + +[`Topic`](Topic.md) The denied topic filter to add. @@ -320,7 +332,9 @@ Adds a managed word list filter to the guardrail. #### Parameters -• **filter**: [`PROFANITY`](../enumerations/ManagedWordFilterType.md#profanity) +##### filter + +[`PROFANITY`](../enumerations/ManagedWordFilterType.md#profanity) The managed word list filter to add. @@ -338,7 +352,9 @@ Adds a PII filter to the guardrail. #### Parameters -• **filter**: [`PIIFilter`](../interfaces/PIIFilter.md) +##### filter + +[`PIIFilter`](../interfaces/PIIFilter.md) The PII filter to add. @@ -356,7 +372,9 @@ Adds a regex filter to the guardrail. #### Parameters -• **filter**: [`RegexFilter`](../interfaces/RegexFilter.md) +##### filter + +[`RegexFilter`](../interfaces/RegexFilter.md) The regex filter to add. @@ -374,7 +392,9 @@ Adds a word filter to the guardrail. #### Parameters -• **filter**: `string` +##### filter + +`string` The word filter to add. @@ -392,7 +412,9 @@ Adds a word filter to the guardrail. #### Parameters -• **filePath**: `string` +##### filePath + +`string` The location of the word filter file. @@ -418,7 +440,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -438,7 +462,9 @@ Create a version for the guardrail. #### Parameters -• **description?**: `string` +##### description? + +`string` The description of the version. @@ -478,13 +504,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -513,7 +543,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -536,7 +568,9 @@ Grant the given identity permissions to apply the guardrail. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -572,7 +606,9 @@ Import a low-level L1 Cfn Guardrail #### Parameters -• **cfnGuardrail**: `CfnGuardrail` +##### cfnGuardrail + +`CfnGuardrail` #### Returns @@ -588,11 +624,17 @@ Import a guardrail given its attributes #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **attrs**: [`GuardrailAttributes`](../interfaces/GuardrailAttributes.md) +##### id + +`string` + +##### attrs + +[`GuardrailAttributes`](../interfaces/GuardrailAttributes.md) #### Returns @@ -622,7 +664,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -646,7 +690,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -666,7 +712,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/GuardrailBase.md b/apidocs/namespaces/bedrock/classes/GuardrailBase.md index f8855c56..07f6a687 100644 --- a/apidocs/namespaces/bedrock/classes/GuardrailBase.md +++ b/apidocs/namespaces/bedrock/classes/GuardrailBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -29,11 +29,17 @@ Contains methods and attributes valid for Guardrails either created with CDK or #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: `ResourceProps` +##### id + +`string` + +##### props? + +`ResourceProps` #### Returns @@ -203,7 +209,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -247,13 +255,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -282,7 +294,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -305,7 +319,9 @@ Grant the given identity permissions to apply the guardrail. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -355,7 +371,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -379,7 +397,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -399,7 +419,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/InferenceProfileBase.md b/apidocs/namespaces/bedrock/classes/InferenceProfileBase.md index d4076e27..1021cb92 100644 --- a/apidocs/namespaces/bedrock/classes/InferenceProfileBase.md +++ b/apidocs/namespaces/bedrock/classes/InferenceProfileBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -30,11 +30,17 @@ Contains methods and attributes valid for ApplicationInferenceProfiles either cr #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: `ResourceProps` +##### id + +`string` + +##### props? + +`ResourceProps` #### Returns @@ -192,7 +198,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -236,13 +244,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -271,7 +283,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -295,7 +309,9 @@ Does not grant permissions to use the model in the profile. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -345,7 +361,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -369,7 +387,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -389,7 +409,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/InlineApiSchema.md b/apidocs/namespaces/bedrock/classes/InlineApiSchema.md index ea589dc9..39e5d096 100644 --- a/apidocs/namespaces/bedrock/classes/InlineApiSchema.md +++ b/apidocs/namespaces/bedrock/classes/InlineApiSchema.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,7 +20,9 @@ API Schema from a string value. #### Parameters -• **schema**: `string` +##### schema + +`string` #### Returns @@ -41,7 +43,9 @@ to the stack, add resources and have fun. #### Parameters -• **\_scope**: `Construct` +##### \_scope + +`Construct` #### Returns @@ -61,7 +65,9 @@ Loads the API Schema from a local disk path. #### Parameters -• **path**: `string` +##### path + +`string` Path to the Open API schema file in yaml or JSON @@ -85,11 +91,15 @@ API Schema as an S3 object. #### Parameters -• **bucket**: `IBucket` +##### bucket + +`IBucket` The S3 bucket -• **key**: `string` +##### key + +`string` The object key @@ -113,7 +123,9 @@ Inline code for API Schema #### Parameters -• **schema**: `string` +##### schema + +`string` The actual Open API schema diff --git a/apidocs/namespaces/bedrock/classes/KnowledgeBase.md b/apidocs/namespaces/bedrock/classes/KnowledgeBase.md index d2101cba..d7794d57 100644 --- a/apidocs/namespaces/bedrock/classes/KnowledgeBase.md +++ b/apidocs/namespaces/bedrock/classes/KnowledgeBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -21,11 +21,17 @@ Pinecone, Redis Enterprise Cloud or Amazon Aurora PostgreSQL. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`KnowledgeBaseProps`](../interfaces/KnowledgeBaseProps.md) +##### id + +`string` + +##### props + +[`KnowledgeBaseProps`](../interfaces/KnowledgeBaseProps.md) #### Returns @@ -211,7 +217,9 @@ Add a Confluence data source to the knowledge base. #### Parameters -• **props**: [`ConfluenceDataSourceAssociationProps`](../interfaces/ConfluenceDataSourceAssociationProps.md) +##### props + +[`ConfluenceDataSourceAssociationProps`](../interfaces/ConfluenceDataSourceAssociationProps.md) #### Returns @@ -231,7 +239,9 @@ Add an S3 data source to the knowledge base. #### Parameters -• **props**: [`S3DataSourceAssociationProps`](../interfaces/S3DataSourceAssociationProps.md) +##### props + +[`S3DataSourceAssociationProps`](../interfaces/S3DataSourceAssociationProps.md) #### Returns @@ -251,7 +261,9 @@ Add a Salesforce data source to the knowledge base. #### Parameters -• **props**: [`SalesforceDataSourceAssociationProps`](../interfaces/SalesforceDataSourceAssociationProps.md) +##### props + +[`SalesforceDataSourceAssociationProps`](../interfaces/SalesforceDataSourceAssociationProps.md) #### Returns @@ -271,7 +283,9 @@ Add a SharePoint data source to the knowledge base. #### Parameters -• **props**: [`SharePointDataSourceAssociationProps`](../interfaces/SharePointDataSourceAssociationProps.md) +##### props + +[`SharePointDataSourceAssociationProps`](../interfaces/SharePointDataSourceAssociationProps.md) #### Returns @@ -291,7 +305,9 @@ Add a web crawler data source to the knowledge base. #### Parameters -• **props**: [`WebCrawlerDataSourceAssociationProps`](../interfaces/WebCrawlerDataSourceAssociationProps.md) +##### props + +[`WebCrawlerDataSourceAssociationProps`](../interfaces/WebCrawlerDataSourceAssociationProps.md) #### Returns @@ -319,7 +335,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -339,7 +357,9 @@ Associate knowledge base with an agent #### Parameters -• **agent**: [`Agent`](Agent.md) +##### agent + +[`Agent`](Agent.md) #### Returns @@ -375,13 +395,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -410,7 +434,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -447,11 +473,17 @@ Returns a string representation of this construct. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` -• **id**: `string` +##### id -• **attrs**: [`KnowledgeBaseAttributes`](../interfaces/KnowledgeBaseAttributes.md) +`string` + +##### attrs + +[`KnowledgeBaseAttributes`](../interfaces/KnowledgeBaseAttributes.md) #### Returns @@ -481,7 +513,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -505,7 +539,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -525,7 +561,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/ParsingStategy.md b/apidocs/namespaces/bedrock/classes/ParsingStategy.md index 119a4b06..25bad637 100644 --- a/apidocs/namespaces/bedrock/classes/ParsingStategy.md +++ b/apidocs/namespaces/bedrock/classes/ParsingStategy.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -53,7 +53,9 @@ from documents such as tables and charts. #### Parameters -• **props**: [`FoundationModelParsingStategyProps`](../interfaces/FoundationModelParsingStategyProps.md) +##### props + +[`FoundationModelParsingStategyProps`](../interfaces/FoundationModelParsingStategyProps.md) #### Returns diff --git a/apidocs/namespaces/bedrock/classes/Prompt.md b/apidocs/namespaces/bedrock/classes/Prompt.md index c54a0a08..c9f95fa1 100644 --- a/apidocs/namespaces/bedrock/classes/Prompt.md +++ b/apidocs/namespaces/bedrock/classes/Prompt.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -34,11 +34,17 @@ https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`PromptProps`](../interfaces/PromptProps.md) +##### id + +`string` + +##### props + +[`PromptProps`](../interfaces/PromptProps.md) #### Returns @@ -156,7 +162,9 @@ Adds a prompt variant. #### Parameters -• **variant**: [`PromptVariant`](PromptVariant.md) +##### variant + +[`PromptVariant`](PromptVariant.md) #### Returns @@ -173,7 +181,9 @@ deployed to production. #### Parameters -• **description?**: `string` +##### description? + +`string` #### Returns @@ -203,11 +213,17 @@ Returns a string representation of this construct. #### Parameters -• **scope**: `Construct` +##### scope + +`Construct` + +##### id -• **id**: `string` +`string` + +##### attrs -• **attrs**: [`PromptAttributes`](../interfaces/PromptAttributes.md) +[`PromptAttributes`](../interfaces/PromptAttributes.md) #### Returns @@ -237,7 +253,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/bedrock/classes/PromptBase.md b/apidocs/namespaces/bedrock/classes/PromptBase.md index e6ab6dcb..0e335988 100644 --- a/apidocs/namespaces/bedrock/classes/PromptBase.md +++ b/apidocs/namespaces/bedrock/classes/PromptBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -25,11 +25,17 @@ Contains methods and attributes valid for Promtps either created with CDK or imp #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: `ResourceProps` +##### id + +`string` + +##### props? + +`ResourceProps` #### Returns @@ -205,7 +211,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -245,13 +253,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -280,7 +292,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -303,7 +317,9 @@ Grant the given identity permissions to get the prompt. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns @@ -349,7 +365,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -373,7 +391,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -393,7 +413,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/PromptVariant.md b/apidocs/namespaces/bedrock/classes/PromptVariant.md index c89038c4..2f94156e 100644 --- a/apidocs/namespaces/bedrock/classes/PromptVariant.md +++ b/apidocs/namespaces/bedrock/classes/PromptVariant.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -70,7 +70,9 @@ Static method to create a text template #### Parameters -• **props**: [`TextPromptVariantProps`](../interfaces/TextPromptVariantProps.md) +##### props + +[`TextPromptVariantProps`](../interfaces/TextPromptVariantProps.md) #### Returns diff --git a/apidocs/namespaces/bedrock/classes/PromptVersion.md b/apidocs/namespaces/bedrock/classes/PromptVersion.md index 52fe12ae..51537ef8 100644 --- a/apidocs/namespaces/bedrock/classes/PromptVersion.md +++ b/apidocs/namespaces/bedrock/classes/PromptVersion.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -33,11 +33,17 @@ https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.ht #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`PromptVersionProps`](../interfaces/PromptVersionProps.md) +##### id + +`string` + +##### props + +[`PromptVersionProps`](../interfaces/PromptVersionProps.md) #### Returns @@ -129,7 +135,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/bedrock/classes/S3ApiSchema.md b/apidocs/namespaces/bedrock/classes/S3ApiSchema.md index b3e33564..a963a3c4 100644 --- a/apidocs/namespaces/bedrock/classes/S3ApiSchema.md +++ b/apidocs/namespaces/bedrock/classes/S3ApiSchema.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,9 +20,13 @@ API Schema in an S3 object. #### Parameters -• **bucket**: `IBucket` +##### bucket -• **key**: `string` +`IBucket` + +##### key + +`string` #### Returns @@ -43,7 +47,9 @@ to the stack, add resources and have fun. #### Parameters -• **\_scope**: `Construct` +##### \_scope + +`Construct` #### Returns @@ -63,7 +69,9 @@ Loads the API Schema from a local disk path. #### Parameters -• **path**: `string` +##### path + +`string` Path to the Open API schema file in yaml or JSON @@ -87,11 +95,15 @@ API Schema as an S3 object. #### Parameters -• **bucket**: `IBucket` +##### bucket + +`IBucket` The S3 bucket -• **key**: `string` +##### key + +`string` The object key @@ -115,7 +127,9 @@ Inline code for API Schema #### Parameters -• **schema**: `string` +##### schema + +`string` The actual Open API schema diff --git a/apidocs/namespaces/bedrock/classes/S3DataSource.md b/apidocs/namespaces/bedrock/classes/S3DataSource.md index e8cb9a73..d8f6dbf6 100644 --- a/apidocs/namespaces/bedrock/classes/S3DataSource.md +++ b/apidocs/namespaces/bedrock/classes/S3DataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Sets up an S3 Data Source to be added to a knowledge base. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`S3DataSourceProps`](../interfaces/S3DataSourceProps.md) +##### id + +`string` + +##### props + +[`S3DataSourceProps`](../interfaces/S3DataSourceProps.md) #### Returns @@ -208,7 +214,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -228,9 +236,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -270,13 +282,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -305,7 +321,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -328,7 +346,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -378,7 +398,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -402,7 +424,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -422,7 +446,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/SalesforceDataSource.md b/apidocs/namespaces/bedrock/classes/SalesforceDataSource.md index 99ef94af..ced839b0 100644 --- a/apidocs/namespaces/bedrock/classes/SalesforceDataSource.md +++ b/apidocs/namespaces/bedrock/classes/SalesforceDataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Sets up an data source to be added to a knowledge base. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`SalesforceDataSourceProps`](../interfaces/SalesforceDataSourceProps.md) +##### id + +`string` + +##### props + +[`SalesforceDataSourceProps`](../interfaces/SalesforceDataSourceProps.md) #### Returns @@ -216,7 +222,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -236,9 +244,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -278,13 +290,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -313,7 +329,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -336,7 +354,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -386,7 +406,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -410,7 +432,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -430,7 +454,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/SharePointDataSource.md b/apidocs/namespaces/bedrock/classes/SharePointDataSource.md index c7e5b4ff..819182a5 100644 --- a/apidocs/namespaces/bedrock/classes/SharePointDataSource.md +++ b/apidocs/namespaces/bedrock/classes/SharePointDataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Sets up an data source to be added to a knowledge base. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`SharePointDataSourceProps`](../interfaces/SharePointDataSourceProps.md) +##### id + +`string` + +##### props + +[`SharePointDataSourceProps`](../interfaces/SharePointDataSourceProps.md) #### Returns @@ -224,7 +230,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -244,9 +252,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -286,13 +298,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -321,7 +337,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -344,7 +362,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -394,7 +414,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -418,7 +440,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -438,7 +462,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/classes/Topic.md b/apidocs/namespaces/bedrock/classes/Topic.md index cc28d247..9f37f827 100644 --- a/apidocs/namespaces/bedrock/classes/Topic.md +++ b/apidocs/namespaces/bedrock/classes/Topic.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -16,7 +16,9 @@ Defines a topic to deny. #### Parameters -• **props**: [`CustomTopicProps`](../interfaces/CustomTopicProps.md) +##### props + +[`CustomTopicProps`](../interfaces/CustomTopicProps.md) #### Returns @@ -84,7 +86,9 @@ The name of the topic to deny. #### Parameters -• **props**: [`CustomTopicProps`](../interfaces/CustomTopicProps.md) +##### props + +[`CustomTopicProps`](../interfaces/CustomTopicProps.md) #### Returns diff --git a/apidocs/namespaces/bedrock/classes/WebCrawlerDataSource.md b/apidocs/namespaces/bedrock/classes/WebCrawlerDataSource.md index 66f06f38..d2adaeb3 100644 --- a/apidocs/namespaces/bedrock/classes/WebCrawlerDataSource.md +++ b/apidocs/namespaces/bedrock/classes/WebCrawlerDataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Sets up a web crawler data source to be added to a knowledge base. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`WebCrawlerDataSourceProps`](../interfaces/WebCrawlerDataSourceProps.md) +##### id + +`string` + +##### props + +[`WebCrawlerDataSourceProps`](../interfaces/WebCrawlerDataSourceProps.md) #### Returns @@ -216,7 +222,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -236,9 +244,13 @@ Formats the data source configuration properties for CloudFormation. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) -• **dataSourceConfiguration**: `DataSourceConfigurationProperty` +##### dataSourceConfiguration + +`DataSourceConfigurationProperty` #### Returns @@ -278,13 +290,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -313,7 +329,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -336,7 +354,9 @@ Adds appropriate permissions to the KB execution role needed by the data source. #### Parameters -• **props**: [`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) +##### props + +[`DataSourceAssociationProps`](../interfaces/DataSourceAssociationProps.md) #### Returns @@ -386,7 +406,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -410,7 +432,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -430,7 +454,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/bedrock/enumerations/ConfluenceDataSourceAuthType.md b/apidocs/namespaces/bedrock/enumerations/ConfluenceDataSourceAuthType.md index 9750ad80..0a8a15df 100644 --- a/apidocs/namespaces/bedrock/enumerations/ConfluenceDataSourceAuthType.md +++ b/apidocs/namespaces/bedrock/enumerations/ConfluenceDataSourceAuthType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ConfluenceObjectType.md b/apidocs/namespaces/bedrock/enumerations/ConfluenceObjectType.md index 0e332e8c..64c340f6 100644 --- a/apidocs/namespaces/bedrock/enumerations/ConfluenceObjectType.md +++ b/apidocs/namespaces/bedrock/enumerations/ConfluenceObjectType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ContentFilterStrength.md b/apidocs/namespaces/bedrock/enumerations/ContentFilterStrength.md index 2f8c0cdd..814d0728 100644 --- a/apidocs/namespaces/bedrock/enumerations/ContentFilterStrength.md +++ b/apidocs/namespaces/bedrock/enumerations/ContentFilterStrength.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ContentFilterType.md b/apidocs/namespaces/bedrock/enumerations/ContentFilterType.md index 3c11bd62..5862e7f7 100644 --- a/apidocs/namespaces/bedrock/enumerations/ContentFilterType.md +++ b/apidocs/namespaces/bedrock/enumerations/ContentFilterType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ContextualGroundingFilterType.md b/apidocs/namespaces/bedrock/enumerations/ContextualGroundingFilterType.md index 3f3281bd..961dedf4 100644 --- a/apidocs/namespaces/bedrock/enumerations/ContextualGroundingFilterType.md +++ b/apidocs/namespaces/bedrock/enumerations/ContextualGroundingFilterType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/CrawlingScope.md b/apidocs/namespaces/bedrock/enumerations/CrawlingScope.md index 47ce3b5d..32669201 100644 --- a/apidocs/namespaces/bedrock/enumerations/CrawlingScope.md +++ b/apidocs/namespaces/bedrock/enumerations/CrawlingScope.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/CrossRegionInferenceProfileRegion.md b/apidocs/namespaces/bedrock/enumerations/CrossRegionInferenceProfileRegion.md index e3cc6225..cc73634d 100644 --- a/apidocs/namespaces/bedrock/enumerations/CrossRegionInferenceProfileRegion.md +++ b/apidocs/namespaces/bedrock/enumerations/CrossRegionInferenceProfileRegion.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/DataDeletionPolicy.md b/apidocs/namespaces/bedrock/enumerations/DataDeletionPolicy.md index 8576cf71..c7878965 100644 --- a/apidocs/namespaces/bedrock/enumerations/DataDeletionPolicy.md +++ b/apidocs/namespaces/bedrock/enumerations/DataDeletionPolicy.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/DataSourceType.md b/apidocs/namespaces/bedrock/enumerations/DataSourceType.md index 78efebc6..6fc58d6a 100644 --- a/apidocs/namespaces/bedrock/enumerations/DataSourceType.md +++ b/apidocs/namespaces/bedrock/enumerations/DataSourceType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/GuardrailAction.md b/apidocs/namespaces/bedrock/enumerations/GuardrailAction.md index 8fe5cd1b..2f4d937e 100644 --- a/apidocs/namespaces/bedrock/enumerations/GuardrailAction.md +++ b/apidocs/namespaces/bedrock/enumerations/GuardrailAction.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/InferenceProfileType.md b/apidocs/namespaces/bedrock/enumerations/InferenceProfileType.md index cabcc6e3..5d07ad42 100644 --- a/apidocs/namespaces/bedrock/enumerations/InferenceProfileType.md +++ b/apidocs/namespaces/bedrock/enumerations/InferenceProfileType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ManagedWordFilterType.md b/apidocs/namespaces/bedrock/enumerations/ManagedWordFilterType.md index 722af265..cb7f9d3d 100644 --- a/apidocs/namespaces/bedrock/enumerations/ManagedWordFilterType.md +++ b/apidocs/namespaces/bedrock/enumerations/ManagedWordFilterType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/ParserMode.md b/apidocs/namespaces/bedrock/enumerations/ParserMode.md index 449b0cf7..c447517c 100644 --- a/apidocs/namespaces/bedrock/enumerations/ParserMode.md +++ b/apidocs/namespaces/bedrock/enumerations/ParserMode.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/PromptCreationMode.md b/apidocs/namespaces/bedrock/enumerations/PromptCreationMode.md index 6a1d5c67..10cc3440 100644 --- a/apidocs/namespaces/bedrock/enumerations/PromptCreationMode.md +++ b/apidocs/namespaces/bedrock/enumerations/PromptCreationMode.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/PromptState.md b/apidocs/namespaces/bedrock/enumerations/PromptState.md index d4443821..27eeaa43 100644 --- a/apidocs/namespaces/bedrock/enumerations/PromptState.md +++ b/apidocs/namespaces/bedrock/enumerations/PromptState.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/PromptTemplateType.md b/apidocs/namespaces/bedrock/enumerations/PromptTemplateType.md index 372f94ff..4117f820 100644 --- a/apidocs/namespaces/bedrock/enumerations/PromptTemplateType.md +++ b/apidocs/namespaces/bedrock/enumerations/PromptTemplateType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/PromptType.md b/apidocs/namespaces/bedrock/enumerations/PromptType.md index fc7010f3..08e8bd2e 100644 --- a/apidocs/namespaces/bedrock/enumerations/PromptType.md +++ b/apidocs/namespaces/bedrock/enumerations/PromptType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/SalesforceDataSourceAuthType.md b/apidocs/namespaces/bedrock/enumerations/SalesforceDataSourceAuthType.md index 83fd48e0..640725ac 100644 --- a/apidocs/namespaces/bedrock/enumerations/SalesforceDataSourceAuthType.md +++ b/apidocs/namespaces/bedrock/enumerations/SalesforceDataSourceAuthType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/SalesforceObjectType.md b/apidocs/namespaces/bedrock/enumerations/SalesforceObjectType.md index a80aca72..7bde5c7a 100644 --- a/apidocs/namespaces/bedrock/enumerations/SalesforceObjectType.md +++ b/apidocs/namespaces/bedrock/enumerations/SalesforceObjectType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/SharePointDataSourceAuthType.md b/apidocs/namespaces/bedrock/enumerations/SharePointDataSourceAuthType.md index 89264dca..53dbbf6f 100644 --- a/apidocs/namespaces/bedrock/enumerations/SharePointDataSourceAuthType.md +++ b/apidocs/namespaces/bedrock/enumerations/SharePointDataSourceAuthType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/SharePointObjectType.md b/apidocs/namespaces/bedrock/enumerations/SharePointObjectType.md index a352df2d..f11bf7df 100644 --- a/apidocs/namespaces/bedrock/enumerations/SharePointObjectType.md +++ b/apidocs/namespaces/bedrock/enumerations/SharePointObjectType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/enumerations/TransformationStep.md b/apidocs/namespaces/bedrock/enumerations/TransformationStep.md index 7fc77265..47ff1707 100644 --- a/apidocs/namespaces/bedrock/enumerations/TransformationStep.md +++ b/apidocs/namespaces/bedrock/enumerations/TransformationStep.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/functions/validateInferenceConfiguration.md b/apidocs/namespaces/bedrock/functions/validateInferenceConfiguration.md index 02c23ce0..c9f200fd 100644 --- a/apidocs/namespaces/bedrock/functions/validateInferenceConfiguration.md +++ b/apidocs/namespaces/bedrock/functions/validateInferenceConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -16,7 +16,9 @@ Validate the inferenceConfiguration of a prompt override. ## Parameters -• **inferenceConfiguration**: [`InferenceConfiguration`](../interfaces/InferenceConfiguration.md) +### inferenceConfiguration + +[`InferenceConfiguration`](../interfaces/InferenceConfiguration.md) ## Returns diff --git a/apidocs/namespaces/bedrock/functions/validatePromptOverrideConfiguration.md b/apidocs/namespaces/bedrock/functions/validatePromptOverrideConfiguration.md index 6ef69d25..51178f70 100644 --- a/apidocs/namespaces/bedrock/functions/validatePromptOverrideConfiguration.md +++ b/apidocs/namespaces/bedrock/functions/validatePromptOverrideConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -16,7 +16,9 @@ Validate the promptOverrideConfiguration. ## Parameters -• **promptOverrideConfiguration**: `undefined` \| [`PromptOverrideConfiguration`](../interfaces/PromptOverrideConfiguration.md) +### promptOverrideConfiguration + +`undefined` | [`PromptOverrideConfiguration`](../interfaces/PromptOverrideConfiguration.md) ## Returns diff --git a/apidocs/namespaces/bedrock/interfaces/ActionGroupExecutor.md b/apidocs/namespaces/bedrock/interfaces/ActionGroupExecutor.md index 40bb92cb..090dec45 100644 --- a/apidocs/namespaces/bedrock/interfaces/ActionGroupExecutor.md +++ b/apidocs/namespaces/bedrock/interfaces/ActionGroupExecutor.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/AddAgentAliasProps.md b/apidocs/namespaces/bedrock/interfaces/AddAgentAliasProps.md index 62b4735f..57edcd90 100644 --- a/apidocs/namespaces/bedrock/interfaces/AddAgentAliasProps.md +++ b/apidocs/namespaces/bedrock/interfaces/AddAgentAliasProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/AgentActionGroupProps.md b/apidocs/namespaces/bedrock/interfaces/AgentActionGroupProps.md index 638284b2..b746236e 100644 --- a/apidocs/namespaces/bedrock/interfaces/AgentActionGroupProps.md +++ b/apidocs/namespaces/bedrock/interfaces/AgentActionGroupProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/AgentAliasProps.md b/apidocs/namespaces/bedrock/interfaces/AgentAliasProps.md index 6435e3c0..fd7d8cd2 100644 --- a/apidocs/namespaces/bedrock/interfaces/AgentAliasProps.md +++ b/apidocs/namespaces/bedrock/interfaces/AgentAliasProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/AgentProps.md b/apidocs/namespaces/bedrock/interfaces/AgentProps.md index 3077c935..f0f23a0d 100644 --- a/apidocs/namespaces/bedrock/interfaces/AgentProps.md +++ b/apidocs/namespaces/bedrock/interfaces/AgentProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ApiSchemaConfig.md b/apidocs/namespaces/bedrock/interfaces/ApiSchemaConfig.md index 450a935d..01d55a65 100644 --- a/apidocs/namespaces/bedrock/interfaces/ApiSchemaConfig.md +++ b/apidocs/namespaces/bedrock/interfaces/ApiSchemaConfig.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileAttributes.md b/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileAttributes.md index 12924b93..695bc2b9 100644 --- a/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileAttributes.md +++ b/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileAttributes.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileProps.md b/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileProps.md index 8f3af826..00155434 100644 --- a/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileProps.md +++ b/apidocs/namespaces/bedrock/interfaces/ApplicationInferenceProfileProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/BedrockFoundationModelProps.md b/apidocs/namespaces/bedrock/interfaces/BedrockFoundationModelProps.md index d53e5622..1fb57248 100644 --- a/apidocs/namespaces/bedrock/interfaces/BedrockFoundationModelProps.md +++ b/apidocs/namespaces/bedrock/interfaces/BedrockFoundationModelProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/CommonPromptVariantProps.md b/apidocs/namespaces/bedrock/interfaces/CommonPromptVariantProps.md index 6ca83574..ed91a405 100644 --- a/apidocs/namespaces/bedrock/interfaces/CommonPromptVariantProps.md +++ b/apidocs/namespaces/bedrock/interfaces/CommonPromptVariantProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ConfluenceCrawlingFilters.md b/apidocs/namespaces/bedrock/interfaces/ConfluenceCrawlingFilters.md index 9d491bd8..9417dc8b 100644 --- a/apidocs/namespaces/bedrock/interfaces/ConfluenceCrawlingFilters.md +++ b/apidocs/namespaces/bedrock/interfaces/ConfluenceCrawlingFilters.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceAssociationProps.md index 9d8eab67..81aa798d 100644 --- a/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceProps.md b/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceProps.md index 3a1c1b21..22b8e534 100644 --- a/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceProps.md +++ b/apidocs/namespaces/bedrock/interfaces/ConfluenceDataSourceProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ContentFilter.md b/apidocs/namespaces/bedrock/interfaces/ContentFilter.md index 7c9e7787..f895eebe 100644 --- a/apidocs/namespaces/bedrock/interfaces/ContentFilter.md +++ b/apidocs/namespaces/bedrock/interfaces/ContentFilter.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/ContextualGroundingFilter.md b/apidocs/namespaces/bedrock/interfaces/ContextualGroundingFilter.md index b55a0ba2..a400479e 100644 --- a/apidocs/namespaces/bedrock/interfaces/ContextualGroundingFilter.md +++ b/apidocs/namespaces/bedrock/interfaces/ContextualGroundingFilter.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/CrawlingFilters.md b/apidocs/namespaces/bedrock/interfaces/CrawlingFilters.md index 5d60d760..f6cfe209 100644 --- a/apidocs/namespaces/bedrock/interfaces/CrawlingFilters.md +++ b/apidocs/namespaces/bedrock/interfaces/CrawlingFilters.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/CrossRegionInferenceProfileProps.md b/apidocs/namespaces/bedrock/interfaces/CrossRegionInferenceProfileProps.md index 27bab6a1..6091c422 100644 --- a/apidocs/namespaces/bedrock/interfaces/CrossRegionInferenceProfileProps.md +++ b/apidocs/namespaces/bedrock/interfaces/CrossRegionInferenceProfileProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/CustomTopicProps.md b/apidocs/namespaces/bedrock/interfaces/CustomTopicProps.md index 46fd690d..faa5769e 100644 --- a/apidocs/namespaces/bedrock/interfaces/CustomTopicProps.md +++ b/apidocs/namespaces/bedrock/interfaces/CustomTopicProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/DataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/DataSourceAssociationProps.md index 0a675199..c8d56306 100644 --- a/apidocs/namespaces/bedrock/interfaces/DataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/DataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/FoundationModelParsingStategyProps.md b/apidocs/namespaces/bedrock/interfaces/FoundationModelParsingStategyProps.md index c3d39f98..7896c139 100644 --- a/apidocs/namespaces/bedrock/interfaces/FoundationModelParsingStategyProps.md +++ b/apidocs/namespaces/bedrock/interfaces/FoundationModelParsingStategyProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/GuardrailAttributes.md b/apidocs/namespaces/bedrock/interfaces/GuardrailAttributes.md index 56d3b150..9c78dd9b 100644 --- a/apidocs/namespaces/bedrock/interfaces/GuardrailAttributes.md +++ b/apidocs/namespaces/bedrock/interfaces/GuardrailAttributes.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/GuardrailConfiguration.md b/apidocs/namespaces/bedrock/interfaces/GuardrailConfiguration.md index e1554470..929c68cc 100644 --- a/apidocs/namespaces/bedrock/interfaces/GuardrailConfiguration.md +++ b/apidocs/namespaces/bedrock/interfaces/GuardrailConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/GuardrailProps.md b/apidocs/namespaces/bedrock/interfaces/GuardrailProps.md index a7477b74..e3fc9a17 100644 --- a/apidocs/namespaces/bedrock/interfaces/GuardrailProps.md +++ b/apidocs/namespaces/bedrock/interfaces/GuardrailProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/HierarchicalChunkingProps.md b/apidocs/namespaces/bedrock/interfaces/HierarchicalChunkingProps.md index dd8ea710..b6fb0e78 100644 --- a/apidocs/namespaces/bedrock/interfaces/HierarchicalChunkingProps.md +++ b/apidocs/namespaces/bedrock/interfaces/HierarchicalChunkingProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/IAgentAlias.md b/apidocs/namespaces/bedrock/interfaces/IAgentAlias.md index 5985a6e1..621bf1fb 100644 --- a/apidocs/namespaces/bedrock/interfaces/IAgentAlias.md +++ b/apidocs/namespaces/bedrock/interfaces/IAgentAlias.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/IDataSource.md b/apidocs/namespaces/bedrock/interfaces/IDataSource.md index a03d0df0..103620c9 100644 --- a/apidocs/namespaces/bedrock/interfaces/IDataSource.md +++ b/apidocs/namespaces/bedrock/interfaces/IDataSource.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -86,7 +86,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns diff --git a/apidocs/namespaces/bedrock/interfaces/IGuardrail.md b/apidocs/namespaces/bedrock/interfaces/IGuardrail.md index 85f203ea..98bc6d8f 100644 --- a/apidocs/namespaces/bedrock/interfaces/IGuardrail.md +++ b/apidocs/namespaces/bedrock/interfaces/IGuardrail.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -121,7 +121,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -141,7 +143,9 @@ Grant the given identity permissions to apply the guardrail. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns diff --git a/apidocs/namespaces/bedrock/interfaces/IInferenceProfile.md b/apidocs/namespaces/bedrock/interfaces/IInferenceProfile.md index bf57e911..23a8af3c 100644 --- a/apidocs/namespaces/bedrock/interfaces/IInferenceProfile.md +++ b/apidocs/namespaces/bedrock/interfaces/IInferenceProfile.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -42,7 +42,9 @@ Grants appropriate permissions to use the inference profile. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns diff --git a/apidocs/namespaces/bedrock/interfaces/IInvokable.md b/apidocs/namespaces/bedrock/interfaces/IInvokable.md index 392f43ca..dc7f79bc 100644 --- a/apidocs/namespaces/bedrock/interfaces/IInvokable.md +++ b/apidocs/namespaces/bedrock/interfaces/IInvokable.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -28,7 +28,9 @@ Gives the appropriate policies to invoke and use the invokable abstraction. #### Parameters -• **grantee**: `IGrantable` +##### grantee + +`IGrantable` #### Returns diff --git a/apidocs/namespaces/bedrock/interfaces/IKnowledgeBase.md b/apidocs/namespaces/bedrock/interfaces/IKnowledgeBase.md index a2276e48..226f7bbb 100644 --- a/apidocs/namespaces/bedrock/interfaces/IKnowledgeBase.md +++ b/apidocs/namespaces/bedrock/interfaces/IKnowledgeBase.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -100,7 +100,9 @@ Add a Confluence data source to the knowledge base. #### Parameters -• **props**: [`ConfluenceDataSourceAssociationProps`](ConfluenceDataSourceAssociationProps.md) +##### props + +[`ConfluenceDataSourceAssociationProps`](ConfluenceDataSourceAssociationProps.md) #### Returns @@ -116,7 +118,9 @@ Add an S3 data source to the knowledge base. #### Parameters -• **props**: [`S3DataSourceAssociationProps`](S3DataSourceAssociationProps.md) +##### props + +[`S3DataSourceAssociationProps`](S3DataSourceAssociationProps.md) #### Returns @@ -132,7 +136,9 @@ Add a Salesforce data source to the knowledge base. #### Parameters -• **props**: [`SalesforceDataSourceAssociationProps`](SalesforceDataSourceAssociationProps.md) +##### props + +[`SalesforceDataSourceAssociationProps`](SalesforceDataSourceAssociationProps.md) #### Returns @@ -148,7 +154,9 @@ Add a SharePoint data source to the knowledge base. #### Parameters -• **props**: [`SharePointDataSourceAssociationProps`](SharePointDataSourceAssociationProps.md) +##### props + +[`SharePointDataSourceAssociationProps`](SharePointDataSourceAssociationProps.md) #### Returns @@ -164,7 +172,9 @@ Add a web crawler data source to the knowledge base. #### Parameters -• **props**: [`WebCrawlerDataSourceAssociationProps`](WebCrawlerDataSourceAssociationProps.md) +##### props + +[`WebCrawlerDataSourceAssociationProps`](WebCrawlerDataSourceAssociationProps.md) #### Returns @@ -188,7 +198,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns diff --git a/apidocs/namespaces/bedrock/interfaces/IPrompt.md b/apidocs/namespaces/bedrock/interfaces/IPrompt.md index b10602a0..922458d4 100644 --- a/apidocs/namespaces/bedrock/interfaces/IPrompt.md +++ b/apidocs/namespaces/bedrock/interfaces/IPrompt.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/InferenceConfiguration.md b/apidocs/namespaces/bedrock/interfaces/InferenceConfiguration.md index 06fc9fd4..46e8a7bd 100644 --- a/apidocs/namespaces/bedrock/interfaces/InferenceConfiguration.md +++ b/apidocs/namespaces/bedrock/interfaces/InferenceConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseAttributes.md b/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseAttributes.md index e596226d..f4ba3946 100644 --- a/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseAttributes.md +++ b/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseAttributes.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseProps.md b/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseProps.md index 9478068a..9b169dcb 100644 --- a/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseProps.md +++ b/apidocs/namespaces/bedrock/interfaces/KnowledgeBaseProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/LambdaCustomTransformationProps.md b/apidocs/namespaces/bedrock/interfaces/LambdaCustomTransformationProps.md index 4338e940..60276841 100644 --- a/apidocs/namespaces/bedrock/interfaces/LambdaCustomTransformationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/LambdaCustomTransformationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PIIFilter.md b/apidocs/namespaces/bedrock/interfaces/PIIFilter.md index 44acc368..639cd378 100644 --- a/apidocs/namespaces/bedrock/interfaces/PIIFilter.md +++ b/apidocs/namespaces/bedrock/interfaces/PIIFilter.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PromptAttributes.md b/apidocs/namespaces/bedrock/interfaces/PromptAttributes.md index 8acc87a3..552e6a90 100644 --- a/apidocs/namespaces/bedrock/interfaces/PromptAttributes.md +++ b/apidocs/namespaces/bedrock/interfaces/PromptAttributes.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PromptConfiguration.md b/apidocs/namespaces/bedrock/interfaces/PromptConfiguration.md index 7d90919c..a98ac590 100644 --- a/apidocs/namespaces/bedrock/interfaces/PromptConfiguration.md +++ b/apidocs/namespaces/bedrock/interfaces/PromptConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PromptOverrideConfiguration.md b/apidocs/namespaces/bedrock/interfaces/PromptOverrideConfiguration.md index 169b5ebc..60dad740 100644 --- a/apidocs/namespaces/bedrock/interfaces/PromptOverrideConfiguration.md +++ b/apidocs/namespaces/bedrock/interfaces/PromptOverrideConfiguration.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PromptProps.md b/apidocs/namespaces/bedrock/interfaces/PromptProps.md index c7242333..5e3e66a2 100644 --- a/apidocs/namespaces/bedrock/interfaces/PromptProps.md +++ b/apidocs/namespaces/bedrock/interfaces/PromptProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/PromptVersionProps.md b/apidocs/namespaces/bedrock/interfaces/PromptVersionProps.md index 5bf0fb31..b57469c8 100644 --- a/apidocs/namespaces/bedrock/interfaces/PromptVersionProps.md +++ b/apidocs/namespaces/bedrock/interfaces/PromptVersionProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/RegexFilter.md b/apidocs/namespaces/bedrock/interfaces/RegexFilter.md index a0a54ef3..db38f016 100644 --- a/apidocs/namespaces/bedrock/interfaces/RegexFilter.md +++ b/apidocs/namespaces/bedrock/interfaces/RegexFilter.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/S3DataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/S3DataSourceAssociationProps.md index ae6d0b4d..278ac3b6 100644 --- a/apidocs/namespaces/bedrock/interfaces/S3DataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/S3DataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/S3DataSourceProps.md b/apidocs/namespaces/bedrock/interfaces/S3DataSourceProps.md index ebbf00a7..faa948e6 100644 --- a/apidocs/namespaces/bedrock/interfaces/S3DataSourceProps.md +++ b/apidocs/namespaces/bedrock/interfaces/S3DataSourceProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/S3Identifier.md b/apidocs/namespaces/bedrock/interfaces/S3Identifier.md index 311e11cb..be6806e3 100644 --- a/apidocs/namespaces/bedrock/interfaces/S3Identifier.md +++ b/apidocs/namespaces/bedrock/interfaces/S3Identifier.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SalesforceCrawlingFilters.md b/apidocs/namespaces/bedrock/interfaces/SalesforceCrawlingFilters.md index cf7c80d1..735c5ede 100644 --- a/apidocs/namespaces/bedrock/interfaces/SalesforceCrawlingFilters.md +++ b/apidocs/namespaces/bedrock/interfaces/SalesforceCrawlingFilters.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceAssociationProps.md index 0186bf79..29378a20 100644 --- a/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceProps.md b/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceProps.md index fb6a59ea..3cfd5ad7 100644 --- a/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceProps.md +++ b/apidocs/namespaces/bedrock/interfaces/SalesforceDataSourceProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SharePointCrawlingFilters.md b/apidocs/namespaces/bedrock/interfaces/SharePointCrawlingFilters.md index f2e472df..87d5b5cc 100644 --- a/apidocs/namespaces/bedrock/interfaces/SharePointCrawlingFilters.md +++ b/apidocs/namespaces/bedrock/interfaces/SharePointCrawlingFilters.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceAssociationProps.md index 7f50f831..39270ed1 100644 --- a/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceProps.md b/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceProps.md index 59a37d69..24cc1499 100644 --- a/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceProps.md +++ b/apidocs/namespaces/bedrock/interfaces/SharePointDataSourceProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/TextPromptVariantProps.md b/apidocs/namespaces/bedrock/interfaces/TextPromptVariantProps.md index 0a2d2f28..081885f6 100644 --- a/apidocs/namespaces/bedrock/interfaces/TextPromptVariantProps.md +++ b/apidocs/namespaces/bedrock/interfaces/TextPromptVariantProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceAssociationProps.md b/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceAssociationProps.md index 1d352954..5a54cf98 100644 --- a/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceAssociationProps.md +++ b/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceAssociationProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceProps.md b/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceProps.md index 0226a1bf..a394ce62 100644 --- a/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceProps.md +++ b/apidocs/namespaces/bedrock/interfaces/WebCrawlerDataSourceProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/README.md b/apidocs/namespaces/bedrock/namespaces/PIIType/README.md index 1cc23948..3f9e4de5 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/README.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/CanadaSpecific.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/CanadaSpecific.md index 1310088f..fde24264 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/CanadaSpecific.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/CanadaSpecific.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/Finance.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/Finance.md index 85e0ca7d..9491557c 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/Finance.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/Finance.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/General.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/General.md index 912886d4..423e0b7e 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/General.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/General.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/InformationTechnology.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/InformationTechnology.md index d4f05d3d..05622f2d 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/InformationTechnology.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/InformationTechnology.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/UKSpecific.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/UKSpecific.md index 36ab0f16..6abae270 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/UKSpecific.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/UKSpecific.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/USASpecific.md b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/USASpecific.md index fc6eae58..5d13ebdd 100644 --- a/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/USASpecific.md +++ b/apidocs/namespaces/bedrock/namespaces/PIIType/enumerations/USASpecific.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../../../README.md) *** diff --git a/apidocs/namespaces/opensearch_vectorindex/README.md b/apidocs/namespaces/opensearch_vectorindex/README.md index a81bbc4f..283f079a 100644 --- a/apidocs/namespaces/opensearch_vectorindex/README.md +++ b/apidocs/namespaces/opensearch_vectorindex/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) *** diff --git a/apidocs/namespaces/opensearch_vectorindex/classes/VectorIndex.md b/apidocs/namespaces/opensearch_vectorindex/classes/VectorIndex.md index 54c562e3..67e2a268 100644 --- a/apidocs/namespaces/opensearch_vectorindex/classes/VectorIndex.md +++ b/apidocs/namespaces/opensearch_vectorindex/classes/VectorIndex.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -20,11 +20,17 @@ Deploy a vector index on the collection. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props**: [`VectorIndexProps`](../interfaces/VectorIndexProps.md) +##### id + +`string` + +##### props + +[`VectorIndexProps`](../interfaces/VectorIndexProps.md) #### Returns @@ -158,7 +164,9 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). #### Parameters -• **policy**: `RemovalPolicy` +##### policy + +`RemovalPolicy` #### Returns @@ -198,13 +206,17 @@ a concrete ARN with the resource's physical name. Make sure to reference #### Parameters -• **arnAttr**: `string` +##### arnAttr + +`string` The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. `resource.attrArn`), but sometimes it's the CFN resource's `ref`. -• **arnComponents**: `ArnComponents` +##### arnComponents + +`ArnComponents` The format of the ARN of this resource. You must reference `this.physicalName` somewhere within the ARN in order for @@ -233,7 +245,9 @@ which will be a concrete name. #### Parameters -• **nameAttr**: `string` +##### nameAttr + +`string` The CFN attribute which resolves to the resource's name. Commonly this is the resource's `ref`. @@ -286,7 +300,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object @@ -310,7 +326,9 @@ Returns true if the construct was created by CDK, and false otherwise #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns @@ -330,7 +348,9 @@ Check whether the given construct is a Resource #### Parameters -• **construct**: `IConstruct` +##### construct + +`IConstruct` #### Returns diff --git a/apidocs/namespaces/opensearch_vectorindex/interfaces/Analyzer.md b/apidocs/namespaces/opensearch_vectorindex/interfaces/Analyzer.md index 1021e08f..72d71d68 100644 --- a/apidocs/namespaces/opensearch_vectorindex/interfaces/Analyzer.md +++ b/apidocs/namespaces/opensearch_vectorindex/interfaces/Analyzer.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearch_vectorindex/interfaces/MetadataManagementFieldProps.md b/apidocs/namespaces/opensearch_vectorindex/interfaces/MetadataManagementFieldProps.md index 1af8bcb3..ac1061fe 100644 --- a/apidocs/namespaces/opensearch_vectorindex/interfaces/MetadataManagementFieldProps.md +++ b/apidocs/namespaces/opensearch_vectorindex/interfaces/MetadataManagementFieldProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearch_vectorindex/interfaces/VectorIndexProps.md b/apidocs/namespaces/opensearch_vectorindex/interfaces/VectorIndexProps.md index fb6ac5b0..0348d3ac 100644 --- a/apidocs/namespaces/opensearch_vectorindex/interfaces/VectorIndexProps.md +++ b/apidocs/namespaces/opensearch_vectorindex/interfaces/VectorIndexProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearch_vectorindex/variables/OpenSearchIndexCRProvider.md b/apidocs/namespaces/opensearch_vectorindex/variables/OpenSearchIndexCRProvider.md index 0d97a2e0..1bfa5f74 100644 --- a/apidocs/namespaces/opensearch_vectorindex/variables/OpenSearchIndexCRProvider.md +++ b/apidocs/namespaces/opensearch_vectorindex/variables/OpenSearchIndexCRProvider.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/README.md b/apidocs/namespaces/opensearchserverless/README.md index efe6bbab..7612fcbf 100644 --- a/apidocs/namespaces/opensearchserverless/README.md +++ b/apidocs/namespaces/opensearchserverless/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/classes/VectorCollection.md b/apidocs/namespaces/opensearchserverless/classes/VectorCollection.md index 14f9d504..6f6d41d1 100644 --- a/apidocs/namespaces/opensearchserverless/classes/VectorCollection.md +++ b/apidocs/namespaces/opensearchserverless/classes/VectorCollection.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -22,11 +22,17 @@ It includes all policies. #### Parameters -• **scope**: `Construct` +##### scope -• **id**: `string` +`Construct` -• **props?**: [`VectorCollectionProps`](../interfaces/VectorCollectionProps.md) +##### id + +`string` + +##### props? + +[`VectorCollectionProps`](../interfaces/VectorCollectionProps.md) #### Returns @@ -106,7 +112,9 @@ Grants the specified role access to data in the collection. #### Parameters -• **grantee**: `IRole` +##### grantee + +`IRole` The role to grant access to. @@ -154,7 +162,9 @@ this type-testing method instead. #### Parameters -• **x**: `any` +##### x + +`any` Any object diff --git a/apidocs/namespaces/opensearchserverless/enumerations/CharacterFilterType.md b/apidocs/namespaces/opensearchserverless/enumerations/CharacterFilterType.md index f9f62fce..7239c66b 100644 --- a/apidocs/namespaces/opensearchserverless/enumerations/CharacterFilterType.md +++ b/apidocs/namespaces/opensearchserverless/enumerations/CharacterFilterType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/enumerations/TokenFilterType.md b/apidocs/namespaces/opensearchserverless/enumerations/TokenFilterType.md index 739f494f..cd0522ff 100644 --- a/apidocs/namespaces/opensearchserverless/enumerations/TokenFilterType.md +++ b/apidocs/namespaces/opensearchserverless/enumerations/TokenFilterType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/enumerations/TokenizerType.md b/apidocs/namespaces/opensearchserverless/enumerations/TokenizerType.md index b0e8d11d..1c7458b0 100644 --- a/apidocs/namespaces/opensearchserverless/enumerations/TokenizerType.md +++ b/apidocs/namespaces/opensearchserverless/enumerations/TokenizerType.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/enumerations/VectorCollectionStandbyReplicas.md b/apidocs/namespaces/opensearchserverless/enumerations/VectorCollectionStandbyReplicas.md index 999bdb91..d3a6d60c 100644 --- a/apidocs/namespaces/opensearchserverless/enumerations/VectorCollectionStandbyReplicas.md +++ b/apidocs/namespaces/opensearchserverless/enumerations/VectorCollectionStandbyReplicas.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/opensearchserverless/interfaces/VectorCollectionProps.md b/apidocs/namespaces/opensearchserverless/interfaces/VectorCollectionProps.md index 2885cc1e..aa0476a7 100644 --- a/apidocs/namespaces/opensearchserverless/interfaces/VectorCollectionProps.md +++ b/apidocs/namespaces/opensearchserverless/interfaces/VectorCollectionProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/namespaces/pinecone/README.md b/apidocs/namespaces/pinecone/README.md index 9fe03d69..878aab43 100644 --- a/apidocs/namespaces/pinecone/README.md +++ b/apidocs/namespaces/pinecone/README.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../README.md) *** diff --git a/apidocs/namespaces/pinecone/classes/PineconeVectorStore.md b/apidocs/namespaces/pinecone/classes/PineconeVectorStore.md index 5d8d9957..af7dd3bf 100644 --- a/apidocs/namespaces/pinecone/classes/PineconeVectorStore.md +++ b/apidocs/namespaces/pinecone/classes/PineconeVectorStore.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** @@ -16,7 +16,9 @@ Class to define a PineconeVectorStore. #### Parameters -• **props**: [`PineconeVectorStoreProps`](../interfaces/PineconeVectorStoreProps.md) +##### props + +[`PineconeVectorStoreProps`](../interfaces/PineconeVectorStoreProps.md) #### Returns diff --git a/apidocs/namespaces/pinecone/interfaces/PineconeVectorStoreProps.md b/apidocs/namespaces/pinecone/interfaces/PineconeVectorStoreProps.md index a7fb90fd..ca7647b3 100644 --- a/apidocs/namespaces/pinecone/interfaces/PineconeVectorStoreProps.md +++ b/apidocs/namespaces/pinecone/interfaces/PineconeVectorStoreProps.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../../../README.md) *** diff --git a/apidocs/variables/version.md b/apidocs/variables/version.md index 92d356ac..4b6f31b0 100644 --- a/apidocs/variables/version.md +++ b/apidocs/variables/version.md @@ -1,4 +1,4 @@ -[**@cdklabs/generative-ai-cdk-constructs**](../README.md) • **Docs** +[**@cdklabs/generative-ai-cdk-constructs**](../README.md) ***