Skip to content

Commit afecfe4

Browse files
Apply suggestions from code review
Co-authored-by: Nastasha Solomon <[email protected]>
1 parent 4922ab2 commit afecfe4

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/serverless/AI-for-security/ai-assistant.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ It has the following tabs:
114114
* **System Prompts:** Edit existing System Prompts or create new ones. To create a new System Prompt, type a unique name in the *Name* field, then press *enter*. Under *Prompt*, enter or update the System Prompt's text. Under *Contexts*, select where the System Prompt should appear.
115115
* **Quick Prompts:** Modify existing Quick Prompts or create new ones. To create a new Quick Prompt, type a unique name in the *Name* field, then press *enter*. Under *Prompt*, enter or update the Quick Prompt's text.
116116
* **Anonymization:** Select fields to include as plaintext, to obfuscate, and to not send when you provide events to AI Assistant as context. <<ai-assistant-anonymization, Learn more>>.
117-
* **Knowledge base:** Provide additional context to AI Assistant. <<ai-assistant-knowledge-base, Learn more>>.
117+
* **Knowledge Base:** Provide additional context to AI Assistant. <<ai-assistant-knowledge-base, Learn more>>.
118118

119119
[discrete]
120120
[[ai-assistant-anonymization]]
@@ -142,7 +142,7 @@ When you include a particular event as context, such as an alert from the Alerts
142142
=== Knowlege base
143143

144144
beta::[]
145-
The **Knowledge base** tab of the **Security AI settings** page allows you to enable AI Assistant to remember specified information, and use it as context to improve response quality. To learn more, refer to <<ai-assistant-knowledge-base>>.
145+
The **Knowledge Base** tab of the **Security AI settings** page allows you to enable AI Assistant to remember specified information, and use it as context to improve response quality. To learn more, refer to <<ai-assistant-knowledge-base>>.
146146

147147
[discrete]
148148
[[security-ai-assistant-get-the-most-from-your-queries]]

docs/serverless/AI-for-security/knowledge-base.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ NOTE: When you upgrade from {elastic-sec} version 8.15 to a newer version, infor
1818
[[knowledge-base-rbac]]
1919
== Role-based access control (RBAC) for Knowledge Base
2020

21-
The `Elastic AI Assistant: All` role privilege allows you to use AI Assistant and access its settings. It has two sub-privileges, `Field Selection and Anonymization`, which allows you to customize which alert fields are sent to AI Assistant and Attack Discovery, and `Knowledge Base`, which allows you to edit and create new Knowledge Base entries.
21+
The `Elastic AI Assistant: All` role privilege allows you to use AI Assistant and access its settings. It has two sub-privileges, `Field Selection and Anonymization`, which allows you to customize which alert fields are sent to AI Assistant and Attack Discovery, and Knowledge Base, which allows you to edit and create new Knowledge Base entries.
2222

