software.amazon.awssdk.services.sagemaker.model

Interface HumanTaskConfig.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HumanTaskConfig.Builder,HumanTaskConfig>, SdkBuilder<HumanTaskConfig.Builder,HumanTaskConfig>, SdkPojo

Enclosing class:

HumanTaskConfig

public static interface HumanTaskConfig.Builder
extends SdkPojo, CopyableBuilder<HumanTaskConfig.Builder,HumanTaskConfig>

Method Summary

Modifier and Type	Method and Description
HumanTaskConfig.Builder	annotationConsolidationConfig(AnnotationConsolidationConfig annotationConsolidationConfig) Configures how labels are consolidated across human workers.
default HumanTaskConfig.Builder	annotationConsolidationConfig(Consumer<AnnotationConsolidationConfig.Builder> annotationConsolidationConfig) Configures how labels are consolidated across human workers.
HumanTaskConfig.Builder	maxConcurrentTaskCount(Integer maxConcurrentTaskCount) Defines the maximum number of data objects that can be labeled by human workers at the same time.
HumanTaskConfig.Builder	numberOfHumanWorkersPerDataObject(Integer numberOfHumanWorkersPerDataObject) The number of human workers that will label an object.
HumanTaskConfig.Builder	preHumanTaskLambdaArn(String preHumanTaskLambdaArn) The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker.
default HumanTaskConfig.Builder	publicWorkforceTaskPrice(Consumer<PublicWorkforceTaskPrice.Builder> publicWorkforceTaskPrice) The price that you pay for each task performed by an Amazon Mechanical Turk worker.
HumanTaskConfig.Builder	publicWorkforceTaskPrice(PublicWorkforceTaskPrice publicWorkforceTaskPrice) The price that you pay for each task performed by an Amazon Mechanical Turk worker.
HumanTaskConfig.Builder	taskAvailabilityLifetimeInSeconds(Integer taskAvailabilityLifetimeInSeconds) The length of time that a task remains available for labeling by human workers.
HumanTaskConfig.Builder	taskDescription(String taskDescription) A description of the task for your human workers.
HumanTaskConfig.Builder	taskKeywords(Collection<String> taskKeywords) Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
HumanTaskConfig.Builder	taskKeywords(String... taskKeywords) Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.
HumanTaskConfig.Builder	taskTimeLimitInSeconds(Integer taskTimeLimitInSeconds) The amount of time that a worker has to complete a task.
HumanTaskConfig.Builder	taskTitle(String taskTitle) A title for the task for your human workers.
default HumanTaskConfig.Builder	uiConfig(Consumer<UiConfig.Builder> uiConfig) Information about the user interface that workers use to complete the labeling task.
HumanTaskConfig.Builder	uiConfig(UiConfig uiConfig) Information about the user interface that workers use to complete the labeling task.
HumanTaskConfig.Builder	workteamArn(String workteamArn) The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

workteamArn

HumanTaskConfig.Builder workteamArn(String workteamArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

uiConfig

HumanTaskConfig.Builder uiConfig(UiConfig uiConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

uiConfig

default HumanTaskConfig.Builder uiConfig(Consumer<UiConfig.Builder> uiConfig)

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

This is a convenience that creates an instance of the UiConfig.Builder avoiding the need to create one manually via UiConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to uiConfig(UiConfig).

Parameters:

uiConfig - a consumer that will call methods on UiConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

uiConfig(UiConfig)

preHumanTaskLambdaArn

HumanTaskConfig.Builder preHumanTaskLambdaArn(String preHumanTaskLambdaArn)

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

Parameters:

preHumanTaskLambdaArn - 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:

Returns a reference to this object so that method calls can be chained together.

taskKeywords

HumanTaskConfig.Builder taskKeywords(Collection<String> taskKeywords)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

taskKeywords

HumanTaskConfig.Builder taskKeywords(String... taskKeywords)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

taskTitle

HumanTaskConfig.Builder taskTitle(String taskTitle)

A title for the task for your human workers.

Parameters:

taskTitle - A title for the task for your human workers.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskDescription

HumanTaskConfig.Builder taskDescription(String taskDescription)

A description of the task for your human workers.

Parameters:

taskDescription - A description of the task for your human workers.

Returns:

Returns a reference to this object so that method calls can be chained together.

numberOfHumanWorkersPerDataObject

HumanTaskConfig.Builder numberOfHumanWorkersPerDataObject(Integer numberOfHumanWorkersPerDataObject)

The number of human workers that will label an object.

Parameters:

numberOfHumanWorkersPerDataObject - The number of human workers that will label an object.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskTimeLimitInSeconds

HumanTaskConfig.Builder taskTimeLimitInSeconds(Integer taskTimeLimitInSeconds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

taskAvailabilityLifetimeInSeconds

HumanTaskConfig.Builder taskAvailabilityLifetimeInSeconds(Integer taskAvailabilityLifetimeInSeconds)

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.

Parameters:

taskAvailabilityLifetimeInSeconds - 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:

Returns a reference to this object so that method calls can be chained together.

maxConcurrentTaskCount

HumanTaskConfig.Builder maxConcurrentTaskCount(Integer maxConcurrentTaskCount)

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.

Parameters:

maxConcurrentTaskCount - 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:

Returns a reference to this object so that method calls can be chained together.

annotationConsolidationConfig

HumanTaskConfig.Builder annotationConsolidationConfig(AnnotationConsolidationConfig annotationConsolidationConfig)

Configures how labels are consolidated across human workers.

Parameters:

annotationConsolidationConfig - Configures how labels are consolidated across human workers.

Returns:

Returns a reference to this object so that method calls can be chained together.

annotationConsolidationConfig

default HumanTaskConfig.Builder annotationConsolidationConfig(Consumer<AnnotationConsolidationConfig.Builder> annotationConsolidationConfig)

Configures how labels are consolidated across human workers.

This is a convenience that creates an instance of the AnnotationConsolidationConfig.Builder avoiding the need to create one manually via AnnotationConsolidationConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to annotationConsolidationConfig(AnnotationConsolidationConfig) .

Parameters:

annotationConsolidationConfig - a consumer that will call methods on AnnotationConsolidationConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

annotationConsolidationConfig(AnnotationConsolidationConfig)

publicWorkforceTaskPrice

HumanTaskConfig.Builder publicWorkforceTaskPrice(PublicWorkforceTaskPrice publicWorkforceTaskPrice)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

publicWorkforceTaskPrice

default HumanTaskConfig.Builder publicWorkforceTaskPrice(Consumer<PublicWorkforceTaskPrice.Builder> publicWorkforceTaskPrice)

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

This is a convenience that creates an instance of the PublicWorkforceTaskPrice.Builder avoiding the need to create one manually via PublicWorkforceTaskPrice.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to publicWorkforceTaskPrice(PublicWorkforceTaskPrice).

Parameters:

publicWorkforceTaskPrice - a consumer that will call methods on PublicWorkforceTaskPrice.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

publicWorkforceTaskPrice(PublicWorkforceTaskPrice)