使用Olami SDK实现一个语音输入数字进行24点计算的iOS程序

前言

在目前的软件应用中，输入方式还是以文字输入方式为主，但是语音输入的方式目前应用的越来越广泛。这是一个利用 Olami SDK 编写的一个24点iOS程序，是通过语音进行输入。
Olami SDK的介绍在下面这个网址
https://cn.olami.ai/wiki/?mp=sdk&content=sdk/ios/reference.html
在这个网址中详细的介绍了Olami SDK包含了那些函数和定义的委托。

App实现

下面就通过24点这个程序来介绍一下如何使用这个SDK。
这个APP可在 https://github.com/lym-ay/OlamiRecognizerMath24 下载

1. 去上面的网址下载Olami SDK.包括两个文件，其中的一个是Olami的静态函数库，一个是其头文件
   第一步是初始化Olami的语音识别对象，并设置代理

olamiRecognizer= [[OlamiRecognizer alloc] init];
olamiRecognizer.delegate = self;

2.调用setAuthorization函数进行授权

[olamiRecognizer setAuthorization:@"d13bbcbef2a4460dbf19ced850eb5d83"
    api:@"asr" appSecret:@"3b08b349c0924a79869153bea334dd86" cusid:OLACUSID];

这个函数的参数的说明在OlamiRecognizer中有说明，也可以去在线API说明去查看
https://cn.olami.ai/wiki/?mp=sdk&content=sdk/ios/reference.html
有些参数必须去Olami的开发平台上注册才可以获的，网址是https://olami.ai

3.设置语系

[olamiRecognizer setLocalization:LANGUAGE_SIMPLIFIED_CHINESE];

在进行录音之前必须要先进行设置，否则会得不到结果。目前只支持简体中文(LANGUAGE_SIMPLIFIED_CHINESE)

4.开始录音
调用 start()接口开始进行录音

[olamiRecognizer start];

5.得到录音的文字和语义，并对其进行处理
通过调用stop()函数或者自动停止，都会获得录音的文字和对其进行的语义分析的结果
实现OlamiRecognizerDelegate onResult函数可以获得结果，其结果以一个json字符串的形式回调过来，对这个字符串进行解析，就可以获得想要的数字。例如对着话筒说”2345算24点”，得到的结果如下

{
    "data": {
        "asr": {
            "result": "二 三 四 五 算 二 十 四 点",
            "speech_status": 0,
            "final": true,
            "status": 0
        },
        "nli": [
            {
                "desc_obj": {
                    "status": 0
                },
                "semantic": [
                    {
                        "app": "math24",
                        "input": "二三四五算二十四点",
                        "slots": [
                            {
                                "num_detail": {
                                    "recommend_value": "",
                                    "type": "number"
                                },
                                "name": "number3",
                                "value": "4"
                            },
                            {
                                "num_detail": {
                                    "recommend_value": "",
                                    "type": "number"
                                },
                                "name": "number4",
                                "value": "5"
                            },
                            {
                                "num_detail": {
                                    "recommend_value": "",
                                    "type": "number"
                                },
                                "name": "number1",
                                "value": "2"
                            },
                            {
                                "num_detail": {
                                    "recommend_value": "",
                                    "type": "number"
                                },
                                "name": "number2",
                                "value": "3"
                            }
                        ],
                        "modifier": [
                            "play_calculate"
                        ],
                        "customer": "58df685e84ae11f0bb7b4893"
                    }
                ],
                "type": "math24"
            }
        ]
    },
    "status": "ok"
}

这个是根据OSL语法描述语言定义的一套规则，返回的结果。这个结果的说明在 https://cn.olami.ai/wiki/?mp=api_nlu&content=api_nlu3.html 这个网址上有说明。

看到这里大家可能会有疑惑，APP怎么知道我说的是什么意思呢？这就涉及到了OSL语法描述语言，OLAMI 语法描述语言（OLAMI Syntax Language，简称：OSL）是 OLAMI 平台针对自然语言处理所发展出的独特语法标记语言，自然语言语义互动（Natural Language Interaction, 简称：NLI）管理系统采用 OSL 取代复杂的编码编程，使用简单、容易学习而且灵活有弹性。可以在这个网址查看详细的说明
https://cn.olami.ai/wiki/?mp=osl&content=osl1.html
在编写这个APP之前，会按照OSL的要求编写好一套语法，这套语法可以被Olami的服务器所理解，并进行语义分析然后给出结果，就是上面的json字符串。在Olami官网上有写好的一些领域的模块，可以直接使用。在 https://cn.olami.ai/wiki/?mp=nli&content=nli1.html 网址可以看到介绍如何使用以后的模块。这个24点就是利用已有的模块来编写代码的。

6.onResult 函数的说明
在整个程序中，最主要的一个函数就是onResult函数

