aws_sdk_bedrockagentcore/client/

evaluate.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`Evaluate`](crate::operation::evaluate::builders::EvaluateFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`evaluator_id(impl Into<String>)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::evaluator_id) / [`set_evaluator_id(Option<String>)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::set_evaluator_id):<br>required: **true**<br><p>The unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g., <code>Builtin.Helpfulness</code>, <code>Builtin.Correctness</code>) or a custom evaluator ARN created through the control plane API.</p><br>
    ///   - [`evaluation_input(EvaluationInput)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::evaluation_input) / [`set_evaluation_input(Option<EvaluationInput>)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::set_evaluation_input):<br>required: **true**<br><p>The input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation.</p><br>
    ///   - [`evaluation_target(EvaluationTarget)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::evaluation_target) / [`set_evaluation_target(Option<EvaluationTarget>)`](crate::operation::evaluate::builders::EvaluateFluentBuilder::set_evaluation_target):<br>required: **false**<br><p>The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions.</p><br>
    /// - On success, responds with [`EvaluateOutput`](crate::operation::evaluate::EvaluateOutput) with field(s):
    ///   - [`evaluation_results(Vec::<EvaluationResultContent>)`](crate::operation::evaluate::EvaluateOutput::evaluation_results): <p>The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator's rating scale, and token usage statistics for the evaluation process.</p>
    /// - On failure, responds with [`SdkError<EvaluateError>`](crate::operation::evaluate::EvaluateError)
    pub fn evaluate(&self) -> crate::operation::evaluate::builders::EvaluateFluentBuilder {
        crate::operation::evaluate::builders::EvaluateFluentBuilder::new(self.handle.clone())
    }
}