[Obs AI Assistant] Display warning banner when re-indexing is in progress by SrdjanLL · Pull Request #222593 · elastic/kibana

SrdjanLL · 2025-06-04T15:09:50Z

Summary

This PR adds a warning callout to the Assistant Page, Flyout and Knowledge Base tab, to make users aware when knowledge base is re-indexing.

This will help avoid users' worry that their data is lost since it's not always shown during re-indexing.

The banner relies on the isReIndexing flag from the knowledge base status. Once the state changes to isReIndexing=false, the banner disappears.

Screenshots

When shown simultaneously with Elastic Managed LLM Callout

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
[] Flaky Test Runner was used on any tests changed -I'm not sure about this one - let me know if there are any related tests I should execute here.
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

github-actions · 2025-06-04T15:10:08Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

viduni94

Thanks for the PR @SrdjanLL

I am wondering whether we should display this callout on the flyout and the AI Assistant page as well. Because when the user interacts with the AI Assistant, they'd expect the KB entries they have to be taken into account in the responses. And if some entries are unavailable they might not get the expected answer. They may or may not go to the knowledge base tab to verify this.

Any thoughts @sorenlouv ?

elasticmachine · 2025-06-04T15:36:08Z

Pinging @elastic/obs-ai-assistant (Team:Obs AI Assistant)

isaclfreire · 2025-06-04T17:36:31Z

Agreed with @viduni94 proposal to show this also in the AI Assistant page

SrdjanLL · 2025-06-05T09:16:15Z

Thanks for the feedback @viduni94 and @isaclfreire - makes sense to me and if that's the agreed addition, I'll include it in this PR.

SrdjanLL · 2025-06-05T12:54:42Z

Team, you will notice that the text alignment is different depending on whether the callout is rendered in the knowledge base tab or in the conversation with assistant, due to the style of parent component (as defined here).

I didn't want to on about manipulating CSS or existing UI components in my first PR without getting your thoughts.

Options:

Leave as is (centrally aligned test like other knowledge base content inside the Assistant page/flyout).
Make callout text left-align like in the knowledge base tab. This would require making some changes to the existing WelcomeMessage component and playing with CSS a bit more - I tried a bit and nothing I thought of felt nice.

Let me know your thoughts and whether it's ok to keep the callout in the assistant page as is.

viduni94 · 2025-06-05T20:08:35Z

...tform/packages/shared/kbn-ai-assistant/src/knowledge_base/welcome_message_knowledge_base.tsx

+      return (
+        <EuiFlexGroup justifyContent="center" gutterSize="s">
+          <EuiFlexItem grow>
+            <EuiCallOut


Can you extract this callout to a re-usable component and use it in here and in settings?

Sure, thanks for pointing out.
I thought that makes sense too, but then the namespaces seemed different and I sort of kept separate and leave for feedback.

viduni94

@isaclfreire could you confirm whether the design for the flyout and page is okay?

I feel like it should appear above the logo (similar to the EIS callout) and wondering whether it should be sticky? Open to hear your thoughts.

SrdjanLL · 2025-06-06T11:35:25Z

I feel like it should appear above the logo (similar to the EIS callout) and wondering whether it should be sticky? Open to hear your thoughts.

@viduni94 - any suggestions on how to reproduce the EIS callout? I traversed the component tree up to find it, but didn't have much luck.

I've extracted the reindexing callout into a shareable component as per your suggestion though :)

viduni94 · 2025-06-06T13:41:13Z

I feel like it should appear above the logo (similar to the EIS callout) and wondering whether it should be sticky? Open to hear your thoughts.

@viduni94 - any suggestions on how to reproduce the EIS callout? I traversed the component tree up to find it, but didn't have much luck.

I've extracted the reindexing callout into a shareable component as per your suggestion though :)

Hey @SrdjanLL
The EIS callout is not merged yet. But you can see some screenshots here - #220782 (the blue callout within the conversation).
Before changing anything let's wait for @isaclfreire's input.

SrdjanLL · 2025-06-06T14:12:35Z

Ahh, thanks for sharing the PR @viduni94 - looks like a good option as well.

Sounds good, let us know what you think @isaclfreire :)

sorenlouv · 2025-06-10T08:24:21Z

Thanks for the PR @SrdjanLL

I am wondering whether we should display this callout on the flyout and the AI Assistant page as well. Because when the user interacts with the AI Assistant, they'd expect the KB entries they have to be taken into account in the responses. And if some entries are unavailable they might not get the expected answer. They may or may not go to the knowledge base tab to verify this.

