AWSLexInteractionKit

Objective-C

@interface AWSLexInteractionKit : NSObject

/*
 * The Tnteraction Kit config.
 */
@property (nonatomic, strong) AWSLexInteractionKitConfig *interactionKitConfig;

@property (nonatomic, weak) id<AWSLexInteractionDelegate> interactionDelegate;

@property (nonatomic, weak) id<AWSLexMicrophoneDelegate> microphoneDelegate;

@property (nonatomic, weak) id<AWSLexAudioPlayerDelegate> audioPlayerDelegate;

/**
 Returns the singleton interactionKit client. If the singleton object does not exist, the SDK instantiates the default service client with `defaultServiceConfiguration` from `[AWSServiceManager defaultServiceManager]`. The reference to this object is maintained by the SDK, and you do not need to retain it manually.
 
 For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:`
 
 *Swift*
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
         let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
         let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
         AWSServiceManager.default().defaultServiceConfiguration = configuration
 
         return true
      }
 
 *Objective-C*
 
      -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
 
         return YES;
      }
 
 Then call the following to get the default service client:
 
 *Swift*
 
      let interactionKit = AWSLexInteractionKit.default()
 
 *Objective-C*
 
      AWSLexInteractionKit *interactionKit = [AWSLexInteractionKit defaultInteractionKit];
 
 @return The default interactionKit client.
 */
+ (instancetype)defaultInteractionKit;


/**
 Creates a InteractionKit client with the given service configuration and registers it for the key.
 
 For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:`
 
 *Swift*
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
         let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
         let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
         AWSLexInteractionKit.register(with: configuration!, forKey: "USWest2InteractionKit")
 
         return true
      }
 
 *Objective-C*
 
      - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider];
 
         [AWSLexInteractionKit registerInteractionKitWithServiceConfiguration:configuration forKey:@"USWest2InteractionKit"];
 
         return YES;
      }
 
 Then call the following to get the service client:
 
 *Swift*
 
      let interactionKit = AWSLexInteractionKit(forKey: "USWest2InteractionKit")
 
 *Objective-C*
 
      AWSLexInteractionKit *interactionKit = [AWSLexInteractionKit interactionKitForKey:@"USWest2InteractionKit"];
 
 @warning After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
 
 @param configuration A service configuration object.
 @param key           A string to identify the service client.
 */
+ (void)registerInteractionKitWithServiceConfiguration:(AWSServiceConfiguration *)configuration
                           interactionKitConfiguration:(AWSLexInteractionKitConfig *)config
                                                forKey:(NSString *)key;

/**
 Retrieves the service client associated with the key. You need to call `+ registerLexWithConfiguration:forKey:` before invoking this method.
 
 For example, set the default service configuration in `- application:didFinishLaunchingWithOptions:`
 
 *Swift*
 
     func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
         let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
         let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
         AWSLexInteractionKit.register(with: configuration!, forKey: "USWest2InteractionKit")
 
         return true
      }
 
 *Objective-C*
 
      - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider];
         [AWSLexInteractionKit registerInteractionKitWithServiceConfiguration:configuration forKey:@"USWest2InteractionKit"];
 
         return YES;
      }
 
 Then call the following to get the service client:
 
 *Swift*
 
      let interactionKit = AWSLexInteractionKit(forKey: "USWest2InteractionKit")
 
 *Objective-C*
 
      AWSLexInteractionKit *interactionKit = [AWSLexInteractionKit interactionKitForKey:@"USWest2InteractionKit"];
 
 @param key A string to identify the service client.
 
 @return An instance of the service client.
 */
+ (instancetype)interactionKitForKey:(NSString *)key;

/**
 Removes the interaction kit associated with the key and release it.
 
 @warning Before calling this method, make sure no method is running on this client.
 
 @param key A string to identify the service client.
 */
+ (void)removeInteractionKitForKey:(NSString *)key;

/**
 Accepts a text input and responds back with a text output
 
 @param inputText The text input
 */
- (void)textInTextOut:(NSString *)inputText;

/**
 Accets a text input and an optional sessionAttribute dictionary and responds back with a text output.
 
 @param inputText The text input
 @param sessionAttributes Optional Session attributes dictionary
 */
- (void)textInTextOut:(NSString *)inputText sessionAttributes:(NSDictionary<NSString *, NSString *> * _Nullable)sessionAttributes;

/**
 Accepts a text input and responds back with an audio response. the playback will begin automatically unless you have set autoplayback to false in the InteractionKitConfig.
 
 @param inputText The text input
 */
- (void)textInAudioOut:(NSString *)inputText;

/**
 Accepts a text input and an optional sessionAttribute dictionary and responds back with an audio response. The playback will begin automatically unless you have set autoplayback to false in the InteractionKitConfig.
 
 @param inputText The text input
 @param sessionAttributes Optional Session attributes dictionary
 */
- (void)textInAudioOut:(NSString *)inputText sessionAttributes:(NSDictionary<NSString *, NSString *> * _Nullable)sessionAttributes;

/**
 Starts the microphone and listens to audio from the phone microphone and responds back with an audio response.The playback will begin automatically unless you have set autoplayback to false in the InteractionKitConfig.
 */
- (void)audioInAudioOut;

/**
 Starts the microphone and listens to audio from the phone microphone and responds back with an audio response.The playback will begin automatically unless you have set autoplayback to false in the InteractionKitConfig.
 
 @param sessionAttributes Optional Session attributes dictionary
 */
- (void)audioInAudioOutWithSessionAttributes:(NSDictionary<NSString *, NSString *> * _Nullable)sessionAttributes;

/**
 Starts the microphone and listens to audio from the phone microphone and responds back with a text response.
 */
- (void)audioInTextOut;

/**
 Starts the microphone and listens to audio from the phone microphone and responds back with a text response.
 
 @param sessionAttributes Optional Session attributes dictionary
 */
- (void)audioInTextOutWithSessionAttributes:(NSDictionary<NSString *, NSString *> * _Nullable)sessionAttributes;

/**
 Cancels ongoing http call and stops listening to Microphone if Audio input was requested.
 */
- (void)cancel;

@end

Swift

class AWSLexInteractionKit : NSObject