Class: Aws::Bedrock::Types::CreateEvaluationJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrock/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:job_description]

Instance Attribute Summary collapse

Instance Attribute Details

#application_type ⇒ String

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#client_request_token ⇒ String

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 [Ensuring idempotency].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#customer_encryption_key_id ⇒ String

Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#evaluation_config ⇒ Types::EvaluationConfig

Contains the configuration details of either an automated or human-based evaluation job.

Returns:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#inference_config ⇒ Types::EvaluationInferenceConfig

Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or [inference profile], and jobs that use human workers support two models or inference profiles.

[1]: docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html

Returns:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#job_description ⇒ String

A description of the evaluation job.

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#job_name ⇒ String

A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account’s Amazon Web Services region.

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#job_tags ⇒ Array<Types::Tag>

Tags to attach to the model evaluation job.

Returns:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#output_data_config ⇒ Types::EvaluationOutputDataConfig

Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

Returns:



2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end

#role_arn ⇒ String

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 [Required permissions for model evaluations].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html

Returns:

  • (String) 


2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
 
# File 'lib/aws-sdk-bedrock/types.rb', line 2863

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :application_type,
  :evaluation_config,
  :inference_config,
  :output_data_config)
  SENSITIVE = [:job_description]
  include Aws::Structure
end