Any thoughts @sorenlouv ?

Sounds good to me 👍

sorenlouv · 2025-06-10T08:29:03Z

I feel like it should appear above the logo (similar to the EIS callout) and wondering whether it should be sticky? Open to hear your thoughts.

Imo it should be sticky (aka non-dismissible) because that's simpler to implement and it will automatically disappear when re-indexing completes. This also provides the user with insights into whether the re-indexing operation somehow got stuck. We do not show or handle that anywhere else.

isaclfreire · 2025-06-10T08:54:46Z

@isaclfreire could you confirm whether the design for the flyout and page is okay?

I feel like it should appear above the logo (similar to the EIS callout) and wondering whether it should be sticky? Open to hear your thoughts.

I think we should keep callouts consistent so above the logo is the way to go. The EIS callout is sticky right? If so, I would keep the same experience. Nice catch 👍

SrdjanLL · 2025-06-10T09:06:15Z

@isaclfreire thanks for the feedback - I'll implement the callout above the logo!

Looks like the EIS callout is not sticky though. Adding it here from Viduni's PR for visibility:

For the reasons @sorenlouv mentioned above, think it might be worth going with sticky callout here even if it's different to EIS:

Because that's simpler to implement and it will automatically disappear when re-indexing completes. This also provides the user with insights into whether the re-indexing operation somehow got stuck.

Feel free to let me know if you disagree 🙂

isaclfreire · 2025-06-10T10:01:17Z

LGTM 👍

viduni94 · 2025-06-10T10:59:46Z

Looks like the EIS callout is not sticky though. Adding it here from Viduni's PR for visibility:

@SrdjanLL The EIS callout is sticky.

sorenlouv · 2025-06-10T11:12:27Z

Looks like the EIS callout is not sticky though. Adding it here from Viduni's PR for visibility:

@SrdjanLL The EIS callout is sticky.

What does "sticky" mean here? I originally thought it meant "non-dismissible" but I see the close icon (X). Does "sticky" refer to the banner being a "sticky header" that remains fixed at the top of the viewport as a user scrolls down?

viduni94 · 2025-06-10T11:54:37Z

What does "sticky" mean here? I originally thought it meant "non-dismissible" but I see the close icon (X). Does "sticky" refer to the banner being a "sticky header" that remains fixed at the top of the viewport as a user scrolls down?

@sorenlouv

Does "sticky" refer to the banner being a "sticky header" that remains fixed at the top of the viewport as a user scrolls down

Yes

The EIS callout is dismissible, but I think the re-indexing callout should be non-dismissible

SrdjanLL · 2025-06-10T11:59:17Z

Ahh, I see. I initially interpreted "sticky" the same way @sorenlouv did. I'll make sure the callout is bot non-dismissible and sticky. Thanks @viduni94 and apologies for the confusion.

…tent with Elastic LLM callout that can appear simultaneously

…efinition for the comment list

…s for new users.

SrdjanLL · 2025-06-12T11:10:50Z

When I installed the KB for the first time from the AI Assistant flyout, the re-indexing callout appeared for a few seconds and disappeared. This is probably because the backend sends re-indexing as true because a lock gets activated and released. This seems a little confusing because the callout says Some entries will be unavailable until the operation completes. I'm wondering whether we should update it to say something like, if you have entries in the KB some may not be available while re-indexing.. otherwise it feels like I'm missing some entries that I didn't have in the first place.

Thank you for spotting this @viduni94 . Does it happen after installation or the users already see installation as complete? I've also not been able to reproduce locally so will wait on the new serverless deployment to complete before trying to see.

I have provisionally updated the wording to:

Knowledge base is currently being re-indexed. If you have entries, some may be unavailable until the operation completes.

Let me know if that sounds all right and I will also ask @isaclfreire for feedback.

isaclfreire · 2025-06-12T12:20:27Z

When I installed the KB for the first time from the AI Assistant flyout, the re-indexing callout appeared for a few seconds and disappeared. This is probably because the backend sends re-indexing as true because a lock gets activated and released. This seems a little confusing because the callout says Some entries will be unavailable until the operation completes. I'm wondering whether we should update it to say something like, if you have entries in the KB some may not be available while re-indexing.. otherwise it feels like I'm missing some entries that I didn't have in the first place.

Thank you for spotting this @viduni94 . Does it happen after installation or the users already see installation as complete? I've also not been able to reproduce locally so will wait on the new serverless deployment to complete before trying to see.

