interface CfnAIGuardrailProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Wisdom.CfnAIGuardrailProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnAIGuardrailProps |
![]() | software.amazon.awscdk.services.wisdom.CfnAIGuardrailProps |
![]() | aws_cdk.aws_wisdom.CfnAIGuardrailProps |
![]() | aws-cdk-lib » aws_wisdom » CfnAIGuardrailProps |
Properties for defining a CfnAIGuardrail
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const cfnAIGuardrailProps: wisdom.CfnAIGuardrailProps = {
assistantId: 'assistantId',
blockedInputMessaging: 'blockedInputMessaging',
blockedOutputsMessaging: 'blockedOutputsMessaging',
// the properties below are optional
contentPolicyConfig: {
filtersConfig: [{
inputStrength: 'inputStrength',
outputStrength: 'outputStrength',
type: 'type',
}],
},
contextualGroundingPolicyConfig: {
filtersConfig: [{
threshold: 123,
type: 'type',
}],
},
description: 'description',
name: 'name',
sensitiveInformationPolicyConfig: {
piiEntitiesConfig: [{
action: 'action',
type: 'type',
}],
regexesConfig: [{
action: 'action',
name: 'name',
pattern: 'pattern',
// the properties below are optional
description: 'description',
}],
},
tags: {
tagsKey: 'tags',
},
topicPolicyConfig: {
topicsConfig: [{
definition: 'definition',
name: 'name',
type: 'type',
// the properties below are optional
examples: ['examples'],
}],
},
wordPolicyConfig: {
managedWordListsConfig: [{
type: 'type',
}],
wordsConfig: [{
text: 'text',
}],
},
};
Properties
Name | Type | Description |
---|---|---|
assistant | string | The identifier of the Amazon Q in Connect assistant. |
blocked | string | The message to return when the AI Guardrail blocks a prompt. |
blocked | string | The message to return when the AI Guardrail blocks a model response. |
content | IResolvable | AIGuardrail | Contains details about how to handle harmful content. |
contextual | IResolvable | AIGuardrail | The policy configuration details for the AI Guardrail's contextual grounding policy. |
description? | string | A description of the AI Guardrail. |
name? | string | The name of the AI Guardrail. |
sensitive | IResolvable | AIGuardrail | Contains details about PII entities and regular expressions to configure for the AI Guardrail. |
tags? | { [string]: string } | The tags used to organize, track, or control access for this resource. |
topic | IResolvable | AIGuardrail | Contains details about topics that the AI Guardrail should identify and deny. |
word | IResolvable | AIGuardrail | Contains details about the word policy to configured for the AI Guardrail. |
assistantId
Type:
string
The identifier of the Amazon Q in Connect assistant.
Can be either the ID or the ARN. URLs cannot contain the ARN.
blockedInputMessaging
Type:
string
The message to return when the AI Guardrail blocks a prompt.
blockedOutputsMessaging
Type:
string
The message to return when the AI Guardrail blocks a model response.
contentPolicyConfig?
Type:
IResolvable
|
AIGuardrail
(optional)
Contains details about how to handle harmful content.
contextualGroundingPolicyConfig?
Type:
IResolvable
|
AIGuardrail
(optional)
The policy configuration details for the AI Guardrail's contextual grounding policy.
description?
Type:
string
(optional)
A description of the AI Guardrail.
name?
Type:
string
(optional)
The name of the AI Guardrail.
sensitiveInformationPolicyConfig?
Type:
IResolvable
|
AIGuardrail
(optional)
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags?
Type:
{ [string]: string }
(optional)
The tags used to organize, track, or control access for this resource.
topicPolicyConfig?
Type:
IResolvable
|
AIGuardrail
(optional)
Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig?
Type:
IResolvable
|
AIGuardrail
(optional)
Contains details about the word policy to configured for the AI Guardrail.