Class GuardrailTopicConfig

java.lang.Object
software.amazon.awssdk.services.bedrock.model.GuardrailTopicConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GuardrailTopicConfig.Builder,GuardrailTopicConfig>
@Generated("software.amazon.awssdk:codegen") public final class GuardrailTopicConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailTopicConfig.Builder,GuardrailTopicConfig>

Details about topics for the guardrail to identify and deny.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the topic to deny.

      Returns:
      The name of the topic to deny.

    • definition

      public final String definition()

      A definition of the topic to deny.

      Returns:
      A definition of the topic to deny.

    • hasExamples

      public final boolean hasExamples()
      For responses, this returns true if the service returned a value for the Examples property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • examples

      public final List<String> examples()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExamples() method.

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

    • type

      public final GuardrailTopicType type()

      Specifies to deny the topic.

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

      Returns:
      Specifies to deny the topic.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies to deny the topic.

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

      Returns:
      Specifies to deny the topic.
      See Also:

    • inputAction

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

      If the service returns an enum value that is not available in the current SDK version, inputAction will return GuardrailTopicAction.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:

    • 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 GuardrailTopicAction.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:

    • outputAction

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

      If the service returns an enum value that is not available in the current SDK version, outputAction will return GuardrailTopicAction.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:

    • 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 GuardrailTopicAction.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:

    • inputEnabled

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

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

    • 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 GuardrailTopicConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GuardrailTopicConfig.Builder,GuardrailTopicConfig>
      Returns:
      a builder for type T

    • builder

      public static GuardrailTopicConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GuardrailTopicConfig.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.