I have provisionally updated the wording to:
Knowledge base is currently being re-indexed. If you have entries, some may be unavailable until the operation completes.
Let me know if that sounds all right and I will also ask @isaclfreire for feedback.

Agree with specifying in the copy. The proposal LGTM!

elasticmachine · 2025-06-12T14:27:02Z

💚 Build Succeeded

Buildkite Build
Commit: 9edbb0f
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-222593-9edbb0f96603

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`observabilityAIAssistantApp`	316	317	+1
`observabilityAiAssistantManagement`	260	261	+1
`searchAssistant`	147	148	+1
total			+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`observabilityAIAssistantApp`	174.8KB	175.8KB	+1.0KB
`observabilityAiAssistantManagement`	96.8KB	97.5KB	+660.0B
`searchAssistant`	101.1KB	102.1KB	+1.0KB
total			+2.7KB

History

💚 Build #307811 succeeded fd4a2b3
💔 Build #307789 failed cbb0246
💚 Build #307384 succeeded 4a0fd87
💚 Build #307201 succeeded 8ac1f07
💚 Build #307012 succeeded 5d01088

viduni94 · 2025-06-12T16:42:50Z

I spotted this in the serverless deployment, and I couldn't record it. And now I'm unable to reset the KB to re-do that flow. Once you push another commit to this branch, it'll re-trigger a serverless deployment and should be able to reproduce there.

Here's the video that I couldn't capture before

Screen.Recording.2025-06-12.at.12.41.58.PM.mov

viduni94

LGTM

viduni94 · 2025-06-12T16:45:15Z

x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx

    tourCalloutDismissed;

+  const showKnowledgeBaseReIndexingCallout =
+    knowledgeBase.status.value?.enabled === true &&


nit:

Suggested change

knowledgeBase.status.value?.enabled === true &&

knowledgeBase.status.value?.enabled &&

These changes cause amguous type errors: Type 'boolean | undefined' is not assignable to type 'boolean' for the flag, so I hope it's all right to leave as is :)

viduni94 · 2025-06-12T16:45:27Z

x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx

+  const showKnowledgeBaseReIndexingCallout =
+    knowledgeBase.status.value?.enabled === true &&
+    knowledgeBase.status.value?.kbState === KnowledgeBaseState.READY &&
+    knowledgeBase.status.value?.isReIndexing === true;


nit:

Suggested change

knowledgeBase.status.value?.isReIndexing === true;

knowledgeBase.status.value?.isReIndexing;

kibanamachine · 2025-06-13T11:29:07Z

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15633478751

kibanamachine · 2025-06-13T11:35:40Z

