Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ManagedWordFilter Struct
Interface for managed word list filters.
| Stability | Experimental |
|---|---|
| Source | bedrock/guardrails/guardrail-filters.ts |
Example
ts
const guardrail = new bedrock.Guardrail(this, 'bedrockGuardrails', {
guardrailName: 'my-BedrockGuardrails',
});
// Add managed word list with input/output actions
guardrail.addManagedWordListFilter({
type: bedrock.ManagedWordFilterType.PROFANITY,
inputAction: bedrock.GuardrailAction.BLOCK,
inputEnabled: true,
outputAction: bedrock.GuardrailAction.NONE,
outputEnabled: true,
});
// Add individual words
guardrail.addWordFilter({text: 'drugs'});
guardrail.addWordFilter({text: 'competitor'});
// Add words from a file
guardrail.addWordFilterFromFile('./scripts/wordsPolicy.csv');
python
guardrail = bedrock.Guardrail(self, "bedrockGuardrails",
guardrail_name="my-BedrockGuardrails"
)
# Add managed word list with input/output actions
guardrail.add_managed_word_list_filter(
type=bedrock.ManagedWordFilterType.PROFANITY,
input_action=bedrock.GuardrailAction.BLOCK,
input_enabled=True,
output_action=bedrock.GuardrailAction.NONE,
output_enabled=True
)
# Add individual words
guardrail.add_word_filter(text="drugs")
guardrail.add_word_filter(text="competitor")
# Add words from a file
guardrail.add_word_filter_from_file("./scripts/wordsPolicy.csv")
java
Guardrail guardrail = Guardrail.Builder.create(this, "bedrockGuardrails")
.guardrailName("my-BedrockGuardrails")
.build();
// Add managed word list with input/output actions
guardrail.addManagedWordListFilter(ManagedWordFilter.builder()
.type(ManagedWordFilterType.PROFANITY)
.inputAction(GuardrailAction.BLOCK)
.inputEnabled(true)
.outputAction(GuardrailAction.NONE)
.outputEnabled(true)
.build());
// Add individual words
guardrail.addWordFilter(WordFilter.builder().text("drugs").build());
guardrail.addWordFilter(WordFilter.builder().text("competitor").build());
// Add words from a file
guardrail.addWordFilterFromFile("./scripts/wordsPolicy.csv");
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
var guardrail = new Guardrail(this, "bedrockGuardrails", new GuardrailProps {
GuardrailName = "my-BedrockGuardrails"
});
// Add managed word list with input/output actions
guardrail.AddManagedWordListFilter(new ManagedWordFilter {
Type = ManagedWordFilterType.PROFANITY,
InputAction = GuardrailAction.BLOCK,
InputEnabled = true,
OutputAction = GuardrailAction.NONE,
OutputEnabled = true
});
// Add individual words
guardrail.AddWordFilter(new WordFilter { Text = "drugs" });
guardrail.AddWordFilter(new WordFilter { Text = "competitor" });
// Add words from a file
guardrail.AddWordFilterFromFile("./scripts/wordsPolicy.csv");
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
guardrail := bedrock.NewGuardrail(this, jsii.String("bedrockGuardrails"), &GuardrailProps{
GuardrailName: jsii.String("my-BedrockGuardrails"),
})
// Add managed word list with input/output actions
guardrail.AddManagedWordListFilter(&ManagedWordFilter{
Type: bedrock.ManagedWordFilterType_PROFANITY,
InputAction: bedrock.GuardrailAction_BLOCK,
InputEnabled: jsii.Boolean(true),
OutputAction: bedrock.GuardrailAction_NONE,
OutputEnabled: jsii.Boolean(true),
})
// Add individual words
guardrail.AddWordFilter(&WordFilter{
Text: jsii.String("drugs"),
})
guardrail.AddWordFilter(&WordFilter{
Text: jsii.String("competitor"),
})
// Add words from a file
guardrail.AddWordFilterFromFile(jsii.String("./scripts/wordsPolicy.csv"))
Properties
inputActionoptionalGuardrailActioninput_actionoptionalGuardrailActioninputActionoptionalGuardrailActionInputActionoptionalGuardrailActionInputActionoptionalGuardrailAction = GuardrailAction.BLOCK #The action to take when a managed word is detected in the input.
inputEnabledoptionalbooleaninput_enabledoptionalboolinputEnabledoptionalBooleanInputEnabledoptionalboolInputEnabledoptional*bool = true #Whether the managed word filter is enabled for input.
outputActionoptionalGuardrailActionoutput_actionoptionalGuardrailActionoutputActionoptionalGuardrailActionOutputActionoptionalGuardrailActionOutputActionoptionalGuardrailAction = GuardrailAction.BLOCK #The action to take when a managed word is detected in the output.
outputEnabledoptionalbooleanoutput_enabledoptionalbooloutputEnabledoptionalBooleanOutputEnabledoptionalboolOutputEnabledoptional*bool = true #Whether the managed word filter is enabled for output.
typeoptionalManagedWordFilterTypetypeoptionalManagedWordFilterTypetypeoptionalManagedWordFilterTypeTypeoptionalManagedWordFilterTypeTypeoptionalManagedWordFilterType = ManagedWordFilterType.PROFANITY #The type of managed word filter.