AWS::Bedrock::Guardrail ContextualGroundingFilterConfig - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Bedrock::Guardrail ContextualGroundingFilterConfig

The filter configuration details for the guardrails contextual grounding filter.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Action" : String,
  "Enabled" : Boolean,
  "Threshold" : Number,
  "Type" : String
}

YAML

  Action: String
  Enabled: Boolean
  Threshold: Number
  Type: String

Properties

Action

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.

Required: No

Type: String

Allowed values: BLOCK | NONE

Update requires: No interruption

Enabled

Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Required: No

Type: Boolean

Update requires: No interruption

Threshold

The threshold details for the guardrails contextual grounding filter.

Required: Yes

Type: Number

Minimum: 0

Update requires: No interruption

Type

The filter details for the guardrails contextual grounding filter.

Required: Yes

Type: String

Allowed values: GROUNDING | RELEVANCE

Update requires: No interruption