Skip to content

HumanLoopConfig

Source code in docs_src/capo_sagemaker/types/human_loop_config.py
class HumanLoopConfig(TypedDict, closed=True):
    workteam_arn: NotRequired["capo_sagemaker.types.workteam_arn.WorkteamArn"]
    """<p>Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-management.html">Create and Manage Workforces</a>.</p>"""
    human_task_ui_arn: NotRequired[
        "capo_sagemaker.types.human_task_ui_arn.HumanTaskUiArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the human task user interface.</p> <p>You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.</p> <p>To learn how to create a custom HTML template, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-custom-templates.html">Create Custom Worker Task Template</a>.</p> <p>To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/a2i-worker-template-console.html">Create and Delete a Worker Task Templates</a>.</p>"""
    task_title: NotRequired[
        "capo_sagemaker.types.flow_definition_task_title.FlowDefinitionTaskTitle"
    ]
    """<p>A title for the human worker task.</p>"""
    task_description: NotRequired[
        "capo_sagemaker.types.flow_definition_task_description.FlowDefinitionTaskDescription"
    ]
    """<p>A description for the human worker task.</p>"""
    task_count: NotRequired[
        "capo_sagemaker.types.flow_definition_task_count.FlowDefinitionTaskCount"
    ]
    """<p>The number of distinct workers who will perform the same task on each object. For example, if <code>TaskCount</code> is set to <code>3</code> for an image classification labeling job, three workers will classify each input image. Increasing <code>TaskCount</code> can improve label accuracy.</p>"""
    task_availability_lifetime_in_seconds: NotRequired[
        "capo_sagemaker.types.flow_definition_task_availability_lifetime_in_seconds.FlowDefinitionTaskAvailabilityLifetimeInSeconds"
    ]
    """<p>The length of time that a task remains available for review by human workers.</p>"""
    task_time_limit_in_seconds: NotRequired[
        "capo_sagemaker.types.flow_definition_task_time_limit_in_seconds.FlowDefinitionTaskTimeLimitInSeconds"
    ]
    """<p>The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).</p>"""
    task_keywords: NotRequired[
        "capo_sagemaker.types.flow_definition_task_keywords.FlowDefinitionTaskKeywords"
    ]
    """<p>Keywords used to describe the task so that workers can discover the task.</p>"""
    public_workforce_task_price: NotRequired[
        "capo_sagemaker.types.public_workforce_task_price.PublicWorkforceTaskPrice"
    ]

human_task_ui_arn instance-attribute

human_task_ui_arn: NotRequired[HumanTaskUiArn]

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

public_workforce_task_price instance-attribute

public_workforce_task_price: NotRequired[PublicWorkforceTaskPrice]

task_availability_lifetime_in_seconds instance-attribute

task_availability_lifetime_in_seconds: NotRequired[
    FlowDefinitionTaskAvailabilityLifetimeInSeconds
]

The length of time that a task remains available for review by human workers.

task_count instance-attribute

task_count: NotRequired[FlowDefinitionTaskCount]

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

task_description instance-attribute

task_description: NotRequired[FlowDefinitionTaskDescription]

A description for the human worker task.

task_keywords instance-attribute

task_keywords: NotRequired[FlowDefinitionTaskKeywords]

Keywords used to describe the task so that workers can discover the task.

task_time_limit_in_seconds instance-attribute

task_time_limit_in_seconds: NotRequired[FlowDefinitionTaskTimeLimitInSeconds]

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

task_title instance-attribute

task_title: NotRequired[FlowDefinitionTaskTitle]

A title for the human worker task.

workteam_arn instance-attribute

workteam_arn: NotRequired[WorkteamArn]

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.