Add discover summary error info and button click logic enhancement #8352

chishui · 2024-09-26T03:58:15Z

Description

Improve some logic for discover query assist summary.

Display error info when agent returns exception
after click thumbup/thumbdown buttons, the other button would be hidden.

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

Signed-off-by: Liyun Xiu <[email protected]>

github-actions · 2024-09-26T03:58:46Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

Signed-off-by: Liyun Xiu <[email protected]>

github-actions · 2024-09-26T04:02:58Z

❌ Empty Changelog Section

The Changelog section in your PR description is empty. Please add a valid changelog entry or entries. If you did add a changelog entry, check to make sure that it was not accidentally included inside the comment block in the Changelog section.

codecov · 2024-09-26T04:17:35Z

Codecov Report

Attention: Patch coverage is 83.33333% with 3 lines in your changes missing coverage. Please review.

Project coverage is 60.93%. Comparing base (58e1645) to head (ab3c2e1).
Report is 17 commits behind head on main.

Files with missing lines	Patch %	Lines
...c/query_assist/components/query_assist_summary.tsx	83.33%	0 Missing and 3 partials ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8352   +/-   ##
=======================================
  Coverage   60.93%   60.93%           
=======================================
  Files        3767     3767           
  Lines       89387    89394    +7     
  Branches    13985    13989    +4     
=======================================
+ Hits        54471    54476    +5     
  Misses      31519    31519           
- Partials     3397     3399    +2

