Categories:
Aura entities definition
Aura entities definition versions:
- Version 5.0.0 for those entities using CSV format
- Version 6.0.0 for those entities using Avro format
Introduction
Aura entities definition includes the different entities currently written in Aura and required to calculate Aura KPIs and generate Aura’s invoices.
Entities are organized by types, as shown in the table below, together with the definition, how they are generated and its format, currently, CSV or Avro.
| Entities types | Description | Generation | Format |
|---|---|---|---|
| Dimensions | They are Aura’s configuration settings that are needed to understand Aura’s entities | They are generated directly by aura-kpis-uploader from the content of the aura-configuration-api. | Avro |
| Message | Message entity is used to store information about the messages handled by aura-bot and the actions performed on them. | They are created in aura-bot. | CSV |
| Recognizer | Recognizer entity is used to store the request to any of the recognizers during the utterance recognition phase of the messages. | They are created by aura-groot, aura-bot and aura-nlp. | CSV |
| Extended Message | Extended Message entity is used to store extra information of a Message. | They are created in aura-bot. | CSV |
| Groot Message | Groot Message entity is used to store information about the messages handled by aura-groot. | They are created in aura-groot. | CSV |
| Gateway Message | Gateway Message entity is used to store information about the messages handled by aura-gateway-api. | They are created by aura-gateway-api. | Avro |
| Audit | Audit entity is used to store information about the interactions handled by Aura components. They will be used to generate Aura’s invoices. | They are created by aura-kpis-uploader based on the information received in Groot Message and Gateway Message. | Avro |
Entities generation
Until Aura’s release 9.3.0 (Gwen Stefani), all entities in Aura were generated in CSV format.
The full procedure is explained in Aura Entities in CSV format.
In release 9.4.0 (Hannah Montana), the process to migrate Aura entities format from CSV to full-URM-compliant Avro format started. It is going to be a phased process, with entities being migrated in small groups to minimize the impact on services already consuming Aura entities in CSV.
The full procedure is explained in Aura Entities in Avro format.