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

Interface GuardrailTopicConfig.Builder

All Superinterfaces:

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

Enclosing class:

GuardrailTopicConfig

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

Method Summary

Modifier and Type	Method	Description
GuardrailTopicConfig.Builder	definition(String definition)	A definition of the topic to deny.
GuardrailTopicConfig.Builder	examples(String... examples)	A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
GuardrailTopicConfig.Builder	examples(Collection<String> examples)	A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
GuardrailTopicConfig.Builder	inputAction(String inputAction)	Specifies the action to take when harmful content is detected in the input.
GuardrailTopicConfig.Builder	inputAction(GuardrailTopicAction inputAction)	Specifies the action to take when harmful content is detected in the input.
GuardrailTopicConfig.Builder	inputEnabled(Boolean inputEnabled)	Specifies whether to enable guardrail evaluation on the input.
GuardrailTopicConfig.Builder	name(String name)	The name of the topic to deny.
GuardrailTopicConfig.Builder	outputAction(String outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailTopicConfig.Builder	outputAction(GuardrailTopicAction outputAction)	Specifies the action to take when harmful content is detected in the output.
GuardrailTopicConfig.Builder	outputEnabled(Boolean outputEnabled)	Specifies whether to enable guardrail evaluation on the output.
GuardrailTopicConfig.Builder	type(String type)	Specifies to deny the topic.
GuardrailTopicConfig.Builder	type(GuardrailTopicType type)	Specifies to deny the topic.

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

name

GuardrailTopicConfig.Builder name(String name)

The name of the topic to deny.

Parameters:

name - The name of the topic to deny.

Returns:

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

definition

GuardrailTopicConfig.Builder definition(String definition)

A definition of the topic to deny.

Parameters:

definition - A definition of the topic to deny.

Returns:

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

examples

GuardrailTopicConfig.Builder examples(Collection<String> examples)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Parameters:

examples - A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

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

examples

GuardrailTopicConfig.Builder examples(String... examples)

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Parameters:

examples - A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

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

type

GuardrailTopicConfig.Builder type(String type)

Specifies to deny the topic.

Parameters:

type - Specifies to deny the topic.

Returns:

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

See Also:

GuardrailTopicType, GuardrailTopicType

type

GuardrailTopicConfig.Builder type(GuardrailTopicType type)

Specifies to deny the topic.

Parameters:

type - Specifies to deny the topic.

Returns:

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

See Also:

GuardrailTopicType, GuardrailTopicType

inputAction

GuardrailTopicConfig.Builder inputAction(String 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.

Parameters:

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.

Returns:

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

See Also:

GuardrailTopicAction, GuardrailTopicAction

inputAction

GuardrailTopicConfig.Builder inputAction(GuardrailTopicAction 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.

Parameters:

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.

Returns:

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

See Also:

GuardrailTopicAction, GuardrailTopicAction

outputAction

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

GuardrailTopicAction, GuardrailTopicAction

outputAction

GuardrailTopicConfig.Builder outputAction(GuardrailTopicAction 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:

GuardrailTopicAction, GuardrailTopicAction

inputEnabled

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

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