Flag	Coverage Δ
Linux_1	`28.95% <ø> (ø)`
Linux_2	`56.25% <ø> (ø)`
Linux_3	`37.75% <ø> (+<0.01%)`	⬆️
Linux_4	`29.92% <83.33%> (+<0.01%)`	⬆️
Windows_1	`28.97% <ø> (ø)`
Windows_2	`56.20% <ø> (ø)`
Windows_3	`37.75% <ø> (ø)`
Windows_4	`29.92% <83.33%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

kavilla

i like this feature. it's cool to see. some questions and suggestions

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

kavilla · 2024-09-26T22:59:21Z

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

 export const QueryAssistSummary: React.FC<QueryAssistSummaryProps> = (props) => {
  const { query, search } = props.data;
-  const [summary, setSummary] = useState(null); // store fetched data


do we know for sure the summary will never be ''. null for me implies no summary was retrieved where as if the summary was an empty string the user might not be able to give feedback on the summary even though the information can be used to capture cases where query assist didn't output any summary.

In case LLM fails to generate summary, we would render an error message. But if LLM is able to generate summary, I believe there's always some outputs.

kavilla · 2024-09-26T23:00:56Z

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

@@ -76,6 +82,9 @@ export const QueryAssistSummary: React.FC<QueryAssistSummaryProps> = (props) =>
    defaultMessage:
      'Thank you for the feedback. Try again by adjusting your question so that I have the opportunity to better assist you.',
  });
+  const errorPrompt = i18n.translate('queryEnhancements.queryAssist.summary.errorPrompt', {


should we consider adding : Try again by adjusting your question so that I have the opportunity to better assist you.

Or do we have an error message that we can display to the user for more insight?

Some errors are not caused by questions, it might be frustrating when there's backend issue but we keep asking users to change questions.

kavilla · 2024-09-26T23:02:13Z

does this go to 2.18? 2.17 next?

cc: @joshuali925 @ashwin-pc

kavilla · 2024-09-26T23:05:25Z

@chishui @ruanyl @joshuali925 @opensearch-project/opensearch-ux should we add a retry button?

does query assist support retries with the context that the user didn't think the summary was good enough and will try again? or will it just give back the same summary

chishui · 2024-09-27T00:10:27Z

@chishui @ruanyl @joshuali925 @opensearch-project/opensearch-ux should we add a retry button?

does query assist support retries with the context that the user didn't think the summary was good enough and will try again? or will it just give back the same summary

We'll have a new UI which is to add such button to regenerate summary, will make change once receives new design.

Signed-off-by: Liyun Xiu <[email protected]>

ashwin-pc · 2024-09-27T18:22:08Z

Lets add discover-next and 2.18 version labels to all these discover changes. Make sure to backport them to 2.x as well

chishui · 2024-09-30T08:49:46Z

@kavilla @ruanyl @ashwin-pc if you guys have no other questions on this PR, could you help approve?

chishui · 2024-10-08T06:06:10Z

@kavilla could you review this PR again? It's been a while, thanks

Hailong-am · 2024-10-12T03:00:27Z

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx

+                      onClick={() => onFeedback(true)}
+                      data-test-subj="queryAssist_summary_buttons_thumbup"


can we disable the button when feedback === FeedbackStatus.THUMB_UP, so that we don't need to check if (feedback !== FeedbackStatus.NONE) return; for onFeedback()

…8352) * Add discover summary error info and button click logic enhancement Signed-off-by: Liyun Xiu <[email protected]> * add changelog Signed-off-by: Liyun Xiu <[email protected]> * Address comments Signed-off-by: Liyun Xiu <[email protected]> --------- Signed-off-by: Liyun Xiu <[email protected]> (cherry picked from commit c4049eb) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…8352) (#8568) * Add discover summary error info and button click logic enhancement * add changelog * Address comments --------- (cherry picked from commit c4049eb) Signed-off-by: Liyun Xiu <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…pensearch-project#8352) * Add discover summary error info and button click logic enhancement Signed-off-by: Liyun Xiu <[email protected]> * add changelog Signed-off-by: Liyun Xiu <[email protected]> * Address comments Signed-off-by: Liyun Xiu <[email protected]> --------- Signed-off-by: Liyun Xiu <[email protected]>

Add discover summary error info and button click logic enhancement

e51b7fc

Signed-off-by: Liyun Xiu <[email protected]>

github-actions bot added the repeat-contributor label Sep 26, 2024

github-actions bot added the failed changeset label Sep 26, 2024

add changelog

d8fa9cc

Signed-off-by: Liyun Xiu <[email protected]>

ruanyl added the backport 2.x label Sep 26, 2024

ruanyl previously approved these changes Sep 26, 2024

View reviewed changes

kavilla reviewed Sep 26, 2024

View reviewed changes

src/plugins/query_enhancements/public/query_assist/components/query_assist_summary.tsx Outdated Show resolved Hide resolved

kavilla reviewed Sep 26, 2024

View reviewed changes

kavilla added the discover for discover reinvent label Sep 26, 2024

Address comments

1b5b3a0

Signed-off-by: Liyun Xiu <[email protected]>

chishui dismissed ruanyl’s stale review via 1b5b3a0 September 27, 2024 00:20

ashwin-pc added discover-next v2.18.0 and removed discover for discover reinvent labels Sep 27, 2024

kavilla added the discover for discover reinvent label Sep 30, 2024

chishui added 2 commits October 2, 2024 10:58

Merge branch 'main' into main

b6d7882

Merge branch 'main' into main

ab3c2e1

ruanyl approved these changes Oct 8, 2024

View reviewed changes

Hailong-am approved these changes Oct 12, 2024

View reviewed changes

ruanyl merged commit c4049eb into opensearch-project:main Oct 12, 2024
68 checks passed

opensearch-trigger-bot bot mentioned this pull request Oct 12, 2024

[Backport 2.x] Add discover summary error info and button click logic enhancement #8568

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add discover summary error info and button click logic enhancement #8352

Add discover summary error info and button click logic enhancement #8352

chishui commented Sep 26, 2024 •

edited

Loading

github-actions bot commented Sep 26, 2024

github-actions bot commented Sep 26, 2024

codecov bot commented Sep 26, 2024 •

edited

Loading

kavilla left a comment

kavilla Sep 26, 2024

chishui Sep 27, 2024

kavilla Sep 26, 2024

chishui Sep 27, 2024

kavilla commented Sep 26, 2024

kavilla commented Sep 26, 2024

chishui commented Sep 27, 2024

ashwin-pc commented Sep 27, 2024

chishui commented Sep 30, 2024

chishui commented Oct 8, 2024

Hailong-am Oct 12, 2024

		onClick={() => onFeedback(true)}
		data-test-subj="queryAssist_summary_buttons_thumbup"

Add discover summary error info and button click logic enhancement #8352

Add discover summary error info and button click logic enhancement #8352

Conversation

chishui commented Sep 26, 2024 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

github-actions bot commented Sep 26, 2024

❌ Empty Changelog Section

github-actions bot commented Sep 26, 2024

❌ Empty Changelog Section

codecov bot commented Sep 26, 2024 • edited Loading

Codecov Report

kavilla left a comment

Choose a reason for hiding this comment

kavilla Sep 26, 2024

Choose a reason for hiding this comment

chishui Sep 27, 2024

Choose a reason for hiding this comment

kavilla Sep 26, 2024

Choose a reason for hiding this comment

chishui Sep 27, 2024

Choose a reason for hiding this comment

kavilla commented Sep 26, 2024

kavilla commented Sep 26, 2024

chishui commented Sep 27, 2024

ashwin-pc commented Sep 27, 2024

chishui commented Sep 30, 2024

chishui commented Oct 8, 2024

Hailong-am Oct 12, 2024

Choose a reason for hiding this comment

chishui commented Sep 26, 2024 •

edited

Loading

codecov bot commented Sep 26, 2024 •

edited

Loading