aws_sdk_bedrock/client/

create_evaluation_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateEvaluationJob`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_name(impl Into<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_job_name):<br>required: **true**<br><p>A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.</p><br>
    ///   - [`job_description(impl Into<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::job_description) / [`set_job_description(Option<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_job_description):<br>required: **false**<br><p>A description of the evaluation job.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_client_request_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, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html">Required permissions for model evaluations</a>.</p><br>
    ///   - [`customer_encryption_key_id(impl Into<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::customer_encryption_key_id) / [`set_customer_encryption_key_id(Option<String>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_customer_encryption_key_id):<br>required: **false**<br><p>Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.</p><br>
    ///   - [`job_tags(Tag)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::job_tags) / [`set_job_tags(Option<Vec::<Tag>>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_job_tags):<br>required: **false**<br><p>Tags to attach to the model evaluation job.</p><br>
    ///   - [`application_type(ApplicationType)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::application_type) / [`set_application_type(Option<ApplicationType>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_application_type):<br>required: **false**<br><p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p><br>
    ///   - [`evaluation_config(EvaluationConfig)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::evaluation_config) / [`set_evaluation_config(Option<EvaluationConfig>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_evaluation_config):<br>required: **true**<br><p>Contains the configuration details of either an automated or human-based evaluation job.</p><br>
    ///   - [`inference_config(EvaluationInferenceConfig)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::inference_config) / [`set_inference_config(Option<EvaluationInferenceConfig>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_inference_config):<br>required: **true**<br><p>Contains the configuration details of the inference model for the evaluation job.</p> <p>For model evaluation jobs, automated jobs support a single model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>, and jobs that use human workers support two models or inference profiles.</p><br>
    ///   - [`output_data_config(EvaluationOutputDataConfig)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<EvaluationOutputDataConfig>)`](crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::set_output_data_config):<br>required: **true**<br><p>Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.</p><br>
    /// - On success, responds with [`CreateEvaluationJobOutput`](crate::operation::create_evaluation_job::CreateEvaluationJobOutput) with field(s):
    ///   - [`job_arn(String)`](crate::operation::create_evaluation_job::CreateEvaluationJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the evaluation job.</p>
    /// - On failure, responds with [`SdkError<CreateEvaluationJobError>`](crate::operation::create_evaluation_job::CreateEvaluationJobError)
    pub fn create_evaluation_job(&self) -> crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder {
        crate::operation::create_evaluation_job::builders::CreateEvaluationJobFluentBuilder::new(self.handle.clone())
    }
}