Aura –

Docs:

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

Build the use case logic: use cases development over Aura Bot

Guidelines for every step included in the development of a use case over Aura Bot, from building the dialog that models the conversational flow with the user and fetches the required data to its deployment in order to make the experience available for Aura users

Process at a glance

Bot
start-up

First time with aura-bot?
. Install aura-bot
. Configure aura-bot

Develop uc logic

. Develop an aura-bot library/dialog
. Test the dialog
. Build the response for Aura users

Package and
test use case

. Package the developed use case
. Test locally to evaluate its performance

Deploy
use case

. Make certain key checks before deployment
. Finally, deploy the developed use case

Use cases in WhatsApp

. Follow the general guidelines, but also check the specific extra steps

Introduction

The documents included in this section show the detailed processes for the development of use cases over aura-bot, with guidelines for all the feasible scenarios that can appear at this stage.

The following figure schematically shows the general workflow for the development of a use case over aura-bot.

Docs:

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

Train Aura to understand: Use cases development over Aura NLP

Guidelines for every step in the process for personalized use cases development over Aura NLP, in order to make Aura understand the users’ requests.

Related documents
📄 Aura NLP descriptive documentation

Process at a glance

Previous requisites

. Get sure your system has the required technical resources
. Install the Aura NLP Virtual Machine
. Generate a local branch for the NLP data repository

Generate NLP model

. Build up the dynamic pipeline
. Configure the NLP model
. Generate training files, test set files and dictionaries

Train NLP model

. Train the understanding model in order to make it understand properly the users' requests

Test NLP model

. Evaluate the accuracy of the NLP model locally
. If results are satisfactory, it must be also validated by Aura Global Team

Deploy NLP package

. Merge and generate the NLP package containing the understanding model
. Deploy the new package to make it available

Introduction

This section includes the detailed process for the development of use cases over aura-nlp together with all the complementary stages that linguists and NLP experts need for this purpose.

The following figure schematically shows the workflow for the development of a use case over Aura NLP, where every stage is fully described in succeeding sections.

Firstly, get sure you fulfil all the prerequisites for the configuration of the NLP development environment.
Afterwards, follow the orderly stages in use cases development over Aura NLP.

If you are interested in a specific process, access directly to its documentation here:

Catalog of components for NLP pipelines: catalog of stages, connectors and normalization pipelines that can be used to compose the NLP pipeline.
Aura NLP entities catalogs: Description of entities catalogs, input for Aura NLP dictionaries.
Aura NLP dictionaries: Description of dictionaries, used to recognize entities.
Use of Grammars in Aura NLP: guidelines for using Grammars in an NLP model.
Complementary processes: processes that may be carried out over external software when developing a use case and procedures followed by the Aura NLP Global Team.

Docs:

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

Build Aura response

When developing a use case, a crucial step is to design the response that Aura provides to its users.

Learn how to generate it using the most appropriate texts and elements.

Introduction

Aura must be able to deal with messages from different partners in several languages and, moreover, from different communication channels.

Considering a user request to Aura through a specific communication channel, Aura must provide the appropriate answer to his/her utterance through a precise message expressed in the user’s language and in natural language.

The response to the user can be provided through three different interfaces, depending on the communication channel:

Custom interface: Interface with screen, voice and text interaction. This is the main Aura interface.
Voice interface: Interface for devices without screen, where the interaction is only done through voice.
Chat interface: Message interface where the text is the main interaction mode, based on a conversational model with bubbles and historic data.

Depending on the channel and its rendering capabilities, the response can include different elements: text, cards, graphic resources, deeplinks, suggestions and actions.

The following documents include the guidelines for the generation of three key elements in Aura response:

Texts: how to generate or update Aura response texts in POEditor.
Cards: different types of cards that can be included in Aura response as visual elements.
Graphic resources: static or dynamic graphic resources that can be included in the response to the user.

Docs:

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

Configure a developed use case

Optional actions in order to configure the use case, such as including it into Aura suggestions

Introduction

This section encloses optional tasks that may be carried out for the configuration of a developed use case, in the following scenarios:

If you want your use case to be shown as an Aura Suggestion

Docs:

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

Use cases development in Google RCS Business Messaging channel

Discover the specific extra steps for the development of a use case in Google RCS Business Messaging channel (from now on, RCS channel)

Related documents
📄 Descriptive documentation regarding RCS channel in Aura

Introduction

When developing a use case in RCS, the general procedure for this task must be followed, depending on the use case type:

Local use cases

However, due to the distinctive features and limitations for each channel, if the use case is to be developed for RCS, then certain extra steps must be carried out, which are described in the following documents:

Pre-requisites

The use of all the available Aura features in RCS requires the previous activation of the channel:
- RCS channel activation
The OB must previously register Aura’s agent and configure the channel in Aura. This should be done by OB, not by use case.

Docs:

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

Use cases development in WhatsApp

Discover the specific extra steps for the development of a use case in Whatsapp channel

Related documents
📄 Descriptive documentation regarding WhatsApp channel in Aura

Introduction

When developing a use case in WhatsApp, the general procedure for this task must be followed, depending on the use case type:

Local use cases

However, due to the distinctive features and limitations for each channel, if the use case is to be developed for WhatsApp, then certain extra steps must be carried out, which are described in the following documents:

Build Aura response taking into account the rendering limitations of WhatsApp.
Rendering Aura response components: learn how aura-bridge renders every component of Aura response.
Use of files in WhatsApp: configure the use case to send a file to the user and vice versa.
Use of templates in WhatsApp: configure the use case to send a template to the user.
Use of catalogs in WhatsApp: configure the use case to send a catalog of products and services to the user.
Use of interactive messages in WhatsApp: how to use reply buttons and list messages in WhatsApp graphical interface.
Redirect the login dialog: how to redirect certain intents that need authentication when the user is anonymous and requires to be authenticated through SMS-OTP.
Error management: guidelines for the resolution of error in WhatsApp channel.
Use of emoticons: how to create a prompt to render emoticons properly.
Use of section title: how to use a section title in interactive messages.
Use of footer: how to use footer in interactive messages.
Use of WhatsApp referral functionality: how to retrieve referral info from a product advertisement.

Pre-requisites

The use of all the available Aura features in WhatsApp requires the previous activation of the channels:
- WhatsApp activation
The OB must previously register Aura’s number in WhatsApp (Kernel procedure) and configure the channel in Aura. This should be done by OB, not by use case.