You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::HumanTaskConfig

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

Overview

Note:

When making an API call, you may pass HumanTaskConfig data as a hash:

{
  workteam_arn: "WorkteamArn", # required
  ui_config: { # required
    ui_template_s3_uri: "S3Uri", # required
  },
  pre_human_task_lambda_arn: "LambdaFunctionArn", # required
  task_keywords: ["TaskKeyword"],
  task_title: "TaskTitle", # required
  task_description: "TaskDescription", # required
  number_of_human_workers_per_data_object: 1, # required
  task_time_limit_in_seconds: 1, # required
  task_availability_lifetime_in_seconds: 1,
  max_concurrent_task_count: 1,
  annotation_consolidation_config: { # required
    annotation_consolidation_lambda_arn: "LambdaFunctionArn", # required
  },
  public_workforce_task_price: {
    amount_in_usd: {
      dollars: 1,
      cents: 1,
      tenth_fractions_of_a_cent: 1,
    },
  },
}

Information required for human workers to complete a labeling task.

Instance Attribute Summary collapse

Instance Attribute Details

#annotation_consolidation_configTypes::AnnotationConsolidationConfig

Configures how labels are consolidated across human workers.



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#max_concurrent_task_countInteger

Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

Returns:

  • (Integer)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#number_of_human_workers_per_data_objectInteger

The number of human workers that will label an object.

Returns:

  • (Integer)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#pre_human_task_lambda_arnString

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

US East (Northern Virginia) (us-east-1):

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

US East (Ohio) (us-east-2):

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

US West (Oregon) (us-west-2):

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

Canada (Central) (ca-central-1):

  • arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

EU (Ireland) (eu-west-1):

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

EU (London) (eu-west-2):

  • arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

EU Frankfurt (eu-central-1):

  • arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

Asia Pacific (Tokyo) (ap-northeast-1):

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

Asia Pacific (Seoul) (ap-northeast-2):

  • arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

Asia Pacific (Mumbai) (ap-south-1):

  • arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

Asia Pacific (Singapore) (ap-southeast-1):

  • arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

Asia Pacific (Sydney) (ap-southeast-2):

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Returns:

  • (String)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#public_workforce_task_priceTypes::PublicWorkforceTaskPrice

The price that you pay for each task performed by an Amazon Mechanical Turk worker.



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#task_availability_lifetime_in_secondsInteger

The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

Returns:

  • (Integer)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#task_descriptionString

A description of the task for your human workers.

Returns:

  • (String)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#task_keywordsArray<String>

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

Returns:

  • (Array<String>)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#task_time_limit_in_secondsInteger

The amount of time that a worker has to complete a task.

Returns:

  • (Integer)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#task_titleString

A title for the task for your human workers.

Returns:

  • (String)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#ui_configTypes::UiConfig

Information about the user interface that workers use to complete the labeling task.

Returns:



5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end

#workteam_arnString

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

Returns:

  • (String)


5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 5770

class HumanTaskConfig < Struct.new(
  :workteam_arn,
  :ui_config,
  :pre_human_task_lambda_arn,
  :task_keywords,
  :task_title,
  :task_description,
  :number_of_human_workers_per_data_object,
  :task_time_limit_in_seconds,
  :task_availability_lifetime_in_seconds,
  :max_concurrent_task_count,
  :annotation_consolidation_config,
  :public_workforce_task_price)
  include Aws::Structure
end