This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Xoel release

Xoel release

This section includes key information regarding new features included in Aura Platform for Xoel and main changes in comparison with previous releases

What’s new in Xoel (8.4.0)?

Discover here the new features and modifications at a glance. You can find the technical details in the release changelog and the Release Notes.

Novelties Description
Improved logs performance ✔️ Reduced logs overhead in Aura NLP, Aura Context and Complex Logic Framerwork in order to improve performance
Basic implementation for supporting AuraLine protocol ✔️ First steps for the implementation of AuraLine protocol in Aura through the generation of a new plugin and API swagger in the aura-bridge component
New aura-bridge service for message feedback ✔️ aura-bridge now includes a new mechanism that allows Aura push to receive the correct status of message delivery to the final users. The possibility of adding a new plugin to handle the errors and ACK as needed is a global feature, but the implementation over Aura push is only available in Brazil, because it is a dedicated plugin for this OB.
Parallel Aura releases deployment ✔️ aura-bridge Redis database is now prefixed with a reference to the environment and version to allow parallel deployments of Aura versions.
Useful information regarding channelData versions ✔️ Find out whether or not aura-bot/aura-groot return the channelData version in the response
Remove MongoDB dependency ✔️ aura-bridge now uses Redis for all the information that needs to be temporarily persisted, completely eliminating its dependency on MongoDB
Completed documentation regarding Giza Lite v1 and global models ✔️ Giza Lite v1 documentation is completed with guidelines for the consumption of global models through an aura-bot use case and for models local testing
New payload fields in Aura request-response model ✔️ Aura request-response model v3 includes new payload fields for the enrichment of both request and response between channels, aura-groot and skills
Improved Aura Platform documentation ✔️ Key documents have been migrated from old repositories into Aura Technical Documentation website
✔️ Publication of an updated version of the README document for contributors to Aura documentation
✔️ Aura components documents are adapted to Aura distributed architecture documentation (Phase 1)
✔️ Documents are continuously updated, reviewed and corrected release after release. Moreover, certain ones have been relocated to ease their management

1 - Xoel release changelog

Xoel release changelog

Discover the record of all notable changes made in Aura for this release, organized by component.

1.1 - Aura system components version

Aura system components versions

Updated versions of Aura system components for the current Aura Platform release

Components versions

All components in the table below run over AKS cluster version 1.26.

Name Namespace Image deployed
alertmanager aura-system devopstf.azurecr.io/tools/alertmanager:v0.23.0
elastic-operator aura-system docker.elastic.co/eck/eck-operator:2.7.0
elasticsearch-es-aura aura-system devopstf.azurecr.io/tools/elasticsearch:8.7.0
elasticsearch-exporter aura-system devopstf.azurecr.io/tools/elasticsearch_exporter:v1.5.0
fluent-bit-aggregator aura-system devopstf.azurecr.io/tools/fluent-bit:1.7.7
grafana aura-system devopstf.azurecr.io/tools/grafana:8.3.4
kibana-kb aura-system docker.elastic.co/kibana/kibana:8.7.0
prometheus aura-system devopstf.azurecr.io/tools/prom/prometheus:v2.32.1
mongodb aura-system devopstf.azurecr.io/tools/mongo:4.4.18
mongodb-atlas-operator aura-system devopstf.azurecr.io/tools/mongodb-atlas-kubernetes-operator:1.5.1
redis-exporter aura-system devopstf.azurecr.io/tools/redis-exporter:1.6.1
redis aura-system devopstf.azurecr.io/tools/redis:6.0.19
thanos-store-gateway aura-system devopstf.azurecr.io/tools/thanos:v0.24.0
atlas-logger aura-system devopstf.azurecr.io/tools/atlas-logger:1.0.0
azure-logger aura-system devopstf.azurecr.io/tools/azure-logger:1.3.1
pushgateway aura-system devopstf.azurecr.io/tools/pushgateway:v1.4.1
thanos-querier aura-system devopstf.azurecr.io/tools/thanos:v0.24.0

Additional information

Information regarding Aura system components end-of-life (EOL) and next updates is included in the document Scheduled updates in Aura components. Find it in the Aura releases section of your corresponding release.

1.2 - Aura bridge changelog

Aura bridge changelog

Changelog of Aura bridge component for Xoel Aura Platform release

Added

2023-09-28 - Auraline channel callback API

  • New API in aura-bridge: auraline-channel-callback-api , that supports the communication between a channel and Aura using AuraLine protocol
  • Affected documents:

