AugmentedAIRuntime
public struct AugmentedAIRuntime
Client object for interacting with AWS AugmentedAIRuntime service.
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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the AugmentedAIRuntime client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Deletes the specified human loop for a flow definition.
Declaration
Swift
public func deleteHumanLoop(_ input: DeleteHumanLoopRequest) -> EventLoopFuture<DeleteHumanLoopResponse>
-
Returns information about the specified human loop.
Declaration
Swift
public func describeHumanLoop(_ input: DescribeHumanLoopRequest) -> EventLoopFuture<DescribeHumanLoopResponse>
-
Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
Declaration
Swift
public func listHumanLoops(_ input: ListHumanLoopsRequest) -> EventLoopFuture<ListHumanLoopsResponse>
-
Starts a human loop, provided that at least one activation condition is met.
Declaration
Swift
public func startHumanLoop(_ input: StartHumanLoopRequest) -> EventLoopFuture<StartHumanLoopResponse>
-
Stops the specified human loop.
Declaration
Swift
public func stopHumanLoop(_ input: StopHumanLoopRequest) -> EventLoopFuture<StopHumanLoopResponse>
-
Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.
Declaration
Swift
public func listHumanLoopsPaginator(_ input: ListHumanLoopsRequest, onPage: @escaping (ListHumanLoopsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListHumanLoopsRequest : AWSShape
extension AugmentedAIRuntime.ListHumanLoopsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ContentClassifier : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum HumanLoopStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SortOrder : String, CustomStringConvertible, Codable