本文介绍如何使用智能语音交互一句话识别的微信小程序SDK,包括SDK的安装方法及SDK代码示例等。
前提条件
下载安装
- 下载并安装SDK。 - 通过Github下载对应SDK代码,或直接下载alibabacloud-nls-wx-sdk-master.zip。 
- 导入SDK。 - 您可将下载好的代码放入工程合适目录下,然后根据目录位置通过require进行导入。 
获取Token
getToken
获取Token并以AKID(AccessKey ID)和AKKEY(AccessKey Secret)为key缓存对应Token,如果缓存的Token过期则自动刷新并获取。缓存机制请参见微信小程序文档的数据缓存部分。
- 参数说明:无。 
- 返回值:String类型的Token。 
getTokenInner
直接获取Token,不带任何缓存机制,适用于用户自定义缓存方式。
- 参数说明:无。 
- 返回值:String类型的Token。 
频繁调用该接口会被服务端拒绝访问。
一句话识别
Class: SpeechRecognition
SpeechRecognition类用于进行一句话识别。
defaultStartParams()
返回一个默认的推荐参数,其中Format为PCM,采样率为16000 Hz,中间结果、标点预测和ITN均为打开状态。您在拿到默认对象后可以根据自身需求,结合接口说明中的参数列表来添加和修改参数。
- 参数说明:无。 
- 返回值: - object类型对象,字段如下: - { "format": "pcm", "sample_rate": 16000, "enable_intermediate_result": true, "enable_punctuation_prediction": true, "enable_inverse_text_normalization": true }
on(which, handler)
设置事件回调。
- 参数说明: - 参数 - 类型 - 参数说明 - which - String - 事件名称。 - handler - Function - 回调函数。 - 支持的回调事件如下: - 事件名称 - 事件说明 - 回调函数参数个数 - 回调函数参数说明 - started - 一句话识别开始。 - 1 - String类型,开始信息。 - changed - 一句话识别中间结果。 - 1 - String类型,中间结果信息。 - completed - 一句话识别完成。 - 1 - String类型,完成信息。 - closed - 连接关闭。 - 0 - 无。 - failed - 错误。 - 1 - String类型,错误信息。 
- 返回值:无。 
async start(param)
根据param发起一次一句话识别,param可以参考defaultStartParams方法的返回,具体参数见接口说明。
- 参数说明: - 参数 - 类型 - 参数说明 - param - Object - 一句话识别参数。 
- 返回值: Promise对象,当started事件发生后触发resolve,并携带started信息;当任何错误发生后触发reject,并携带异常信息。 
async close(param)
停止一句话识别。
- 参数说明: - 参数 - 类型 - 参数说明 - param - Object - 一句话识别结束参数。 
- 返回值: - Promise对象,当completed事件发生后触发resolve,并携带completed信息;当任何错误发生后触发reject,并携带异常信息。 
shutdown()
强制断开连接。
- 参数说明:无。 
- 返回值:无。 
sendAudio(data)
发送音频,音频格式必须和参数中一致。
- 参数说明: - 参数 - 类型 - 参数说明 - data - ArrayBuffer - 二进制音频数据。 
- 返回值:无。 
代码示例
以下代码示例仅供参考,代码中使用微信小程序自带录音功能,实际使用时,需要考虑微信小程序的限制,以及前端页面设计和具体业务功能。
// pages/sr/sr.js
const app = getApp()
const AKID = "Your AKID"
const AKKEY = "Your AKKEY"
const getToken = require("../../utils/token").getToken
const SpeechRecognition = require("../../utils/sr")
const sleep = require("../../utils/util").sleep
Page({
    /**
     * 页面的初始数据
     */
    data: {
        srStart : false,
        srResult : "未开始识别"
    },
    /**
     * 生命周期函数--监听页面加载
     */
    onLoad: async function (options) {
        wx.getRecorderManager().onFrameRecorded((res)=>{
            if (res.isLastFrame) {
                console.log("record done")
            }
            if (this.data.sr && this.data.srStart) {
                console.log("send " + res.frameBuffer.byteLength)
                this.data.sr.sendAudio(res.frameBuffer)
            }
        })
        wx.getRecorderManager().onStart(()=>{
            console.log("start recording...")
        })
        wx.getRecorderManager().onStop((res) => {
            console.log("stop recording...")
            if (res.tempFilePath) {
                wx.removeSavedFile({
                    filePath:res.tempFilePath
                })
            }
        })
        wx.getRecorderManager().onError((res) => {
            console.log("recording failed:" + res)
        })
        try {
            this.data.token = await getToken(AKID, AKKEY)
        } catch (e) {
            console.log("error on get token:", JSON.stringify(e))
            return
        }
        let sr = new SpeechRecognition({
            url : app.globalData.URL,
            appkey: app.globalData.APPKEY,
            token: this.data.token
        })
        sr.on("started", (msg)=> {
            console.log("Client recv started")
            this.setData({
                srResult : msg
            })
        })
        sr.on("changed", (msg)=>{
            console.log("Client recv changed:", msg)
            this.setData({
                srResult : msg
            })
        })
      
        sr.on("completed", (msg)=>{
            console.log("Client recv completed:", msg)
            this.setData({
                srResult : msg
            })
        })
    
        sr.on("closed", () => {
            console.log("Client recv closed")
        })
    
        sr.on("failed", (msg)=>{
            console.log("Client recv failed:", msg)
            this.setData({
                srResult : msg
            })
        })
        this.data.sr = sr
    },
    /**
     * 生命周期函数--监听页面初次渲染完成
     */
    onReady: function () {
    },
    /**
     * 生命周期函数--监听页面显示
     */
    onShow: function () {
    },
    /**
     * 生命周期函数--监听页面隐藏
     */
    onHide: function () {
    },
    /**
     * 生命周期函数--监听页面卸载
     */
    onUnload: function () {
        console.log("sr onUnload")
        this.data.srStart = false
        wx.getRecorderManager().stop()
        if (this.data.sr) {
            this.data.sr.shutdown()
        } else {
            console.log("sr is null")
        }
    },
    /**
     * 页面相关事件处理函数--监听用户下拉动作
     */
    onPullDownRefresh: function () {
    },
    /**
     * 页面上拉触底事件的处理函数
     */
    onReachBottom: function () {
    },
    /**
     * 用户点击右上角分享
     */
    onShareAppMessage: function () {
    },
    onSrStart: async function() {
        if (!this.data.sr) {
            console.log("sr is null")
            return
        }
        if (this.data.srStart) {
            console.log("sr is started!")
            return
        }
        let sr = this.data.sr
        try {
            await sr.start(sr.defaultStartParams())
            this.data.srStart = true
        } catch (e) {
            console.log("start failed:" + e)
            return
        }
        wx.getRecorderManager().start({
            duration: 600000,
            numberOfChannels: 1,
            sampleRate : 16000,
            format: "PCM",
            frameSize: 4
        })
    },
    onSrStop: async function() {
        wx.getRecorderManager().stop()
        await sleep(500)
        if (this.data.srStart && this.data.sr) {
            try {
                console.log("prepare close sr")
                await this.data.sr.close()
                this.data.srStart = false
            } catch(e) {
                console.log("close sr failed:" + e)
            }
        }
    }
})