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

AI Assistant Management Plugin + Knowledge Base Management #171933

Merged
merged 63 commits into from
Dec 5, 2023

Conversation

CoenWarmer
Copy link
Contributor

@CoenWarmer CoenWarmer commented Nov 24, 2023

Summary

This PR adds a bunch of plugins to help manage AI Assistant Management settings.

It offers a 'selection' plugin inside Stack Management where a user can select which AI Assistant she wants to manage.
The Security team can hook into this one, so settings for both AI Assistants can be accessed from inside one place inside Stack Management.

This PR also adds the plugin to manage settings for the AI Assistant for Observability, including Knowledge Base management. This plugin is available both in Stack Management (stateful) and Project Settings (serverless).

What it looks like

Screen.Recording.2023-11-24.at.17.17.09_high.mov

Detailed

  1. Adds a Stack Management plugin (/src/plugins/ai_assistant_management/selection). Its primary function is to render a selection screen to help users navigate to the settings plugin for the AI Assistant for a specific solution. This plugin is displayed in Stack Management, which is only available in stateful versions of Kibana.

  2. Adds a AI Assistant for Observability Settings plugin (/src/plugins/ai_assistant_management/observability). This plugin allows management of specific Observability AI Assistant settings. It is available in stateful versions of Kibana (via the aforementioned Stack Management plugin) or in serverless versions via Project Management.

  3. Knowledge Base management for Observability AI Assistant: The AI Assistant for Observability Settings plugin has a Knowledge Base tab, which allows users to add / read / update / delete and bulk import entries into the Knowledge Base of the Observability AI Assistant.

  4. Moving of KB endpoints in Observability AI Assistant plugin: KB endpoints and functions were located in the same folder. As this PR adds new endpoints for the KB for CRUD operations, it also moves the existing ones from the function folder into a dedicated one so there's a clearer distinction between kb and functions.

  5. Adding of GenAI Connector inside Chat Flyout: If the user has admin rights, it is possible to set up a GenAI connector from within the Observability AI Assistant Chat Flyout. This provides a faster and more seamless onboarding experience. If the user does not, she will be redirected to the Settings page.

Bug fixes

  • Fixes chat item styling issues (padding, background color).

How to test

  • Check if the Stack Management plugin works on stateful
  • Check if the AI Assistant Settings plugin works on stateful + serverless
  • Check if CRUD operations on KB work
  • Check if searching on KB entries work
  • Check if its possible to navigate to KB tab directly (app/management/kibana/aiAssistantManagementObservability?tab=knowledge_base)

Todo

  • Add sorting to getEntries
  • Add params for tab routing
  • Add unit tests
  • Add API tests
  • Add fallback for already indexed entries when searching

@CoenWarmer CoenWarmer requested review from a team as code owners November 24, 2023 16:14
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