2023-10-10 - New aura-bridge plugin

  • New plugin in aura-bridge: auraline-conversation-api plugin, that generates conversation identifiers together with an associated token to be able to communicate through the new Auraline service.
  • Affected documents:

2023-10-10 - Added new plugin aurapush-feedback-service-plugin

  • A new plugin is added to aura-bridge: aurapush-sendfeedback-service-plugin, that contains services and utilities to send information to the aura-push service.
  • Affected documents:

2023-10-11 - Parallel deployments of Aura when aura-bridge uses Redis

  • aura-bridge Redis database is now prefixed with a reference to the environment and version to allow parallel deployments of Aura versions. The new environment variable AURA_ENVIRONMENT_PREFIX allows mixing in a single Redis service messages coming from different environments in the same Azure subscription.
  • Affected documents:

Changed

2023-10-10 - Changed cache in aura-bridge to use Redis instead of MongoDB

  • aura-bridge cache components have been modified to use Redis instead of MongoDB.
  • Affected documents:
  • New environment variables are added to aura-bridge and some others are modified or deleted for the management of Redis and aura-behavior-manager.
  • Affected documents:

1.3 - Aura NLP changelog

Aura NLP changelog

Changelog of Aura NLP component for Xoel Aura Platform release

Changed

2023-10-06 - Improved logs performance

  • Tuned KPIs logs configuration.
  • Moved runtime log checks to testing time.

1.4 - Aura Complex Logic Framework changelog

Aura Complex Logic Framework changelog

Changelog of Aura Complex Logic Framework component for Xoel Aura Platform release

Changed

2023-10-06 - Improved logs performance

  • Tuned KPIs logs configuration.
  • Moved runtime log checks to testing time.

1.5 - Aura request-response model changelog

Aura request-response model changelog

Changelog of Aura request-response model v3 for Xoel release

Added

2023-10-11 - New fields in Aura request-response model

  • With the new Aura distributed architecture, the Aura Request – Response Semantic Model is intended to allow the proper communication between a channel, aura-groot and skills.
  • The payload field of Aura request-response model v3 is updated with new properties that allow the enrichment of information sent from aura-groot to the skill (auraGrootPayload) and information generated from the skill to aura-groot (skillPayload).
  • Affected documents:

1.6 - Aura Context changelog

Aura Context changelog

Changelog of Aura Context component for Xoel Aura Platform release

Changed

2023-10-06 - Improved logs performance

  • Tuned KPIs logs configuration.
  • Moved runtime log checks to testing time.

1.7 - Giza Lite v1 & models changelog

Giza Lite v1 and models changelog

Changelog of Giza Lite v1 and Advanced Analytics Models for Xoel Aura Platform release

Added

2023-10-10 - Guidelines for calling a model from a dialog

2023-10-10 - Guidelines for testing a model locally with Aura minibot

2023-10-11 - Guidelines for models consumption in Giza Lite v1

2023-10-18 - Added API client for Giza Lite global models

Changed

2023-10-05 - Moved AAMs APIs definition

  • The Advanced Analytics Models (AAMs) APIs documentation is now included as a new section in Giza documentation.
  • Affected documents:

1.8 - Aura documentation changelog

Aura documentation changelog

Changelog of Aura Documentation for Xoel Aura Platform release

The current section:

✅ Includes changes that exclusively affect to the improvement of Aura documentation (generation of new documents, writing style, structure, format, fixing typos, etc.)

⛔ Does not include technical corrections in documents or modifications derived from changes over a specific Aura component. These ones will be included in their corresponding section within the release changelog.

Added

2023-09-27 - Added table of returned version in response

  • The aura-bot response message formats documentation is completed with a table including relevant information regarding whether or not aura-bot/aura-groot return the channelData version in the response, depending on several parameters.
  • Affected documents:

2023-09-26 - Guidelines to access to Github repositories

  • Guidelines for requesting access to the aura-bot and Aura NLP repositories in Github are added to Aura Technical Documentation website.
  • Affected documents:

2023-10-03 - Completed document Scheduled updates in Aura components

2023-10-06 - Added Aura entities definition database

  • The Aura entities definition database, that includes the different entities currently used in Aura and required to calculate Aura KPIs, has been migrated to Aura Technical Documentation website.
  • Affected documents:

2023-10-10 - README for Aura Technical Documentation website

  • An updated and completed version of the README document is published, including all the key information for the contributors to Aura Technical Documentation website.
  • Affected documents:

2023-10-16 - Added missing API clients

  • The list of Aura API clients is completed with complex-logic-client, intelli-context-client and with the aura-bridge-client, that has been updated in the current release.
  • Affected documents:

2023-10-18 - Added guidelines for message exchange between a channel and a skill

  • Documentation for working with skills have been completed with guidelines for the exchange of messages between channels and skills, using Aura request-response model v3.
  • Affected documents:

Changed

2023-10-01 - API definition documentation

  • Aura APIs documentation, that was previously located in the top bar as an separate section, has now been integrated into the documentation for each individual Aura component. This change has been made to ease finding all the information of this specific component together with its API definition.
  • Affected documents:
    • Aura components: each component includes a new section named api-definition that includes the API swagger of this specific component
    • Aura APIs documentation: index of Aura APIs definition documents

2023-10-06 - API clients documentation

  • Aura API clients documentation, that was previously located in the top bar as an separate section, has now been integrated into the section “Develop experiences”, as constructors can use these documents when building experiences over Aura.
  • Affected documents:

2023-10-09 - Completed QA Tool documentation

  • Aura QA Tool documentation includes a requirement for the activation of VPN Full in order to execute tests.
  • Affected documents:

2023-10-11 - Adaptation of contents to Aura distributed architecture

  • Documentation of key Aura components have been updated to include modifications related to the introduction of the new distributed architecture in Aura. Basically, references to aura-groot and components’ flowcharts have been modified. This task will continue in the following Aura Platform release until all the components documentation is updated.
  • Affected documents:

2023-10-18 - Documents fixes and corrections

Throughout the website, different links, styles and typos have been corrected, for a continuous improvement of Aura Platform documentation.

2 - Scheduled updates in Aura components

Scheduled updates in Aura components

List of basic dependencies used by Aura components with their EOL information and the maximum frequency of update proposed by Aura Global team to avoid security issues. It also contains the next scheduled update, if it is already known.

Future updates

Aura Component Dependency Current Version EOL Max frequency Next update EOL Info
Aura System aks/kubernetes 1.26 03/24 Twice a year 2023Q4 https://learn.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli#kubernetes-versions
Aura System elasticsearch 8.7.0 10/08/24 Once a year 2023Q4 https://www.elastic.co/es/support/eol
Aura System grafana 8.3.4 N/A Once a year 2023Q4 https://community.grafana.com/t/support-policy-for-previous-releases/53350
Aura System kibana 8.7.0 10/08/24 Once a year 2023Q4 https://www.elastic.co/es/support/eol
Aura System prometheus 2.32.1 N/A Once a year 2023Q4 https://prometheus.io/docs/introduction/release-cycle/
Aura System, Aura Bot mongodb 4.4 02/24 Once a year 2023Q4 https://www.mongodb.com/support-policy/lifecycles
Aura System, Aura Bot node docker image node:18.16.0-alpine3.17 11/24 Once a year 2024Q2 https://endoflife.date/alpine
Aura System, Aura Context redis 6.X (azure) 08/24 Once a year 2024Q1 https://endoflife.date/redis
Aura Bot nodejs 18.16.0 04/24 Once a year 2024Q2 https://endoflife.date/nodejs
Aura Bot typescript 5.0.0 12/24 Once a year 2024Q2
Aura Bot botbuilder 4.19.6 N/A Once a year 2024Q2
Aura Bot joi 17.6.0 N/A Once a year 2024Q2
Aura Bot superagent 8.0.5 N/A Once a year 2024Q2
QA Tool python 3.8/3.9 14/10/24 (3.8) Once a year 2024Q3 https://endoflife.date/python
Aura Cognitive python 3.9/3.11 05/10/25(3.9) 24/10/27(3.11) Each 2 years 2024Q2 https://endoflife.date/python
Aura Cognitive python packages dependencies N/A N/A Each 2 years 2025Q2 (python - 1 year)
Aura Cognitive ubuntu 22.04 LTS 01/04/27 Each 5 years 2026Q4 https://ubuntu.com/about/release-cycle
Aura Cognitive local tool containers N/A N/A Each 2 years 2024Q1
Aura Cognitive Abacus react 17.0.2 🔴 29/03/22 Each 3 years 2024Q4 https://endoflife.date/react
Aura Cognitive Abacus typescript 4.1 N/A Each 3 years 2024Q4

3 - Xoel Release Notes

Xoel Release Notes