Interface NlpCommandResponse

Description

May be returned when enableSystemCommands() API is used. The NlpCommandResponse contains the results of the servers' NLP command model classification on the last sentence and indicates that a predetermined system command was detected. Current supported commands:

“Take a Snap”: takes a snapshot. “Start Recording”: starts a video recording if not already started. "Stop Recording”: stops an ongoing video recording, if applicable.

Example

//@input Asset.VoiceMLModule vmlModule

var parseAdditionalParams = function(additionalParams) {
    if (additionalParams.length == 0) return "";
    var retParams = "Additional params";
    for (var i = 0; i < additionalParams.length; i++) {
        retParams += " Key: " + additionalParams[i].key + " Value: " + additionalParams[i].value;
    }
    return retParams;
}

var parseStatusCode = function(status) {
    var code = "";
    switch(status.code) {
        case VoiceMLModule.NlpResponsesStatusCodes.OK:
            code = "OK";
        break;
        case VoiceMLModule.NlpResponsesStatusCodes.ERROR:
            code = "ERROR";
        break;
    }
    return "\nStatus Code: " + code + " Description: " + status.description;
}

var onUpdateListeningEventHandler = function(eventArgs) {
    var commandResponses = eventArgs.getCommandResponses();
    var nlpResponseText = "";
    
    for (var iIterator = 0; iIterator < commandResponses.length; iIterator++) {
        var commandResponse = commandResponses[iIterator];
        nlpResponseText += "Command Response: " + commandResponse.modelName + "\n command: " + commandResponse.command;
        nlpResponseText += parseAdditionalParams(commandResponse.additionalParams);
        nlpResponseText += parseStatusCode(commandResponse.status);
        nlpResponseText += "\n\n";
    }
}

script.vmlModule.enableSystemCommands();
script.vmlModule.onListeningUpdate.add(onUpdateListeningEventHandler);
Copy