Aura –

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Global authentication dialogs

Global authentication dialogs support different types of authentication in Aura

Global authentication dialogs include:

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Conversational dialog

Description of the conversational-dialog global use case available for Aiwi

Introduction

The conversational-dialog allows users to interact with an LLM with a predefined prompt.

This prompt should return a json formatted object to be mapped in a standard Aiwi response message.

Specific configuration

The conversational-dialog is designed to handle user’s requests using LLMs in ATRIA.

Currently, this dialog is available for Aura channelData V1 version and can only be used for the channel AIWI.

For this use case, the required specific configuration is set below:

    {
      "name": "conversational",
      "dialogs": [
        {
          "id": "conversational-dialog",
          "allowAnonymous": true,
          "triggerConditions": [
            {
              "intent": "None"
            }
          ],
          "bypass": {
            "duration": 30,
            "payloadName": "conversational",
            "initialData": {},
            "recognizersEnabled": false,
            "recognizersBreakIntents": {}
          }
        }
      ]
    }

Specific values

Key	Value	Description
bypass.duration	30 (minutes)	This value overwrites the default aura-bot value for bypass lasting 10 minutes.
bypass.payloadName	conversational	Name of the interface that will be used as bypass payload for this dialog.
bypass.initialData	empty	It should contain any data needed by the dialog to be initialized.
bypass.recognizersEnabled	false	This value overwrites the default aura-bot way of working with recognizers when it is in bypass mode. If it is set to `true`, recognizers are executed, and their result is stored in the bypass payload to be used, if needed, afterwards.
bypass.recognizersBreakIntents	empty	Used to handle when the user requested any other use case during the execution of the dialog. To enable this config, `bypass.recognizersEnabled` should be enabled.

Environment variables

Property	Type	Description	Modifiable by OB?
AURA_GATEWAY_API_ENDPOINT	URI string	Endpoint to access the locally deployed ATRIA aura-gateway-api	NO
AURA_GATEWAY_API_ISSUER_URL	string	Aura issuer URL. It is automatically fulfilled by the installer.	NO
CONVERSATIONAL_COMMAND_KEY	string	Key of the command in the returned json from prompt.	YES
CONVERSATIONAL_MESSAGE_KEY	string	Key of the message in the returned json from prompt.	YES

Configuration by channel

From Prince’s release onwards, the configuration of applicationId and presetId per channel and intent has been added to the channel model.

For this use case, the required specific configuration per channel is set below (added dialogs section under atria property at Main-Recognizer-Video-Triage-29855):

{
  "atria": {
    "dialogs":{
      "None": {
        "applicationId": "816bdab6-3ea3-4a77-bdea-12945d6d7053",
        "presetId": "ef3d0603-3fef-4109-a577-0ab92f9060df"
      }
    }
  }
}

Specific values by channel

Intent	Key	Value	Description	Modifiable by OB?
intent.tv.custom_recommendation	applicationId	1eb11727-14f2-447f-acc0-a2211ab55870	ATRIA application identifier	NO
intent.tv.custom_recommendation	presetId	e0cdcae2-025d-4624-8096-d6bf4b5eaaff	ATRIA preset identifier to be used within the use case.	NO

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bot generic-ai-dialog

Description of Aura bot generic-ai-dialog, that allows managing several experiences for TV channels using AI services and complex logic resolution.

Introduction

The aura-bot-generic-ai-library library includes the following list of dialogs:

generic-ai-dialog-v1: allows managing several experiences for TV channels using AI services and complex logic resolution for channelData v1 channels.
generic-ai-dialog-v3: allows managing several experiences for TV channels using AI services and complex logic resolution for channelData v3 channels.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bot generic-dialog

Description of Aura bot generic-dialog, that allows managing several experiences for TV channels based on a simple configuration

Find here details regarding the global generic library and dialogs’ versions and the condition for a use case to be generic

Introduction

The generic-dialog allows OBs to implement certain local use cases for Movistar Home, Movistar Plus and Set-top Box (STB) channels in an autonomous, agile and simple way with no code development, only by means of configuration.

Different versions compatible with channelData v1 and v3 are available:

If your channelData version is v1, then use generic-dialog-v1
If your channelData version is v3, then use generic-dialog-v3

Aura global generic-dialog

The generic-dialog responds to the intention of having a single dialog based on configuration that allows managing several intents whose behavior is similar.

Therefore, it allows the development of certain types of use cases in a simple and autonomous way, with no associated code development and simply by means of configuration.

The global generic-dialog file, generic-dialog.ts includes the logic for the use case execution, where configuration is recovered and the output message is generated with the defined parameters.

Besides this global generic-dialog, there are several plugins based on the same dialog, all of them working as the global one and with similar code. In this framework, each OB have a specific generic-dialog in its corresponding library generic-[OB]/ which must be used when developing a local use case.

The global library that includes the generic dialog is named generic and has been designed for the management of different types of dialogs.

You can find it here.

Conditions for a use case to be generic

In order to consider a use case as part of the generic-dialog, it must fulfil these conditions:

✅ Local use cases developed from scratch by the OBs.
✅ Use cases with intents that can be managed by Movistar Plus, Movistar Home or Set-Top-Box (STB) channels.
✅ Dialog with only one interaction with the user: only one message from the user and one response from the bot are allowed. For example: greetings dialog.
✅ There is a direct transformation from intent to action (you may or may not call the API Movistar Resolution for this purpose). For example: tv-remote-actions use cases).
✅ Use cases that require the conversion of input parameters through a function to get the correct payload. For example: conversion on entities. For example: move_forward.
✅ Currently, only one text response is allowed:

settings.locale.success when all works fine.
settings.locale.error when something goes wrong.
Also, the text can be set in the response from the resolution API but, if required for example a variable text depending on the response of the API or the recognized entity, then developers must create another dialog.

Merely as examples of the potential of aura-bot generic dialog, below you can find different use cases for the channels Movistar Plus, Movistar Home or STB channels that can be developed through it. Use them as a reference for developing your own local experiences!

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura global dialogs: miscellaneous

Aura Global dialogs belonging to different fields of application in terms of users’ experiences

Introduction

This section includes both global dialogs/libraries that can be installed by the OB as well as core dialogs that are deployed within the corresponding Aura Platform release:

context-filter dialog in charge of all the contextFilters configured in each dialog.
disambiguation library in charge of disambiguation processes.
handover-genesys dialogs, available in the Whatsapp channel to handle handover experiences.
mocks-v3 dialog, in charge of returning mocked responses in channelData v3 format.
suggestions dialog that manages suggestions sent to the users.
unexpected-file dialog that controls the unforeseen files received in aura-bot.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura video use cases

Discover the global experiences developed by Aura Platform Team for video channels

Aura global video use cases provide different experiences to Telefónica customers for video services. Those video services could be provided by two platforms (BoB, for Spain or GVP, currently in Brazil) and through different channels, like Set-Top-Box, mobile apps or Movistar Home.

Experiences provided by Aura video use cases are related to searching or playing TV content, TV channels tuning, TV program guide information, reproduction control (move forwards/back, pause, resume, etc.), menu navigation, language and subtitles changing, actions to control (switch on/off, move channels up/down, mute/unmute, volume up/down) and more.

Those use cases are currently available in Spain legacy video platform for MH, STB and MP channels, but from now on, Aura Global Team will progressively migrate and adapt them in three ways:

Use cases will be migrated to a new Aura Platform component called Complex Logic Framework
Use cases will be adapted to normalized Aura v3 request-response model
Use cases will be adapted to use Video Contents normalized Kernel API

ℹ️ The objective and focus of all the documentation you can find here is for normalized Aura Global Video use cases (v3).

Access the left menu and discover the available video global experiences.

In addition, related with video plugins, there is a Postman collection available in Video Contents Kernel API.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura AI use cases

Discover the AI global experiences developed by Aura Platform Team for video channels

Aura AI global cases provide different experiences to Telefónica customers for video services. Those video services could be provided by two platforms (one in Spain and GVP, currently in Brazil) and through different media, like Set-Top-Box and mobile apps, Movistar Plus.

Access the left menu and discover the available AI global experiences.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Use cases for testing Aura

Libraries for testing different Aura Platform functionalities

Introduction

The Github library aura-bot-libraries-test contains different libraries and dialogs used by the Aura Global Team for testing Aura.

Check the Github repository:
https://github.com/Telefonica/aura-bot-libraries-test/tree/master/packages

It includes several examples generated by APE for testing the use of certain Aura features and the factotum library that integrates test dialogs related to Aura core functionalities.

Within the factotum library, several dialogs are included for the management of the handover use case for the WhatsApp channel:

handover-genesys dialogs

The different dialogs from the GitHub repository will be progressively documented here in upcoming releases