Skip to content

/AWS1/CL_BDKGUARDRAILWORDCFG

A word to configure for the guardrail.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_text TYPE /AWS1/BDKSTRING /AWS1/BDKSTRING

Text of the word configured for the guardrail to block.

Optional arguments:

iv_inputaction TYPE /AWS1/BDKGUARDRAILWORDACTION /AWS1/BDKGUARDRAILWORDACTION

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.

iv_outputaction TYPE /AWS1/BDKGUARDRAILWORDACTION /AWS1/BDKGUARDRAILWORDACTION

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.

iv_inputenabled TYPE /AWS1/BDKBOOLEAN /AWS1/BDKBOOLEAN

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.

iv_outputenabled TYPE /AWS1/BDKBOOLEAN /AWS1/BDKBOOLEAN

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.


Queryable Attributes

text

Text of the word configured for the guardrail to block.

Accessible with the following methods

Method Description
GET_TEXT() Getter for TEXT, with configurable default
ASK_TEXT() Getter for TEXT w/ exceptions if field has no value
HAS_TEXT() Determine if TEXT has a value

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.

Accessible with the following methods

Method Description
GET_INPUTACTION() Getter for INPUTACTION, with configurable default
ASK_INPUTACTION() Getter for INPUTACTION w/ exceptions if field has no value
HAS_INPUTACTION() Determine if INPUTACTION has a value

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.

Accessible with the following methods

Method Description
GET_OUTPUTACTION() Getter for OUTPUTACTION, with configurable default
ASK_OUTPUTACTION() Getter for OUTPUTACTION w/ exceptions if field has no value
HAS_OUTPUTACTION() Determine if OUTPUTACTION has a value

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.

Accessible with the following methods

Method Description
GET_INPUTENABLED() Getter for INPUTENABLED, with configurable default
ASK_INPUTENABLED() Getter for INPUTENABLED w/ exceptions if field has no value
HAS_INPUTENABLED() Determine if INPUTENABLED has a value

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.

Accessible with the following methods

Method Description
GET_OUTPUTENABLED() Getter for OUTPUTENABLED, with configurable default
ASK_OUTPUTENABLED() Getter for OUTPUTENABLED w/ exceptions if field has no value
HAS_OUTPUTENABLED() Determine if OUTPUTENABLED has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_GUARDRAILWORDSCONFIG

TYPES TT_GUARDRAILWORDSCONFIG TYPE STANDARD TABLE OF REF TO /AWS1/CL_BDKGUARDRAILWORDCFG WITH DEFAULT KEY
.