Interface GuardrailWordConfig.Builder

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

  • Method Details

    • text

      GuardrailWordConfig.Builder text(String text)

      Text of the word configured for the guardrail to block.

      Parameters:
      text - Text of the word configured for the guardrail to block.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputAction

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

    • inputAction

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

      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:

    • outputAction

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

    • outputAction

      GuardrailWordConfig.Builder outputAction(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.

      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:

    • inputEnabled

      GuardrailWordConfig.Builder inputEnabled(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • outputEnabled

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