interface ContextualGroundingFilterConfigProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnGuardrail.ContextualGroundingFilterConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnGuardrail_ContextualGroundingFilterConfigProperty
Java	software.amazon.awscdk.services.bedrock.CfnGuardrail.ContextualGroundingFilterConfigProperty
Python	aws_cdk.aws_bedrock.CfnGuardrail.ContextualGroundingFilterConfigProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnGuardrail » ContextualGroundingFilterConfigProperty

The filter configuration details for the guardrails contextual grounding filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const contextualGroundingFilterConfigProperty: bedrock.CfnGuardrail.ContextualGroundingFilterConfigProperty = {
  threshold: 123,
  type: 'type',

  // the properties below are optional
  action: 'action',
  enabled: false,
};

Properties

Name	Type	Description
threshold	number	The threshold details for the guardrails contextual grounding filter.
type	string	The filter details for the guardrails contextual grounding filter.
action?	string	Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:.
enabled?	boolean | IResolvable	Specifies whether to enable contextual grounding evaluation.

---

threshold

Type: number

The threshold details for the guardrails contextual grounding filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-threshold

---

type

Type: string

The filter details for the guardrails contextual grounding filter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-type

---

action?

Type: string (optional)

Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:.

• BLOCK – Block the content and replace it with blocked messaging.
• NONE – Take no action but return detection information in the trace response.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action

---

enabled?

Type: boolean | IResolvable (optional)

Specifies whether to enable contextual grounding evaluation.

When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled