> **Experimental**
>
> `@aws-cdk/aws-bedrock-alpha` is an [**experimental**](https://docs.aws.amazon.com/cdk/api/stability.html) (alpha) package: its API may change in any release, without a major version bump.
# WordFilter

Interface to define a Word Filter.

Used as argument in: [Guardrail.addWordFilter](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.Guardrail.html#addwordfilter)

- Stability: [Experimental](https://docs.aws.amazon.com/cdk/api/stability.html)
- Source: [`bedrock/guardrails/guardrail-filters.ts`](https://github.com/aws/aws-cdk/blob/v2.278.0/packages/@aws-cdk/aws-bedrock-alpha/bedrock/guardrails/guardrail-filters.ts#L397)

## Example

TypeScript:

```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:

```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:

```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");
```

C# / .NET:

```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");
```

Golang:

```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

- `inputAction`: [GuardrailAction](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.GuardrailAction.html) = GuardrailAction.BLOCK — The action to take when a word is detected in the input.

- `inputEnabled`: boolean = true — Whether the word filter is enabled for input.

- `outputAction`: [GuardrailAction](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-bedrock-alpha.GuardrailAction.html) = GuardrailAction.BLOCK — The action to take when a word is detected in the output.

- `outputEnabled`: boolean = true — Whether the word filter is enabled for output.

- `text`: string (required) — The text to filter.
