Aura – feedback

Docs:

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

Aura Push send feedback service

Description of Aura Push send feedback service

Description

aurapush-sendfeedback-service plugin contains the services and utilities to send information to the aura-push service.

To send this information an event consumer is used: aurapush-sendfeedback-consumer. This consumer listens for the following events:

whatsapp.ackMessageReceived: Event emitted when a new ack message is received.
core.flow.error.directlineToWhatsappFlow: Event emitted when an error occurs during sending a message from Direct Line to WhatsApp.

sequenceDiagram  
    alt whatsapp.ackMessageReceived
        AuraPushFeedbackConsumer->>+onAckMessageReceived: ACK
    end
    alt core.flow.error.directlineToWhatsappFlow
        AuraPushFeedbackConsumer->>+onCoreErrorDirectlineToWhatsappFlow: Core flow error
    end
        onAckMessageReceived->>+auraPushFeedbackClient: ACK and path
        onCoreErrorDirectlineToWhatsappFlow->>+auraPushFeedbackClient: Core flow error and path
        auraPushFeedbackClient->>+Aura Push: Message

⚠️ For Brazil OB, the aurapush-sendfeedback-service plugin requires a specific configuration in the installer aurak8s.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
eventService	PluginType.Service	Bridge event management service

Provides components (IOC)

Name	Type	Description
auraPushSendFeedbackService	PluginType.Service	Services and utilities for AuraPush send message feedback
auraPushFeedbackClient	PluginType.Service	Aura push feedback client

Docs:

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

aura-mocks-send-feedback-api plugin

Plugin that mocks feedback sent by *aura-bridge

Description

The aura-mocks-send-feedback-api plugin simulates the server that is responsible for receiving the different requests from the aurapush-sendfeedback-service plugin of *aura-bridge component. These requests may involve the sending of statues, errors o messages.

Find more information in the Github repository:
https://github.com/Telefonica/aura-mocks-server/tree/master/src/plugins/aura-mocks-send-feedback-api

This is part of aura-mocks-server project.

Endpoints API

Enpoint	Method	Group	description
/feedback/statuses/update	PUT	Send Feedback	Update statuses
/feedback/errors/update	PUT	Send Feedback	Update errors
/feedback/messages/update	PUT	Send Feedback	Update messages
/feedback/messages	DELETE	Send Feedback	Delete cache
/feedback/messages/:messageId	GET	Send Feedback	Get message feedback by MessageId
/feedback/messages	GET	Send Feedback	Get all message feedback

PUT: /feedback/statuses/update

Update statuses by messageId, so messageId is mandatory.

PUT: /feedback/errors/update

Update errors by messageId, so messageId is mandatory.

PUT: /feedback/messages/update

Update messages by messageId, so messageId is mandatory.

DELETE: /feedback/messages/

Delete feedback message by messageId. The query param messageId is mandatory.

GET: /feedback/messages/

Get all messages feedback by MessageId. The query messageId value is mandatory.

GET: /feedback/messages/:messageId

Get message feedback by MessageId. The property in body messageId is mandatory.

Docs:

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

Generative feedback functional description

Discover the feedback functionality that can be used for Generative AI and RAG capabilities

If you are interested in the detailed technical operational flow of this capability, that includes the sequence diagram of interactions between components, access here

Introduction

Within the use of the ATRIA AI-driven Generative AI or RAG capabilities, we have developed a feedback functionality.

This feedback functionality allows the estimation of the user’s satisfaction regarding the obtained response.

The user can provide feedback by clicking on a thumbs-up icon if the quality and appropriateness of the answer is correct or selecting the thumbs-down icon if the response misses the point, contains hallucinations, or is unclear.

Functional operation

The underlying process is summarized in the following lines and schematically shown in the figure below:

An application sends a request to aura-gateway-api generative with a correlator.
Firstly, it passes through Kernel (Telefónica Digital Ecosystem) for authentication and security purposes.
aura-gateway-api processes the received request and sends the request to the auto-generative content generator atria-model-gateway to obtain an appropriate response.
atria-model-gateway generates the most appropriate response and sends it back to aura-gateway-api.
aura-gateway-api sends the response back to the service that initiated the request with the same correlator and a session identifier.
An application sends a request to aura-gateway-api feedback with:
- A new header correlator
- The sessionId received in the path
- The field msg_corrid, in the body, that indicates the correlator of the message the feedback is about.
aura-gateway-api processes the received request and communicates with atria-model-gateway to send this request.
atria-model-gateway stores the feedback.
aura-gateway-api communicates a 204 to the application.

Docs:

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

Aura Feedback API

Description of Aura Feedback API

Download swagger file

Docs:

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

Feedback capability operational workflow

ATRIA technical operational flow corresponding to the operation of the feedback capability that can be used for Generative AI and RAG capabilities

Flow diagram

@startuml
title Feedback API diagram
participant Application
participant Kernel #1add4d
participant AuraGatewayApi #76bbe7
Note right of Application: The application has made a previous request to `aiservices/generative/prompts` on which it will give feedback. Use the correlatorId sending in the request and the session_id received in the response. View Generative API diagram
Application -> Kernel: Request to aiservices/{session_id}/feedback with token and msg_corrId: correlatorId
Kernel -> AuraGatewayApi: Request to aiservices/{session_id}/feedback with token-info header and msg_corrId: correlatorId
AuraGatewayApi -> AuraGatewayApi: Validate request
AuraGatewayApi -> AuraGatewayApi: Covert message to format atria-model-gateway
AuraGatewayApi -> AtriaModelGateway: Send feedback to atria-model-gateway
AtriaModelGateway -> AuraGatewayApi: Response feedback
AuraGatewayApi -> AuraGatewayApi: process atria-model-gateway response
AuraGatewayApi -> AuraGatewayApi: generate response
AuraGatewayApi -> Kernel: response 204
Kernel -> Application: response 204


@enduml

Generative feedback sequence diagram

Request

curl --location 'https://api.environment.baikalplatform.com/aura-aiservices/v1/{session_id}/feedback' \
--header 'x-correlator: <uuid2>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}' \
--data '{
  "application": {    
    "name": "app-name",    
  },
  "value": true,  
  "msg_corrId": "{previous-x-correlator}"
}'

Docs:

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

aura-feedback-api plugin

Description of the aura-feedback-api plugin

Introduction

The aura-feedback-api plugin manages the communication with atria-model-gateway to provide feedback about the Generative and RAG services behavior.

Consumes components (IOC)

Name	Type	Description
configurationManager	PluginType.Service	Configuration manager
applicationConfiguration	PluginType.Service	Configuration of applications

Provides components (IOC)

Name	Type	Description
feedbackApi	PluginType.API	Endpoints for the communication with feedback endpoint