Skip to content

Commit 4e453ae

Browse files
aws-rafamskrokoko
andauthored
fix(bedrock): adopt best practices (#751)
* feat(bedrock): guardrails best practices --------- Co-authored-by: Alain Krok <[email protected]>
1 parent 974657d commit 4e453ae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+3912
-1699
lines changed

apidocs/namespaces/bedrock/README.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,26 @@
88

99
## Index
1010

11+
### Namespaces
12+
13+
- [PIIType](namespaces/PIIType/README.md)
14+
1115
### Enumerations
1216

13-
- [CanadaSpecific](enumerations/CanadaSpecific.md)
1417
- [ConfluenceDataSourceAuthType](enumerations/ConfluenceDataSourceAuthType.md)
1518
- [ConfluenceObjectType](enumerations/ConfluenceObjectType.md)
19+
- [ContentFilterStrength](enumerations/ContentFilterStrength.md)
20+
- [ContentFilterType](enumerations/ContentFilterType.md)
1621
- [ContextualGroundingFilterConfigType](enumerations/ContextualGroundingFilterConfigType.md)
22+
- [ContextualGroundingFilterType](enumerations/ContextualGroundingFilterType.md)
1723
- [CrawlingScope](enumerations/CrawlingScope.md)
1824
- [DataDeletionPolicy](enumerations/DataDeletionPolicy.md)
1925
- [DataSourceType](enumerations/DataSourceType.md)
2026
- [FiltersConfigStrength](enumerations/FiltersConfigStrength.md)
2127
- [FiltersConfigType](enumerations/FiltersConfigType.md)
22-
- [Finance](enumerations/Finance.md)
23-
- [General](enumerations/General.md)
24-
- [InformationTechnology](enumerations/InformationTechnology.md)
28+
- [GuardrailAction](enumerations/GuardrailAction.md)
29+
- [ManagedWordFilterType](enumerations/ManagedWordFilterType.md)
2530
- [ParserMode](enumerations/ParserMode.md)
26-
- [PiiEntitiesConfigAction](enumerations/PiiEntitiesConfigAction.md)
2731
- [PromptCreationMode](enumerations/PromptCreationMode.md)
2832
- [PromptState](enumerations/PromptState.md)
2933
- [PromptTemplateType](enumerations/PromptTemplateType.md)
@@ -33,8 +37,6 @@
3337
- [SharePointDataSourceAuthType](enumerations/SharePointDataSourceAuthType.md)
3438
- [SharePointObjectType](enumerations/SharePointObjectType.md)
3539
- [TransformationStep](enumerations/TransformationStep.md)
36-
- [UKSpecific](enumerations/UKSpecific.md)
37-
- [USASpecific](enumerations/USASpecific.md)
3840

3941
### Classes
4042

@@ -51,7 +53,7 @@
5153
- [DataSourceBase](classes/DataSourceBase.md)
5254
- [DataSourceNew](classes/DataSourceNew.md)
5355
- [Guardrail](classes/Guardrail.md)
54-
- [GuardrailVersion](classes/GuardrailVersion.md)
56+
- [GuardrailBase](classes/GuardrailBase.md)
5557
- [InlineApiSchema](classes/InlineApiSchema.md)
5658
- [KnowledgeBase](classes/KnowledgeBase.md)
5759
- [ParsingStategy](classes/ParsingStategy.md)
@@ -61,7 +63,6 @@
6163
- [S3ApiSchema](classes/S3ApiSchema.md)
6264
- [S3DataSource](classes/S3DataSource.md)
6365
- [SalesforceDataSource](classes/SalesforceDataSource.md)
64-
- [SensitiveInformationPolicyConfig](classes/SensitiveInformationPolicyConfig.md)
6566
- [SharePointDataSource](classes/SharePointDataSource.md)
6667
- [Topic](classes/Topic.md)
6768
- [WebCrawlerDataSource](classes/WebCrawlerDataSource.md)
@@ -79,38 +80,43 @@
7980
- [ConfluenceCrawlingFilters](interfaces/ConfluenceCrawlingFilters.md)
8081
- [ConfluenceDataSourceAssociationProps](interfaces/ConfluenceDataSourceAssociationProps.md)
8182
- [ConfluenceDataSourceProps](interfaces/ConfluenceDataSourceProps.md)
83+
- [ContentFilter](interfaces/ContentFilter.md)
8284
- [ContentPolicyConfigProps](interfaces/ContentPolicyConfigProps.md)
85+
- [ContextualGroundingFilter](interfaces/ContextualGroundingFilter.md)
8386
- [ContextualGroundingPolicyConfigProps](interfaces/ContextualGroundingPolicyConfigProps.md)
8487
- [CrawlingFilters](interfaces/CrawlingFilters.md)
88+
- [CustomTopicProps](interfaces/CustomTopicProps.md)
8589
- [DataSourceAssociationProps](interfaces/DataSourceAssociationProps.md)
8690
- [FoundationModelParsingStategyProps](interfaces/FoundationModelParsingStategyProps.md)
91+
- [GuardrailAttributes](interfaces/GuardrailAttributes.md)
8792
- [GuardrailConfiguration](interfaces/GuardrailConfiguration.md)
8893
- [GuardrailProps](interfaces/GuardrailProps.md)
8994
- [HierarchicalChunkingProps](interfaces/HierarchicalChunkingProps.md)
9095
- [IAgentAlias](interfaces/IAgentAlias.md)
9196
- [IDataSource](interfaces/IDataSource.md)
97+
- [IGuardrail](interfaces/IGuardrail.md)
9298
- [IKnowledgeBase](interfaces/IKnowledgeBase.md)
9399
- [InferenceConfiguration](interfaces/InferenceConfiguration.md)
94100
- [IPrompt](interfaces/IPrompt.md)
95101
- [KnowledgeBaseAttributes](interfaces/KnowledgeBaseAttributes.md)
96102
- [KnowledgeBaseProps](interfaces/KnowledgeBaseProps.md)
97103
- [LambdaCustomTransformationProps](interfaces/LambdaCustomTransformationProps.md)
104+
- [PIIFilter](interfaces/PIIFilter.md)
98105
- [PromptConfiguration](interfaces/PromptConfiguration.md)
99106
- [PromptOverrideConfiguration](interfaces/PromptOverrideConfiguration.md)
100107
- [PromptProps](interfaces/PromptProps.md)
101108
- [PromptVersionProps](interfaces/PromptVersionProps.md)
109+
- [RegexFilter](interfaces/RegexFilter.md)
102110
- [S3DataSourceAssociationProps](interfaces/S3DataSourceAssociationProps.md)
103111
- [S3DataSourceProps](interfaces/S3DataSourceProps.md)
104112
- [S3Identifier](interfaces/S3Identifier.md)
105113
- [SalesforceCrawlingFilters](interfaces/SalesforceCrawlingFilters.md)
106114
- [SalesforceDataSourceAssociationProps](interfaces/SalesforceDataSourceAssociationProps.md)
107115
- [SalesforceDataSourceProps](interfaces/SalesforceDataSourceProps.md)
108-
- [SensitiveInformationPolicyConfigProps](interfaces/SensitiveInformationPolicyConfigProps.md)
109116
- [SharePointCrawlingFilters](interfaces/SharePointCrawlingFilters.md)
110117
- [SharePointDataSourceAssociationProps](interfaces/SharePointDataSourceAssociationProps.md)
111118
- [SharePointDataSourceProps](interfaces/SharePointDataSourceProps.md)
112119
- [TextPromptVariantProps](interfaces/TextPromptVariantProps.md)
113-
- [TopicProps](interfaces/TopicProps.md)
114120
- [WebCrawlerDataSourceAssociationProps](interfaces/WebCrawlerDataSourceAssociationProps.md)
115121
- [WebCrawlerDataSourceProps](interfaces/WebCrawlerDataSourceProps.md)
116122

apidocs/namespaces/bedrock/classes/Agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ Add guardrail to the agent.
212212

213213
#### Parameters
214214

215-
**guardrail**: [`Guardrail`](Guardrail.md)
215+
**guardrail**: [`IGuardrail`](../interfaces/IGuardrail.md)
216216

217217
#### Returns
218218

0 commit comments

Comments
 (0)