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

Interface GuardrailContentFilterConfig.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailContentFilterConfig

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

Method Summary

Modifier and Type	Method	Description
GuardrailContentFilterConfig.Builder	inputAction(String inputAction)	Specifies the action to take when harmful content is detected.
GuardrailContentFilterConfig.Builder	inputAction(GuardrailContentFilterAction inputAction)	Specifies the action to take when harmful content is detected.
GuardrailContentFilterConfig.Builder	inputEnabled(Boolean inputEnabled)	Specifies whether to enable guardrail evaluation on the input.
GuardrailContentFilterConfig.Builder	inputModalities(Collection<GuardrailModality> inputModalities)	The input modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	inputModalities(GuardrailModality... inputModalities)	The input modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	inputModalitiesWithStrings(String... inputModalities)	The input modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	inputModalitiesWithStrings(Collection<String> inputModalities)	The input modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	inputStrength(String inputStrength)	The strength of the content filter to apply to prompts.
GuardrailContentFilterConfig.Builder	inputStrength(GuardrailFilterStrength inputStrength)	The strength of the content filter to apply to prompts.
GuardrailContentFilterConfig.Builder	outputAction(String outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailContentFilterConfig.Builder	outputAction(GuardrailContentFilterAction outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailContentFilterConfig.Builder	outputEnabled(Boolean outputEnabled)	Specifies whether to enable guardrail evaluation on the output.
GuardrailContentFilterConfig.Builder	outputModalities(Collection<GuardrailModality> outputModalities)	The output modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	outputModalities(GuardrailModality... outputModalities)	The output modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	outputModalitiesWithStrings(String... outputModalities)	The output modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	outputModalitiesWithStrings(Collection<String> outputModalities)	The output modalities selected for the guardrail content filter configuration.
GuardrailContentFilterConfig.Builder	outputStrength(String outputStrength)	The strength of the content filter to apply to model responses.
GuardrailContentFilterConfig.Builder	outputStrength(GuardrailFilterStrength outputStrength)	The strength of the content filter to apply to model responses.
GuardrailContentFilterConfig.Builder	type(String type)	The harmful category that the content filter is applied to.
GuardrailContentFilterConfig.Builder	type(GuardrailContentFilterType type)	The harmful category that the content filter is applied to.

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

GuardrailContentFilterConfig.Builder type(String type)

The harmful category that the content filter is applied to.

Parameters:

type - The harmful category that the content filter is applied to.

Returns:

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

See Also:

GuardrailContentFilterType, GuardrailContentFilterType

type

GuardrailContentFilterConfig.Builder type(GuardrailContentFilterType type)

The harmful category that the content filter is applied to.

Parameters:

type - The harmful category that the content filter is applied to.

Returns:

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

See Also:

GuardrailContentFilterType, GuardrailContentFilterType

inputStrength

GuardrailContentFilterConfig.Builder inputStrength(String inputStrength)

The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Parameters:

inputStrength - The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Returns:

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

See Also:

GuardrailFilterStrength, GuardrailFilterStrength

inputStrength

GuardrailContentFilterConfig.Builder inputStrength(GuardrailFilterStrength inputStrength)

The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Parameters:

inputStrength - The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Returns:

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

See Also:

GuardrailFilterStrength, GuardrailFilterStrength

outputStrength

GuardrailContentFilterConfig.Builder outputStrength(String outputStrength)

The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Parameters:

outputStrength - The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Returns:

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

See Also:

GuardrailFilterStrength, GuardrailFilterStrength

outputStrength

GuardrailContentFilterConfig.Builder outputStrength(GuardrailFilterStrength outputStrength)

The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Parameters:

outputStrength - The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

Returns:

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

See Also:

GuardrailFilterStrength, GuardrailFilterStrength

inputModalitiesWithStrings

GuardrailContentFilterConfig.Builder inputModalitiesWithStrings(Collection<String> inputModalities)

The input modalities selected for the guardrail content filter configuration.

Parameters:

inputModalities - The input modalities selected for the guardrail content filter configuration.

Returns:

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

inputModalitiesWithStrings

GuardrailContentFilterConfig.Builder inputModalitiesWithStrings(String... inputModalities)

The input modalities selected for the guardrail content filter configuration.

Parameters:

inputModalities - The input modalities selected for the guardrail content filter configuration.

Returns:

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

inputModalities

GuardrailContentFilterConfig.Builder inputModalities(Collection<GuardrailModality> inputModalities)

The input modalities selected for the guardrail content filter configuration.

Parameters:

inputModalities - The input modalities selected for the guardrail content filter configuration.

Returns:

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

inputModalities

GuardrailContentFilterConfig.Builder inputModalities(GuardrailModality... inputModalities)

The input modalities selected for the guardrail content filter configuration.

Parameters:

inputModalities - The input modalities selected for the guardrail content filter configuration.

Returns:

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

outputModalitiesWithStrings

GuardrailContentFilterConfig.Builder outputModalitiesWithStrings(Collection<String> outputModalities)

The output modalities selected for the guardrail content filter configuration.

Parameters:

outputModalities - The output modalities selected for the guardrail content filter configuration.

Returns:

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

outputModalitiesWithStrings

GuardrailContentFilterConfig.Builder outputModalitiesWithStrings(String... outputModalities)

The output modalities selected for the guardrail content filter configuration.

Parameters:

outputModalities - The output modalities selected for the guardrail content filter configuration.

Returns:

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

outputModalities

GuardrailContentFilterConfig.Builder outputModalities(Collection<GuardrailModality> outputModalities)

The output modalities selected for the guardrail content filter configuration.

Parameters:

outputModalities - The output modalities selected for the guardrail content filter configuration.

Returns:

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

outputModalities

GuardrailContentFilterConfig.Builder outputModalities(GuardrailModality... outputModalities)

The output modalities selected for the guardrail content filter configuration.

Parameters:

outputModalities - The output modalities selected for the guardrail content filter configuration.

Returns:

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

inputAction

GuardrailContentFilterConfig.Builder inputAction(String inputAction)

Specifies the action to take when harmful content is detected. 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:

inputAction - Specifies the action to take when harmful content is detected. 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:

GuardrailContentFilterAction, GuardrailContentFilterAction

inputAction

GuardrailContentFilterConfig.Builder inputAction(GuardrailContentFilterAction inputAction)

Specifies the action to take when harmful content is detected. 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:

inputAction - Specifies the action to take when harmful content is detected. 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:

GuardrailContentFilterAction, GuardrailContentFilterAction

outputAction

GuardrailContentFilterConfig.Builder outputAction(String outputAction)

Specifies the action to take when harmful content is detected in the output. 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:

outputAction - Specifies the action to take when harmful content is detected in the output. 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:

GuardrailContentFilterAction, GuardrailContentFilterAction

outputAction

GuardrailContentFilterConfig.Builder outputAction(GuardrailContentFilterAction outputAction)

Specifies the action to take when harmful content is detected in the output. 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:

outputAction - Specifies the action to take when harmful content is detected in the output. 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:

GuardrailContentFilterAction, GuardrailContentFilterAction

inputEnabled

GuardrailContentFilterConfig.Builder inputEnabled(Boolean inputEnabled)

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

Parameters:

inputEnabled - Specifies whether to enable guardrail evaluation on the input. 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.

outputEnabled

GuardrailContentFilterConfig.Builder outputEnabled(Boolean outputEnabled)

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

Parameters:

outputEnabled - Specifies whether to enable guardrail evaluation on the output. 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.