Package software.amazon.awssdk.services.bedrock.model

Interface GuardrailContextualGroundingFilterConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GuardrailContextualGroundingFilterConfig.Builder,GuardrailContextualGroundingFilterConfig>, SdkBuilder<GuardrailContextualGroundingFilterConfig.Builder,GuardrailContextualGroundingFilterConfig>, SdkPojo

Enclosing class:

GuardrailContextualGroundingFilterConfig

@Mutable
@NotThreadSafe
public static interface GuardrailContextualGroundingFilterConfig.Builder
extends SdkPojo, CopyableBuilder<GuardrailContextualGroundingFilterConfig.Builder,GuardrailContextualGroundingFilterConfig>

Method Summary

Modifier and Type	Method	Description
GuardrailContextualGroundingFilterConfig.Builder	action(String action)	Specifies the action to take when content fails the contextual grounding evaluation.
GuardrailContextualGroundingFilterConfig.Builder	action(GuardrailContextualGroundingAction action)	Specifies the action to take when content fails the contextual grounding evaluation.
GuardrailContextualGroundingFilterConfig.Builder	enabled(Boolean enabled)	Specifies whether to enable contextual grounding evaluation.
GuardrailContextualGroundingFilterConfig.Builder	threshold(Double threshold)	The threshold details for the guardrails contextual grounding filter.
GuardrailContextualGroundingFilterConfig.Builder	type(String type)	The filter details for the guardrails contextual grounding filter.
GuardrailContextualGroundingFilterConfig.Builder	type(GuardrailContextualGroundingFilterType type)	The filter details for the guardrails contextual grounding filter.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

type

GuardrailContextualGroundingFilterConfig.Builder type(String type)

The filter details for the guardrails contextual grounding filter.

Parameters:

type - The filter details for the guardrails contextual grounding filter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContextualGroundingFilterType, GuardrailContextualGroundingFilterType

type

GuardrailContextualGroundingFilterConfig.Builder type(GuardrailContextualGroundingFilterType type)

The filter details for the guardrails contextual grounding filter.

Parameters:

type - The filter details for the guardrails contextual grounding filter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContextualGroundingFilterType, GuardrailContextualGroundingFilterType

threshold

GuardrailContextualGroundingFilterConfig.Builder threshold(Double threshold)

The threshold details for the guardrails contextual grounding filter.

Parameters:

threshold - The threshold details for the guardrails contextual grounding filter.

Returns:

Returns a reference to this object so that method calls can be chained together.

action

GuardrailContextualGroundingFilterConfig.Builder action(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContextualGroundingAction, GuardrailContextualGroundingAction

action

GuardrailContextualGroundingFilterConfig.Builder action(GuardrailContextualGroundingAction 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

GuardrailContextualGroundingAction, GuardrailContextualGroundingAction

enabled

GuardrailContextualGroundingFilterConfig.Builder enabled(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.