Package software.amazon.awscdk.services.bedrock

Interface CfnGuardrail.ContextualGroundingFilterConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardrail.ContextualGroundingFilterConfigProperty.Jsii$Proxy

Enclosing class:

CfnGuardrail

@Stability(Stable)
public static interface CfnGuardrail.ContextualGroundingFilterConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.bedrock.*;
 ContextualGroundingFilterConfigProperty contextualGroundingFilterConfigProperty = ContextualGroundingFilterConfigProperty.builder()
         .threshold(123)
         .type("type")
         // the properties below are optional
         .action("action")
         .enabled(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGuardrail.ContextualGroundingFilterConfigProperty.Builder	A builder for CfnGuardrail.ContextualGroundingFilterConfigProperty
static final class	CfnGuardrail.ContextualGroundingFilterConfigProperty.Jsii$Proxy	An implementation for CfnGuardrail.ContextualGroundingFilterConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnGuardrail.ContextualGroundingFilterConfigProperty.Builder	builder()
default String	getAction()	Specifies the action to take when content fails the contextual grounding evaluation.
default Object	getEnabled()	Specifies whether to enable contextual grounding evaluation.
Number	getThreshold()	The threshold details for the guardrails contextual grounding filter.
String	getType()	The filter details for the guardrails contextual grounding filter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getThreshold

@Stability(Stable)
@NotNull
Number getThreshold()

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

getType

@Stability(Stable)
@NotNull
String getType()

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

getAction

@Stability(Stable)
@Nullable
default String getAction()

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Specifies whether to enable contextual grounding evaluation.

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

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnGuardrail.ContextualGroundingFilterConfigProperty.Builder builder()

Returns:

a CfnGuardrail.ContextualGroundingFilterConfigProperty.Builder of CfnGuardrail.ContextualGroundingFilterConfigProperty