mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 01:13:23 -04:00
b6fe3628e3
# Backport This will backport the following commits from `main` to `8.x`: - [[LLM tasks] Add product documentation retrieval task (#194379)](https://github.com/elastic/kibana/pull/194379) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Pierre Gayvallet","email":"pierre.gayvallet@elastic.co"},"sourceCommit":{"committedDate":"2024-11-19T14:28:26Z","message":"[LLM tasks] Add product documentation retrieval task (#194379)\n\n## Summary\r\n\r\nClose https://github.com/elastic/kibana/issues/193473\r\nClose https://github.com/elastic/kibana/issues/193474\r\n\r\nThis PR utilize the documentation packages that are build via the tool\r\nintroduced by https://github.com/elastic/kibana/pull/193847, allowing to\r\ninstall them in Kibana and expose documentation retrieval as an LLM task\r\nthat AI assistants (or other consumers) can call.\r\n\r\nUsers can now decide to install the Elastic documentation from the\r\nassistant's config screen, which will expose a new tool for the\r\nassistant, `retrieve_documentation` (only implemented for the o11y\r\nassistant in the current PR, shall be done for security as a follow up).\r\n\r\nFor more information, please refer to the self-review.\r\n\r\n## General architecture\r\n\r\n<img width=\"1118\" alt=\"Screenshot 2024-10-17 at 09 22 32\"\r\nsrc=\"https://github.com/user-attachments/assets/3df8c30a-9ccc-49ab-92ce-c204b96d6fc4\">\r\n\r\n## What this PR does\r\n\r\nAdds two plugin:\r\n- `productDocBase`: contains all the logic related to product\r\ndocumentation installation, status, and search. This is meant to be a\r\n\"low level\" components only responsible for this specific part.\r\n- `llmTasks`: an higher level plugin that will contain various LLM tasks\r\nto be used by assistants and genAI consumers. The intent is not to have\r\na single place to put all llm tasks, but more to have a default place\r\nwhere we can introduce new tasks from. (fwiw, the `nlToEsql` task will\r\nprobably be moved to that plugin).\r\n\r\n- Add a `retrieve_documentation` tool registration for the o11y\r\nassistant\r\n- Add a component on the o11y assistant configuration page to install\r\nthe product doc\r\n\r\n(wiring the feature to the o11y assistant was done for testing purposes\r\nmostly, any addition / changes / enhancement should be done by the\r\nowning team - either in this PR or as a follow-up)\r\n\r\n## What is NOT included in this PR:\r\n\r\n- Wire product base feature to the security assistant (should be done by\r\nthe owning team as a follow-up)\r\n - installation\r\n - utilization as tool\r\n\r\n- FTR tests: this is somewhat blocked by the same things we need to\r\nfigure out for https://github.com/elastic/kibana-team/issues/1271\r\n\r\n## Screenshots \r\n\r\n### Installation from o11y assistant configuration page\r\n\r\n<img width=\"1476\" alt=\"Screenshot 2024-10-17 at 09 41 24\"\r\nsrc=\"https://github.com/user-attachments/assets/31daa585-9fb2-400a-a2d1-5917a262367a\">\r\n\r\n### Example of output\r\n\r\n#### Without product documentation installed \r\n\r\n<img width=\"739\" alt=\"Screenshot 2024-10-10 at 09 59 41\"\r\nsrc=\"https://github.com/user-attachments/assets/993fb216-6c9a-433f-bf44-f6e383d20d9d\">\r\n\r\n#### With product documentation installed\r\n\r\n<img width=\"718\" alt=\"Screenshot 2024-10-10 at 09 55 38\"\r\nsrc=\"https://github.com/user-attachments/assets/805ea4ca-8bc9-4355-a434-0ba81f8228a9\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Alex Szabo <alex.szabo@elastic.co>\r\nCo-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"455c781c6d1e1161f66e275299cf06064a0ffde2","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","ci:cloud-deploy","Team:Obs AI Assistant","ci:project-deploy-observability","Team:AI Infra","v8.17.0"],"number":194379,"url":"https://github.com/elastic/kibana/pull/194379","mergeCommit":{"message":"[LLM tasks] Add product documentation retrieval task (#194379)\n\n## Summary\r\n\r\nClose https://github.com/elastic/kibana/issues/193473\r\nClose https://github.com/elastic/kibana/issues/193474\r\n\r\nThis PR utilize the documentation packages that are build via the tool\r\nintroduced by https://github.com/elastic/kibana/pull/193847, allowing to\r\ninstall them in Kibana and expose documentation retrieval as an LLM task\r\nthat AI assistants (or other consumers) can call.\r\n\r\nUsers can now decide to install the Elastic documentation from the\r\nassistant's config screen, which will expose a new tool for the\r\nassistant, `retrieve_documentation` (only implemented for the o11y\r\nassistant in the current PR, shall be done for security as a follow up).\r\n\r\nFor more information, please refer to the self-review.\r\n\r\n## General architecture\r\n\r\n<img width=\"1118\" alt=\"Screenshot 2024-10-17 at 09 22 32\"\r\nsrc=\"https://github.com/user-attachments/assets/3df8c30a-9ccc-49ab-92ce-c204b96d6fc4\">\r\n\r\n## What this PR does\r\n\r\nAdds two plugin:\r\n- `productDocBase`: contains all the logic related to product\r\ndocumentation installation, status, and search. This is meant to be a\r\n\"low level\" components only responsible for this specific part.\r\n- `llmTasks`: an higher level plugin that will contain various LLM tasks\r\nto be used by assistants and genAI consumers. The intent is not to have\r\na single place to put all llm tasks, but more to have a default place\r\nwhere we can introduce new tasks from. (fwiw, the `nlToEsql` task will\r\nprobably be moved to that plugin).\r\n\r\n- Add a `retrieve_documentation` tool registration for the o11y\r\nassistant\r\n- Add a component on the o11y assistant configuration page to install\r\nthe product doc\r\n\r\n(wiring the feature to the o11y assistant was done for testing purposes\r\nmostly, any addition / changes / enhancement should be done by the\r\nowning team - either in this PR or as a follow-up)\r\n\r\n## What is NOT included in this PR:\r\n\r\n- Wire product base feature to the security assistant (should be done by\r\nthe owning team as a follow-up)\r\n - installation\r\n - utilization as tool\r\n\r\n- FTR tests: this is somewhat blocked by the same things we need to\r\nfigure out for https://github.com/elastic/kibana-team/issues/1271\r\n\r\n## Screenshots \r\n\r\n### Installation from o11y assistant configuration page\r\n\r\n<img width=\"1476\" alt=\"Screenshot 2024-10-17 at 09 41 24\"\r\nsrc=\"https://github.com/user-attachments/assets/31daa585-9fb2-400a-a2d1-5917a262367a\">\r\n\r\n### Example of output\r\n\r\n#### Without product documentation installed \r\n\r\n<img width=\"739\" alt=\"Screenshot 2024-10-10 at 09 59 41\"\r\nsrc=\"https://github.com/user-attachments/assets/993fb216-6c9a-433f-bf44-f6e383d20d9d\">\r\n\r\n#### With product documentation installed\r\n\r\n<img width=\"718\" alt=\"Screenshot 2024-10-10 at 09 55 38\"\r\nsrc=\"https://github.com/user-attachments/assets/805ea4ca-8bc9-4355-a434-0ba81f8228a9\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Alex Szabo <alex.szabo@elastic.co>\r\nCo-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"455c781c6d1e1161f66e275299cf06064a0ffde2"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194379","number":194379,"mergeCommit":{"message":"[LLM tasks] Add product documentation retrieval task (#194379)\n\n## Summary\r\n\r\nClose https://github.com/elastic/kibana/issues/193473\r\nClose https://github.com/elastic/kibana/issues/193474\r\n\r\nThis PR utilize the documentation packages that are build via the tool\r\nintroduced by https://github.com/elastic/kibana/pull/193847, allowing to\r\ninstall them in Kibana and expose documentation retrieval as an LLM task\r\nthat AI assistants (or other consumers) can call.\r\n\r\nUsers can now decide to install the Elastic documentation from the\r\nassistant's config screen, which will expose a new tool for the\r\nassistant, `retrieve_documentation` (only implemented for the o11y\r\nassistant in the current PR, shall be done for security as a follow up).\r\n\r\nFor more information, please refer to the self-review.\r\n\r\n## General architecture\r\n\r\n<img width=\"1118\" alt=\"Screenshot 2024-10-17 at 09 22 32\"\r\nsrc=\"https://github.com/user-attachments/assets/3df8c30a-9ccc-49ab-92ce-c204b96d6fc4\">\r\n\r\n## What this PR does\r\n\r\nAdds two plugin:\r\n- `productDocBase`: contains all the logic related to product\r\ndocumentation installation, status, and search. This is meant to be a\r\n\"low level\" components only responsible for this specific part.\r\n- `llmTasks`: an higher level plugin that will contain various LLM tasks\r\nto be used by assistants and genAI consumers. The intent is not to have\r\na single place to put all llm tasks, but more to have a default place\r\nwhere we can introduce new tasks from. (fwiw, the `nlToEsql` task will\r\nprobably be moved to that plugin).\r\n\r\n- Add a `retrieve_documentation` tool registration for the o11y\r\nassistant\r\n- Add a component on the o11y assistant configuration page to install\r\nthe product doc\r\n\r\n(wiring the feature to the o11y assistant was done for testing purposes\r\nmostly, any addition / changes / enhancement should be done by the\r\nowning team - either in this PR or as a follow-up)\r\n\r\n## What is NOT included in this PR:\r\n\r\n- Wire product base feature to the security assistant (should be done by\r\nthe owning team as a follow-up)\r\n - installation\r\n - utilization as tool\r\n\r\n- FTR tests: this is somewhat blocked by the same things we need to\r\nfigure out for https://github.com/elastic/kibana-team/issues/1271\r\n\r\n## Screenshots \r\n\r\n### Installation from o11y assistant configuration page\r\n\r\n<img width=\"1476\" alt=\"Screenshot 2024-10-17 at 09 41 24\"\r\nsrc=\"https://github.com/user-attachments/assets/31daa585-9fb2-400a-a2d1-5917a262367a\">\r\n\r\n### Example of output\r\n\r\n#### Without product documentation installed \r\n\r\n<img width=\"739\" alt=\"Screenshot 2024-10-10 at 09 59 41\"\r\nsrc=\"https://github.com/user-attachments/assets/993fb216-6c9a-433f-bf44-f6e383d20d9d\">\r\n\r\n#### With product documentation installed\r\n\r\n<img width=\"718\" alt=\"Screenshot 2024-10-10 at 09 55 38\"\r\nsrc=\"https://github.com/user-attachments/assets/805ea4ca-8bc9-4355-a434-0ba81f8228a9\">\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Alex Szabo <alex.szabo@elastic.co>\r\nCo-authored-by: Matthias Wilhelm <matthias.wilhelm@elastic.co>\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"455c781c6d1e1161f66e275299cf06064a0ffde2"}},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> |
||
|---|---|---|
| .. | ||
| advanced | ||
| architecture | ||
| best-practices | ||
| contributing | ||
| getting-started | ||
| images | ||
| plugin | ||
| index.asciidoc | ||
| plugin-list.asciidoc | ||
| telemetry.asciidoc | ||