Struct GuardrailWord 

#[non_exhaustive]
pub struct GuardrailWord {
    pub text: String,
    pub input_action: Option<GuardrailWordAction>,
    pub output_action: Option<GuardrailWordAction>,
    pub input_enabled: Option<bool>,
    pub output_enabled: Option<bool>,
}

A word configured for the guardrail.

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.

text: String

Text of the word configured for the guardrail to block.

input_action: Option<GuardrailWordAction>

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<GuardrailWordAction>

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 GuardrailWord

pub fn text(&self) -> &str

Text of the word configured for the guardrail to block.

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

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<&GuardrailWordAction>

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 GuardrailWord

pub fn builder() -> GuardrailWordBuilder

Creates a new builder-style object to manufacture GuardrailWord.

Trait Implementations

impl Clone for GuardrailWord

fn clone(&self) -> GuardrailWord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuardrailWord

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

Formats the value using the given formatter.

impl PartialEq for GuardrailWord

fn eq(&self, other: &GuardrailWord) -> 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 GuardrailWord