---
title: Relevance Generative Answering (RGA) reports and UA events
slug: nb6a0210
canonical_url: https://docs.coveo.com/en/nb6a0210/
collection: leverage-machine-learning
source_format: adoc
---
# Relevance Generative Answering (RGA) reports and UA events
To track the usage of [Relevance Generative Answering (RGA)](https://docs.coveo.com/en/nbtb6010/), [Coveo Analytics](https://docs.coveo.com/en/182/) logs [events](https://docs.coveo.com/en/260/) for actions performed on the [RGA component](https://docs.coveo.com/en/nb6a0037/) in your search interface.

This article provides instructions on how to [create a report](#create-an-rga-report) to view the performance of your [RGA](https://docs.coveo.com/en/nbtb6010/) implementation, and provides a [reference](#rga-analytics-events) for the RGA [events](https://docs.coveo.com/en/260/) that are tracked by Coveo Analytics.

## Add custom dimensions

To be able to [create a report](#create-an-rga-report) to view data on the [RGA custom events](#rga-analytics-events), you must add the following custom dimensions to your Coveo [organization](https://docs.coveo.com/en/185/):

* `c_answergenerated`

* To view event data collected from the [RGA feedback modal](https://docs.coveo.com/en/nb6a0037#rga-answer-feedback):

** `c_helpful`

** `c_readable`

** `c_documented`

** `c_correctTopic`

** `c_hallucinationFree`

** `c_details`

** `c_documentUrl`

To add a custom dimension for RGA

[Add a dimension](https://docs.coveo.com/en/1522#add-dimensions-on-custom-metadata) using the following criteria:

* For each of the custom dimensions, **API name** is the name of the dimension.
For example, when creating the `c_answergenerated` dimension, **API name** is `c_answergenerated`.

* For each of the custom dimensions, **Related events** must be set to **Custom event**.

**Example**

To create the `c_answergenerated` dimension, the settings are as follows:

![Relevance Generative Answering custom dimension | Coveo](https://docs.coveo.com/en/assets/images/leverage-machine-learning/rga-custom-dimension.png)

## Create an RGA report

You can quickly create a report to analyze the performance of your [Relevance Generative Answering (RGA)](https://docs.coveo.com/en/nbtb6010/) implementation by using the preconfigured **Generative Answering Performance** [dashboard](https://docs.coveo.com/en/256/) template.

The template creates a report with three tabs:

* **Search Metrics**: Contains [report cards](https://docs.coveo.com/en/267/) that show metrics such as the number of generated answers, click-through rate, and top queries with and without generated answers.

* **User Feedback**: Displays data collected through the [RGA feedback modal](https://docs.coveo.com/en/nb6a0037#rga-answer-feedback).

> **Note**
>
> If your [RGA](https://docs.coveo.com/en/nbtb6010/)-enabled search interface is [associated with an answer configuration](https://docs.coveo.com/en/p5db9314/) in the [Knowledge Hub](https://docs.coveo.com/en/p59f0295/), you must use the Knowledge Hub to [view the answer feedback data](https://docs.coveo.com/en/p5db0180/).
> In this case, the user feedback data won't appear in reports that are generated using the **Generative Answering Performance** template.

* **Self Service**: Lets you see the impact of [RGA](https://docs.coveo.com/en/nbtb6010/) on case submission, and by extension on self-service success, if you're logging a custom event when a user submits a case during the same visit when accessing the [RGA](https://docs.coveo.com/en/nbtb6010/)-enabled search interface.

![Relevance Generative Answering report template | Coveo](https://docs.coveo.com/en/assets/images/leverage-machine-learning/rga-template.png)

. If you haven't done so already, [add the custom dimensions](#add-custom-dimensions) to your Coveo [organization](https://docs.coveo.com/en/185/).

. [Add a dashboard](https://docs.coveo.com/en/1631#add-a-dashboard) using the **Generative Answering Performance** template.

## RGA analytics events

This section lists the custom Coveo Analytics events for RGA.

[cols="2",options="header"]
|===
|Value
|Event

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerStreamEnd`
| The answer was successfully streamed in the [search interface](https://docs.coveo.com/en/2741/).
This event won't be logged if the user initiates another search while the answer is being generated.

a| In customData:  
`answerGenerated`: true
| An answer was successfully generated for the query.

a| In customData:  
`answerGenerated`: false
a| An answer wasn't generated for the query because there wasn't enough relevant information to generate an answer.

> **Note**
>
> If RGA wasn't able to generate an answer due to an empty query, empty search results, or an error, no event is logged and no message appears in the search interface.

a| * eventType: `generatedAnswer`  
* eventValue: `openGeneratedAnswerSource`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.  
** `citationId`: The ID of the citation that was clicked.  
** `permanentId`: The permanent ID of the item corresponding to the citation that was clicked.
a| A citation link was clicked.

> **Note**
>
> As of the [Coveo Headless](https://docs.coveo.com/en/lcdf0493/) [v3 release](https://docs.coveo.com/en/headless/latest/headless-upgrade-from-v2), RGA citation clicks are tracked as regular click events instead of custom click events.
> As a result, citation click events now have a [click rank](https://docs.coveo.com/en/2948#click-rank) value of `1`.
> Additionally, the click **Event Cause** value is set to [`generatedAnswerCitationClick`](https://docs.coveo.com/en/2948#generatedanswercitationclick).

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerSourceHover`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.  
** `citationId`: The ID of the citation that was clicked.  
** `permanentId`: The permanent ID of the item corresponding to the citation that was clicked.  
** `citationHoverTimeMs`: The duration of the hover in milliseconds (ms).
| A user hovered over a citation link.

a| * eventType: `generatedAnswer`  
* eventValue: `likeGeneratedAnswer`
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.  
| A user clicked the thumbs-up icon to provide positive feedback for the generated answer.

a| * eventType: `generatedAnswer`  
* eventValue: `dislikeGeneratedAnswer`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
| A user clicked the thumbs-down icon to provide negative feedback for the generated answer.

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerFeedbackSubmitV2`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
** `helpful`: The feedback icon that was clicked. Shows "true" for thumbs-up, and "false" for thumbs-down.
** `readable`: The feedback option selected for if the generated answer is in a readable format ("yes", "unknown", or "no").  
** `documented`: The feedback option selected for if the answer is present in the existing dataset ("yes", "unknown", or "no").  
** `correctTopic`: The feedback option selected for if the generated answer relates to the correct topic ("yes", "unknown", or "no").  
** `hallucinationFree`: The feedback option selected for if the generated answer is free of non-factual (hallucinated) content ("yes", "unknown", or "no").  
** `details`: Shows any additional notes entered by the user.  
** `documentUrl`: Shows the URL entered by the user that points to the dataset item that contains the answer.  
| If the thumbs-up or thumbs-down icon is clicked, the user submits feedback details using the [RGA feedback modal](https://docs.coveo.com/en/nb6a0037#rga-answer-feedback).

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerCopyToClipboard`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
| A user clicked the copy button to copy the generated answer to their clipboard.

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerHideAnswers`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
| A user closed (hid) the RGA component.

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerShowAnswers`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
| A user opened (showed) the RGA component.

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerExpand`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
a| A user expanded the generated answer using **Show more**.  
> **Note**
>
> This feature is enabled using the `collapsible` property in the [Coveo Atomic Library](https://static.cloud.coveo.com/atomic/v3/storybook/index.html?path=/docs/atomic-generated-answer\--docs) or [Coveo Quantic Library](https://docs.coveo.com/en/quantic/latest/reference/search-components/search-generated-answer/).

a| * eventType: `generatedAnswer`  
* eventValue: `generatedAnswerCollapse`  
* In customData:  
** `generativeQuestionAnsweringID`: The ID of the generated answer.
a| A user collapsed the generated answer using **Show less**.  
> **Note**
>
> This feature is enabled using the `collapsible` property in the [Coveo Atomic Library](https://static.cloud.coveo.com/atomic/v3/storybook/index.html?path=/docs/atomic-generated-answer\--docs) or [Coveo Quantic Library](https://docs.coveo.com/en/quantic/latest/reference/search-components/search-generated-answer/).
|===

### Inspect your search page

Use your browser developer tools to retrieve what's being tracked:

. Open a Coveo-powered [search interface](https://docs.coveo.com/en/2741/) with [RGA enabled](https://docs.coveo.com/en/nb6a0037/).

. Open your web browser's developer tools.

> **Note**
>
> The examples in this article use the **Google Chrome** developer tools.
> For browser-specific information, see:
> 
> * [Google Chrome](https://developers.google.com/web/tools/chrome-devtools/open)
> 
> * [Mozilla Firefox](https://developer.mozilla.org/en-US/docs/Tools)
> 
> * [Safari](https://support.apple.com/en-ca/guide/safari/sfri20948/mac)

. Select the **Network** tab.

. On the search page, perform a query that will generate an answer.

. [Perform an action in the RGA component](https://docs.coveo.com/en/nb6a0037#rga-component-features).

. Back in the developer tools window, under the **Name** column, click the latest `custom` call to Coveo Analytics.

. Select the **Payload** tab.
You should now see the tracked [Coveo Analytics event](https://docs.coveo.com/en/260/).