AugmentedAIRuntime class
Amazon Augmented AI (Amazon A2I) adds the benefit of human judgment to any
machine learning application. When an AI application can't evaluate data
with a high degree of confidence, human reviewers can take over. This human
review is called a human review workflow. To create and start a human review
workflow, you need three resources: a worker task template, a flow
definition, and a human loop.
For information about these resources and prerequisites for using Amazon A2I, see Get Started with Amazon Augmented AI in the Amazon SageMaker Developer Guide.
This API reference includes information about API actions and data types that you can use to interact with Amazon A2I programmatically. Use this guide to:
-
Start a human loop with the
StartHumanLoop
operation when using Amazon A2I with a custom task type. To learn more about the difference between custom and built-in task types, see Use Task Types . To learn how to start a human loop using this API, see Create and Start a Human Loop for a Custom Task Type in the Amazon SageMaker Developer Guide. - Manage your human loops. You can list all human loops that you have created, describe individual human loops, and stop and delete human loops. To learn more, see Monitor and Manage Your Human Loop in the Amazon SageMaker Developer Guide.
Constructors
- AugmentedAIRuntime({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
deleteHumanLoop(
{required String humanLoopName}) → Future< void> - Deletes the specified human loop for a flow definition.
-
describeHumanLoop(
{required String humanLoopName}) → Future< DescribeHumanLoopResponse> - Returns information about the specified human loop.
-
listHumanLoops(
{required String flowDefinitionArn, DateTime? creationTimeAfter, DateTime? creationTimeBefore, int? maxResults, String? nextToken, SortOrder? sortOrder}) → Future< ListHumanLoopsResponse> - Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
startHumanLoop(
{required String flowDefinitionArn, required HumanLoopInput humanLoopInput, required String humanLoopName, HumanLoopDataAttributes? dataAttributes}) → Future< StartHumanLoopResponse> - Starts a human loop, provided that at least one activation condition is met.
-
stopHumanLoop(
{required String humanLoopName}) → Future< void> - Stops the specified human loop.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited