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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:job_description]

Instance Attribute Summary collapse

Instance Attribute Details

#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.

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#customer_encryption_key_id ⇒ String

Specify your customer managed key ARN that will be used to encrypt your model evaluation job.

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#evaluation_config ⇒ Types::EvaluationConfig

Specifies whether the model evaluation job is automatic or uses human worker.

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#inference_config ⇒ Types::EvaluationInferenceConfig

Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#job_description ⇒ String

A description of the model evaluation job.

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#job_name ⇒ String

The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :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:



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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

#output_data_config ⇒ Types::EvaluationOutputDataConfig

An object that defines where the results of model evaluation job will be saved in Amazon S3.

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

class CreateEvaluationJobRequest < Struct.new(
  :job_name,
  :job_description,
  :client_request_token,
  :role_arn,
  :customer_encryption_key_id,
  :job_tags,
  :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. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions.

Returns:

  • (String) 


144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 144

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