Protected
constructorReadonly
additionalAdditional params to send in the response.
Readonly
commandThe classification result of the NLP command model for the sentence. For example, for the sentence "Take a snap!" with the VoiceMLModule.enableSystemCommands API enabled, the result will be a VoiceML.NlpCommandResponse holding a take a snap
VoiceML.NlpCommandResponse#command. In addition, the following values could be returned:
#SNAP_ERROR_INCONCLUSIVE
: two or more commands detected.#SNAP_ERROR_INDECISIVE
: no command detected.#SNAP_ERROR_NONVERBAL
: no transcribable human voice was detected.#SNAP_ERROR_SILENCE
: silence was detected.Anything starting with #SNAP_ERROR_
: Errors that are not currently defined in this documentation and should be ignored.
Readonly
modelName of the model that sent the response. In current studio release, you can expect the result to contain either VOICE_ENABLED_UI
like described in VoiceML.NlpIntentModel. If using enableSystemCommands()
, SYSTEM_COMMANDS
will be returned as well.
Readonly
statusThe status of the NLP response. in case of successful result, the value should be VoiceMLModule.NlpResponsesStatusCodes.OK
, in case of failure, the value should be VoiceMLModule.NlpResponsesStatusCodes.ERROR
.
Returns the name of this object's type.
Returns true if the object matches or derives from the passed in type.
Returns true if this object is the same as other
. Useful for checking if two references point to the same thing.
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