[Explore] Add AI summary component in explore plugin #9975

FriedhelmWS · 2025-06-25T07:05:24Z

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

skip

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

codecov · 2025-06-25T07:17:56Z

Codecov Report

Attention: Patch coverage is 3.27869% with 118 lines in your changes missing coverage. Please review.

Please upload report for BASE (query_explore@ac67424). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...mponents/results_summary/results_summary_panel.tsx	2.83%	103 Missing ⚠️
...lic/components/results_summary/results_summary.tsx	6.25%	15 Missing ⚠️

Additional details and impacted files

@@               Coverage Diff                @@
##             query_explore    #9975   +/-   ##
================================================
  Coverage                 ?   60.08%           
================================================
  Files                    ?     4065           
  Lines                    ?   103587           
  Branches                 ?    16456           
================================================
  Hits                     ?    62244           
  Misses                   ?    37212           
  Partials                 ?     4131

Flag	Coverage Δ
Linux_1	`28.00% <ø> (?)`
Linux_2	`41.63% <ø> (?)`
Linux_3	`39.31% <ø> (?)`
Windows_1	`28.01% <ø> (?)`
Windows_2	`41.61% <ø> (?)`
Windows_3	`39.32% <ø> (?)`
Windows_4	`29.42% <3.27%> (?)`

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

kavilla

modifying global styles

kavilla · 2025-06-25T07:25:53Z

src/plugins/explore/public/components/results_summary/results_summary_panel.scss

+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/* stylelint-disable @osd/stylelint/no_modifying_global_selectors */


please avoid doing this if possible. this is so we don't accidentally modify styles globally

if any plugin uses the class resultSummary then we would be modifying them which might be likely.

Hi, I personally think this would be intentional as we want to custom the accordion component (i.e. add buttons to the header). Could you please suggest a better approach without modifying the global style if possible? Thanks!

hey. thanks for the quick response.

for some context the stylelinter was added to prevent visual regression bugs. and resultsSummary seems like it has a high likelihood to change the styling of a component unrelated to this component without the plugin owners knowledge.

we could potentially make this component class name more specific but my rule of thumb has been if its failing the stylelinter then we should revisit the actual ux design.

oui component supports the button in the header if im not mistaken but do you mean the styling? looking at the oui props https://oui.opensearch.org/1.19/#/layout/accordion there should be ability to pass in classNames to the component to style without using global selectors

I’ve updated some of the CSS class names to be more distinctive and to use custom className passing. There are still a few global styles that we can’t work around, but I hope these changes help reduce the risk of future style collisions.

kavilla · 2025-06-25T07:28:35Z

src/plugins/explore/public/components/results_summary/results_summary_panel.tsx

+
+const ACCORDION_STATE_LOCAL_STORAGE_KEY = 'resultsSummary.summaryAccordionState';
+
+export const convertResult = (body: IDataFrame) => {


how come we don't use the proper search functionality?

This is not the search but convert the result data frame to proper JSON object, I think this is only relevant to t2ppl API.

for more context, PPL search essentially does the same. and it's structured like search via
hits.

so to me it looks like we generally treat this feature as search where we could just leverage existing code rather no copy and pasting.

For discover, we retrieve the raw data from an subscribed observable, we actually not doing a search again as all results are relevant, no result will be filter out in this function and it is just simply a utils function to convert result from one format to another.

kavilla · 2025-06-25T07:32:06Z

src/plugins/explore/public/components/results_summary/results_summary.tsx

+import React from 'react';
+import { i18n } from '@osd/i18n';
+
+export enum FeedbackStatus {


ive seen this defined multiple times in this project we shouldn't redefine it if i t can be available at a different place

Could we leave this to a later PR for refactoring? Since this one is only add the component to the page, there would be another PR for fully integrate with t2ppl feature by @ruchidh, add unit test, remove mocks, clean up the code, etc.

kavilla · 2025-06-25T07:41:50Z

src/plugins/explore/public/application/index.tsx


 const renderExploreFlavor = (flavor: ExploreFlavor, props: ExploreComponentProps) => {
  switch (flavor) {
    case ExploreFlavor.Logs:
-      return <LogsPage setHeaderActionMenu={props.setHeaderActionMenu} />;
+      return (
+        <LogsPage setHeaderActionMenu={props.setHeaderActionMenu} dataSetup={props.dataSetup} />


eventually if any access to services and plugins. it would make more sense to use the OpenSearch Dashboards react context

Would it be appropriate to put a setup dependency in the context of explore service?

@FriedhelmWS I think you can use data from the context which is DataPublicPluginStart

Done, sorry for didn't noticed that QueryStart and SearchStart are also valid to be used.

kavilla · 2025-06-25T07:42:31Z

src/plugins/explore/public/components/results_summary/results_summary.tsx

+  loading: boolean;
+  onGenerateSummary: () => void;
+  brandingLabel?: string;
+  sampleSize: number;


are we not respecting the advanced settings sample size

This is the sample size for AI agent so I think it should not be the same sample size we defined in advanced settings. In the future, we can add another setting option for AI-related sample size.

apologies. do you mind explaining more. i assumed the results summary should be the summary on the results provided to the user. the summary utilizes the query from the user right? if so then that should be the sample size from advanced settings

if not regardless of the returned results we are just generating a summary of a static number? if the user gets 10 results, wouldn't it be confusing to display a summary on 100 results because we statically defined it for 100 results.

kavilla · 2025-06-25T22:04:03Z

src/plugins/explore/public/components/results_summary/results_summary_panel.scss

+  &.resultsSummary_accordion {
+    .euiAccordion__triggerWrapper {
+      /* stylelint-disable  @osd/stylelint/no_restricted_values */
+      background: lightOrDarkTheme(linear-gradient(to left, #edf7ff, #f9f4ff), $euiColorEmptyShade);


iif this is absolutely required and there is no SASS variable already then we should define them. as this shouldn't be the only place this is used

Signed-off-by: Owen Wang <owenwyk@amazon.com>

github-actions bot added the seasoned-contributor label Jun 25, 2025

github-actions bot removed the failed changeset label Jun 25, 2025

kavilla requested changes Jun 25, 2025

View reviewed changes

FriedhelmWS force-pushed the owen-explore branch from 705abd4 to 79599ae Compare June 25, 2025 07:22

kavilla reviewed Jun 25, 2025

View reviewed changes

FriedhelmWS force-pushed the owen-explore branch 2 times, most recently from 398af81 to ba667e9 Compare June 25, 2025 08:57

kavilla reviewed Jun 25, 2025

View reviewed changes

FriedhelmWS force-pushed the owen-explore branch 5 times, most recently from b6f604b to 6ba3d6a Compare June 26, 2025 05:02

ruanyl previously approved these changes Jun 26, 2025

View reviewed changes

joshuali925 mentioned this pull request Jun 26, 2025

[RFC] Integrate Automated AI-based Code Reviews #9997

Open

FriedhelmWS added 5 commits June 27, 2025 10:21

Add AI summary component in explore plugin

449f61c

Signed-off-by: Owen Wang <owenwyk@amazon.com>

Add icon for explore results summary

8330407

Signed-off-by: Owen Wang <owenwyk@amazon.com>

Add auto trigger for explore results summary

1464f59

Signed-off-by: Owen Wang <owenwyk@amazon.com>

Improve CSS styles of explore results summary

99fbcb0

Signed-off-by: Owen Wang <owenwyk@amazon.com>

Use dataStart instead of dataSetup

8a51782

Signed-off-by: Owen Wang <owenwyk@amazon.com>

FriedhelmWS dismissed ruanyl’s stale review via 8a51782 June 27, 2025 02:22

FriedhelmWS force-pushed the owen-explore branch from 6ba3d6a to 8a51782 Compare June 27, 2025 02:22

ruanyl approved these changes Jun 27, 2025

View reviewed changes

FriedhelmWS requested a review from kavilla June 27, 2025 04:55

raintygao approved these changes Jun 27, 2025

View reviewed changes

FriedhelmWS closed this Jun 27, 2025


		const ACCORDION_STATE_LOCAL_STORAGE_KEY = 'resultsSummary.summaryAccordionState';

		export const convertResult = (body: IDataFrame) => {

[Explore] Add AI summary component in explore plugin #9975

[Explore] Add AI summary component in explore plugin #9975

Uh oh!

Conversation

FriedhelmWS commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Screenshot

Testing the changes

Changelog

Check List

Uh oh!

codecov bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kavilla left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

FriedhelmWS commented Jun 25, 2025 •

edited

Loading

codecov bot commented Jun 25, 2025 •

edited

Loading