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

Interface GuardrailContextualGroundingFilter.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailContextualGroundingFilter

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

Method Summary

Modifier and Type	Method	Description
GuardrailContextualGroundingFilter.Builder	action(String action)	The action to take when content fails the contextual grounding evaluation.
GuardrailContextualGroundingFilter.Builder	action(GuardrailContextualGroundingAction action)	The action to take when content fails the contextual grounding evaluation.
GuardrailContextualGroundingFilter.Builder	enabled(Boolean enabled)	Indicates whether contextual grounding is enabled for evaluation.
GuardrailContextualGroundingFilter.Builder	threshold(Double threshold)	The threshold details for the guardrails contextual grounding filter.
GuardrailContextualGroundingFilter.Builder	type(String type)	The filter type details for the guardrails contextual grounding filter.
GuardrailContextualGroundingFilter.Builder	type(GuardrailContextualGroundingFilterType type)	The filter type 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

GuardrailContextualGroundingFilter.Builder type(String type)

The filter type details for the guardrails contextual grounding filter.

Parameters:

type - The filter type 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

GuardrailContextualGroundingFilter.Builder type(GuardrailContextualGroundingFilterType type)

The filter type details for the guardrails contextual grounding filter.

Parameters:

type - The filter type 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

GuardrailContextualGroundingFilter.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

GuardrailContextualGroundingFilter.Builder action(String action)

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 - 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

GuardrailContextualGroundingFilter.Builder action(GuardrailContextualGroundingAction action)

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 - 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

GuardrailContextualGroundingFilter.Builder enabled(Boolean enabled)

Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Parameters:

enabled - Indicates whether contextual grounding is enabled for 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.