Classes Reference


                    
                    
                    OwasNlpCore

Main entry point to the SDK. Before using any component, the SDK should be initialised here.

Declaration

Swift

public class OwasNlpCore


                    
                    
                    EmotionAnalyzer

Class to extract the sentiments from a text.

It is a good idea to test that the model is loaded before calling analyze(). A simple use case to analyze a text for prevalent emotions would be:

func classifyText(text: String) -> EmotionResult? {
    if (EmotionAnalyzer.sharedInstance().isLoaded()) {
        return EmotionAnalyzer.sharedInstance().analyze(text: text)
    }
    return nil
}

Declaration

Swift

public class EmotionAnalyzer


                    
                    
                    HateSpeechAnalyzer

Class to analyze a text for hate speech content.

It is a good idea to test that the model is loaded before calling analyze(). A simple use-case to test a text for hate speech would be:

func classifyText(text: String) -> Double? {
    if (HateSpeechAnalyzer.sharedInstance().isLoaded()) {
        return HateSpeechAnalyzer.sharedInstance().analyze(text: text)
    }
    return nil
}

Declaration

Swift

public class HateSpeechAnalyzer


                    
                    
                    ProfanityAnalyzer

Class to analyze a text for hate speech content.

It is a good idea to test that the model is loaded before calling analyze(). A simple use-case to test a text for hate speech would be:

func classifyText(text: String) -> Bool {
    if (ProfanityAnalyzer.sharedInstance().isLoaded()) {
        return ProfanityAnalyzer.sharedInstance().containsProfanity(text: text)
    }
    return false
}

Declaration

Swift

public class ProfanityAnalyzer


                    
                    
                    SensitiveInfoAnalyzer

Class to analyse a text for sensitive information.

It is a good idea to test that the model is loaded before calling analyseText(). A simple use-case to test a text for sensitive information would be:

func classifyText(text: String) -> Score? {
    if (SensitiveInfoAnalyzer.sharedInstance().isLoaded()) {
        return SensitiveInfoAnalyzer.sharedInstance().analyse(text: text)
    }
    return nil
}

Declaration

Swift

public class SensitiveInfoAnalyzer


                    
                    
                    ToxicityAnalyzer

Class to analyze a text for toxic content.

It is a good idea to test that the model is loaded before calling analyze(). A simple use-case to get the toxicity of a text would be:

func classifyText(text: String) -> Score? {
    if (ToxicityAnalyzer.sharedInstance().isLoaded()) {
        return ToxicityAnalyzer.sharedInstance().analyze(text: text)
    }
    return nil
}

Declaration

Swift

public class ToxicityAnalyzer


                    
                    
                    EmotionResult

Representation of an emotion classification result. The supported emotions are:

"anger", "fear", "joy", "love", "neutral", "sadness" and "surprise"

Declaration

Swift

public class EmotionResult : CustomStringConvertible, Codable


                    
                    
                    SensitiveInfoResult

Result of an analysis by the SensitiveInfoAnalyser.

Declaration

Swift

public class SensitiveInfoResult : CustomStringConvertible, Codable


                    
                    
                    TriggerAnalysisResult

Result of an analysis by the TriggerWordsAnalyser.

Declaration

Swift

public class TriggerAnalysisResult : CustomStringConvertible, Codable