[UI copy]: Review UX copy for the AI Assistant Citations feature #6485
Assignees
Labels
Comments
|
Updated UX Copy screen shots below
Also a small update to toggle "Show anonymized values" ('d' missing in Serverless right now). cc @KDKHD |
9 tasks
KDKHD
added a commit
to elastic/kibana
that referenced
this issue
Feb 21, 2025
…#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](#208517). ### 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>
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Feb 21, 2025
…elastic#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](elastic#208517). ### 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> (cherry picked from commit b59712f)
KDKHD
added a commit
to KDKHD/kibana
that referenced
this issue
Feb 21, 2025
…elastic#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](elastic#208517). ### 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> (cherry picked from commit b59712f) # Conflicts: # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/settings_context_menu/settings_context_menu.tsx
KDKHD
added a commit
to KDKHD/kibana
that referenced
this issue
Feb 21, 2025
…elastic#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](elastic#208517). ### 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> (cherry picked from commit b59712f) # Conflicts: # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/settings_context_menu/settings_context_menu.tsx
KDKHD
added a commit
to KDKHD/kibana
that referenced
this issue
Feb 21, 2025
…elastic#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](elastic#208517). ### 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> (cherry picked from commit b59712f) # Conflicts: # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/settings_context_menu/settings_context_menu.tsx
KDKHD
added a commit
to KDKHD/kibana
that referenced
this issue
Feb 21, 2025
…elastic#210398) ## Summary Addresses elastic/security-docs#6485 (comment) This PR updates the copy in the Citations and Anonymized values tour according to the figma linked in the issue. Furthermore, the PR includes the logic that disables the "Show anonymized values" and "Show citations" buttons in the assistant settings menu when the conversation does not contain anonymized values or citations respectivly. ### How to test new copy is correct <img width="864" alt="image" src="https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Clear the key `elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from your local storage if it exists. - Open Security assistant - Ask the assistant a question about your alerts or a KB document, the response should contain anonymized values or a citation. - The tour with the new copy should appear (copy in screenshot above). *the Anonymized values and citations will not appear if the knowledge base tour is currently open. ### How to test assistant settings menu changes: <img width="349" alt="image" src="https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d" /> - Enable feature flag ```yaml # kibana.dev.yml xpack.securitySolution.enableExperimental: ['contentReferencesEnabled'] ``` - Open Security assistant - In a new conversation, inside the settings menu, the "Show anonymized values" and "Show citations" menu items should be disabled because the conversation is empty and does not contain citations or anonymized values. - Ask the assistant a question about a KB document or Alert. The "Show citations" menu item should become available if the response contains citations. The "Show anonymized values" menu item will become available if the conversation contains replacements. Hovering over the disabled menu item will make a tooltip appear explaining why it is disabled. *Sometimes the conversation will contain replacements but the replacements are not used in the messages. In that case, the anonymized values menu item will not be disabled. This is a known [issue](elastic#208517). ### 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> (cherry picked from commit b59712f) # Conflicts: # x-pack/platform/packages/shared/kbn-elastic-assistant/impl/assistant/settings/settings_context_menu/settings_context_menu.tsx
kibanamachine
added a commit
to elastic/kibana
that referenced
this issue
Feb 21, 2025
… tour. (#210398) (#212018) # Backport This will backport the following commits from `main` to `9.0`: - [[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)](#210398) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Kenneth Kreindler","email":"42113355+KDKHD@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-02-21T09:03:53Z","message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Security Generative AI","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] [AI Assistant] Update copy of the citations tour.","number":210398,"url":"https://github.com/elastic/kibana/pull/210398","mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"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/210398","number":210398,"mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Kenneth Kreindler <42113355+KDKHD@users.noreply.github.com>
KDKHD
added a commit
to elastic/kibana
that referenced
this issue
Feb 21, 2025
… tour. (#210398) (#212024) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)](#210398) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Kenneth Kreindler","email":"42113355+KDKHD@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-02-21T09:03:53Z","message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Security Generative AI","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] [AI Assistant] Update copy of the citations tour.","number":210398,"url":"https://github.com/elastic/kibana/pull/210398","mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},"sourceBranch":"main","suggestedTargetBranches":["8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212018","number":212018,"state":"OPEN"},{"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/210398","number":210398,"mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
KDKHD
added a commit
to elastic/kibana
that referenced
this issue
Feb 21, 2025
…s tour. (#210398) (#212025) # Backport This will backport the following commits from `main` to `8.18`: - [[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)](#210398) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Kenneth Kreindler","email":"42113355+KDKHD@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-02-21T09:03:53Z","message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Security Generative AI","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[Security Solution] [AI Assistant] Update copy of the citations tour.","number":210398,"url":"https://github.com/elastic/kibana/pull/210398","mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},"sourceBranch":"main","suggestedTargetBranches":["8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212018","number":212018,"state":"OPEN"},{"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/210398","number":210398,"mergeCommit":{"message":"[Security Solution] [AI Assistant] Update copy of the citations tour. (#210398)\n\n## Summary\n\nAddresses\nhttps://github.com/elastic/security-docs/issues/6485#issuecomment-2639562221\n\nThis PR updates the copy in the Citations and Anonymized values tour\naccording to the figma linked in the issue. Furthermore, the PR includes\nthe logic that disables the \"Show anonymized values\" and \"Show\ncitations\" buttons in the assistant settings menu when the conversation\ndoes not contain anonymized values or citations respectivly.\n\n### How to test new copy is correct\n<img width=\"864\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/22bd2671-6d06-4e68-85f5-3c10d9974a4a\"\n/>\n\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Clear the key\n`elasticAssistant.anonymizedValuesAndCitationsTourCompleted.v8.18` from\nyour local storage if it exists.\n- Open Security assistant\n- Ask the assistant a question about your alerts or a KB document, the\nresponse should contain anonymized values or a citation.\n- The tour with the new copy should appear (copy in screenshot above).\n*the Anonymized values and citations will not appear if the knowledge\nbase tour is currently open.\n\n### How to test assistant settings menu changes:\n<img width=\"349\" alt=\"image\"\nsrc=\"https://github.com/user-attachments/assets/58e445d7-79c0-46ca-a245-bc2ab90eeb5d\"\n/>\n\n- Enable feature flag\n```yaml\n# kibana.dev.yml\nxpack.securitySolution.enableExperimental: ['contentReferencesEnabled']\n```\n- Open Security assistant\n- In a new conversation, inside the settings menu, the \"Show anonymized\nvalues\" and \"Show citations\" menu items should be disabled because the\nconversation is empty and does not contain citations or anonymized\nvalues.\n- Ask the assistant a question about a KB document or Alert. The \"Show\ncitations\" menu item should become available if the response contains\ncitations. The \"Show anonymized values\" menu item will become available\nif the conversation contains replacements. Hovering over the disabled\nmenu item will make a tooltip appear explaining why it is disabled.\n*Sometimes the conversation will contain replacements but the\nreplacements are not used in the messages. In that case, the anonymized\nvalues menu item will not be disabled. This is a known\n[issue](https://github.com/elastic/kibana/issues/208517).\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [X] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [X]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [X] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [X] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [X] This was checked for breaking HTTP API changes, and any breaking\nchanges have been approved by the breaking-change committee. The\n`release_note:breaking` label should be applied in these situations.\n- [X] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [X] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n### Identify risks\n\nDoes this PR introduce any risks? For example, consider risks like hard\nto test bugs, performance regression, potential of data loss.\n\nDescribe the risk, its severity, and mitigation for each identified\nrisk. Invite stakeholders and evaluate how to proceed before merging.\n\n- [ ] [See some risk\nexamples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)\n- [ ] ...\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"b59712fa8cc5709cb36da6914c61823411b6c1fe"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Description
OVERVIEW
We're introducing a new feature to include citations in the AI Chat Assistant when the AI is reponding to the user, and referring to Knolwege Base entries within the answer. The citations are shown via a superscript number and on hover show the name of the KB entry or doc source and allow the user to view via link.
THE ASK
Please review the UX Copy for succinctness and clarity.
Related links / assets
Please include each of the following, if applicable:
Figma link(s): Citiatons
Github epic link(s): elastic/kibana#204376
How to find the text in a production environment: PR link
Which documentation set does this change impact?
ESS and serverless
Feature differences
No difference
Software version
This feature is part of 8.18 release.
Collaborators
PM: @jamesspi
Designer: @bojanasan
Developer: @KDKHD
Design Manger @Ayeletpazakler
Timeline / deliverables
In time for 8.18 release.
The text was updated successfully, but these errors were encountered: