Tags:
Categories:

Aura_Message v6.0.0

Within the different entities currently used in Aura, this document describes those included in the entity type Aura_Message

Under implementation

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.
Last modified June 18, 2025: feat: Documentation improvement for Quotsa release #AURA-29739 [RTM] (f401ed2f)