@CoenWarmer CoenWarmer added the release_note:skip Skip the PR/issue when compiling release notes label Nov 24, 2023
@CoenWarmer CoenWarmer force-pushed the feat/obs-aiassistant-settings-page branch from ac741c8 to e4a86ad Compare December 4, 2023 13:50
}
if (
category.entries.length === 1 &&
category.entries[0].role === 'assistant_summarization'
Copy link
Contributor Author

@CoenWarmer CoenWarmer Dec 4, 2023

Choose a reason for hiding this comment

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

If you are wondering, 'why not use the enum from Obs AI Assistant?'

Module not found: Error: import [@kbn/observability-ai-assistant-plugin/public] references a public export of the [observabilityAIAssistant] bundle, but that bundle is not in the "requiredPlugins" or "requiredBundles" list in the plugin manifest [/Users/coenwarmer/Dev/kibana2/src/plugins/ai_assistant_management/observability/kibana.jsonc]

and due to OSS plugins not being able to require xpack plugins, the plugin can't be included in requiredPlugins

@CoenWarmer CoenWarmer enabled auto-merge (squash) December 5, 2023 16:10
@dgieselaar
Copy link
Member

@elasticmachine merge upstream

@CoenWarmer CoenWarmer force-pushed the feat/obs-aiassistant-settings-page branch from 3ed5869 to e99b539 Compare December 5, 2023 19:55
@kibana-ci
Copy link
Collaborator

kibana-ci commented Dec 5, 2023

💔 Build Failed

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
aiAssistantManagementObservability - 76 +76
aiAssistantManagementSelection - 62 +62
observabilityAIAssistant 224 227 +3
total +141

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
aiAssistantManagementObservability - 2 +2
aiAssistantManagementSelection - 2 +2
observabilityAIAssistant 39 86 +47
total +51

Async chunks

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

id before after diff
aiAssistantManagementObservability - 71.1KB +71.1KB
aiAssistantManagementSelection - 50.1KB +50.1KB
apm 3.7MB 3.7MB +8.0B
exploratoryView 203.4KB 203.5KB +8.0B
infra 1.9MB 1.9MB +10.0B
management 75.2KB 75.2KB +53.0B
observability 1.1MB 1.1MB +8.0B
observabilityAIAssistant 209.1KB 202.3KB -6.8KB
profiling 375.3KB 375.4KB +32.0B
securitySolutionServerless 337.8KB 337.8KB +51.0B
synthetics 866.5KB 866.6KB +100.0B
uptime 480.8KB 480.8KB +8.0B
ux 168.9KB 168.9KB +8.0B
total +114.7KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
observabilityAIAssistant 7 9 +2

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
aiAssistantManagementObservability - 4.2KB +4.2KB
aiAssistantManagementSelection - 4.1KB +4.1KB
apm 36.7KB 36.7KB +8.0B
infra 103.0KB 103.0KB +10.0B
logsShared 221.1KB 221.1KB +18.0B
management 13.8KB 13.9KB +79.0B
observabilityAIAssistant 10.6KB 15.7KB +5.2KB
serverlessObservability 64.6KB 65.0KB +471.0B
serverlessSearch 54.0KB 54.0KB +51.0B
synthetics 19.6KB 19.7KB +54.0B
total +14.2KB
Unknown metric groups

API count

id before after diff
aiAssistantManagementObservability - 2 +2
aiAssistantManagementSelection - 2 +2
observabilityAIAssistant 42 91 +49
total +53

async chunk count

id before after diff
aiAssistantManagementObservability - 1 +1
aiAssistantManagementSelection - 1 +1
total +2

ESLint disabled line counts

id before after diff
aiAssistantManagementObservability - 4 +4
aiAssistantManagementSelection - 3 +3
total +7

Total ESLint disabled count

id before after diff
aiAssistantManagementObservability - 4 +4
aiAssistantManagementSelection - 3 +3
total +7

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@jbudz
Copy link
Member

jbudz commented Dec 5, 2023

Merging now.

Synthetics tests are failing upstream - see https://buildkite.com/elastic/kibana-on-merge-unsupported-ftrs/builds?branch=main. If there's any concerns please reach out.

@jbudz jbudz disabled auto-merge December 5, 2023 22:07
@jbudz jbudz merged commit 7d990cf into elastic:main Dec 5, 2023
@kibanamachine kibanamachine added v8.12.0 backport:skip This commit does not require backporting labels Dec 5, 2023
@justinkambic justinkambic mentioned this pull request Dec 6, 2023
10 tasks
justinkambic added a commit that referenced this pull request Dec 6, 2023
## Summary

Recently, #171933 introduced a
notion of `QueryClientProvider` to observability. It seems like we might
need to include this also in our rule wrapper, as it is perhaps rendered
outside of the tree in question and doesn't play nice, perhaps as a
result of lazy loading.

Strangely I cannot repro this failure locally. Here's an example build
failure though:
https://buildkite.com/elastic/kibana-pull-request/builds/182158#018c3f75-d7c8-42a6-ac6c-0c30f66fe54c

~This initial patch might not resolve the issue, in which case I'll ping
others to assist.~

This seems to have un-broken the tests.

### Checklist

Delete any items that are not applicable to this PR.

- [ ] 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/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces—unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes—Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
@paulb-elastic paulb-elastic added Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability and removed Team:uptime labels Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:review backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:APM All issues that need APM UI Team support Team:obs-ux-management Observability Management User Experience Team Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v8.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.