Protected
constructorReadonly
additionalAdditional params to send in the response.
Readonly
intentThe classification result of the NLP intent model for the sentence. For example for the sentence "show me the next item" with the model VOICE_ENABLED_UI
, the result will be next
for VOICE_ENABLED_UI
the following intents are valid: next
, back
, left
, right
, up
, down
, first
, second
, third
, fourth
, fifth
, sixth
, seventh
, eighth
, ninth
, tenth
. In addition, the following values could be returned:
#SNAP_ERROR_INCONCLUSIVE
: two or more intents detected.
#SNAP_ERROR_INDECISIVE
: no intent 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.
Returned when NlpIntentModel was specificed in the ListeningOptions, it contains the results of the NLP Intent model classification on the last sentence.
NlpIntentResponse
will only run on complete sentences (isFinalTranscription = true
).Example