- (void)onResult:(NSData *)result {
    NSError *error;
    __weak typeof(self) weakSelf = self;
    NSDictionary *dic = [NSJSONSerialization JSONObjectWithData:result
                        options:NSJSONReadingMutableContainers
                        error:&error];
    if (error) {
        NSLog(@"error is %@",error.localizedDescription);
    }else{
        NSString *jsonStr=[[NSString alloc]initWithData:result
                          encoding:NSUTF8StringEncoding];
        NSLog(@"jsonStr is %@",jsonStr);
        NSString *ok = [dic objectForKey:@"status"];
        if ([ok isEqualToString:@"ok"]) {
            NSDictionary *dicData = [dic objectForKey:@"data"];
            NSDictionary *asr = [dicData objectForKey:@"asr"];
            if (asr) {//如果asr不为空，说明目前是语音输入
                [weakSelf processASR:asr];
            }
            NSDictionary *nli = [[dicData objectForKey:@"nli"] objectAtIndex:0];
            NSDictionary *desc = [nli objectForKey:@"desc_obj"];
            int status = [[desc objectForKey:@"status"] intValue];
            if (status != 0) {// 0 说明状态正常,非零为状态不正常
                NSString *result  = [desc objectForKey:@"result"];
                dispatch_async(dispatch_get_main_queue(), ^{
                    _resultTextView.text = result;
                });

            }else{
                NSDictionary *semantic = [[nli objectForKey:@"semantic"]
                                         objectAtIndex:0];
                [weakSelf processSemantic:semantic];

            }

        }else{
            dispatch_async(dispatch_get_main_queue(), ^{
                _resultTextView.text = @"请说出10以内的4个数";
            });
        }
    }



}

在这个函数中，调用了三个函数，分别来处理josn格式中的三个比较重要的节点

- (void)processASR:(NSDictionary*)asrDic {
    NSString *result  = [asrDic objectForKey:@"result"];
    if (result.length == 0) { //如果结果为空，则弹出警告框
        UIAlertController *alertController = [UIAlertController
                                              alertControllerWithTitle:@"没有接受到语音，请重新输入!"
                                              message:nil
                                              preferredStyle:UIAlertControllerStyleAlert];
        [self presentViewController:alertController animated:YES completion:^{
            dispatch_time_t time=dispatch_time(DISPATCH_TIME_NOW, 1*NSEC_PER_SEC);
            dispatch_after(time, dispatch_get_main_queue(), ^{
                [alertController dismissViewControllerAnimated:YES completion:nil];

            });

        }];

    }else{
        dispatch_async(dispatch_get_main_queue(), ^{
            NSString *str = [result stringByReplacingOccurrencesOfString:@" " withString:@""];//去掉字符中间的空格
            _inputTextView.text = str;
        });
    }

}

这个用来处理ASR节点，获得语音识别的结果，显示在第一个TextView中

- (void)processSemantic:(NSDictionary*)semanticDic {
    NSArray *slot = [semanticDic objectForKey:@"slots"];
    [_slotValue removeAllObjects];
    if (slot.count != 0) {
        for (NSDictionary *dic in slot) {
            NSString* val = [dic objectForKey:@"value"];
            [_slotValue addObject:val];
        }

    }

    NSArray *modify = [semanticDic objectForKey:@"modifier"];
    if (modify.count != 0) {
        for (NSString *s in modify) {
            [self processModify:s];

        }

    }

}

这个用来处理Semantic节点，这个节点中包含了slot的值。OSL 语法描述语言中的 slot 可理解为语义中的变量，用于传递、提取信息。关于slot的值可以参考 https://cn.olami.ai/wiki/?mp=osl&content=osl_slot.html，这里有详细说明。在24点程序中我们的要计算的数字就是从这里获得的。

- (void)processModify:(NSString*) str {
    if ([str isEqualToString:@"play_want"]
        || [str isEqualToString:@"play_want_ask"]
        || [str isEqualToString:@"needmore"]
        || [str isEqualToString:@"needmore_ask"]) {//要求用户输入值
        dispatch_async(dispatch_get_main_queue(), ^{
            _resultTextView.text = @"请说出10以内的4个数";
        });
    }else if ([str isEqualToString:@"rules"]){
        dispatch_async(dispatch_get_main_queue(), ^{
            _resultTextView.text = @"四个数字运算结果等于二十四";
        });

    }else if ([str isEqualToString:@"play_calculate"]){
        NSString* str = [[Math24 shareInstance] calculate:_slotValue];
        dispatch_async(dispatch_get_main_queue(), ^{
            _resultTextView.text = str;
        });

    }else if ([str isEqualToString:@"attention"]){
        dispatch_async(dispatch_get_main_queue(), ^{
            _resultTextView.text = @"四个数字必须是10以内的，不能超过10";
        });
    }

}

这个用来处理语音和语义的结果。这个函数主要是处理json字符串中的modifier节点。modifier 语法描述规则是 OSL 语法描述语言中，除了 slot 以外的另一种内置的信息传递机制，一般用来表示语义目的，也可以理解为对于语义的一种注释方式，以便让应用程序的开发者得知 grammar 所代表的相应意图。详细说明参考
https://cn.olami.ai/wiki/?mp=osl&content=osl_regex.html#11通过modifier，我们才能知道程序的意图是什么？例如是想发问，还是计算结果。

如上代码所示，在24点钟我们定义了7个modifier，根据字面意思大家也可以猜出来。这些都可以在OSL语法中自定义，然后通过Josn字符串获得，在程序中进行处理。