Interface GuardrailManagedWords.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GuardrailManagedWords.Builder,GuardrailManagedWords>, SdkBuilder<GuardrailManagedWords.Builder,GuardrailManagedWords>, SdkPojo
Enclosing class:
GuardrailManagedWords
@Mutable @NotThreadSafe public static interface GuardrailManagedWords.Builder extends SdkPojo, CopyableBuilder<GuardrailManagedWords.Builder,GuardrailManagedWords>

  • Method Details

    • type

      GuardrailManagedWords.Builder type(String type)

      ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)

      Parameters:
      type - ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      GuardrailManagedWords.Builder type(GuardrailManagedWordsType type)

      ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)

      Parameters:
      type - ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputAction

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

    • inputAction

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

    • outputAction

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

    • outputAction

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

    • inputEnabled

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

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