KIOSDecodingGraph.h

//
//  KIOSDecodingGraph.h
//  KeenASR
//
//  Created by Ognjen Todic on 5/17/16.
//  Copyright © 2016 Keen Research. All rights reserved.
//
 
#ifndef KIOSDecodingGraph_h
#define KIOSDecodingGraph_h

typedef NS_ENUM(NSInteger, KIOSSpeakingTask) {
  KIOSSpeakingTaskDefault,
  KIOSSpeakingTaskOralReading,
//  /** Keyword spotting among small number (20-30) of words */
//  KIOSSpeakingTaskKeywordSpotting,
};
 
@class KIOSRecognizer;
@class KIOSWordPronunciation;

@interface KIOSDecodingGraph : NSObject 

+ (BOOL)createDecodingGraphFromPhrases:(nonnull NSArray *)phrases
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
          usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                 andTask:(KIOSSpeakingTask) task
                         andSaveWithName:(nonnull NSString *)decodingGraphName;
 

+ (BOOL)createDecodingGraphFromPhrases:(nonnull NSArray *)phrases
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
          usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                 andTask:(KIOSSpeakingTask) task
              withSpokenNoiseProbability:(float) spokenNoiseProbability
                         andSaveWithName:(nonnull NSString *)decodingGraphName;


+ (BOOL)createContextualDecodingGraphFromPhrases:(nonnull NSArray<NSArray *> *) contextualPhrases
                                   forRecognizer:(nonnull KIOSRecognizer *) recognizer
                  usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                         andTask:(KIOSSpeakingTask) task
                                 andSaveWithName:(nonnull NSString *)decodingGraphName;
 

+ (BOOL)createContextualDecodingGraphFromPhrases:(nonnull NSArray<NSArray *> *) contextualPhrases
                                   forRecognizer:(nonnull KIOSRecognizer *) recognizer
                  usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                         andTask:(KIOSSpeakingTask) task
                      withSpokenNoiseProbability:(float)spokenNoiseProbability
                                 andSaveWithName:(nonnull NSString *)decodingGraphName;
 

+ (BOOL)createDecodingGraphFromPhrases:(nonnull NSArray *)phrases
                       withTriggerPhrase:(nonnull NSString *)triggerPhrase
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
                         andSaveWithName:(nonnull NSString *)decodingGraphName;

 

+ (BOOL)decodingGraphWithNameExists:(nonnull NSString *)decodingGraphName
                      forRecognizer:(nonnull KIOSRecognizer *)recognizer;
 

+ (BOOL)decodingGraphAtPathExists:(nonnull NSString *)absolutePathToDecodingGraphDirectory;
 

+ (BOOL)decodingGraphExistsAtPath:(nonnull NSString *)absolutePathToDecodingGraphDirectory
__deprecated_msg("Please use decodingGraphAtPathExists method");
 

+ (nullable NSDate *)decodingGraphCreationDate:(nonnull NSString *)decodingGraphName
                                 forRecognizer:(nonnull KIOSRecognizer *)recognizer;

+ (nullable NSURL *)getDecodingGraphDirURL:(nonnull NSString *)decodingGraphName
                             forRecognizer:(nonnull KIOSRecognizer *)recognizer;
 

 
+ (BOOL)createDecodingGraphFromSentences:(nonnull NSArray *)sentences
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
                            andSaveWithName:(nonnull NSString *)decodingGraphName
__deprecated_msg("Please use createDecodingGraphFromPhrases methods");
 
 
+ (BOOL)createContextualDecodingGraphFromSentences:(nonnull NSArray<NSArray *> *) contextualSentences
                                     forRecognizer:(nonnull KIOSRecognizer *) recognizer
                    usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                           andTask:(KIOSSpeakingTask) task
                                   andSaveWithName:(nonnull NSString *)decodingGraphName
__deprecated_msg("Please use createContextualDecodingGraphFromPhrases methods");
 
 
+ (BOOL)createDecodingGraphFromSentences:(nonnull NSArray *)sentences
                       withTriggerPhrase:(nonnull NSString *)triggerPhrase
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
                         andSaveWithName:(nonnull NSString *)decodingGraphName
__deprecated_msg("Please use createDecodingGraphFromPhrases: withTriggerPhrase method");
 
 
+ (BOOL)createDecodingGraphFromSentences:(nonnull NSArray *)sentences
                           forRecognizer:(nonnull KIOSRecognizer *) recognizer
          usingAlternativePronunciations:(nullable NSArray<KIOSWordPronunciation *> *) alternativePronunciations
                                 andTask:(KIOSSpeakingTask) task
                            andSaveWithName:(nonnull NSString *)decodingGraphName
__deprecated_msg("Please use createDecodingGraphFromPhrases methods");
 
@end
 
 
#endif /* KIOSDecodingGraph_h */