Categories:
Guidelines for the configuration of an application
Comprehensive instructions for the configuration of an application to communicate with aura-gateway-api
Introduction
Prior to the development of a use case that needs aura-gateway-api to connect with an external service, the configuration of an application is required to set the specific parameters of the ATRIA AI-driven capability to be used.
Additionally, if certain changes must be made on an existing application through a hot swapping process, follow the guidelines Hot swapping of Aura applications configuration
Guidelines to create and configure an application
The creation of an application requires the following steps:
-
Create a task for the configuration of an application in JIRA.
-
Copy the tables below and paste them into the JIRA task.
-
Fill in all the fields corresponding to your specific ATRIA capability in the table’s column “Value in app”.
Do not modify the content of the remaining columns aside from “Value in app”. -
The application must be available in the applications list of the environment, which is available through the aura-configuration-api server.
-
The edited sheet will serve as the basis for the subsequent validation of the application by Aura Global Team and its uploading to the system.
- Mandatory parameters: parameter_name
- Optional parameters: parameter_name
Application basic data
| Parameter | Definition | Type | Value in app |
|---|---|---|---|
| disabled | Boolean value to enable or disable the application. By default: false |
Boolean | complete |
| id | Unique application identifier | UUID | complete |
| name | Unique application name | String | complete |
| brand | Identifier of the Telefónica Brand associated to the application. Available values in the document Telefónica brands management |
String | complete |
| nlp | Parameters to use the NLP as a Service capability Mandatory for using this capability |
N/A | Go to NLP as a Service section |
| models | Parameters to use the Generative AI capability or RAG capability Mandatory for using these capabilities |
N/A | Go to Using Generative AI / RAG section |
| agents | Identifiers of the agents associated with the application. Mandatory if the application requires integration with agents. |
String[] | complete |
Using NLP as a Service: nlp parameter
The use of the NLP as a Service capability by a channel requires the previous registration of the channel in Aura using the channels registration template.
| Parameter | Definition | Type | Value in app |
|---|---|---|---|
| channelId | Identifier of the channel willing to use NLP as a Service |
String | complete |
Using Generative AI / RAG: models parameter
The use of Generative AI or RAG capabilities by applications requires the definition of the following parameters:
| Parameter | Definition | Type |
|---|---|---|
| level | . It indicates if level application in atria-model-gateway, meaning that it has specific access and control privileges. . Default value user |
String |
| presets | . Include here all the presets (configurable entities that define the instructions to work with the AI model for the resolution of a use case) that will be assigned to this application. . For this purpose, follow the guidelines to include a preset in the application . Take into account that a preset must be previously created in ATRIA |
String[] |