QASummary Class

  • Article

QASummary Class

Raised by:  SALT application, Speech Controls
Base Class:  ApplicationScriptEvent
Derived Classes:  None

QASummary is raised to the Trace log at the completion of each Prompt playout / Recognition attempt pair, for a particular Question/Answer (QA) control. (In some cases there will be no recognition defined for a control; in that case this event is raised at the completion of Prompt playout.)

Note  QASummary information is designed largely as report input, and is targeted toward SALT developers, for the purpose of application tuning.

QASummary has the following properties:

Property

Type

Description

Name

String

The name of the QA control.

Count

Integer

The number of times a prompt (and recognition, if one is defined) was executed for the same QA control, before exiting the control. (Count is incremented by one for each cycle.)

Prompt

String

The text of the prompt that was played out to the user.

PromptID

String

The ID of the prompt element.

PromptStatus

String

One of the possible completion states for the prompt. Completion states include 'async', 'bargedin', 'completed', and 'fail'. A completion state of 'fail' includes an integer representing the reason for the failure:

  1. Generic failure to queue the prompt onto the PromptQueue object.

  2. Failure to find a speech output resource (for distributed architectures).

  3. An illegal property/attribute setting that causes a problem with the synthesis request.

  4. Failure to resolve content - often an unreachable URI, or malformed markup content.

ListenID

String

The ID of the listen element.

ListenGrammarRefs

StringArray

A list of URLs to any grammar files referenced by the listen element.

Sml

String

The contents of the SML recognition result returned by Speech Engine Services (SES).

SemanticItems

StringArray

An array of strings containing information about semantic items changed by the user during one cycle of the QA control. The following data is collected (separated by a semi-colon) for each answer, extra answer, and confirm:

  • The ID of the semantic item

  • The state of the semantic item at the end of the cycle (for example, 'Needs confirmation').

  • The value of the semantic item (for example, London).

    Note  For more information, see the topics QA Members and AnswerCollection class.

DtmfID

String

The ID of the dtmf element.

DtmfGrammarRefs

StringArray

A list of URLs to any grammar files referenced by the dtmf element.

Mode

String

Either DTMF or Listen.

History

String

A string containing the last command or exception for the QA control. If no command or exception occurred, an empty string.

Command

String

The recognized command, as defined by the application, received from the user (for example, "Help", "Repeat" and so forth).

If History resolves to a recognized command, the value here appears in History as well.

CommandPrompt

String

An optional, additional prompt to be played to the user (as defined in the command) when a command is recognized.

Message

String

A string containing the locale ID for the current page. The default is lang="en-US";.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events | CommonEvent | Event Filters | Filtering Logged Events