23-
image::images/knowledge-base-rbac.png[Knowledge base's RBAC settings,60%]
23+
image::images/knowledge-base-rbac.png[Knowledge Base's RBAC settings,60%]
2424

2525
[discrete]
2626
[[enable-knowledge-base]]
@@ -37,7 +37,7 @@ Open a conversation with AI Assistant, select a large language model, then click
3737

3838
image::images/knowledge-base-assistant-setup-button.png[An AI Assistant conversation showing the Setup Knowledge Base button]
3939

40-
Knowledge base setup may take several minutes. It will continue in the background if you close the conversation. After setup is complete, you can access Knowledge Base settings from AI Assistant's conversation settings menu (access the conversation settings menu by clicking the three dots button next to the model selection dropdown).
40+
Knowledge Base setup may take several minutes. It will continue in the background if you close the conversation. After setup is complete, you can access Knowledge Base settings from AI Assistant's conversation settings menu (access the conversation settings menu by clicking the three dots button next to the model selection dropdown).
4141

4242
image::images/knowledge-base-assistant-menu-dropdown.png[AI Assistant's dropdown menu with the Knowledge Base option highlighted]
4343

@@ -51,21 +51,21 @@ image::images/knowledge-base-assistant-settings-kb-tab.png[AI Assistant's settin
5151

5252
[discrete]
5353
[[rag-for-alerts]]
54-
== Knowledge base for alerts
54+
== Knowledge Base for alerts
5555
When Knowledge Base is enabled, AI Assistant receives `open` or `acknowledged` alerts from your environment from the last 24 hours. It uses these as context for each of your prompts. This enables it to answer questions about multiple alerts in your environment rather than just about individual alerts you choose to send it. It receives alerts ordered by risk score, then by the most recently generated. Building block alerts are excluded.
5656

5757
To enable Knowledge Base for alerts:
5858

59-
. Ensure that knowledge base is <<enable-knowledge-base, enabled>>.
60-
. Use the slider on the Security AI settings' Knowledge Base tab to select the number of alerts to send to AI Assistant. Click **Save**.
59+
. Ensure that Knowledge Base is <<enable-knowledge-base, enabled>>.
60+
. Use the slider on the Security AI settings' **Knowledge Base** tab to select the number of alerts to send to AI Assistant. Click **Save**.
6161

6262
NOTE: Including a large number of alerts may cause your request to exceed the maximum token length of your third-party generative AI provider. If this happens, try selecting a lower number of alerts to send.
6363

6464
[discrete]
6565
[[knowledge-base-add-knowledge]]
6666
== Add knowledge
6767

68-
To view all knowledge base entries, go to the Security AI settings and select the **Knowledge Base** tab. You can add individual documents or entire indices containing multiple documents. Each entry in the Knowledge Base (a document or index) has a **Sharing** setting of `private` or `global`. Private entries apply to the current user only and do not affect other users in the {kib} space, whereas global entries affect all users. Each entry can also have a `Required knowledge` setting, which means it will be included as context for every message sent to AI Assistant.
68+
To view all Knowledge Base entries, go to the Security AI settings and select the **Knowledge Base** tab. You can add individual documents or entire indices containing multiple documents. Each entry in the Knowledge Base (a document or index) has a **Sharing** setting of `private` or `global`. Private entries apply to the current user only and do not affect other users in the {kib} space, whereas global entries affect all users. Each entry can also have a `Required knowledge` setting, which means it will be included as context for every message sent to AI Assistant.
6969

7070
NOTE: When you enable Knowledge Base, it comes pre-populated with articles from https://www.elastic.co/security-labs[Elastic Security Labs], current through September 30, 2024, which allows AI Assistant to leverage Elastic's security research during your conversations. This enables it to answer questions such as, “Are there any new tactics used against Windows hosts that I should be aware of when investigating my alerts?”
7171

@@ -81,7 +81,7 @@ Add an individual document to Knowledge Base when you want AI Assistant to remem
8181
. Write the knowledge AI Assistant should remember in the **Markdown text** field.
8282
. In the **Markdown text** field, enter the information you want AI Assistant to remember.
8383
. If it should be **Required knowledge**, select the option. Otherwise, leave it blank.
84-
Alternatively, you can simply send a message to AI Assistant that instructs it to "Remember" the information. For example, "Remember that I changed my password today, October 24, 2024", or "Remember we always use the Threat Hunting Timeline template when investigating potential threats". Entries created in this way are private to you. By default they are not required knowledge, but you can make them required by instructing AI Assistant to "Always remember", for example "Always remember to address me as madam", or "Always remember that our primary data center is located in Austin, Texas".
84+
Alternatively, you can simply send a message to AI Assistant that instructs it to "Remember" the information. For example, "Remember that I changed my password today, October 24, 2024", or "Remember we always use the Threat Hunting Timeline template when investigating potential threats". Entries created in this way are private to you. By default, they are not required knowledge, but you can make them required by instructing AI Assistant to "Always remember", for example "Always remember to address me as madam", or "Always remember that our primary data center is located in Austin, Texas".
8585

8686
Refer to the following video for an example of adding a document to Knowledge Base from the settings menu.
8787

0 commit comments

Comments
 (0)