ArchSettingsNluSlot(coreSlotSettingsViewModel)

new ArchSettingsNluSlot(coreSlotSettingsViewModel)

Parameters:
Name Type Description
coreSlotSettingsViewModel object

( Internal ) a core slot settings view model

See:

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchSettingsNluSlot'.

readonly associateWithGrammarByIdAsync :void

This function looks up the supplied grammar by ID. If a grammar with that ID is found, that grammar becomes associated with the NLU slot. At flow runtime, this grammar is used by an Ask For Slot action if this slot is selected and no other grammar is supplied.

readonly associateWithGrammarByNameAsync :void

This function looks up the supplied grammar by name case insensitively. If a grammar with that name is found, that grammar becomes associated with the NLU slot. At flow runtime, this grammar is used by an Ask For Slot action if this slot is selected and no other grammar is supplied.

readonly associateWithSpeechToTextEngineByIdAsync :void

This function looks up the supplied speech to text engine by ID. If a speech to text engine with that ID is found, that speech to text engine becomes associated with the NLU slot. At flow runtime, this speech to text engine is used by an Ask For Slot action if this slot is selected and no other grammar is supplied.

readonly associateWithSpeechToTextEngineByNameAsync :void

This function looks up the supplied speech to text engine by name case insensitively. If a speech to text engine with that name is found, that speech to text engine becomes associated with the NLU slot. At flow runtime, this speech to text engine is used by an Ask For Slot action if this slot is selected and no other grammar is supplied.

readonly getAssociatedGrammarId :string

Returns the id that is associated with this Grammar. If one is not associated with this grammar or a slot is not found, undefined is returned.

readonly getAssociatedGrammarName :string

Returns the name that is associated with this Grammar. If one is not associated with this grammar or a slot is not found, undefined is returned.

readonly getAssociatedGrammarSpeechToTextEngineId :string

Returns the id that is associated with this Slot's speech to text engine. If one is not associated with this grammar or a slot is not found, undefined is returned.

readonly getAssociatedGrammarSpeechToTextEngineName :string

Returns the name that is associated with this Grammar Speech to Text engine. If one is not associated with this slot or a slot is not found, undefined is returned.

readonly isArchSettingsNluSlot :boolean

Returns true indicating that this is an ArchSettingsNluSlot instance.

readonly logStr :string

A string suitable for logging that contains information about this ArchSettingsNluSlot.

Overrides:

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Overrides:

parentFlow :ArchFlowBot|ArchFlowDigitalBot

The parent ArchFlowBot or ArchFlowDigitalBot that this ArchSettingsNluSlot belongs to.

Methods

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:
Name Type Description
archFilterObject ArchFilterObject

the object filter to use to determine if it's a match.

Returns:
boolean
Overrides:

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:
Name Type Description
errorStr string

the error string to log.

Overrides:

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:
Name Type Description
errorStr string

the error string to log. This should be a non-blank string.

Throws:
  • Throws the submitted error string.
Overrides:

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.

Overrides:

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.

Overrides:

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:
Name Type Description
warningStr string

the warning string to log. This should be a non-blank string.

Overrides: