[Security Solution] [AI Assistant] security assistant content references tour by KDKHD · Pull Request #208775 · elastic/kibana

KDKHD · 2025-01-29T15:20:54Z

Summary

Follow up to : #206683

This PR adds a tour that tells the user how to toggle citations on and off and how to show and hide anonymized values.

How to test:

Enable feature flag:

# kibana.dev.yml
xpack.securitySolution.enableExperimental: ['contentReferencesEnabled']

Launch the security AI assistant
Now we need to get the assistant to reply with a message that contains either anonymized values or citations. This is what triggers the tour. To do this ask it a question about one of your KB documents or an alert that contains anonymized properties or returns a citation.
Once the assistant stream ends, the tour should appear 1 second later (unless the knowledge base tour is open).

The tour will only appear one time per browser. To make it appear again, clear the key elasticAssistant.anonymizedValuesAndCitationsTourCompleted from local storage.

Also fixes a typo.

tour.mov

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
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
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
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

See some risk examples
...

KDKHD · 2025-01-29T15:43:50Z

/ci

KDKHD · 2025-01-29T17:51:14Z

/ci

KDKHD · 2025-01-29T17:55:32Z

/ci

…-fix'

KDKHD · 2025-01-29T19:07:18Z

/ci

KDKHD · 2025-01-30T09:49:07Z

x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/index.tsx

@@ -448,196 +449,201 @@ const AssistantComponent: React.FC<Props> = ({
  );

  return (


"Hide whitespaces" for this file.

…-fix'

…s-tour.2

KDKHD · 2025-02-03T10:00:25Z

@elasticmachine merge upstream

…s-tour.2

KDKHD · 2025-02-03T16:08:40Z

...ecurity_solution/public/assistant/get_comments/content_reference/content_reference_parser.ts


    const contentReferenceId = readArg('(', ')');

-    const closeChar = value[index++];


The ++ was unnecessary because index is never used after this line.

x-pack/platform/packages/shared/kbn-elastic-assistant/impl/tour/const.ts

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx

stephmilovic · 2025-02-03T17:34:39Z

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx

+      timer = setTimeout(() => {
+        setShowTour(true);
+      }, 1000);
+      return;


this return prevents the cleanup function from being hit, is that intended?

stephmilovic · 2025-02-03T17:35:45Z

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx

+    setShowTour(false);
+  }, [setTourCompleted, setShowTour]);
+
+  return useMemo(


Since useMemo is used around the JSX element itself, it only optimizes the re-creation of the component tree, not expensive calculations.

EuiTourStep itself should handle performance well, so useMemo here is unnecessary.

…r/const.ts Co-authored-by: Steph Milovic <stephanie.milovic@elastic.co>

stephmilovic · 2025-02-03T17:56:26Z

.../shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/step_config.tsx

+        id="xpack.elasticAssistant.anonymizedValuesAndCitations.tour.content.citedKnowledgeBaseEntries"
+        defaultMessage="<bold>Cited</bold> Knowledge base entries show in the chat stream. Toggle on or off in the menu or with the shortcut: {keyboardShortcut}."
+        values={{
+          keyboardShortcut: isMac ? '⌥ c' : 'Alt c',


Suggested change

keyboardShortcut: isMac ? '⌥ c' : 'Alt c',

keyboardShortcut: isMac ? '⌥ + c' : 'Alt + c',

consider using a + in this equation. Looking around the repo and the web for other shortcuts, it appears standard to use the +

stephmilovic · 2025-02-03T18:00:02Z

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx

+    const containsContentReferences =
+      conversation.messages &&
+      conversation.messages.some((message) => message.metadata?.contentReferences != null);
+    const containsReplacements = !(
+      conversation.replacements == null || isEmpty(conversation.replacements)
+    );


nit, these can be simplified:

Suggested change

const containsContentReferences =

conversation.messages &&

conversation.messages.some((message) => message.metadata?.contentReferences != null);

const containsReplacements = !(

conversation.replacements == null || isEmpty(conversation.replacements)

);

const containsContentReferences = conversation.messages?.some(

(message) => message.metadata?.contentReferences != null

);

const containsReplacements = !isEmpty(conversation.replacements);

stephmilovic · 2025-02-03T18:01:44Z

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx

+        clearTimeout(timer);
+      };
+    }
+  }, [conversation, tourCompleted, setShowTour, showTour]);


