AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing AugmentedAIRuntime Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.

From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between "ML only" systems with unacceptably high error rates or "human only" systems that are expensive and difficult to scale, and that slow down decision making.

This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically.

You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as Textract.AnalyzeDocument and Rekognition.DetectModerationLabels. These AI services, in turn, invoke the StartHumanLoop API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.

You can find additional Augmented AI API documentation in the following reference guides: Amazon Rekognition, Amazon SageMaker, and Amazon Textract.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AugmentedAIRuntime.AmazonAugmentedAIRuntimeClient

Namespace: Amazon.AugmentedAIRuntime
Assembly: AWSSDK.AugmentedAIRuntime.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAugmentedAIRuntimeClient : AmazonServiceClient
         IAmazonAugmentedAIRuntime, IAmazonService, IDisposable

The AmazonAugmentedAIRuntimeClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAugmentedAIRuntimeClient()

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAugmentedAIRuntimeClient(RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAugmentedAIRuntimeClient(AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials

Public Method AmazonAugmentedAIRuntimeClient(AWSCredentials, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Credentials and an AmazonAugmentedAIRuntimeClient Configuration object.

Public Method AmazonAugmentedAIRuntimeClient(string, string)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID, AWS Secret Key and an AmazonAugmentedAIRuntimeClient Configuration object.

Public Method AmazonAugmentedAIRuntimeClient(string, string, string)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, string, RegionEndpoint)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAugmentedAIRuntimeClient(string, string, string, AmazonAugmentedAIRuntimeConfig)

Constructs AmazonAugmentedAIRuntimeClient with AWS Access Key ID, AWS Secret Key and an AmazonAugmentedAIRuntimeClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DeleteHumanLoop(DeleteHumanLoopRequest)

Deletes the specified human loop for a flow definition.

Public Method DeleteHumanLoopAsync(DeleteHumanLoopRequest, CancellationToken)

Deletes the specified human loop for a flow definition.

Public Method DescribeHumanLoop(DescribeHumanLoopRequest)

Returns information about the specified human loop.

Public Method DescribeHumanLoopAsync(DescribeHumanLoopRequest, CancellationToken)

Returns information about the specified human loop.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ListHumanLoops(ListHumanLoopsRequest)

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

Public Method ListHumanLoopsAsync(ListHumanLoopsRequest, CancellationToken)

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

Public Method StartHumanLoop(StartHumanLoopRequest)

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

Public Method StartHumanLoopAsync(StartHumanLoopRequest, CancellationToken)

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

Public Method StopHumanLoop(StopHumanLoopRequest)

Stops the specified human loop.

Public Method StopHumanLoopAsync(StopHumanLoopRequest, CancellationToken)

Stops the specified human loop.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms