Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(genQA): new RGA UA events added to the search page client #438

Merged
merged 7 commits into from
Oct 10, 2023

Conversation

mmitiche
Copy link
Contributor

@mmitiche mmitiche commented Oct 5, 2023

SFINT-5206

The following events has been added:

Custom events:

  • generatedAnswerCitationHover
  • generatedAnswerCopyToClipboard
  • generatedAnswerHideAnswers
  • generatedAnswerShowAnswers
  • generativeQuestionFeedbackSubmit

Search events:

  • rephraseGeneratedAnswer

Added the ability to send generated answer metadata in all the Search UA events by adding a new function getGeneratedAnswerMetadata to the SearchPageClientProvider:

example of adding the fields showGeneratedAnswer and generatedAnswerFormat:

ExampleSearch

The events are documented here: UA events schemas- GenAI v2

@mmitiche mmitiche marked this pull request as ready for review October 5, 2023 19:24
@mmitiche mmitiche requested review from fvanham-coveo and a team as code owners October 5, 2023 19:24
Copy link
Contributor

@SimonMilord SimonMilord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

Copy link
Contributor

@erocheleau erocheleau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some questions / suggestions

src/searchPage/searchPageEvents.ts Outdated Show resolved Hide resolved
src/searchPage/searchPageEvents.ts Outdated Show resolved Hide resolved
src/searchPage/searchPageEvents.ts Outdated Show resolved Hide resolved
src/searchPage/searchPageClient.ts Outdated Show resolved Hide resolved
src/searchPage/searchPageClient.ts Outdated Show resolved Hide resolved
@jmprovencher
Copy link
Collaborator

Don't we think that generatedAnswerCitationHover might generate a little bit too much data and does it actually provides us with any clear insight ?

@nathanlb
Copy link
Contributor

Don't we think that generatedAnswerCitationHover might generate a little bit too much data and does it actually provides us with any clear insight ?

It's there because hovering over the citation will show a popup with the relevant document snippet inside and we want to see if it is read.
We'll put it on a debounce timer so it should only trigger an event when the hovering lasted a second or two.

@jmprovencher
Copy link
Collaborator

Don't we think that generatedAnswerCitationHover might generate a little bit too much data and does it actually provides us with any clear insight ?

It's there because hovering over the citation will show a popup with the relevant document snippet inside and we want to see if it is read. We'll put it on a debounce timer so it should only trigger an event when the hovering lasted a second or two.

Should we allow more than one hover events per generated answer?

@nathanlb
Copy link
Contributor

Don't we think that generatedAnswerCitationHover might generate a little bit too much data and does it actually provides us with any clear insight ?

It's there because hovering over the citation will show a popup with the relevant document snippet inside and we want to see if it is read. We'll put it on a debounce timer so it should only trigger an event when the hovering lasted a second or two.

Should we allow more than one hover events per generated answer?

Each generated answer can have up to 5 citations and each citation will be hover-able. I don't think capping it makes sense. Given the hover needs to be for a "meaningful" amount of time for the event to be sent, I doubt it'll be accidentally abused.

@felixpelletier
Copy link

Don't we think that generatedAnswerCitationHover might generate a little bit too much data and does it actually provides us with any clear insight ?

It's there because hovering over the citation will show a popup with the relevant document snippet inside and we want to see if it is read. We'll put it on a debounce timer so it should only trigger an event when the hovering lasted a second or two.

Should we allow more than one hover events per generated answer?

Each generated answer can have up to 5 citations and each citation will be hover-able. I don't think capping it makes sense. Given the hover needs to be for a "meaningful" amount of time for the event to be sent, I doubt it'll be accidentally abused.

Yep. To be clear, we're looking at new ways to track whether customers "click" on documents (because they might not not that there's answers). We think that customers hovering of citations may be a sign of the customer needing more insight, but the info in the citation hover being good enough (there's nothing in the citation hover today, but there could very well be. We heard that as an idea several times). Could be a cue to indicate the answer is suboptimal but the content is good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants