Aura entities definition

• 1: Aura entities definition in Avro
• 1.1: Aura_Atria_Message
• 1.2: Aura_Audit
• 1.3: Aura_Gateway_Message
• 1.4: Aura_Message
• 1.5: D_Aura_Dimensional
• 2: Aura entities definition in CSV
• 2.1: Aura_Gateway_Message
• 2.2: Message
• 2.3: Recognizer
• 2.4: Extended Message
• 2.5: Groot message

1 - Aura entities definition in Avro

Aura entities definition in Avro format

Introduction

The Aura entities definition includes the different entities currently written in Aura in Avro format, URM-compliant.

For further information regarding Kernel Avro datasets access the following links:

• How to handle datasets in Kernel
• Kernel datasets

Entities generated in Avro URM-compliant format

Entities types	Description	Generation
Aura_Atria_Message	Summary of Aura’s interactions handled by aura-rag-server, aura-groot and aura-bot	Generated by aura-gateway-api
Aura_Audit	Entity used to store information about the interactions handled by Aura components. It will be used to generate Aura’s invoices.	Created by aura-kpis-uploader based on the information received in Groot Message and Gateway Message
Aura_Gateway_Message	Entity used to store information about the messages handled by aura-gateway-api.	Created by aura-gateway-api.
Aura_Message	Entity that contains the summary of Aura’s interactions handled by aura-bridge, aura-groot and aura-bot	Created directly by aura-groot and aura-bot
D_Aura_Dimensionals	They are Aura’s configuration settings that are needed to understand Aura’s entities	Generated directly by aura-kpis-uploader from the content of the aura-configuration-api.

Entities generation

Avro Entities tables nomenclature

• Position: Field order in the Avro schema definition.
• Field: Name of the field being defined. Usually, capitalized, although more aliases will be available in the schema definition.
• PK: Parameter that indicates if the field is a Primary Key or not, that is, a value that uniquely identifies this field.
• Referenced Entity: When the field references a value from another dataset, indicating that a join must be defined in the schema, this parameter contains the name of the dataset.
• Referenced Entity Field: When the field references a value from another dataset, indicating that a join must be defined in the schema, this parameter contains the name of the field of the other dataset.
• Type: Type of the field. It can be one of Avro logical types defined in Kernel.
• Doc: Brief description of the field.
• Nullable doc: If the field can be null, it should contain the cases when a null value is valid.

1.1 - Aura_Atria_Message

Aura_Atria_Message v6.0.0

This entity contains the summary of Aura’s interactions handled by aura-rag-server, aura-groot and aura-bot

Avro schema definition published in Kernel - TO BE COMPLETED

POSITION	FIELD	PK	Referenced Entity	Referenced Entity Field	TYPE	DESCRIPTION	NULLABLE_DES
1	MESSAGE_ID	YES			“type”:[“string”, “x-fp-unique-constraint”]	Unique ID of the current message.
2	MESSAGE_TM				“type”: “string” “logicalType”: “datetime”	Timestamp when the message is processed.
3	AURA_APP_ID		D_Aura_App	AURA_APP_ID	“type”: “string”	Identifier of the Aura application used by the user to interact with Aura. If due to an error, the application sent a wrongly formatted string without app_id, it will be set to null.	Null if due to an error, we are not capable of getting the incoming application.
4	COUNTRY_3_ALPHA_CD		D_Gbl_Country	COUNTRY_3_ALPHA_CD	“type”: “string”	Country of the operator running the current Aura deployment Three letters (alpha-3) code element of the country name (e.g. DEU) defined in ISO 3166-1
5	CORR_ID				“type”: “string”	Cross service transaction identifier that allows tracking a request through all the services and components.
6	AURA_PRESET_NAME		D_Aura_Preset	AURA_PRESET_NAME	“type”: “string”	Configuration used by the app to access Aura AI services.
7	SESSION_ID				“type”: “string”	Session identifier.
8	STAGE_NAME				“type”: [“null”, “string”]	Name of RAG stage	Null in the full request.
9	STAGE_EXECUTION_NUM				“type”: “int”	Stage execution counter.
10	STAGE_SEQUENCE_NUM				“type”: “int”	Stage execution order.
11	COMPLETION_TOKENS_NUM				“type”: “int”	Number of tokens the model used to respond to your request.
12	PROMPTS_TOKENS_NUM				“type”: “int”	Tokens used to represent the text sent in the request.
13	INPUT_QUERY_DESC				“type”: “string”	Stage input text.
14	OUTPUT_QUERY_DESC				“type”: [“null”, “string”]	Stage output text.
15	DURATION_QT				“type”: “string” logicalType: “duration”	Time spent per stage.	Null in error cases.
16	STATUS_CD				“type”: “string”	Aura status code. Values: SUCCESS or ERROR.
17	AURA_COMPONENT_ID		D_Aura_Component	AURA_COMPONENT_ID	“type”: “string”	Identifier of the Aura component that handled the current request, usually the name of the deployment running the corresponding Aura service. This name is consistent over time.
18	AURA_VERSION_ID				“type”: “string”	Aura platform version that produces this data.
19	DAY_DT				“type”: “string”, “logicalType”: “iso-date”	Year, month and day of the interaction.

1.2 - Aura_Audit

Aura_Audit v6.0.0

