#[non_exhaustive]pub struct GuardrailAssessment {
pub topic_policy: Option<GuardrailTopicPolicyAssessment>,
pub content_policy: Option<GuardrailContentPolicyAssessment>,
pub word_policy: Option<GuardrailWordPolicyAssessment>,
pub sensitive_information_policy: Option<GuardrailSensitiveInformationPolicyAssessment>,
pub contextual_grounding_policy: Option<GuardrailContextualGroundingPolicyAssessment>,
pub automated_reasoning_policy: Option<GuardrailAutomatedReasoningPolicyAssessment>,
pub invocation_metrics: Option<GuardrailInvocationMetrics>,
}
Expand description
A behavior assessment of the guardrail policies used in a call to the Converse API.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.topic_policy: Option<GuardrailTopicPolicyAssessment>
The topic policy.
content_policy: Option<GuardrailContentPolicyAssessment>
The content policy.
word_policy: Option<GuardrailWordPolicyAssessment>
The word policy.
sensitive_information_policy: Option<GuardrailSensitiveInformationPolicyAssessment>
The sensitive information policy.
contextual_grounding_policy: Option<GuardrailContextualGroundingPolicyAssessment>
The contextual grounding policy used for the guardrail assessment.
automated_reasoning_policy: Option<GuardrailAutomatedReasoningPolicyAssessment>
The automated reasoning policy assessment results, including logical validation findings for the input content.
invocation_metrics: Option<GuardrailInvocationMetrics>
The invocation metrics for the guardrail assessment.
Implementations§
Source§impl GuardrailAssessment
impl GuardrailAssessment
Sourcepub fn topic_policy(&self) -> Option<&GuardrailTopicPolicyAssessment>
pub fn topic_policy(&self) -> Option<&GuardrailTopicPolicyAssessment>
The topic policy.
Sourcepub fn content_policy(&self) -> Option<&GuardrailContentPolicyAssessment>
pub fn content_policy(&self) -> Option<&GuardrailContentPolicyAssessment>
The content policy.
Sourcepub fn word_policy(&self) -> Option<&GuardrailWordPolicyAssessment>
pub fn word_policy(&self) -> Option<&GuardrailWordPolicyAssessment>
The word policy.
Sourcepub fn sensitive_information_policy(
&self,
) -> Option<&GuardrailSensitiveInformationPolicyAssessment>
pub fn sensitive_information_policy( &self, ) -> Option<&GuardrailSensitiveInformationPolicyAssessment>
The sensitive information policy.
Sourcepub fn contextual_grounding_policy(
&self,
) -> Option<&GuardrailContextualGroundingPolicyAssessment>
pub fn contextual_grounding_policy( &self, ) -> Option<&GuardrailContextualGroundingPolicyAssessment>
The contextual grounding policy used for the guardrail assessment.
Sourcepub fn automated_reasoning_policy(
&self,
) -> Option<&GuardrailAutomatedReasoningPolicyAssessment>
pub fn automated_reasoning_policy( &self, ) -> Option<&GuardrailAutomatedReasoningPolicyAssessment>
The automated reasoning policy assessment results, including logical validation findings for the input content.
Sourcepub fn invocation_metrics(&self) -> Option<&GuardrailInvocationMetrics>
pub fn invocation_metrics(&self) -> Option<&GuardrailInvocationMetrics>
The invocation metrics for the guardrail assessment.
Source§impl GuardrailAssessment
impl GuardrailAssessment
Sourcepub fn builder() -> GuardrailAssessmentBuilder
pub fn builder() -> GuardrailAssessmentBuilder
Creates a new builder-style object to manufacture GuardrailAssessment
.
Trait Implementations§
Source§impl Clone for GuardrailAssessment
impl Clone for GuardrailAssessment
Source§fn clone(&self) -> GuardrailAssessment
fn clone(&self) -> GuardrailAssessment
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GuardrailAssessment
impl Debug for GuardrailAssessment
Source§impl PartialEq for GuardrailAssessment
impl PartialEq for GuardrailAssessment
impl StructuralPartialEq for GuardrailAssessment
Auto Trait Implementations§
impl Freeze for GuardrailAssessment
impl RefUnwindSafe for GuardrailAssessment
impl Send for GuardrailAssessment
impl Sync for GuardrailAssessment
impl Unpin for GuardrailAssessment
impl UnwindSafe for GuardrailAssessment
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);