Package software.amazon.awscdk.services.bedrock.alpha

Class CustomTopicProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.alpha.CustomTopicProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CustomTopicProps>

Enclosing interface:

CustomTopicProps

@Stability(Experimental)
public static final class CustomTopicProps.Builder
extends Object
implements software.amazon.jsii.Builder<CustomTopicProps>

A builder for CustomTopicProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CustomTopicProps	build()	Builds the configured instance.
CustomTopicProps.Builder	definition(String definition)	Sets the value of CustomTopicProps.getDefinition()
CustomTopicProps.Builder	examples(List<String> examples)	Sets the value of CustomTopicProps.getExamples()
CustomTopicProps.Builder	inputAction(GuardrailAction inputAction)	Sets the value of CustomTopicProps.getInputAction()
CustomTopicProps.Builder	inputEnabled(Boolean inputEnabled)	Sets the value of CustomTopicProps.getInputEnabled()
CustomTopicProps.Builder	name(String name)	Sets the value of CustomTopicProps.getName()
CustomTopicProps.Builder	outputAction(GuardrailAction outputAction)	Sets the value of CustomTopicProps.getOutputAction()
CustomTopicProps.Builder	outputEnabled(Boolean outputEnabled)	Sets the value of CustomTopicProps.getOutputEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

definition

@Stability(Experimental)
public CustomTopicProps.Builder definition(String definition)

Sets the value of CustomTopicProps.getDefinition()

Parameters:

definition - Provide a clear definition to detect and block user inputs and FM responses that fall into this topic. This parameter is required. Avoid starting with "don't".

Returns:

this

examples

@Stability(Experimental)
public CustomTopicProps.Builder examples(List<String> examples)

Sets the value of CustomTopicProps.getExamples()

Parameters:

examples - Representative phrases that refer to the topic. This parameter is required. These phrases can represent a user input or a model response. Add between 1 and 100 phrases, up to 100 characters each.

Returns:

this

name

@Stability(Experimental)
public CustomTopicProps.Builder name(String name)

Sets the value of CustomTopicProps.getName()

Parameters:

name - The name of the topic to deny. This parameter is required.

Returns:

this

inputAction

@Stability(Experimental)
public CustomTopicProps.Builder inputAction(GuardrailAction inputAction)

Sets the value of CustomTopicProps.getInputAction()

Parameters:

inputAction - The action to take when a topic is detected in the input.

Returns:

this

inputEnabled

@Stability(Experimental)
public CustomTopicProps.Builder inputEnabled(Boolean inputEnabled)

Sets the value of CustomTopicProps.getInputEnabled()

Parameters:

inputEnabled - Whether the topic filter is enabled for input.

Returns:

this

outputAction

@Stability(Experimental)
public CustomTopicProps.Builder outputAction(GuardrailAction outputAction)

Sets the value of CustomTopicProps.getOutputAction()

Parameters:

outputAction - The action to take when a topic is detected in the output.

Returns:

this

outputEnabled

@Stability(Experimental)
public CustomTopicProps.Builder outputEnabled(Boolean outputEnabled)

Sets the value of CustomTopicProps.getOutputEnabled()

Parameters:

outputEnabled - Whether the topic filter is enabled for output.

Returns:

this

build

@Stability(Experimental)
public CustomTopicProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CustomTopicProps>

Returns:

a new instance of CustomTopicProps

Throws:

NullPointerException - if any required attribute was not provided