Search Agent reports and UA events

This is for:

Developer System Administrator
Important
Beta feature

Coveo Search Agent is currently available as a beta offering. Contact your Customer Success Manager for access to this feature. Your use of this feature is subject to the beta and pre-release terms of your agreement with Coveo, including any applicable beta or pre-release provisions therein. To the extent your agreement does not contain specific beta or pre-release terms, Section 8 (Beta Features) of the Coveo Customer Agreement shall apply. This feature is provided "as-is," without warranty or SLA coverage, and may be modified, suspended, or discontinued at any time. You should not use this feature to process sensitive or regulated data.

To track usage analytics of the Search Agent, Coveo Analytics logs events for actions performed on the Search Agent component in your Coveo-powered search interface.

This article provides instructions on how to create custom dimensions in your Coveo organization to track Search Agent usage analytics events, and provides a reference for the Search Agent events that are tracked by Coveo Analytics.

Note

For complete implementation steps for the Coveo Search Agent, see Search Agent implementation overview.

Add custom dimensions

In order for Coveo Analytics to track and log events for actions performed on the Search Agent component, you must add a custom c_answergenerated dimension to your Coveo organization.

Add a dimension, and use the following criteria to create the custom dimension:

  • Make sure that Semi-structured dimension is disabled.

  • Under API name, enter c_answergenerated.

  • Type must be set to Text.

  • 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

Create Search Agent report

You can quickly create a report to analyze the performance of your Search Agent implementation by using the preconfigured Generative Answering Performance dashboard template.

  1. If you haven’t done so already, add the custom dimensions to your Coveo organization.

  2. Add a dashboard using the Generative Answering Performance template.

Search Agent analytics events

This section lists the custom Coveo Analytics events for the Search Agent.

Value Event

  • eventType: generatedAnswer

  • eventValue: generatedAnswerStreamEnd

The answer was successfully streamed in the search interface. This event won’t be logged if the user initiates another search while the answer is being generated.

In customData:
answerGenerated: true

An answer was successfully generated for the query.

In customData:
answerGenerated: false

An answer wasn’t generated for the query because there wasn’t enough relevant information to generate an answer.

Note

If an answer wasn’t generated due to an empty query, empty search results, or an error, no event is logged.

  • 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 citation link was clicked.

Note

As of the Coveo Headless v3 release, citation clicks are tracked as regular click events instead of custom click events. As a result, citation click events now have a click rank value of 1. Additionally, the click Event Cause value is set to generatedAnswerCitationClick.

  • 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.

  • 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.

  • 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.

  • 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.

  • eventType: generatedAnswer

  • eventValue: generatedAnswerHideAnswers

  • In customData:

    • generativeQuestionAnsweringID: The ID of the generated answer.

A user closed (hid) the Search Agent component.

  • eventType: generatedAnswer

  • eventValue: generatedAnswerShowAnswers

  • In customData:

    • generativeQuestionAnsweringID: The ID of the generated answer.

A user opened (showed) the Search Agent component.

Inspect your search page

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

  1. Open a Coveo-powered search interface that uses the Search Agent.

  2. Open your web browser’s developer tools.

    Note

    This article uses the Google Chrome developer tools. For browser-specific information, see:

  3. Select the Network tab.

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

  5. Perform an action in the Search Agent component.

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

  7. Select the Payload tab. You should now see the tracked Coveo Analytics events.