5.0.0 • Published 5 years ago

@datafire/amazonaws_sagemaker_a2i_runtime v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_sagemaker_a2i_runtime

Client library for Amazon Augmented AI Runtime

Installation and Usage

npm install --save @datafire/amazonaws_sagemaker_a2i_runtime
let amazonaws_sagemaker_a2i_runtime = require('@datafire/amazonaws_sagemaker_a2i_runtime').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Augmented AI is in preview release and is subject to change. We do not recommend using this product in production environments. 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.

Actions

StartHumanLoop

amazonaws_sagemaker_a2i_runtime.StartHumanLoop({
  "HumanLoopName": "",
  "FlowDefinitionArn": "",
  "HumanLoopInput": {}
}, context)

Input

  • input object
    • DataAttributes object: Attributes of the data specified by the customer. Use these to describe the data to be labeled.
    • FlowDefinitionArn required string: The Amazon Resource Name (ARN) of the flow definition associated with this human loop.
    • HumanLoopInput required object: An object containing the human loop input in JSON format.
      • InputContent
    • HumanLoopName required string: The name of the human loop.

Output

ListHumanLoops

amazonaws_sagemaker_a2i_runtime.ListHumanLoops({
  "FlowDefinitionArn": ""
}, context)

Input

  • input object
    • CreationTimeAfter string
    • CreationTimeBefore string
    • FlowDefinitionArn required string
    • SortOrder string
    • NextToken string
    • MaxResults integer

Output

StopHumanLoop

amazonaws_sagemaker_a2i_runtime.StopHumanLoop({
  "HumanLoopName": ""
}, context)

Input

  • input object
    • HumanLoopName required string: The name of the human loop that you want to stop.

Output

DeleteHumanLoop

amazonaws_sagemaker_a2i_runtime.DeleteHumanLoop({
  "HumanLoopName": ""
}, context)

Input

  • input object
    • HumanLoopName required string

Output

DescribeHumanLoop

amazonaws_sagemaker_a2i_runtime.DescribeHumanLoop({
  "HumanLoopName": ""
}, context)

Input

  • input object
    • HumanLoopName required string

Output

Definitions

ConflictException

ContentClassifier

  • ContentClassifier string (values: FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent)

ContentClassifiers

DeleteHumanLoopRequest

  • DeleteHumanLoopRequest object

DeleteHumanLoopResponse

  • DeleteHumanLoopResponse object

DescribeHumanLoopRequest

  • DescribeHumanLoopRequest object

DescribeHumanLoopResponse

  • DescribeHumanLoopResponse object
    • CreationTime required
    • FailureCode
    • FailureReason
    • FlowDefinitionArn required
    • HumanLoopArn required
    • HumanLoopName required
    • HumanLoopOutput
      • OutputS3Uri required
    • HumanLoopStatus required

FailureReason

  • FailureReason string

FlowDefinitionArn

  • FlowDefinitionArn string

HumanLoopArn

  • HumanLoopArn string

HumanLoopDataAttributes

  • HumanLoopDataAttributes object: Attributes of the data specified by the customer. Use these to describe the data to be labeled.

HumanLoopInput

  • HumanLoopInput object: An object containing the human loop input in JSON format.
    • InputContent required

HumanLoopName

  • HumanLoopName string

HumanLoopOutput

  • HumanLoopOutput object: Information about where the human output will be stored.
    • OutputS3Uri required

HumanLoopStatus

  • HumanLoopStatus string (values: InProgress, Failed, Completed, Stopped, Stopping)

HumanLoopSummaries

HumanLoopSummary

  • HumanLoopSummary object: Summary information about the human loop.
    • CreationTime
    • FailureReason
    • FlowDefinitionArn
    • HumanLoopName
    • HumanLoopStatus

InputContent

  • InputContent string

InternalServerException

ListHumanLoopsRequest

  • ListHumanLoopsRequest object

ListHumanLoopsResponse

  • ListHumanLoopsResponse object

MaxResults

  • MaxResults integer

NextToken

  • NextToken string

ResourceNotFoundException

ServiceQuotaExceededException

SortOrder

  • SortOrder string (values: Ascending, Descending)

StartHumanLoopRequest

  • StartHumanLoopRequest object
    • DataAttributes
    • FlowDefinitionArn required
    • HumanLoopInput required
      • InputContent required
    • HumanLoopName required

StartHumanLoopResponse

  • StartHumanLoopResponse object
    • HumanLoopArn

StopHumanLoopRequest

  • StopHumanLoopRequest object
    • HumanLoopName required

StopHumanLoopResponse

  • StopHumanLoopResponse object

String

  • String string

ThrottlingException

Timestamp

  • Timestamp string

ValidationException

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago