API Versions & Features
API Versions
There are currently 2 API Versions for the Amazon Wake Word Engine, they are not compatible.
API v1 (deprecated)
API Version 1 supports Wake Word detection only. Depending on the engine type, it can support all wakeword model types except for "X" type models. "X" type models require API Version 2.
API v2 (PRLXXXX)
API Version 2 is required for features other than Wake Word detection. V2 binaries and API usage samples are named with a -PRLXXXX
suffix that indicates the features set supported. API Version 2 is not backward compatible with API V1.
Features
The following table shows the features supported by the v1 API and v2 API (PRLXXXX) versions:
Version | Wake Word | Wake Word (X-class)* | Feature Extraction | Media Suppression | Acoustic Event Detection (AED) | Speaker Verification (SV) |
---|---|---|---|---|---|---|
v1 | ✅ | |||||
PRL1000 (v2) | ✅ | |||||
PRL1100 (v2) | ✅ | ✅ | ||||
PRL1200 (v2) | ✅ | ✅ | ✅ | |||
PRL1300 (v2) | ✅ | ✅ | ✅ | |||
PRL2000 (v2) | ✅ | ✅ | ✅ | |||
PRL3000 (v2) | ✅ | ✅ | ✅ | ✅ | ||
PRL5000 (v2) | ✅ | ✅ | ✅ | ✅ | ✅ |
* v1 API and PRL1000 (v2) do not support "X" class models. They are for ultra-low power implementations only.
For details on the above features, see the Features section.