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

Class GuardrailWordConfig

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GuardrailWordConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GuardrailWordConfig.Builder,GuardrailWordConfig>

@Generated("software.amazon.awssdk:codegen")
public final class GuardrailWordConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailWordConfig.Builder,GuardrailWordConfig>

A word to configure for the guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailWordConfig.Builder

Method Summary

Modifier and Type	Method	Description
static GuardrailWordConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
GuardrailWordAction	inputAction()	Specifies the action to take when harmful content is detected in the input.
String	inputActionAsString()	Specifies the action to take when harmful content is detected in the input.
Boolean	inputEnabled()	Specifies whether to enable guardrail evaluation on the intput.
GuardrailWordAction	outputAction()	Specifies the action to take when harmful content is detected in the output.
String	outputActionAsString()	Specifies the action to take when harmful content is detected in the output.
Boolean	outputEnabled()	Specifies whether to enable guardrail evaluation on the output.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailWordConfig.Builder>	serializableBuilderClass()
String	text()	Text of the word configured for the guardrail to block.
GuardrailWordConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

text

public final String text()

Text of the word configured for the guardrail to block.

Returns:

Text of the word configured for the guardrail to block.

inputAction

public final GuardrailWordAction inputAction()

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

If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().

Returns:

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

See Also:

GuardrailWordAction

inputActionAsString

public final String inputActionAsString()

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

If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inputActionAsString().

Returns:

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

See Also:

GuardrailWordAction

outputAction

public final GuardrailWordAction 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.

If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().

Returns:

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.

See Also:

GuardrailWordAction

outputActionAsString

public final String outputActionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailWordAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputActionAsString().

Returns:

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.

See Also:

GuardrailWordAction

inputEnabled

public final Boolean inputEnabled()

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

Returns:

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

outputEnabled

public final 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.

Returns:

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.

toBuilder

public GuardrailWordConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailWordConfig.Builder,GuardrailWordConfig>

builder

public static GuardrailWordConfig.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailWordConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo