Struct GuardrailTopic 

#[non_exhaustive]
pub struct GuardrailTopic {
    pub name: String,
    pub definition: String,
    pub examples: Option<Vec<String>>,
    pub type: Option<GuardrailTopicType>,
    pub input_action: Option<GuardrailTopicAction>,
    pub output_action: Option<GuardrailTopicAction>,
    pub input_enabled: Option<bool>,
    pub output_enabled: Option<bool>,
}

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

• GetGuardrail response body

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the topic to deny.

definition: String

A definition of the topic to deny.

examples: Option<Vec<String>>

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

type: Option<GuardrailTopicType>

Specifies to deny the topic.

input_action: Option<GuardrailTopicAction>

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.

output_action: Option<GuardrailTopicAction>

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.

input_enabled: Option<bool>

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.

output_enabled: Option<bool>

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.

Implementations

impl GuardrailTopic

pub fn name(&self) -> &str

The name of the topic to deny.

pub fn definition(&self) -> &str

A definition of the topic to deny.

pub fn examples(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .examples.is_none().

pub fn type(&self) -> Option<&GuardrailTopicType>

Specifies to deny the topic.

pub fn input_action(&self) -> Option<&GuardrailTopicAction>

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.

pub fn output_action(&self) -> Option<&GuardrailTopicAction>

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.

pub fn input_enabled(&self) -> Option<bool>

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.

pub fn output_enabled(&self) -> Option<bool>

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.

impl GuardrailTopic

pub fn builder() -> GuardrailTopicBuilder

Creates a new builder-style object to manufacture GuardrailTopic.

Trait Implementations

impl Clone for GuardrailTopic

fn clone(&self) -> GuardrailTopic

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GuardrailTopic

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GuardrailTopic

fn eq(&self, other: &GuardrailTopic) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GuardrailTopic