This entity contains the summary of Aura’s interactions intended for accountability purposes.

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	INTERACTION_ID	YES			string; x-fp-unique-constraint:1	Unique ID of the current interaction. First part of the compound primary key of the dataset.
2	AURA_TM				string;datetime	Timestamp when the interaction happens.
3	AURA_CHANNEL_ID		D_Aura_Channel	AURA_CHANNEL_ID	string;null	Identifier of the Aura channel used by the user to interact with Aura.	If due to an error the channel sent a wrongly formatted string without channelId or auraId, it will be set to null.
4	AURA_APP_ID		D_Aura_App	AURA_APP_ID	string;null	Identifier of the Aura application used by the user to interact with Aura. If due to an error the application sent a wrongly formatted string without app_id, it will be set to null.	It will be null if due to an error, we are not capable of getting the incoming application. Also, if the request goes through aura-groot or aura-bridge
5	COUNTRY_3_ALPHA_CD		D_Gbl_Country	COUNTRY_3_ALPHA_CD	string	Three letters (alpha-3) code element of the country name (e.g. DEU) defined in ISO 3166-1
6	AURA_SERVICE_NAME_CD				enum;[message,nlpaas,ai,other]	Specific service consumed during the interaction. message: if the interaction happens in aura-groot ai: if the interaction calls generative services nlpaas: if the interaction calls Aura’s NLP as a service endpoint other: future use, for extra cases.
7	AURA_PRESET_NAME		D_Aura_Preset	AURA_PRESET_NAME	string;null	Preset used for the interaction, if using an AI service	It will be null for interactions not using AI services
8	AURA_COMPONENT_ID		D_Aura_Component	AURA_COMPONENT_ID	string;x-fp-unique-constraint:1	Identifier of the Aura component handling the incoming request of the user. Second part of the compound primary key of the dataset.
9	AURA_COMPONENT_HOST_ID				string	An identifier of the Aura component host that handled the current request, usually the pod identifier running the corresponding Aura service. This name changes every time a pod is reinitiated.
10	AURA_VERSION_ID				string	Aura platform version that produces this data.
11	DAY_DT				string;iso-date;partition-key	Year, month and day of the interaction.
12	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	string	Brand id. Join with D_Gbl_Brand.

1.3 - Aura_Gateway_Message

Aura_Gateway_Message v6.0.0

This entity contains the summary of Aura’s interactions handled by aura-gateway-api.

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	MESSAGE_ID	YES			string; x-fp-unique-constraint	Unique ID of the current message.
2	MESSAGE_TM				string;datetime	Timestamp when the message is processed
3	AURA_APP_ID		D_Aura_App	AURA_APP_ID	string;null	Identifier of the Aura application used by the user to interact with Aura. If due to an error the application sent a wrongly formatted string without app_id, it will be set to null.	It will be null if due to an error we are not capable of getting the incoming application.
4	COUNTRY_3_ALPHA_CD		D_Gbl_Country	COUNTRY_3_ALPHA_CD	string	Three letters (alpha-3) code element of the country name (e.g. DEU) defined in ISO 3166-1
5	CORR_ID				string	Cross service transaction identifier that allows tracking a request through all the services and components.
6	AURA_NLP_IND				boolean	Flag indicating whether or not this interaction goes to ATRIA NLP as a Service.
7	AURA_PRESET_NAME		D_Aura_Preset	AURA_PRESET_NAME	string;null	Configuration used by the app to access Aura AI services	If it is a NLP access no preset will be defined
8	AURA_COMPONENT_HOST_ID				string	An identifier of the aura component host that handled the current request, usually the pod identifier running the corresponding aura service. This name changes every time a pod is reinitiated.
9	AURA_COMPONENT_ID		D_Aura_Component	AURA_COMPONENT_ID	string	An identifier of the aura component that handled the current request, usually the name of the deployment running the corresponding aura service. This name is consistent over time.
10	AURA_VERSION_ID				string	Aura platform version that produces this data.
11	DAY_DT				string;iso-date;partition-key	Year, month and day of the interaction
12	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	string	Brand id. Join with D_Gbl_Brand

1.4 - Aura_Message

Aura_Message v6.0.0

This entity contains the summary of Aura’s interactions handled by aura-bridge, aura-groot and aura-bot

Avro schema definition published in Kernel - TO BE COMPLETED

