interface ContextualGroundingFilterConfigProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnGuardrailPropsMixin.ContextualGroundingFilterConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnGuardrailPropsMixin_ContextualGroundingFilterConfigProperty`
Java	`software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnGuardrailPropsMixin.ContextualGroundingFilterConfigProperty`
Python	`aws_cdk.mixins_preview.aws_bedrock.mixins.CfnGuardrailPropsMixin.ContextualGroundingFilterConfigProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_bedrock` » `mixins` » `CfnGuardrailPropsMixin` » `ContextualGroundingFilterConfigProperty`

The filter configuration details for the guardrails contextual grounding filter.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const contextualGroundingFilterConfigProperty: bedrock_mixins.CfnGuardrailPropsMixin.ContextualGroundingFilterConfigProperty = {
  action: 'action',
  enabled: false,
  threshold: 123,
  type: 'type',
};

Properties

Name	Type	Description
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?	`number`	The threshold details for the guardrails contextual grounding filter.
type?	`string`	The filter details for the guardrails contextual grounding filter.

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.

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.

threshold?

Type: number (optional)

The threshold details for the guardrails contextual grounding filter.

type?