AWS.AugmentedAIRuntime — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Amazon A2I integrates APIs from various AWS services to create and start human review workflows for those services. To learn how Amazon A2I uses these APIs, see Use APIs in Amazon A2I in the Amazon SageMaker Developer Guide.

Sending a Request Using AugmentedAIRuntime

var augmentedairuntime = new AWS.AugmentedAIRuntime();
augmentedairuntime.deleteHumanLoop(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the AugmentedAIRuntime object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var augmentedairuntime = new AWS.AugmentedAIRuntime({apiVersion: '2019-11-07'});

You can also set the API version globally in AWS.config.apiVersions using the augmentedairuntime service identifier:

AWS.config.apiVersions = {
  augmentedairuntime: '2019-11-07',
  // other service API versions
};

var augmentedairuntime = new AWS.AugmentedAIRuntime();

Constructor Summarycollapse

• new AWS.AugmentedAIRuntime(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• deleteHumanLoop(params = {}, callback) ⇒ AWS.Request
  Deletes the specified human loop for a flow definition.
  If the human loop was deleted, this operation will return a ResourceNotFoundException.
• describeHumanLoop(params = {}, callback) ⇒ AWS.Request
  Returns information about the specified human loop.
• listHumanLoops(params = {}, callback) ⇒ AWS.Request
  Returns information about human loops, given the specified parameters.
• startHumanLoop(params = {}, callback) ⇒ AWS.Request
  Starts a human loop, provided that at least one activation condition is met.
  .
• stopHumanLoop(params = {}, callback) ⇒ AWS.Request
  Stops the specified human loop.
  .

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.AugmentedAIRuntime(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteHumanLoop(params = {}, callback) ⇒ AWS.Request

Deletes the specified human loop for a flow definition.

If the human loop was deleted, this operation will return a ResourceNotFoundException.

describeHumanLoop(params = {}, callback) ⇒ AWS.Request

Returns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error.

listHumanLoops(params = {}, callback) ⇒ AWS.Request

Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.

startHumanLoop(params = {}, callback) ⇒ AWS.Request

Starts a human loop, provided that at least one activation condition is met.

stopHumanLoop(params = {}, callback) ⇒ AWS.Request

Stops the specified human loop.