Amazon Augmented AI Runtime
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…
AI & machine learning#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 5
- GETDescribe human loop
/human-loops/:HumanLoopNameReturns information about the specified human loop. If the human loop was deleted, this operation will return a ResourceNotFoundException error. - DELETEDelete human loop
/human-loops/:HumanLoopNameDeletes the specified human loop for a flow definition. If the human loop was deleted, this operation will return a ResourceNotFoundException . - GETList human loops
/human-loops?CreationTimeAfter=string&CreationTimeBefore=string&FlowDefinitionArn=string&SortOrder=string&NextToken=string&MaxResults=0Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included. - POSTStart human loop
/human-loopsStarts a human loop, provided that at least one activation condition is met. - POSTStop human loop
/human-loops/stopStops the specified human loop.
API details
- Base URL
https://a2i-runtime.sagemaker.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 5 operations on 3 pathsGET 2POST 2DELETE 1
- Description format
- AWS Smithy model, API version
2019-11-07 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Augmented AI Runtime in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Augmented AI Runtime collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Describe human loop” (GET /human-loops/:HumanLoopName), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Augmented AI Runtime?
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… It is listed under AI & machine learning and has 5 endpoints.
Who publishes the Amazon Augmented AI Runtime?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Augmented AI Runtime?
Requests go to https://a2i-runtime.sagemaker.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Augmented AI Runtime?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Augmented AI Runtime have?
5 operations on 3 paths (2 GET, 2 POST, 1 DELETE).
Is forking the Amazon Augmented AI Runtime free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.