Interface BaseNlpResponse

The abstract base class all NlpResponses inherit from. NlpResponses are used as the result from the VoiceML NLP engine with information after processing the transcript of the input audio.

interface BaseNlpResponse {
    additionalParams: AdditionalParam[];
    modelName: string;
    status: NlpResponseStatus;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

additionalParams modelName status

Methods

getTypeName isOfType isSame

Properties

ReadonlyadditionalParams

additionalParams: AdditionalParam[]

Additional params to send in the response.

ReadonlymodelName

modelName: string

Name 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 NlpModel. If using enableSystemCommands(), SYSTEM_COMMANDS will be returned as well.

Readonlystatus

status: NlpResponseStatus

The 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.

Methods

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods