Class DialogModule

Provides access to Question Answering Service powered by VoiceML.

Remarks

Allows to answer questions based on provided text.

Hierarchy (View Summary, Expand)

Asset
- DialogModule

Index

Constructors

Properties

name uniqueIdentifier

Methods

askQuestions getTypeName isOfType isSame

Constructors

`Protected`constructor

new DialogModule(): DialogModule
Returns DialogModule
Overrides Asset.constructor

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

askQuestions

askQuestions(
    context: string,
    questions: string[],
    onQuestionsAnswerComplete: (answers: Answer[]) => void,
    onQuestionsAnswerError: (error: number, description: string) => void,
): void
Sends a request to ask questions using the DialogModule. context is the text the model will use as context for answering the question. questions is a list of questions to ask. When answers are ready, onQuestionsAnswerComplete will be called with a list of Dialog.Answer objects corresponding to the questions in the questions list. onQuestionsAnswerError will be called if any error occurs.
Parameters
- context: string
- questions: string[]
- onQuestionsAnswerComplete: (answers: Answer[]) => void
- onQuestionsAnswerError: (error: number, description: string) => void
Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Asset.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame