You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AI Assistant's knowledge base feature enables it to recall specific documents and other specified information, and to use it as context when responding to your queries. This page describes how to enable and add information to knowledge base.
4
+
AI Assistant's Knowledge Base feature enables AI Assistant to recall specific documents and other specified information. This information, which can include everything from the location of your datacenters to the latest threat research, provides additional context that can improve the quality of AI Assistant's responses to your queries. This topic describes how to enable and add information to Knowledge Base.
5
5
6
6
NOTE: When you upgrade from {elastic-sec} version 8.15 to a newer version, information previously stored by AI Assistant will be lost.
7
7
8
8
.Requirements
9
9
[sidebar]
10
10
--
11
11
12
-
* To use knowledge base, you need the `Elastic AI Assistant: All` privilege. To edit global knowledge base entries (information that will affect the AI Assistant experience for other users in the {kib} space), you need the `Allow Changes to Global Entries` privilege.
13
-
* To use knowledge base, you must <<ml-requirements, enable machine learning>> with a minimum ML node size of 4GB.
12
+
* To use Knowledge Base, you need the `Elastic AI Assistant: All` privilege. To edit global Knowledge Base entries (information that will affect the AI Assistant experience for other users in the {kib} space), you need the `Allow Changes to Global Entries` privilege.
13
+
* You must <<ml-requirements, enable machine learning>> with a minimum ML node size of 4 GB.
14
14
15
15
--
16
16
17
+
[discrete]
18
+
[[knowledge-base-rbac]]
19
+
== Role-based access control (RBAC) for Knowledge Base
20
+
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.
NOTE: You must individually enable knowledge base for each {kib} space where you want to use it.
31
+
NOTE: You must individually enable Knowledge Base for each {kib} space where you want to use it.
24
32
25
33
[discrete]
26
-
=== Option 1 — enable knowledge base from an AI Assistant conversation
34
+
=== Option 1: Enable Knowledge Base from an AI Assistant conversation
27
35
28
-
Open a conversation with AI Assistant, select a large language model, then click **Setup Knowledge Base**. If the button doesn't appear, knowledge base is already enabled.
36
+
Open a conversation with AI Assistant, select a large language model, then click **Setup Knowledge Base**. If the button doesn't appear, Knowledge Base is already enabled.
29
37
30
38
image::images/knowledge-base-assistant-setup-button.png[An AI Assistant conversation showing the Setup Knowledge Base button]
31
39
32
-
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 the conversation settings menu.
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).
33
41
34
-
image::images/knowledge-base-assistant-menu-dropdown.png[AI Assistant's dropdown menu with the knowledge base option highlighted]
42
+
image::images/knowledge-base-assistant-menu-dropdown.png[AI Assistant's dropdown menu with the Knowledge Base option highlighted]
35
43
36
44
[discrete]
37
-
=== Option 2 — enable knowledge base from the Security AI settings menu
45
+
=== Option 2: Enable Knowledge Base from the Security AI settings
38
46
39
-
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI assistant for security".
40
-
. Click **Setup Knowledge Base**. If the button doesn't appear, knowledge base is already enabled.
47
+
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI Assistant for Security."
48
+
. Click **Setup Knowledge Base**. If the button doesn't appear, Knowledge Base is already enabled.
41
49
42
-
image::images/knowledge-base-assistant-settings-kb-tab.png[AI Assistant's settings menu open to the knowledge base tab]
50
+
image::images/knowledge-base-assistant-settings-kb-tab.png[AI Assistant's settings menu open to the Knowledge Base tab]
43
51
44
52
[discrete]
45
53
[[rag-for-alerts]]
46
54
== Knowledge base for alerts
47
-
When knowledge base is enabled, AI Assistant receives alerts from your environment as context for each of your prompts. It will receive alerts from the last 24 hours that have a status of `open` or `acknowledged`, ordered first by risk score, then by recency. Building block alerts are excluded. This enables it to answer questions about multiple alerts in your environment, rather than just the individual alerts you choose to include as context.
55
+
When Knowledge Base is enabled, AI Assistant receives alerts from your environment from the last 24 hours which have a status of `open` or `acknowledged`. 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.
48
56
49
-
To enable knowledge base for alerts:
57
+
To enable Knowledge Base for alerts:
50
58
51
-
. Make sure that knowledge base is <<enable-knowledge-base, enabled>>.
52
-
. Use the slider on the Security AI settings menu's 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**.
53
61
54
62
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.
55
63
56
64
[discrete]
57
65
[[knowledge-base-add-knowledge]]
58
66
== Add knowledge
59
67
60
-
To view all knowledge base entries, go to the Security AI settings menu's Knowledge Base tab. You can add either individual documents, or entire indices containing multiple documents. Each entry in the knowledge base (a document or index) has a **Sharing** setting of either `private` or `global`. Private entries do not affect other users in the {kib} space, whereas global entries affect all users. Each entry can also be `Required knowledge`, which means it will be included as context to every message 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.
61
69
62
-
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?”
70
+
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?”
63
71
64
72
[discrete]
65
73
[[knowledge-base-add-knowledge-document]]
66
74
=== Add an individual document
67
75
68
-
Add an individual document to knowledge base when you want AI Assistant to remember a specific piece of information.
76
+
Add an individual document to Knowledge Base when you want AI Assistant to remember a specific piece of information.
69
77
70
-
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI assistant for security". Go to the Knowledge Base tab.
71
-
. Click **New → Document**.
72
-
. Name the knowledge document.
78
+
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI Assistant for Security." Select the **Knowledge Base** tab.
79
+
. Click **New → Document** and give it a name.
73
80
. Under **Sharing**, select whether this knowledge should be **Global** or **Private**.
74
81
. Write the knowledge in the **Markdown text** field.
75
-
. Decide whether to make it **Required knowledge**.
76
-
82
+
. In the **Markdown text** field, enter the information you want AI Assistant to remember.
83
+
. If it should be **Required knowledge**, select the option. Otherwise, leave it blank.
77
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".
78
85
79
-
Refer to the following video for an example of adding a document to knowledge base from the settings menu.
86
+
Refer to the following video for an example of adding a document to Knowledge Base from the settings menu.
80
87
81
88
=======
82
89
++++
@@ -99,9 +106,9 @@ Refer to the following video for an example of adding a document to knowledge ba
99
106
100
107
Add an index as a knowledge source when you want new information added to that index to automatically inform AI Assistant's responses. Common security examples include asset inventories, network configuration information, on-call matrices, threat intelligence reports, and vulnerability scans.
101
108
102
-
IMPORTANT: Indexes added to knowledge base must have at least one field mapped as {ref}/semantic-text.html[semantic text].
109
+
IMPORTANT: Indices added to Knowledge Base must have at least one field mapped as {ref}/semantic-text.html[semantic text].
103
110
104
-
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI assistant for security". Go to the Knowledge Base tab.
111
+
. To open Security AI settings, use the {kibana-ref}/introduction.html#kibana-navigation-search[global search field] to find "AI Assistant for Security." Select the **Knowledge Base** tab.
105
112
. Click **New → Index**.
106
113
. Name the knowledge source.
107
114
. Under **Sharing**, select whether this knowledge should be **Global** or **Private**.
@@ -111,9 +118,9 @@ IMPORTANT: Indexes added to knowledge base must have at least one field mapped a
111
118
. Under **Query Instruction**, describe how AI Assistant should query this index to retrieve relevant information.
112
119
. Under **Output Fields**, list the fields which should be sent to AI Assistant. If none are listed, all fields will be sent.
113
120
114
-
image::images/knowledge-base-add-index-config.png[Knowledge base's Edit index entry menu]
121
+
image::images/knowledge-base-add-index-config.png[Knowledge base's Edit index entry menu,80%]
115
122
116
-
Refer to the following video for an example of adding an index to knowledge base.
123
+
Refer to the following video for an example of adding an index to Knowledge Base.
117
124
118
125
=======
119
126
++++
@@ -129,11 +136,3 @@ Refer to the following video for an example of adding an index to knowledge base
129
136
</br>
130
137
++++
131
138
=======
132
-
133
-
[discrete]
134
-
[[knowledge-base-rbac]]
135
-
== Role-based access control (RBAC) for knowledge base
136
-
137
-
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.
0 commit comments