Package software.amazon.awssdk.services.bedrockruntime.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 performed by the guardrails contextual grounding filter.
GuardrailContextualGroundingFilter.Builder	action(GuardrailContextualGroundingPolicyAction action)	The action performed by the guardrails contextual grounding filter.
GuardrailContextualGroundingFilter.Builder	detected(Boolean detected)	Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.
GuardrailContextualGroundingFilter.Builder	score(Double score)	The score generated by contextual grounding filter.
GuardrailContextualGroundingFilter.Builder	threshold(Double threshold)	The threshold used by contextual grounding filter to determine whether the content is grounded or not.
GuardrailContextualGroundingFilter.Builder	type(String type)	The contextual grounding filter type.
GuardrailContextualGroundingFilter.Builder	type(GuardrailContextualGroundingFilterType type)	The contextual grounding filter type.

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 contextual grounding filter type.

Parameters:

type - The contextual grounding filter type.

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 contextual grounding filter type.

Parameters:

type - The contextual grounding filter type.

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 used by contextual grounding filter to determine whether the content is grounded or not.

Parameters:

threshold - The threshold used by contextual grounding filter to determine whether the content is grounded or not.

Returns:

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

score

GuardrailContextualGroundingFilter.Builder score(Double score)

The score generated by contextual grounding filter.

Parameters:

score - The score generated by 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 performed by the guardrails contextual grounding filter.

Parameters:

action - The action performed by the guardrails contextual grounding filter.

Returns:

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

See Also:

GuardrailContextualGroundingPolicyAction, GuardrailContextualGroundingPolicyAction

action

GuardrailContextualGroundingFilter.Builder action(GuardrailContextualGroundingPolicyAction action)

The action performed by the guardrails contextual grounding filter.

Parameters:

action - The action performed by the guardrails contextual grounding filter.

Returns:

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

See Also:

GuardrailContextualGroundingPolicyAction, GuardrailContextualGroundingPolicyAction

detected

GuardrailContextualGroundingFilter.Builder detected(Boolean detected)

Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

Parameters:

detected - Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

Returns:

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