aws_sdk_bedrockagentcore/client/
start_batch_evaluation.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 [`StartBatchEvaluation`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`batch_evaluation_name(impl Into<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::batch_evaluation_name) / [`set_batch_evaluation_name(Option<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_batch_evaluation_name):<br>required: **true**<br><p>The name of the batch evaluation. Must be unique within your account.</p><br>
7    ///   - [`evaluators(Evaluator)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::evaluators) / [`set_evaluators(Option<Vec::<Evaluator>>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_evaluators):<br>required: **false**<br><p>The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.</p><br>
8    ///   - [`insights(Insight)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::insights) / [`set_insights(Option<Vec::<Insight>>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_insights):<br>required: **false**<br><p>The list of insight analyses to run against sessions during the batch evaluation. Maximum of 10 insights.</p><br>
9    ///   - [`data_source_config(DataSourceConfig)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::data_source_config) / [`set_data_source_config(Option<DataSourceConfig>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_data_source_config):<br>required: **true**<br><p>The data source configuration that specifies where to pull agent session traces from for evaluation.</p><br>
10    ///   - [`client_token(impl Into<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p><br>
11    ///   - [`evaluation_metadata(EvaluationMetadata)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::evaluation_metadata) / [`set_evaluation_metadata(Option<EvaluationMetadata>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_evaluation_metadata):<br>required: **false**<br><p>Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.</p><br>
12    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_tags):<br>required: **false**<br><p>A map of tag keys and values to associate with the batch evaluation.</p><br>
13    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The ARN of the KMS key used to encrypt evaluation data. If provided, customer data is encrypted at rest with the specified key.</p><br>
14    ///   - [`description(impl Into<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::set_description):<br>required: **false**<br><p>The description of the batch evaluation.</p><br>
15    /// - On success, responds with [`StartBatchEvaluationOutput`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput) with field(s):
16    ///   - [`batch_evaluation_id(String)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::batch_evaluation_id): <p>The unique identifier of the created batch evaluation.</p>
17    ///   - [`batch_evaluation_arn(String)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::batch_evaluation_arn): <p>The Amazon Resource Name (ARN) of the created batch evaluation.</p>
18    ///   - [`batch_evaluation_name(String)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::batch_evaluation_name): <p>The name of the batch evaluation.</p>
19    ///   - [`evaluators(Option<Vec::<Evaluator>>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::evaluators): <p>The list of evaluators applied during the batch evaluation.</p>
20    ///   - [`insights(Option<Vec::<Insight>>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::insights): <p>The list of insight analyses applied during the batch evaluation.</p>
21    ///   - [`status(BatchEvaluationStatus)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::status): <p>The status of the batch evaluation.</p>
22    ///   - [`created_at(DateTime)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::created_at): <p>The timestamp when the batch evaluation was created.</p>
23    ///   - [`output_config(Option<OutputConfig>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::output_config): <p>The output configuration specifying where evaluation results are written.</p>
24    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::tags): <p>The tags associated with the batch evaluation.</p>
25    ///   - [`kms_key_arn(Option<String>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::kms_key_arn): <p>The ARN of the KMS key used to encrypt evaluation data.</p>
26    ///   - [`description(Option<String>)`](crate::operation::start_batch_evaluation::StartBatchEvaluationOutput::description): <p>The description of the batch evaluation.</p>
27    /// - On failure, responds with [`SdkError<StartBatchEvaluationError>`](crate::operation::start_batch_evaluation::StartBatchEvaluationError)
28    pub fn start_batch_evaluation(&self) -> crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder {
29        crate::operation::start_batch_evaluation::builders::StartBatchEvaluationFluentBuilder::new(self.handle.clone())
30    }
31}
aws_sdk_bedrockagentcore/client/start_batch_evaluation.rs

aws_sdk_bedrockagentcore/client/
start_batch_evaluation.rs