Suggested change

}, [conversation, tourCompleted, setShowTour, showTour]);

}, [conversation, tourCompleted, showTour]);

setShowTour is a state setter, so it's stable and does not need to be included in the dependencies

stephmilovic

LGTM, works as expected.

…-fix'

…f github.com:KDKHD/kibana into feature/security-assistant-content-references-tour.2

elasticmachine · 2025-02-03T22:47:29Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 5c7124e

Failed CI Steps

Jest Tests #8

Test Failures

[job] [logs] Jest Tests #8 / InsertTimeline should call useInsertTimeline with correct arguments

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`automaticImport`	715	717	+2
`securitySolution`	6640	6642	+2
total			+4

Async chunks

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

id	before	after	diff
`securitySolution`	21.4MB	21.4MB	+2.9KB

History

💔 Build #272878 failed 8f78627
💔 Build #272856 failed a159566
💛 Build #272609 was flaky cf43ef9
💚 Build #271913 succeeded c55c238
💔 Build #271749 failed a6a5db8

kibanamachine · 2025-02-03T22:47:55Z

Starting backport for target branches: 8.18, 9.0

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

…ces tour (elastic#208775) ## Summary Follow up to : elastic#206683 This PR adds a tour that tells the user how to toggle citations on and off and how to show and hide anonymized values. ### How to test: - Enable feature flag: ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Launch the security AI assistant - Now we need to get the assistant to reply with a message that contains either anonymized values or citations. This is what triggers the tour. To do this ask it a question about one of your KB documents or an alert that contains anonymized properties or returns a citation. - Once the assistant stream ends, the tour should appear 1 second later (unless the knowledge base tour is open). The tour will only appear one time per browser. To make it appear again, clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted` from local storage. Also fixes a [typo](https://github.com/elastic/kibana/pull/208775/files#diff-e6ed566edfccebe7592cb2491ae0a601c2c54da879114e6100602b8b08099ca6R69). https://github.com/user-attachments/assets/97fca992-d39d-43e7-8e73-a11daf7549ca ### 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] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [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] 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) - [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. - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [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) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Steph Milovic <stephanie.milovic@elastic.co> (cherry picked from commit 572e665)

kibanamachine · 2025-02-03T22:53:22Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.18	Backport failed because of merge conflicts
✅	9.0

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 208775

Questions ?

Please refer to the Backport tool documentation

…eferences tour (#208775) (#209425) # Backport This will backport the following commits from `main` to `9.0`: - [[Security Solution] [AI Assistant] security assistant content references tour (#208775)](#208775)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Kenneth Kreindler <42113355+KDKHD@users.noreply.github.com>

KDKHD · 2025-02-04T09:19:32Z

💚 All backports created successfully

Status	Branch	Result
✅	8.18

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

Questions ?

Please refer to the Backport tool documentation

…references tour (#208775) (#209474) # Backport This will backport the following commits from `main` to `8.18`: - [[Security Solution] [AI Assistant] security assistant content references tour (#208775)](#208775)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Kenneth Kreindler <42113355+KDKHD@users.noreply.github.com>"}},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/208775","number":208775,"mergeCommit":{"message":"[Security Solution] [AI Assistant] security assistant content references tour (#208775)\n\n## Summary\r\nFollow up to : https://github.com/elastic/kibana/pull/206683\r\n\r\nThis PR adds a tour that tells the user how to toggle citations on and\r\noff and how to show and hide anonymized values.\r\n\r\n### How to test:\r\n- Enable feature flag: \r\n```yaml\r\n# kibana.dev.yml\r\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\r\n```\r\n- Launch the security AI assistant\r\n- Now we need to get the assistant to reply with a message that contains\r\neither anonymized values or citations. This is what triggers the tour.\r\nTo do this ask it a question about one of your KB documents or an alert\r\nthat contains anonymized properties or returns a citation.\r\n- Once the assistant stream ends, the tour should appear 1 second later\r\n(unless the knowledge base tour is open).\r\n\r\nThe tour will only appear one time per browser. To make it appear again,\r\nclear the key\r\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted` from local\r\nstorage.\r\n\r\nAlso fixes a\r\n[typo](https://github.com/elastic/kibana/pull/208775/files#diff-e6ed566edfccebe7592cb2491ae0a601c2c54da879114e6100602b8b08099ca6R69).\r\n\r\n\r\nhttps://github.com/user-attachments/assets/97fca992-d39d-43e7-8e73-a11daf7549ca\r\n\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies following conditions. \r\n\r\nReviewers should verify this PR satisfies this list as well.\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] If a plugin configuration key changed, check if it needs to be\r\nallowlisted in the cloud and added to the [docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n- [x] This was checked for breaking HTTP API changes, and any breaking\r\nchanges have been approved by the breaking-change committee. The\r\n`release_note:breaking` label should be applied in these situations.\r\n- [x] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n### Identify risks\r\n\r\nDoes this PR introduce any risks? For example, consider risks like hard\r\nto test bugs, performance regression, potential of data loss.\r\n\r\nDescribe the risk, its severity, and mitigation for each identified\r\nrisk. Invite stakeholders and evaluate how to proceed before merging.\r\n\r\n- [ ] [See some risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\r\n- [ ] ...\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>\r\nCo-authored-by: Steph Milovic <stephanie.milovic@elastic.co>","sha":"572e6656d1dcd0e5a54b026fcda9d0a277c8357f"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

KDKHD · 2025-02-05T10:44:46Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

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

Questions ?

Please refer to the Backport tool documentation

…eferences tour (#208775) (#209733) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] [AI Assistant] security assistant content references tour (#208775)](https://github.com/elastic/kibana/pull/208775)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Kenneth Kreindler <42113355+KDKHD@users.noreply.github.com>"}},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/209474","number":209474,"state":"MERGED","mergeCommit":{"sha":"97cd9adc4a28e1b4e445b40e0c1ada44d5aff2f6","message":"[8.18] [Security Solution] [AI Assistant] security assistant content references tour (#208775) (#209474)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.18`:\n- [[Security Solution] [AI Assistant] security assistant content\nreferences tour\n(#208775)](https://github.com/elastic/kibana/pull/208775)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\\n\\n### Questions ?\\nPlease refer to the\n[Backport\ntool\\ndocumentation](https://github.com/sqren/backport)\\n\\n\\n\\nCo-authored-by:\nKenneth Kreindler\n<42113355+KDKHD@users.noreply.github.com>\"}},{\"branch\":\"8.18\",\"label\":\"v8.18.0\",\"branchLabelMappingKey\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v9.1.0\",\"branchLabelMappingKey\":\"^v9.1.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/208775\",\"number\":208775,\"mergeCommit\":{\"message\":\"[Security\nSolution] [AI Assistant] security assistant content references tour\n(#208775)\\n\\n## Summary\\r\\nFollow up to :\nhttps://github.com/elastic/kibana/pull/206683\\r\\n\\r\\nThis PR adds a tour\nthat tells the user how to toggle citations on and\\r\\noff and how to\nshow and hide anonymized values.\\r\\n\\r\\n### How to test:\\r\\n- Enable\nfeature flag: \\r\\n```yaml\\r\\n#\nkibana.dev.yml\\r\\nxpack.securitySolution.enableExperimental:\n['contentReferencesEnabled']\\r\\n```\\r\\n- Launch the security AI\nassistant\\r\\n- Now we need to get the assistant to reply with a message\nthat contains\\r\\neither anonymized values or citations. This is what\ntriggers the tour.\\r\\nTo do this ask it a question about one of your KB\ndocuments or an alert\\r\\nthat contains anonymized properties or returns\na citation.\\r\\n- Once the assistant stream ends, the tour should appear\n1 second later\\r\\n(unless the knowledge base tour is open).\\r\\n\\r\\nThe\ntour will only appear one time per browser. To make it appear\nagain,\\r\\nclear the\nkey\\r\\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted` from\nlocal\\r\\nstorage.\\r\\n\\r\\nAlso fixes\na\\r\\n[typo](https://github.com/elastic/kibana/pull/208775/files#diff-e6ed566edfccebe7592cb2491ae0a601c2c54da879114e6100602b8b08099ca6R69).\\r\\n\\r\\n\\r\\nhttps://github.com/user-attachments/assets/97fca992-d39d-43e7-8e73-a11daf7549ca\\r\\n\\r\\n\\r\\n###\nChecklist\\r\\n\\r\\nCheck the PR satisfies following conditions.\n\\r\\n\\r\\nReviewers should verify this PR satisfies this list as\nwell.\\r\\n\\r\\n- [x] Any text added follows [EUI's\nwriting\\r\\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),\nuses\\r\\nsentence case text and includes\n[i18n\\r\\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\\r\\n-\n[x]\\r\\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\\r\\nwas\nadded for features that require explanation or tutorials\\r\\n- [x] [Unit\nor\nfunctional\\r\\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\\r\\nwere\nupdated or added to match the most common scenarios\\r\\n- [x] If a plugin\nconfiguration key changed, check if it needs to be\\r\\nallowlisted in the\ncloud and added to the\n[docker\\r\\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\\r\\n-\n[x] This was checked for breaking HTTP API changes, and any\nbreaking\\r\\nchanges have been approved by the breaking-change committee.\nThe\\r\\n`release_note:breaking` label should be applied in these\nsituations.\\r\\n- [x] [Flaky\nTest\\r\\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)\nwas\\r\\nused on any tests changed\\r\\n- [x] The PR description includes\nthe appropriate Release Notes section,\\r\\nand the correct\n`release_note:*` label is applied per\nthe\\r\\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\\r\\n\\r\\n###\nIdentify risks\\r\\n\\r\\nDoes this PR introduce any risks? For example,\nconsider risks like hard\\r\\nto test bugs, performance regression,\npotential of data loss.\\r\\n\\r\\nDescribe the risk, its severity, and\nmitigation for each identified\\r\\nrisk. Invite stakeholders and evaluate\nhow to proceed before merging.\\r\\n\\r\\n- [ ] [See some\nrisk\\r\\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\\r\\n-\n[ ] ...\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\\r\\nCo-authored-by:\nElastic Machine\n<elasticmachine@users.noreply.github.com>\\r\\nCo-authored-by: Steph\nMilovic\n<stephanie.milovic@elastic.co>\",\"sha\":\"572e6656d1dcd0e5a54b026fcda9d0a277c8357f\"}}]}]\nBACKPORT-->\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/208775","number":208775,"mergeCommit":{"message":"[Security Solution] [AI Assistant] security assistant content references tour (#208775)\n\n## Summary\r\nFollow up to : https://github.com/elastic/kibana/pull/206683\r\n\r\nThis PR adds a tour that tells the user how to toggle citations on and\r\noff and how to show and hide anonymized values.\r\n\r\n### How to test:\r\n- Enable feature flag: \r\n```yaml\r\n# kibana.dev.yml\r\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\r\n```\r\n- Launch the security AI assistant\r\n- Now we need to get the assistant to reply with a message that contains\r\neither anonymized values or citations. This is what triggers the tour.\r\nTo do this ask it a question about one of your KB documents or an alert\r\nthat contains anonymized properties or returns a citation.\r\n- Once the assistant stream ends, the tour should appear 1 second later\r\n(unless the knowledge base tour is open).\r\n\r\nThe tour will only appear one time per browser. To make it appear again,\r\nclear the key\r\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted` from local\r\nstorage.\r\n\r\nAlso fixes a\r\n[typo](https://github.com/elastic/kibana/pull/208775/files#diff-e6ed566edfccebe7592cb2491ae0a601c2c54da879114e6100602b8b08099ca6R69).\r\n\r\n\r\nhttps://github.com/user-attachments/assets/97fca992-d39d-43e7-8e73-a11daf7549ca\r\n\r\n\r\n### Checklist\r\n\r\nCheck the PR satisfies following conditions. \r\n\r\nReviewers should verify this PR satisfies this list as well.\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\r\n- [x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas added for features that require explanation or tutorials\r\n- [x] [Unit or functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere updated or added to match the most common scenarios\r\n- [x] If a plugin configuration key changed, check if it needs to be\r\nallowlisted in the cloud and added to the [docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n- [x] This was checked for breaking HTTP API changes, and any breaking\r\nchanges have been approved by the breaking-change committee. The\r\n`release_note:breaking` label should be applied in these situations.\r\n- [x] [Flaky Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\r\nused on any tests changed\r\n- [x] The PR description includes the appropriate Release Notes section,\r\nand the correct `release_note:*` label is applied per the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\r\n\r\n### Identify risks\r\n\r\nDoes this PR introduce any risks? For example, consider risks like hard\r\nto test bugs, performance regression, potential of data loss.\r\n\r\nDescribe the risk, its severity, and mitigation for each identified\r\nrisk. Invite stakeholders and evaluate how to proceed before merging.\r\n\r\n- [ ] [See some risk\r\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\r\n- [ ] ...\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>\r\nCo-authored-by: Steph Milovic <stephanie.milovic@elastic.co>","sha":"572e6656d1dcd0e5a54b026fcda9d0a277c8357f"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…ces tour (elastic#208775) ## Summary Follow up to : elastic#206683 This PR adds a tour that tells the user how to toggle citations on and off and how to show and hide anonymized values. ### How to test: - Enable feature flag: ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Launch the security AI assistant - Now we need to get the assistant to reply with a message that contains either anonymized values or citations. This is what triggers the tour. To do this ask it a question about one of your KB documents or an alert that contains anonymized properties or returns a citation. - Once the assistant stream ends, the tour should appear 1 second later (unless the knowledge base tour is open). The tour will only appear one time per browser. To make it appear again, clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted` from local storage. Also fixes a [typo](https://github.com/elastic/kibana/pull/208775/files#diff-e6ed566edfccebe7592cb2491ae0a601c2c54da879114e6100602b8b08099ca6R69). https://github.com/user-attachments/assets/97fca992-d39d-43e7-8e73-a11daf7549ca ### 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] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [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] 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) - [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. - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [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) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Steph Milovic <stephanie.milovic@elastic.co>

Content references tour

db21a1d

KDKHD changed the title ~~Content references tour~~ [Security Solution] [AI Assistant] security assistant content references Jan 29, 2025

KDKHD changed the title ~~[Security Solution] [AI Assistant] security assistant content references~~ [Security Solution] [AI Assistant] security assistant content references tour Jan 29, 2025

KDKHD added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 Team:Security Generative AI Security Generative AI backport:version Backport to applied version labels v8.18.0 labels Jan 29, 2025

lint

efb542f

kibanamachine and others added 2 commits January 29, 2025 18:19

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

f9508f0

…-fix'

lint

a6a5db8

KDKHD commented Jan 30, 2025

View reviewed changes

fix typo, clean up code

edc5049

KDKHD marked this pull request as ready for review January 30, 2025 10:05

KDKHD requested a review from a team as a code owner January 30, 2025 10:05

kibanamachine and others added 2 commits January 30, 2025 10:32

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

90abd9e

…-fix'

Merge branch 'main' into feature/security-assistant-content-reference…

c55c238

…s-tour.2

Merge branch 'main' into feature/security-assistant-content-reference…

cf43ef9

…s-tour.2

KDKHD added the v9.1.0 label Feb 3, 2025

KDKHD commented Feb 3, 2025

View reviewed changes

clean up

7fdf4ba

stephmilovic reviewed Feb 3, 2025

View reviewed changes

x-pack/platform/packages/shared/kbn-elastic-assistant/impl/tour/const.ts Outdated Show resolved Hide resolved

stephmilovic reviewed Feb 3, 2025

View reviewed changes

...ckages/shared/kbn-elastic-assistant/impl/tour/anonymized_values_and_citations_tour/index.tsx Outdated Show resolved Hide resolved

stephmilovic reviewed Feb 3, 2025

View reviewed changes

KDKHD and others added 2 commits February 3, 2025 17:42

Update x-pack/platform/packages/shared/kbn-elastic-assistant/impl/tou…

7773643

…r/const.ts Co-authored-by: Steph Milovic <stephanie.milovic@elastic.co>

@stephmilovic pr comments

a159566

stephmilovic reviewed Feb 3, 2025

View reviewed changes

stephmilovic approved these changes Feb 3, 2025

View reviewed changes

KDKHD and others added 4 commits February 3, 2025 18:27

code review comments

375ba84

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

8f78627

…-fix'

lint

285c153

Merge branch 'feature/security-assistant-content-references-tour.2' o…

5c7124e

…f github.com:KDKHD/kibana into feature/security-assistant-content-references-tour.2

KDKHD merged commit 572e665 into elastic:main Feb 3, 2025

kibanamachine mentioned this pull request Feb 3, 2025

[9.0] [Security Solution] [AI Assistant] security assistant content references tour (#208775) #209425

Merged

KDKHD mentioned this pull request Feb 4, 2025

[8.18] [Security Solution] [AI Assistant] security assistant content references tour (#208775) #209474

Merged

KDKHD added the v8.19.0 label Feb 5, 2025

KDKHD mentioned this pull request Feb 5, 2025

[8.x] [Security Solution] [AI Assistant] security assistant content references tour (#208775) #209733

Merged

kibanamachine mentioned this pull request Feb 5, 2025

[Streams 🌊] Introduce GroupStreams #208126

Merged

		@@ -448,196 +449,201 @@ const AssistantComponent: React.FC<Props> = ({
		);

		return (


		const contentReferenceId = readArg('(', ')');

		const closeChar = value[index++];

	keyboardShortcut: isMac ? '⌥ c' : 'Alt c',
	keyboardShortcut: isMac ? '⌥ + c' : 'Alt + c',

	}, [conversation, tourCompleted, setShowTour, showTour]);
	}, [conversation, tourCompleted, showTour]);

Conversation

KDKHD commented Jan 29, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

How to test:

Checklist

Identify risks

Uh oh!

KDKHD commented Jan 29, 2025

Uh oh!

KDKHD commented Jan 29, 2025

Uh oh!

KDKHD commented Jan 29, 2025

Uh oh!

KDKHD commented Jan 29, 2025

Uh oh!

KDKHD Jan 30, 2025

Choose a reason for hiding this comment

Uh oh!

KDKHD commented Feb 3, 2025

Uh oh!

KDKHD Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stephmilovic Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

stephmilovic Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stephmilovic Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

stephmilovic Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

stephmilovic Feb 3, 2025

Choose a reason for hiding this comment

Uh oh!

stephmilovic left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Feb 3, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

History

Uh oh!

kibanamachine commented Feb 3, 2025

Uh oh!

kibanamachine commented Feb 3, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

KDKHD commented Feb 4, 2025

💚 All backports created successfully

Questions ?

Uh oh!

KDKHD commented Feb 5, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

KDKHD commented Jan 29, 2025 •

edited by kibanamachine

Loading

stephmilovic Feb 3, 2025 •

edited

Loading