Position	Field	PK	Referenced Entity	Referenced Entity	Type	Description	Nullable_Des
1	MESSAGE_ID	Yes			“type”: “string” {x-fp-unique-constraint}	Unique ID of the current message.
2	MESSAGE_TM				“type”:“string” “logicalType”: “datetime”	Timestamp when the message happens.
3	ACTION_CD				“type”:“enum” “values”: [‘send’, ‘receive’, ’event’, ‘audit’]	Code of the action that produces the data.
4	AURA_ID				“type”: [“null”, “string”] “x-fp-data-protection”: “pseudonymize”	Unique user login ID in Aura. User might have a new AURA_ID with each logging in the channel or when the previous authorization in Kernel expires.	Null if the channel fails to send it
5	AURA_CHANNEL_ID		D_Aura_Channel	AURA_CHANNEL_ID	“type”: [“null”, “string”]	Identifier of the Aura channel used by the user to interact with Aura.	Null if the channel wrongly sends a string without channelId or auraId
6	COUNTRY_3_ALPHA_CD		D_Gbl_Country	COUNTRY_3_ALPHA_CD	“type”:“string”	Country of the operator running the current Aura deployment.
7	CORR_ID				“type”: “string”	Cross-service transaction ID for tracking requests through all services and components.
8	AURA_COMPONENT_HOST_ID				“type”: “string”	Identifier of the Aura component host handling the request, usually the pod identifier running the corresponding Aura service. This name changes with each pod restart.
9	AURA_COMPONENT_ID		D_Aura_Component	AURA_COMPONENT_ID	“type”: “string”	Identifier of the Aura component handling the request (usually, the deployment running the corresponding Aura service). This name is consistent over time.
10	AURA_VERSION_ID				“type”: “string”	Aura platform version that produces this data.
11	DURATION_QT				type": “string” logicalType: “duration” default: “PT0S”	Duration of the action to handle the current message. For inbound, it is 0 (it only logs that message is in the system); For Outbound, it logs the number of milliseconds to process message and send response back to the channel.
12	AURA_STATUS_CD				“type”: “string”	Aura status code. “SUCCESS” for inbound; For outbound, it sends the corresponding status. For v1 requests, if no status nor error is provided, then SUCCESS is sent.
13	AURA_SKILL_ID		D_Aura_Skill	AURA_SKILL_ID	“type”: “string”, null	Identifier of the skill handling the message.	Null if no skill-bot is available to handle the message due to an error.
14	AURA_CHANNEL_CONVERSATION_ID				“type”: “string”	Identifier of the conversation in the channel.
15	AURA_SKILL_CONVERSATION_ID				“type”: “string”,null	Identifier of the conversation in the skill.	Null for incoming messages or outgoing ones in case of error.
16	WIN_RECOGNIZER_ID		D_Aura_Recognizer	AURA_RECOGNIZER_ID	“type”: “string”,null	Identifier of the recognizer that returns the top score.	Null for incoming messages.
17	WIN_RECOGNIZER_SCORE_QT				“type”:“float”	Score of the recognizer with higher score for this message.
18	RESULT_INTENT_NAME				“type”: “string”,null	Intent resolved by the recognizer, that is, the Aura action that resolves the intention of the user, related with the use case triggered by the user utterance. As example, in the sentence: “I want to see a movie of Lars von Trier”, NLP would return “intent.tv.play” as user intention.	Null for incoming messages.
19	RESULT_INTENT_ENTITIES_ARRAY				“type”: “array[RESULT_INTENT_ENTITIES_ARRAY_ITEM]”, null	Recognized entities, as part of the action in Aura to resolve the user’s intention. For instance, in TV use cases, recognizable entities can be: movies, actors, directors, series. As example, in the sentence: “I want to see a movie of Lars von Trier”, NLP would return two entities: one of type audiovisual_content with “movie” as name, and one of type movie_director with “lars von trier” as name.	Null for incoming messages and for those intents that do not define them.
19.1	RESULT_INTENT_ENTITIES_ARRAY_ITEM.INTENT_ENTITY_NAME				“type”: “string”	Entity name handled by Aura services. It corresponds with the string extracted from the user’s utterance that matches any of the defined entities of any of the types. See example above.
19.2	RESULT_INTENT_ENTITIES_ARRAY_ITEM.INTENT_ENTITY_TYPE_DES				“type”: “string”	Entity type handled by Aura services. It corresponds with the type of the entity extracted from the user’s utterance that matches any of the defined entities of any of the types. See example above.
19.3	RESULT_INTENT_ENTITIES_ARRAY_ITEM.INTENT_ENTITY_CANON_NAME				“type”: “string”	Entity type handled by Aura services. It corresponds with the canonical value of the entity extracted from the user’s utterance that matches any of the defined entities of any of the types. In the previous example: entity of type audiovisual_content: “movie” as name and “film” as canon; entity of type “movie_director”: “lars von trier” as name and “Lars von Trier” as canon.
19.4	RESULT_INTENT_ENTITIES_ARRAY_ITEM.INTENT_ENTITY_LABEL_NAME				type: string, null	Entity type handled by Aura services. It corresponds with a common alias of the entity type extracted from the user’s utterance that matches any of the defined entities of any of the types. In the previous example: entity of type audiovisual_content (“movie” as name, “movie” as canon and “MOV” as label; entity of type “movie_director”: “lars von trier” as name,“Lars von Trier” as canon, and without label).	Labels for entities must have been introduced in the training set.
20	ENRICHMENT_ARRAY				“type”: “array[ENRICHMENT_ARRAY_ITEM]”, null	Contextual information to enrich the request to get a more efficient recognition.	Null for incoming messages and for those messages where no enrichment pipeline was executed.
20.1	ENRICHMENT_ARRAY_ITEM.ENRICHMENT_TYPE_NAME				string	Type of data added as contextual information. For instance: sentiment, profile, language (not a closed list).
20.2	ENRICHMENT_ARRAY_ITEM.ENRICHMENT_PROVIDER_NAME				type: string	Specific component executed that provides meaningful information for this request. For instance, regarding language, a provider to detect the language or to translate it.
20.3	ENRICHMENT_ARRAY_ITEM.ENRICHMENT_VALUE_DES				type: string	Specific value returned by the enricher. For instance, in sentiment analysis: happy, sad, angry.
20.4	ENRICHMENT_ARRAY_ITEM.ENRICHMENT_VALUE_DURATION_QT				“type”: “string”, “logicalType”: “duration”,default: “PT0S”	Duration of the request execution to obtain this contextual information.
21	MESSAGE_DES				“type”: “string”, null	Incoming/outgoing information sent by the user or by Aura. Incoming: it can contain: text sent by the user, for simpler cases; auraCommand sent by the channel; prompt option clicked or selected by the user when responding to a prompt; response of any asynchronous API called by aura-bot, such as when calling handover systems. Outgoing: text sent by Aura, titles, texts and button values of the cards sent as attachments, name of files sent as attachments.	Null if no message is sent back and forth.
22	MODALITY_CD				“type”: “enum” “values”: [“form”, “text”, “voice”]	The form used by the user to send the interaction to Aura. Values: “form”, if the user clicks a button to send the message; “text”, if the input is a written text; “voice”, if the user sends an utterance, regardless of whether it was passed to text before calling Aura.
23	CHANNEL_DATA_VERSION_NUM				“type”: “integer”	channelData request and response version used by the channel. If none is sent, the default version handled by Aura is assumed.
24	AURA_GLOBAL_ID				“type”: “string” “x-fp-data-protection”: “pseudonymize”	It identifies the user id logged in Kernel (USER_4P_ID) with the same authentication method. If there is no information regarding the AURA_ID, a value based on the default AURA_ID will be set, but calculated with the same method as any other AURA_GLOBAL_ID
25	USER_4P_ID				“type”: “string” “x-fp-user-id”: true, “x-fp-data-protection”: “pseudonymize”	Unique identifier of the user (data owner) in Kernel platform. This identifier must coincide with the user_id parameter of the Kernel APIs, as they both refer to the same concept. Example values: “3706277557884218994”, “-6189348075566519429”.
26	USER_IDENTIFICATION_CD				“type”: “enum” “values”: [“anonymous”, “identifiable”, “authenticated”]	Flag to indicate if the user can be identified univocally. If she is already authenticated (her user_4p_id is a a real one), or it is not authenticated, (the user_4p_id is generated based on her aura_id and, in this case, shows if the aura_id is completely random (anonymous, for example, based on a cookie of a webpage) or corresponds to a unique user (identifiable, for example, based on the whatsapp_id of a user).
27	ADMINISTRATIVE_NUMBER				“type”: “string”, null	Identifier of customer in video platform. A user may have more than one administrative number, if she has more than one video product.
28	EXT_APP_ID				“type”: “string”, null	Identifier of the application that is calling Aura.	It will be null if the application does not send it to Aura.
29	EXT_APP_SESSION_ID				“type”: “string”, null	Identifier of the session handled by the application that is calling Aura.	Null if the application does not send it to Aura.
30	DAY_DT				“type”: “string” “logicalType”:“iso-date” partition key	Year, month and day of the interaction.
31	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	“type”: “string”	Commercial brand global identifier (codified according to D_Gbl_Brand) used to differentiate among different brands in the same OB.

1.5 - D_Aura_Dimensional

Aura Dimensional entities

D_Aura_App schema definition v6.0.0

This entity contains the list of possible Apps defined in Aura.

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_APP_ID	YES			string; x-fp-unique-constraint:1	Unique identifier of the Aura application.
2	AURA_APP_NAME				string; x-fp-unique-constraint:2	Name of the Aura application.
3	AURA_NLP_CHANNEL_ID		D_Aura_Channel	AURA_CHANNEL_ID	string;null	Identifier of the Aura channel configured for this application.	It will be null if the application does not count on nlpaas configuration.
4	AURA_PRESET_NAMES_ARRAY		D_Aura_Preset	AURA_PRESET_NAME	Array[string];null	List of presets available for the current application.	It will be null if the application does not count on LLM configuration.
5	EXTRACTION_TM				string; datetime	Timestamp of the data.
6	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	string	Brand id. Join with D_Gbl_Brand

D_Aura_Channel v6.0.0

This entity contains the list of possible channels defined in Aura

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_CHANNEL_ID	YES			string; x-fp-unique-constraint:1	Identifier of the Aura channel
2	AURA_CHANNEL_NAME				string; x-fp-unique-constraint:2	Name of the Aura channel
3	AURA_CHANNEL_SHORT_NAME				string	Short name of the Aura channel
4	AURA_SKILL_ID		D_Aura_SKill	AURA_SKILL_ID	string	Identifier of the skill that handles this channel
5	AURA_NLP_STAGES_ARRAY				Array[string];null	List of the nlp stages configured for this channel	The value can be null if the channel does not count on nlp configuration
6	GBL_CONTACT_CHANNEL_ID		D_Gbl_Contact_Channel	GBL_CONTACT_CHANNEL_ID	string	Identifier of the contact channel. Join with D_Gbl_Contact_Channel v5
7	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	string	Brand id. Join with D_Gbl_Brand v6
5	EXTRACTION_TM				string; datetime	Timestamp of the data.

D_Aura_Component v6.0.0

This entity contains the list of possible components defined by Aura

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_COMPONENT_ID	YES			string; x-fp-unique-constraint:1	Aura identifier for each component available in Aura.
2	AURA_COMPONENT_NAME				string; x-fp-unique-constraint:2	Aura component name
3	EXTRACTION_TM				string; datetime	Timestamp of the data.

D_Aura_Preset v6.0.0

This entity contains the list of possible presets defined by Aura

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_PRESET_ID	YES			string; x-fp-unique-constraint:1	Unique identifier of the Aura preset.
2	AURA_PRESET_NAME				string; x-fp-unique-constraint:2	Aura preset name
3	AURA_MODEL_ID				string	Identifier of the model that will run with this preset
4	AURA_PRESET_GROUP_NAME_CD				enum;[simple_ai,enriched_ai]	Type of the preset that means the underlying models and stages that will run with this preset
5	EXTRACTION_TM				string; datetime	Timestamp of the data.

D_Aura_Recognizer v6.0.0

This entity contains the list of possible recognizers defined by Aura

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_RECOGNIZER_ID	YES			string; x-fp-unique-constraint:1	Identifier of the exact recognizer
2	AURA_RECOGNIZER_NAME				string; x-fp-unique-constraint:2	Recognizer code
3	EXTRACTION_TM				string; datetime	Timestamp of the data.

D_Aura_Skill v6.0.0

This entity contains the list of possible skills defined by Aura

Avro schema definition published in Kernel

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	AURA_SKILL_ID	YES			string; x-fp-unique-constraint:1	Unique identifier
2	AURA_SKILL_NAME				string; x-fp-unique-constraint:2	Skill code
3	EXTERNAL_SKILL_IND				boolean	Flag to indicate whether it is an internal skill based in aura-bot or an external skill, done using any technology.
4	EXTRACTION_TM				string; datetime	Timestamp of the data.

2 - Aura entities definition in CSV

Aura entities definition in CSV format

Introduction

The Aura entities definition includes the different entities currently written in Aura in CSV and required to calculate Aura KPIs or by any other team in their data processes.

Entities types	Description	Generation
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.
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.
Extended Message	Extended Message entity is used to store extra information of a Message.	They are created in aura-bot.
Groot Message	Groot Message entity is used to store information about the messages handled by aura-groot.	They are created in aura-groot.

Entities generation

Until release 9.3.0 (Gwen Stefani), all entities in Aura were generated in CSV format. They were also uploaded into Kernel storage in CSV format. Although using a script provided by and running in Kernel, some of them are converted to Avro entities (in a deprecated Avro format, not URM compliant).

In particular, the following conversions are provided:

• Recognizer:
  • Aura Authenticated Users’ Recognizer
  • Aura Anonymous Users’ Recognizer

As can be seen, the entities in Avro are duplicated to hold authenticated and anonymous users interactions separately, because the field USER_4P_ID cannot be null if it exists in a dataset definition.

CSV files format

All entities’ files must be created following these rules:

• File format: UNIX. UTF8 without BOM
• Date format: ISO8601
  • Date: 2018-05-02
  • Datetime: 2018-05-02T15:18:11Z => Always UTC

Usually, these kinds of files are stored in .txt and zipped, before uploading.

• Entities used for the calculation of KPIs are stored in a Kernel bucket. Each entity must be included in a different folder, with files distributed by months, in the path:
  [OB]/[ENTITY]/YYYYMM

• Files generated in aura-bot can be stored as needed.
  Filename: BOT_[HOST_ID]_[OB]_[ENTITY]_YYYYMMDDTHH0000Z.txt

• Files generated in aura-services (authentication) can be stored as needed.
  Filename: SERVICES_[HOST_ID]_[OB]_[ENTITY]_YYYYMMDDTHH0000Z.txt

• Files generated in Aura NLP components can be stored as needed:
  Filename: NLP_<HOST_ID>_<OB>_<ENTITY>_YYYYMMDDTHH0000Z.txt

• Dimensions entities:
  Path: [OB]/DIMENSIONS/YYYYMM
  Filename: [OB]_DIM_[DIM_NAME]_YYYYMMDDTHH0000Z.txt
  For example: ES_DIM_CHANNEL_20180612T160000Z.txt

All the files are refreshed every day.

CSV Entities tables nomenclature

• #: Field ID
• FIELD: Specific field of the entity type
• PK: Parameter that indicates if the field is a Primary Key or not, that is, a value that uniquely identifies this field.
• NULLABLE: Parameter that indicates if a field is allowed to have a null value or not.
• TYPE: Type of the field. It can be one of: text, date, number, boolean
• DESCRIPTION: Brief description of the field
• FORMAT: Field mandatory format, if applicable
• ALLOWED VALUES: Prefixed values permitted for this field
• EXAMPLE: Example of application

The following considerations must be taken into account:

• Numeric values are rounded to two decimal positions
• The amount of money must be included in local currency

2.1 - Aura_Gateway_Message

Aura_Gateway_Message v6.0.0

This entity contains the summary of Aura’s interactions handled by aura-gateway-api.

Position	Field	PK	Referenced entity	Referenced entity field	Type	Doc	Nullable Doc
1	MESSAGE_ID	YES			string; x-fp-unique-constraint	Unique ID of the current message.
2	MESSAGE_TM				string;datetime	Timestamp when the message is processed
3	AURA_APP_ID		D_Aura_App	AURA_APP_ID	string;null	Identifier of the Aura application used by the user to interact with Aura. If due to an error the application sent a wrongly formatted string without app_id, it will be set to null.	It will be null if due to an error we are not capable of getting the incoming application.
4	COUNTRY_3_ALPHA_CD		D_Gbl_Country	COUNTRY_3_ALPHA_CD	string	Three letters (alpha-3) code element of the country name (e.g. DEU) defined in ISO 3166-1
5	CORR_ID				string	Cross service transaction identifier that allows tracking a request through all the services and components.
6	AURA_NLP_IND				boolean	Flag indicating whether or not this interaction goes to ATRIA NLP as a Service.
7	AURA_PRESET_NAME		D_Aura_Preset	AURA_PRESET_NAME	string;null	Configuration used by the app to access Aura AI services	If it is a NLP access no preset will be defined
8	AURA_COMPONENT_HOST_ID				string	An identifier of the aura component host that handled the current request, usually the pod identifier running the corresponding aura service. This name changes every time a pod is reinitiated.
9	AURA_COMPONENT_ID		D_Aura_Component	AURA_COMPONENT_ID	string	An identifier of the aura component that handled the current request, usually the name of the deployment running the corresponding aura service. This name is consistent over time.
10	AURA_VERSION_ID				string	Aura platform version that produces this data.
11	DAY_DT				string;iso-date;partition-key	Year, month and day of the interaction
12	BRAND_ID		D_Gbl_Brand	GBL_BRAND_ID	string	Brand id. Join with D_Gbl_Brand
13	USER_ID				string	Identifier of the user sending the message	YES

2.2 - Message

Message

#	FIELD	PK	NULLABLE	TYPE	DESCRIPTION	FORMAT	ALLOWED VALUES	EXAMPLE
1	USER_ID	NO	NO	Text	Unique User ID in the OB Systems or unique generated one for anonymous users	Format depends on the OB	—
2	MSG_DT	NO	NO	Date	Timestamp of the data in UTC time	ISO 8601	—
3	MSG_ID	YES	NO	Text	Unique ID of the message	UUID	—
4	ACTION_CD	NO	NO	Text	Code of the action that produces the data	—	send, receive, event	—
5	AURA_ID	NO	YES	Text	User logging ID in Aura Starting in this version, the user will have a new aura_id each time she logs in Aura	UUID	—
6	PHONE_ID	NO	YES	Text	Phone number of the user	Phone number including international prefix	—
7	CHANNEL_CD	NO	YES	Text	Code of the channel where the action happened	—	Same values as AURA_CHANNEL_NAME field in the dimensional entity D_Aura_Channel
8	SUBSCRIPTION_CD	NO	YES	Text	Code of the subscription type of the user in the OB	—	PREPAID, POSTPAID, CONTROL	—
9	DOMAIN_CD	NO	YES	Text	Code of the domain where the action happened ⚠️ Future use	—	—
10	CATEGORY_CD	NO	YES	Text	Code of the category where the action happened ⚠️ Future use	—	—
11	COUNTRY_CD	NO	NO	Text	ISO code of the country	ISO 3166	—
12	CORR_ID	NO	NO	Text	Correlator ID of the request that produces the data	UUID	—
13	IS_CACHED	NO	NO	Boolean	It shows if the entity content was already cached or not	—	true/false	—
14	STATUS_CD	NO	YES	Text	Status code of the action, if meaningful	HTTP status code of the response	—
15	REASON	NO	YES	Text	Result of the action in error case: error code	—	—
16	VERSION_ID	NO	NO	Text	Aura version that produces this data	X.Y.Z	—	8.2.0.
17	LANG_CD	NO	YES	Text	Language configured by the user for the communication	- ISO 639 two-letter lowercase culture code - ISO 3166 two-letter lowercase subculture code associated with a country or region	—
18	TZ_CD	NO	NO	Text	Timezone where the communication happened	UTC offset of the TZ. TZ codes	—
19	DURATION_NU	NO	YES	Number	Duration of the action in milliseconds	Natural number	—
20	MESSAGE	NO	NO	Text	Content of the message	—	—
21	DIALOG_ID	NO	YES	Text	Id of the dialog where the message happens	—	—
22	CONVERSATION_ID	NO	NO	Text	Id of the conversation where the message happens	UUID	—
23	WIN_RECOGNIZER_CD	NO	YES	Text	Code of the recognizer that wins for this message		Same values as AURA_RECOGNIZER_NAME field in the dimensional entity D_Aura_Recognizer
24	WIN_RECOGNIZER_SCORE_NU	NO	YES	Number	Score of the recognizer that wins for this message	—	—
25	INTENT	NO	YES	Text	Selected intent	—	—
26	ENTITIES	NO	YES	Text	List of entities determined by the recognizer	—	—
27	MODALITY_CD	NO	YES	Text	It explains how the user communicates with Aura	—	text, voice, form	—
28	AURA_ID_GLOBAL	NO	YES	Text	It identifies the same user_id logged with the same authentication method	—	—
29	ACCOUNT_NUMBER	NO	YES	Text	Unique account number of the user Mandatory only for Spain. But it can be null also in Spain because it is only available in aura-bot, not in aura-services	—	—

2.3 - Recognizer

Recognizer

#	FIELD	PK	NULLABLE	TYPE	DESCRIPTION	FORMAT	ALLOWED VALUES	EXAMPLE
1	USER_ID	NO	NO	Text	Unique User ID in the OB Systems or unique generated one for anonymous users	Format depends on the OB	—
2	RECOGNIZER_DT	NO	NO	Date	Timestamp of the data in UTC time	ISO 8601	—
3	RECOGNIZER_ID	YES	NO	Text	Unique ID of the recognizer	UUID	—
4	ACTION_CD	NO	NO	Text	Code of the action that produces the data	—	recognize	—
5	AURA_ID	NO	YES	Text	User logging ID in Aura Starting in this version, the user will have a new aura_id each time she logs in Aura.	UUID	—
6	PHONE_ID	NO	YES	Text	Phone number of the user	Phone number including international prefix	—
7	CHANNEL_CD	NO	YES	Text	Code of the channel where the action happened	—	Same values as AURA_CHANNEL_NAME field in the dimensional entity D_Aura_Channel
8	DOMAIN_CD	NO	YES	Text	Code of the domain where the action happened ⚠️ Future use	—	—
9	CATEGORY_CD	NO	YES	Text	Code of the category where the action happened ⚠️ Future use	—	—
10	COUNTRY_CD	NO	NO	Text	ISO code of the country	ISO 3166	—
11	CORR_ID	NO	NO	Text	Correlator ID of the request that produces the data	UUID	—
12	IS_CACHED	NO	NO	Boolean	It shows if the entity content was already cached or not	—	true/false	—
13	STATUS_CD	NO	YES	Text	Status code of the action, if meaningful	HTTP status code of the response	—
14	REASON	NO	YES	Text	Result of the action in error case: error code	—	—
15	VERSION_ID	NO	NO	Text	Aura version that produces the data	X.Y.Z	—	8.2.0.
16	LANG_CD	NO	YES	Text	Language configured by the user for the communication	- ISO 639 two-letter lowercase culture code - ISO 3166 two-letter lowercase subculture code associated with a country or region	—
17	TZ_CD	NO	YES	Text	Timezone where the communication happened	UTC offset of the TZ. TZ codes	—
18	DURATION_NU	NO	NO	Number	Duration in milliseconds of the action	Natural number	—
19	SCORE_NU	NO	NO	Number	Score returned by the recognizer	Real number from 0 to 1	—
20	INPUT	NO	YES	Text	User input sent to the recognizer null if incoming message is an auraCommand	—	—
21	OUTPUT	NO	YES	Text	Complete output generated by the recognizer	—	—
22	INTENT	NO	YES	Text	Intent returned by the recognizer	Format depends on the OB	—
23	ENTITIES	NO	YES	Text	Entities returned by the recognizer due to the intent	—	—
24	COMMON_THRESHOLD_NU	NO	YES	Number	Common threshold used to determine the best answer of all recognizers	Real number from 0 to 1	—
25	THRESHOLD	NO	YES	Number	Established threshold for the recognizer	Real number from 0 to 1	—
26	EXPECTED_INTENT	NO	YES	Text	Intent expected to be returned by the recognizer	—	—
27	EXPECTED_ENTITIES	NO	YES	Text	Entities expected to be returned by the recognizer due to the intent	—	—
28	AURA_ID_GLOBAL	NO	YES	Text	It identifies the same user_id logged with the same authentication method	—	—
29	ACCOUNT_NUMBER	NO	YES	Text	Unique account number of the user Mandatory only for Spain. But it can be null also in Spain because it is only available in aura-bot, not in aura-services	—	—

2.4 - Extended Message

Extended Message

#	FIELD	PK	NULLABLE	TYPE	DESCRIPTION	FORMAT	ALLOWED VALUES	EXAMPLE
1	USER_ID	NO	NO	Text	Unique User ID in the OB Systems or unique generated one for anonymous users	Format depends on the OB	—
2	MSG_DT	NO	NO	Date	Timestamp of the data in UTC time	ISO 8601	—
3	MSG_ID	YES	NO	Text	Unique ID of the message	UUID	—
4	ACTION_CD	NO	NO	Text	Code of the action that produces data	—	send, receive, event	—
5	AURA_ID	NO	YES	Text	User logging ID in Aura Starting in this version, the user will have a new aura_id each time she logs in Aura	UUID	—
6	PHONE_ID	NO	YES	Text	Phone number of the user	Phone number including international prefix	—
7	CHANNEL_CD	NO	YES	Text	Code of the channel where the action happened	—	Same values as AURA_CHANNEL_NAME field in the dimensional entity D_Aura_Channel	—
8	SUBSCRIPTION_CD	NO	YES	Text	Code of the subscription type of the user in the OB	—	PREPAID, POSTPAID, CONTROL	—
9	DOMAIN_CD	NO	YES	Text	Code of the domain where the action happened ⚠️ Future use	—	—
10	CATEGORY_CD	NO	YES	Text	Code of the category where the action happened ⚠️ Future use	—	—
11	COUNTRY_CD	NO	NO	Text	ISO code of the country	ISO 3166	—
12	CORR_ID	NO	NO	Text	Correlator ID of the request that produces the data	UUID	—
13	IS_CACHED	NO	NO	Boolean	It shows if the entity content was already cached or not	—	true/false	—
14	STATUS_CD	NO	YES	Text	Status code of the action, if meaningful	HTTP status code of the response	—
15	REASON	NO	YES	Text	Result of the action in error case: error code	—	—
16	VERSION_ID	NO	NO	Text	Aura version that produces this data	X.Y.Z	—	8.2.0.
17	LANG_CD	NO	YES	Text	Language configured by the user for the communication	- ISO 639 two-letter lowercase culture code - ISO 3166 two-letter lowercase subculture code associated with a country or region	—
18	TZ_CD	NO	NO	Text	Timezone where the communication happened	UTC offset of the TZ. TZ codes	—
19	DURATION_NU	NO	YES	Number	Duration of the action in milliseconds	Natural number	—
20	MESSAGE	NO	NO	Text	Content of the message	—	—
21	DIALOG_ID	NO	YES	Text	Id of the dialog where the message happens	—	—
22	CONVERSATION_ID	NO	NO	Text	Id of the conversation where the message happens	UUID	—
23	WIN_RECOGNIZER_CD	NO	YES	Text	Code of the recognizer that wins for this message		Same values as AURA_RECOGNIZER_NAME field in the dimensional entity D_Aura_Recognizer
24	WIN_RECOGNIZER_SCORE_NU	NO	YES	Number	Score of the recognizer that wins for this message	—	—
25	INTENT	NO	YES	Text	Selected intent	—	—
26	ENTITIES	NO	YES	Text	List of entities determined by the recognizer	—	—
27	MODALITY_CD	NO	YES	Text	It explains how the user communicates with Aura	—	text, voice, form	—
28	AURA_ID_GLOBAL	NO	YES	Text	It identifies the same user_id logged with the same authentication method	—	—
29	ACCOUNT_NUMBER	NO	YES	Text	Unique account number of the user Mandatory only for Spain. But it can be null also in Spain because it is only available in aura-bot, not in aura-services	—	—

2.5 - Groot message

Groot message

#	FIELD	PK	NULLABLE	TYPE	DESCRIPTION	FORMAT	ALLOWED VALUES	EXAMPLE
1	USER_ID	NO	NO	Text	Unique User ID in the OB Systems or unique generated one for anonymous users	Format depends on the OB	—
2	MSG_DT	NO	NO	Date	Timestamp of the data in UTC time	ISO 8601	—
3	MSG_ID	YES	NO	Text	Unique ID of the message	UUID	—
4	ACTION_CD	NO	NO	Text	Code of the action that produces data	—	send, receive, event	—
5	AURA_ID	NO	YES	Text	User logging ID in Aura Starting in this version, the user will have a new aura_id each time she logs in Aura	UUID	—
6	PHONE_ID	NO	YES	Text	Phone number of the user	Phone number including international prefix	—
7	CHANNEL_CD	NO	YES	Text	Code of the channel where the action happened	—	Same values as AURA_CHANNEL_NAME field in the dimensional entity D_Aura_Channel	—
8	DOMAIN_CD	NO	YES	Text	Code of the domain where the action happened ⚠️ Future Use	—	—
9	CATEGORY_CD	NO	YES	Text	Code of the category where the action happened ⚠️ Future Use	—	—
10	COUNTRY_CD	NO	NO	Text	ISO code of the country	ISO 3166	—
11	CORR_ID	NO	NO	Text	Correlator ID of the request that produces data	UUID	—
12	IS_CACHED	NO	NO	Boolean	It shows if the entity content was already cached or not	—	true/false	—
13	STATUS_CD	NO	YES	Text	Status code of the API request	HTTP status of the response	—
14	REASON	NO	YES	Text	Result of the action in error case: error code	—	—
15	VERSION_ID	NO	NO	Text	Aura version that produces data	X.Y.Z	—	8.2.0.
16	LANG_CD	NO	YES	Text	Language configured by the user for the communication	- ISO 639 two-letter lowercase culture code - ISO 3166 two-letter lowercase subculture code associated with a country or region	—
17	TZ_CD	NO	YES	Text	Timezone where the communication happened	UTC offset of the TZ. TZ codes	—
18	DURATION_NU	NO	NO	Number	Duration in milliseconds of the action	Natural number
19	MESSAGE	NO	NO	Text	Content of the message	—	—
20	CHANNEL_CONVERSATION_CD	NO	NO	Text	Identifier of the conversation in the channel (conversationId in aura-groot)	—	—
21	SKILL_CONVERSATION_CD	NO	NO	Text	Identifier of the conversation in the skill	—	—-
22	WIN_RECOGNIZER_CD	NO	YES	Text	Code of the recognizer that wins for this message	—	Same values as AURA_RECOGNIZER_NAME field in the dimensional entity D_Aura_Recognizer
23	WIN_RECOGNIZER_SCORE_NU	NO	YES	Number	Score of the recognizer that wins for this message	—	—
24	AURA_ID_GLOBAL	NO	YES	Text	It identifies the same user_id logged with the same authentication method	—	—
25	ACCOUNT_NUMBER	NO	YES	Text	Unique account number of the user Mandatory only for Spain, but it can be null also in this country because it is only available in aura-bot, not in aura-services	—	—
26	SKILL_CD	No	No	Text	Identifier of the skill	—	Same values as AURA_SKILL_NAME field in the dimensional entity D_Aura_Skill
27	AURA_COMPONENT_ID	No	No	Text	Identifier of the Aura component	—	Same values as AURA_COMPONENT_NAME field in the dimensional entity D_Aura_Component
28	AURA_COMPONENT_HOST_ID	No	No	Text	Identifier of the host running the specific component	—
29	BRAND_ID	No	No	Text	Identifier of the Telefonica’s brand	—	Same values as BRAND_ID field in D_GBL_BRAND