pub struct CreateGuardrailFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateGuardrail.
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
-
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
-
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
-
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
-
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.
Implementations§
Source§impl CreateGuardrailFluentBuilder
impl CreateGuardrailFluentBuilder
Sourcepub fn as_input(&self) -> &CreateGuardrailInputBuilder
pub fn as_input(&self) -> &CreateGuardrailInputBuilder
Access the CreateGuardrail as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateGuardrailOutput, SdkError<CreateGuardrailError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateGuardrailOutput, SdkError<CreateGuardrailError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateGuardrailOutput, CreateGuardrailError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateGuardrailOutput, CreateGuardrailError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the guardrail.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the guardrail.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the guardrail.
Sourcepub fn topic_policy_config(self, input: GuardrailTopicPolicyConfig) -> Self
pub fn topic_policy_config(self, input: GuardrailTopicPolicyConfig) -> Self
The topic policies to configure for the guardrail.
Sourcepub fn set_topic_policy_config(
self,
input: Option<GuardrailTopicPolicyConfig>,
) -> Self
pub fn set_topic_policy_config( self, input: Option<GuardrailTopicPolicyConfig>, ) -> Self
The topic policies to configure for the guardrail.
Sourcepub fn get_topic_policy_config(&self) -> &Option<GuardrailTopicPolicyConfig>
pub fn get_topic_policy_config(&self) -> &Option<GuardrailTopicPolicyConfig>
The topic policies to configure for the guardrail.
Sourcepub fn content_policy_config(self, input: GuardrailContentPolicyConfig) -> Self
pub fn content_policy_config(self, input: GuardrailContentPolicyConfig) -> Self
The content filter policies to configure for the guardrail.
Sourcepub fn set_content_policy_config(
self,
input: Option<GuardrailContentPolicyConfig>,
) -> Self
pub fn set_content_policy_config( self, input: Option<GuardrailContentPolicyConfig>, ) -> Self
The content filter policies to configure for the guardrail.
Sourcepub fn get_content_policy_config(&self) -> &Option<GuardrailContentPolicyConfig>
pub fn get_content_policy_config(&self) -> &Option<GuardrailContentPolicyConfig>
The content filter policies to configure for the guardrail.
Sourcepub fn word_policy_config(self, input: GuardrailWordPolicyConfig) -> Self
pub fn word_policy_config(self, input: GuardrailWordPolicyConfig) -> Self
The word policy you configure for the guardrail.
Sourcepub fn set_word_policy_config(
self,
input: Option<GuardrailWordPolicyConfig>,
) -> Self
pub fn set_word_policy_config( self, input: Option<GuardrailWordPolicyConfig>, ) -> Self
The word policy you configure for the guardrail.
Sourcepub fn get_word_policy_config(&self) -> &Option<GuardrailWordPolicyConfig>
pub fn get_word_policy_config(&self) -> &Option<GuardrailWordPolicyConfig>
The word policy you configure for the guardrail.
Sourcepub fn sensitive_information_policy_config(
self,
input: GuardrailSensitiveInformationPolicyConfig,
) -> Self
pub fn sensitive_information_policy_config( self, input: GuardrailSensitiveInformationPolicyConfig, ) -> Self
The sensitive information policy to configure for the guardrail.
Sourcepub fn set_sensitive_information_policy_config(
self,
input: Option<GuardrailSensitiveInformationPolicyConfig>,
) -> Self
pub fn set_sensitive_information_policy_config( self, input: Option<GuardrailSensitiveInformationPolicyConfig>, ) -> Self
The sensitive information policy to configure for the guardrail.
Sourcepub fn get_sensitive_information_policy_config(
&self,
) -> &Option<GuardrailSensitiveInformationPolicyConfig>
pub fn get_sensitive_information_policy_config( &self, ) -> &Option<GuardrailSensitiveInformationPolicyConfig>
The sensitive information policy to configure for the guardrail.
Sourcepub fn contextual_grounding_policy_config(
self,
input: GuardrailContextualGroundingPolicyConfig,
) -> Self
pub fn contextual_grounding_policy_config( self, input: GuardrailContextualGroundingPolicyConfig, ) -> Self
The contextual grounding policy configuration used to create a guardrail.
Sourcepub fn set_contextual_grounding_policy_config(
self,
input: Option<GuardrailContextualGroundingPolicyConfig>,
) -> Self
pub fn set_contextual_grounding_policy_config( self, input: Option<GuardrailContextualGroundingPolicyConfig>, ) -> Self
The contextual grounding policy configuration used to create a guardrail.
Sourcepub fn get_contextual_grounding_policy_config(
&self,
) -> &Option<GuardrailContextualGroundingPolicyConfig>
pub fn get_contextual_grounding_policy_config( &self, ) -> &Option<GuardrailContextualGroundingPolicyConfig>
The contextual grounding policy configuration used to create a guardrail.
Sourcepub fn automated_reasoning_policy_config(
self,
input: GuardrailAutomatedReasoningPolicyConfig,
) -> Self
pub fn automated_reasoning_policy_config( self, input: GuardrailAutomatedReasoningPolicyConfig, ) -> Self
Optional configuration for integrating Automated Reasoning policies with the new guardrail.
Sourcepub fn set_automated_reasoning_policy_config(
self,
input: Option<GuardrailAutomatedReasoningPolicyConfig>,
) -> Self
pub fn set_automated_reasoning_policy_config( self, input: Option<GuardrailAutomatedReasoningPolicyConfig>, ) -> Self
Optional configuration for integrating Automated Reasoning policies with the new guardrail.
Sourcepub fn get_automated_reasoning_policy_config(
&self,
) -> &Option<GuardrailAutomatedReasoningPolicyConfig>
pub fn get_automated_reasoning_policy_config( &self, ) -> &Option<GuardrailAutomatedReasoningPolicyConfig>
Optional configuration for integrating Automated Reasoning policies with the new guardrail.
Sourcepub fn cross_region_config(self, input: GuardrailCrossRegionConfig) -> Self
pub fn cross_region_config(self, input: GuardrailCrossRegionConfig) -> Self
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
Sourcepub fn set_cross_region_config(
self,
input: Option<GuardrailCrossRegionConfig>,
) -> Self
pub fn set_cross_region_config( self, input: Option<GuardrailCrossRegionConfig>, ) -> Self
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
Sourcepub fn get_cross_region_config(&self) -> &Option<GuardrailCrossRegionConfig>
pub fn get_cross_region_config(&self) -> &Option<GuardrailCrossRegionConfig>
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.
For more information, see the Amazon Bedrock User Guide.
Sourcepub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_input_messaging(self, input: impl Into<String>) -> Self
The message to return when the guardrail blocks a prompt.
Sourcepub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_input_messaging(self, input: Option<String>) -> Self
The message to return when the guardrail blocks a prompt.
Sourcepub fn get_blocked_input_messaging(&self) -> &Option<String>
pub fn get_blocked_input_messaging(&self) -> &Option<String>
The message to return when the guardrail blocks a prompt.
Sourcepub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
pub fn blocked_outputs_messaging(self, input: impl Into<String>) -> Self
The message to return when the guardrail blocks a model response.
Sourcepub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
pub fn set_blocked_outputs_messaging(self, input: Option<String>) -> Self
The message to return when the guardrail blocks a model response.
Sourcepub fn get_blocked_outputs_messaging(&self) -> &Option<String>
pub fn get_blocked_outputs_messaging(&self) -> &Option<String>
The message to return when the guardrail blocks a model response.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The ARN of the KMS key that you use to encrypt the guardrail.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The ARN of the KMS key that you use to encrypt the guardrail.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The ARN of the KMS key that you use to encrypt the guardrail.
Appends an item to tags.
To override the contents of this collection use set_tags.
The tags that you want to attach to the guardrail.
The tags that you want to attach to the guardrail.
The tags that you want to attach to the guardrail.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
Trait Implementations§
Source§impl Clone for CreateGuardrailFluentBuilder
impl Clone for CreateGuardrailFluentBuilder
Source§fn clone(&self) -> CreateGuardrailFluentBuilder
fn clone(&self) -> CreateGuardrailFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateGuardrailFluentBuilder
impl !RefUnwindSafe for CreateGuardrailFluentBuilder
impl Send for CreateGuardrailFluentBuilder
impl Sync for CreateGuardrailFluentBuilder
impl Unpin for CreateGuardrailFluentBuilder
impl !UnwindSafe for CreateGuardrailFluentBuilder
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);