Skip to main content

aws_sdk_bedrockruntime/client/
invoke_guardrail_checks.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`InvokeGuardrailChecks`](crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`messages(GuardrailChecksMessage)`](crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder::messages) / [`set_messages(Option<Vec::<GuardrailChecksMessage>>)`](crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder::set_messages):<br>required: **true**<br><p>The messages to evaluate against the specified guardrail checks. Each message includes a role and one or more content blocks.</p><br>
7    ///   - [`checks(GuardrailChecksConfig)`](crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder::checks) / [`set_checks(Option<GuardrailChecksConfig>)`](crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder::set_checks):<br>required: **true**<br><p>The inline check configurations that specify which guardrail checks to run against the messages.</p><br>
8    /// - On success, responds with [`InvokeGuardrailChecksOutput`](crate::operation::invoke_guardrail_checks::InvokeGuardrailChecksOutput) with field(s):
9    ///   - [`results(Option<GuardrailChecksResults>)`](crate::operation::invoke_guardrail_checks::InvokeGuardrailChecksOutput::results): <p>The per-check results containing findings from the guardrail evaluation.</p>
10    ///   - [`usage(Option<GuardrailChecksUsageResults>)`](crate::operation::invoke_guardrail_checks::InvokeGuardrailChecksOutput::usage): <p>The per-check text unit consumption for the guardrail evaluation.</p>
11    /// - On failure, responds with [`SdkError<InvokeGuardrailChecksError>`](crate::operation::invoke_guardrail_checks::InvokeGuardrailChecksError)
12    pub fn invoke_guardrail_checks(&self) -> crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder {
13        crate::operation::invoke_guardrail_checks::builders::InvokeGuardrailChecksFluentBuilder::new(self.handle.clone())
14    }
15}