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

Interface GuardrailWord.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailWord

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

Method Summary

Modifier and Type	Method	Description
GuardrailWord.Builder	inputAction(String inputAction)	The action to take when harmful content is detected in the input.
GuardrailWord.Builder	inputAction(GuardrailWordAction inputAction)	The action to take when harmful content is detected in the input.
GuardrailWord.Builder	inputEnabled(Boolean inputEnabled)	Indicates whether guardrail evaluation is enabled on the input.
GuardrailWord.Builder	outputAction(String outputAction)	The action to take when harmful content is detected in the output.
GuardrailWord.Builder	outputAction(GuardrailWordAction outputAction)	The action to take when harmful content is detected in the output.
GuardrailWord.Builder	outputEnabled(Boolean outputEnabled)	Indicates whether guardrail evaluation is enabled on the output.
GuardrailWord.Builder	text(String text)	Text of the word configured for the guardrail to block.

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

text

GuardrailWord.Builder text(String text)

Text of the word configured for the guardrail to block.

Parameters:

text - Text of the word configured for the guardrail to block.

Returns:

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

inputAction

GuardrailWord.Builder inputAction(String inputAction)

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

GuardrailWordAction, GuardrailWordAction

inputAction

GuardrailWord.Builder inputAction(GuardrailWordAction inputAction)

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

GuardrailWordAction, GuardrailWordAction

outputAction

GuardrailWord.Builder outputAction(String outputAction)

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

GuardrailWordAction, GuardrailWordAction

outputAction

GuardrailWord.Builder outputAction(GuardrailWordAction outputAction)

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

GuardrailWordAction, GuardrailWordAction

inputEnabled

GuardrailWord.Builder inputEnabled(Boolean inputEnabled)

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

Parameters:

inputEnabled - Indicates whether guardrail evaluation is enabled 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

GuardrailWord.Builder outputEnabled(Boolean outputEnabled)

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

Parameters:

outputEnabled - Indicates whether guardrail evaluation is enabled 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.