Xoel release changelog

• 1: Aura system components version
• 2: Aura bridge changelog
• 3: Aura NLP changelog
• 4: Aura Complex Logic Framework changelog
• 5: Aura request-response model changelog
• 6: Aura Context changelog
• 7: Giza Lite v1 & models changelog
• 8: Aura documentation changelog

1 - Aura system components version

Aura system components versions

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.

2 - Aura bridge changelog

Aura bridge changelog

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:
  • auraline-channel-callback-api

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:
  • auraline-conversation-api plugin

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:
  • aurapush-sendfeedback-service-plugin

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:
  • aura-bridge environment variables

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:
  • aura-bridge cache

2023-10-10 - Modified aura-bridge environment variables related to Redis and aura-behavior-manager

• 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:
  • aura-bridge environment variables

3 - Aura NLP changelog

Aura NLP changelog

Changed

2023-10-06 - Improved logs performance

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

4 - Aura Complex Logic Framework changelog

Aura Complex Logic Framework changelog

Changed

2023-10-06 - Improved logs performance

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

5 - Aura request-response model changelog

Aura request-response model changelog

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:
  • Aura request semantic model v3: AuraGrootPayload property
  • Aura response semantic model v3: SkillPayload property

6 - Aura Context changelog

Aura Context changelog

Changed

2023-10-06 - Improved logs performance

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

7 - Giza Lite v1 & models changelog

Giza Lite v1 and models changelog

Added

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

• Guidelines for building a dialog over aura-bot that calls a global Advanced Analytics Model (AAM) from the ones integrated into Giza Lite v1.
• Affected documents:
  • Guidelines for building a dialog that calls a model

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

• Guidelines for working with mocks for testing a global model in Aura minibot.
• Affected documents:
  • Aura minibot: Mocks for testing a global model

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

• Adapted Giza Lite v1 guidelines for the consumption of the global models, currently only available through an aura-bot use case.
• Affected documents:
  • Giza Lite v1 guidelines: models consumption

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

• API clients for the three global Advanced Analytics Models currently integrated in Giza Lite v1 are added to the API clients documentation.
• Affected documents:
  • Sentiments API client
  • Repetitions API client
  • Language detection API client

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:
  • Advanced Analytics Models APIs

8 - Aura documentation changelog

Aura documentation 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:
  • Version in response messages

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:
  • Request access to Github repositories

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

• The document Scheduled updates in Aura components is completed with information regarding Aura Cognitive components.
• Affected documents:
  • 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:
  • Aura entities definition

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:
  • README.md

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:
  • API clients

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:
  • Message exchange between channels and skills

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:
  • Aura API clients

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:
  • Aura QA Tool execution guide

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:
  • aura-bot documentation
  • aura-authentication-api documentation

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.