/AWS1/CL_BDKGUARDRAILTOPICCFG¶
Details about topics for the guardrail to identify and deny.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_name TYPE /AWS1/BDKGUARDRAILTOPICNAME /AWS1/BDKGUARDRAILTOPICNAME¶
The name of the topic to deny.
iv_definition TYPE /AWS1/BDKGUARDRAILTOPICDEFN /AWS1/BDKGUARDRAILTOPICDEFN¶
A definition of the topic to deny.
iv_type TYPE /AWS1/BDKGUARDRAILTOPICTYPE /AWS1/BDKGUARDRAILTOPICTYPE¶
Specifies to deny the topic.
Optional arguments:¶
it_examples TYPE /AWS1/CL_BDKGUARDRAILTPCEXAM00=>TT_GUARDRAILTOPICEXAMPLES TT_GUARDRAILTOPICEXAMPLES¶
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
iv_inputaction TYPE /AWS1/BDKGUARDRAILTOPICACTION /AWS1/BDKGUARDRAILTOPICACTION¶
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/BDKGUARDRAILTOPICACTION /AWS1/BDKGUARDRAILTOPICACTION¶
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 input. 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¶
name¶
The name of the topic to deny.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
definition¶
A definition of the topic to deny.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFINITION() |
Getter for DEFINITION, with configurable default |
ASK_DEFINITION() |
Getter for DEFINITION w/ exceptions if field has no value |
HAS_DEFINITION() |
Determine if DEFINITION has a value |
examples¶
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXAMPLES() |
Getter for EXAMPLES, with configurable default |
ASK_EXAMPLES() |
Getter for EXAMPLES w/ exceptions if field has no value |
HAS_EXAMPLES() |
Determine if EXAMPLES has a value |
type¶
Specifies to deny the topic.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE 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 input. 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_GUARDRAILTOPICSCONFIG¶
TYPES TT_GUARDRAILTOPICSCONFIG TYPE STANDARD TABLE OF REF TO /AWS1/CL_BDKGUARDRAILTOPICCFG WITH DEFAULT KEY
.