💔 All backports failed

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts You might need to backport the following PRs to 8.19: - [Obs AI Assistant] Anonymization support (#223351)

Manual backport

To create the backport manually run:

node scripts/backport --pr 222593

Questions ?

Please refer to the Backport tool documentation

SrdjanLL · 2025-06-13T13:06:46Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…in progress (#222593) (#223906) # Backport This will backport the following commits from `main` to `8.19`: - [[Obs AI Assistant] Display warning banner when re-indexing is in progress (#222593)](#222593)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…ress (elastic#222593) Closes elastic#221837 ## Summary This PR adds a warning callout to the Assistant Page, Flyout and Knowledge Base tab, to make users aware when knowledge base is re-indexing. This will help avoid users' worry that their data is lost since it's not always shown during re-indexing. The banner relies on the `isReIndexing` flag from the knowledge base status. Once the state changes to `isReIndexing=false`, the banner disappears. ### Screenshots <img width="1481" alt="image" src="https://github.com/user-attachments/assets/b56f4d7a-ce97-4c33-a80f-4ce342f3e8b7" /> <img width="1725" alt="image" src="https://github.com/user-attachments/assets/38d63042-df9c-4d8b-9963-606cd076a67a" /> <img width="1481" alt="image" src="https://github.com/user-attachments/assets/32908997-dfcc-4162-9103-f07ed21c27eb" /> #### When shown simultaneously with Elastic Managed LLM Callout <img width="1481" alt="image" src="https://github.com/user-attachments/assets/45bb49ec-149f-446a-ad1b-6773a08d8c95" /> ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed -**I'm not sure about this one - let me know if there are any related tests I should execute here**. - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

SrdjanLL requested a review from a team as a code owner June 4, 2025 15:09

SrdjanLL added the release_note:enhancement label Jun 4, 2025

botelastic bot added the ci:project-deploy-observability Create an Observability project label Jun 4, 2025

SrdjanLL added backport:version Backport to applied version labels v9.1.0 v8.19.0 labels Jun 4, 2025

viduni94 reviewed Jun 4, 2025

View reviewed changes

viduni94 added the Team:Obs AI Assistant Observability AI Assistant label Jun 4, 2025

SrdjanLL requested a review from a team as a code owner June 5, 2025 12:29

SrdjanLL changed the title ~~[Obs AI Assistant] Display warning banner in knowledge base tab when re-indexing is in progress~~ [Obs AI Assistant] Display warning banner when re-indexing is in progress Jun 5, 2025

SrdjanLL requested a review from viduni94 June 5, 2025 12:58

viduni94 reviewed Jun 5, 2025

View reviewed changes

SrdjanLL added 7 commits June 12, 2025 11:42

Add return type to the test_helper render function

90d4d67

Extract re-indexing callout into a shared component

7b2cc38

Move re-indexing callout to the top of the welcome message

fe836a4

Add re-indexing callout to the chat timeline

e273bfe

Fix variable name for showKnowledgeBaseReIndexingCallout

5d6ff81

Update styling of the re-indexing callout to be compatible and consis…

e5c0537

…tent with Elastic LLM callout that can appear simultaneously

Move re-indexing callout flag to the parent component and fix style d…

17416fa

…efinition for the comment list

SrdjanLL force-pushed the kb-reindexing-banner branch from 4a0fd87 to 17416fa Compare June 12, 2025 10:42

Update the callout wording to make reduce confusion in case it appear…

cbb0246

…s for new users.

Update tests

fd4a2b3

Move eui comment styling outside of the ChatTimeline component

9edbb0f

SrdjanLL force-pushed the kb-reindexing-banner branch from 37b1526 to 9edbb0f Compare June 12, 2025 13:20

viduni94 approved these changes Jun 12, 2025

View reviewed changes

SrdjanLL added v8.18.3 v9.0.3 release_note:skip Skip the PR/issue when compiling release notes and removed release_note:enhancement v9.0.3 v8.18.3 labels Jun 13, 2025

SrdjanLL merged commit 1d2ab08 into elastic:main Jun 13, 2025
19 checks passed

SrdjanLL mentioned this pull request Jun 13, 2025

[8.19] [Obs AI Assistant] Display warning banner when re-indexing is in progress (#222593) #223906

Merged

	knowledgeBase.status.value?.enabled === true &&
	knowledgeBase.status.value?.enabled &&

	knowledgeBase.status.value?.isReIndexing === true;
	knowledgeBase.status.value?.isReIndexing;

Conversation

SrdjanLL commented Jun 4, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Screenshots

When shown simultaneously with Elastic Managed LLM Callout

Checklist

Uh oh!

github-actions bot commented Jun 4, 2025

🤖 GitHub comments

Uh oh!

viduni94 left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jun 4, 2025

Uh oh!

isaclfreire commented Jun 4, 2025

Uh oh!

SrdjanLL commented Jun 5, 2025

Uh oh!

SrdjanLL commented Jun 5, 2025

Uh oh!

viduni94 Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

SrdjanLL Jun 5, 2025

Choose a reason for hiding this comment

Uh oh!

viduni94 left a comment

Choose a reason for hiding this comment

Uh oh!

SrdjanLL commented Jun 6, 2025

Uh oh!

viduni94 commented Jun 6, 2025

Uh oh!

SrdjanLL commented Jun 6, 2025

Uh oh!

sorenlouv commented Jun 10, 2025

Uh oh!

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

Uh oh!

Uh oh!

isaclfreire commented Jun 10, 2025

Uh oh!

SrdjanLL commented Jun 10, 2025

Uh oh!

isaclfreire commented Jun 10, 2025

Uh oh!

viduni94 commented Jun 10, 2025

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

SrdjanLL commented Jun 10, 2025

Uh oh!

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

Uh oh!

Uh oh!

isaclfreire commented Jun 12, 2025

Uh oh!

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

Uh oh!

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

Uh oh!

viduni94 commented Jun 12, 2025

Uh oh!

viduni94 left a comment

Choose a reason for hiding this comment

Uh oh!

viduni94 Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

SrdjanLL Jun 13, 2025

SrdjanLL commented Jun 4, 2025 •

edited by kibanamachine

Loading

sorenlouv commented Jun 10, 2025 •

edited

Loading

sorenlouv commented Jun 10, 2025 •

edited

Loading

viduni94 commented Jun 10, 2025 •

edited

Loading

SrdjanLL commented Jun 12, 2025 •

edited

Loading

elasticmachine commented Jun 12, 2025 •

edited

Loading