Skip to content

WWDI: Wake Word Diagnostic Information

Notice

As of August 2020, implementing WWDI is a requirement to pass AVS Certification

Wake word diagnostic information provides Alexa Voice Service a way to improve customer experience by attaching certain diagnostic information with detection events emitted by Amazon wake word engine (also known as Keyword Detectors/KWD in the AVS Device SDK).

The diagnostic information is used for understanding wake word engine performance and assess health of devices in the field. It is minimal in size (on the order of 2KB) to ensure there is no effect on user perceived latency. This feature also improves the ability for AVS endpoints to detect and reject false wakes. It does NOT contain audio that would breach privacy, nor does it contain customer specific information. The diagnostic information is prepended to SpeechRecognizer Recognize events as an HTTP/2 encoded multipart message.

image.png

Wake word diagnostic metadata contains information such as the following:

  • WWDI version
  • Detected wake word name
  • Engine Version
  • Model Version
  • Uptime of the wake word engine
  • Wake word detection score
  • Wake word detection thresholds

In future, Amazon may add fields as new diagnostic information becomes available with new features and engine versions.

Wake word diagnostic information is emitted only when wake word event is detected. The diagnostic information is pre-pended to the audio stream for SpeechRecognizer Recognize events. The WWDI is in the range of 2KB in size. There is a hard limit of 4KB before the WWDI is rejected by the Alexa Service.

For details on integration WWDI into your application, see the Integration Guide.

Dependencies

None. WWDI is output by all versions of the Wake Word Engine.

Resource Requirements

None

FAQ

See the WWDI section of the FAQ.