Skip to content

Commit 5c758f7

Browse files
committed
adds new data upload method
1 parent 70ea3e1 commit 5c758f7

File tree

1 file changed

+29
-13
lines changed

1 file changed

+29
-13
lines changed

solutions/security/ai/ai-assistant-knowledge-base.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ When you enable Knowledge Base, it comes pre-populated with articles from [Elast
104104

105105

106106

107-
### Add an individual document [knowledge-base-add-knowledge-document]
107+
### Add a markdown document [knowledge-base-add-knowledge-document]
108108

109-
Add an individual document to Knowledge Base when you want AI Assistant to remember a specific piece of information.
109+
Add a markdown document to Knowledge Base when you want AI Assistant to remember a specific piece of information.
110110

111111
1. To open **Security AI settings**, use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find "AI Assistant for Security." Select the **Knowledge Base** tab.
112112
2. Click **New → Document** and give it a name.
@@ -119,39 +119,55 @@ Refer to the following video for an example of adding a document to Knowledge Ba
119119

120120
[![Add knowledge document video](https://play.vidyard.com/rQsTujEfikpx3vv1vrbfde.jpg)](https://videos.elastic.co/watch/rQsTujEfikpx3vv1vrbfde?)
121121

122+
### Add a text, PDF, ODF, Word, Excel, PowerPoint, NDJSON, CSV, TSV, or log file [add-specific-file]
123+
124+
To add an individual file to knowledge base, you first need to ingest it into an index and ensure that it includes a semantic text field.
125+
126+
1. Access the **Upload file** interface by using the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find "File upload".
127+
2. Review the list of currently supported file formats and sizes, then select the file you want to upload. Click **Import**.
128+
3. In the **Index name** section, name the index that will contain the data in the uploaded file. Go to the **Advanced** tab.
129+
4. (Optional) Review and update the mappings and ingest pipeline for your new index.
130+
5. Click **Add additional field -> Add semantic text field**.
131+
- For **Field** select the field you want to use as a semantic text field. It should contain information that AI Assistant can use to determine whether a document is relevant to a given query. Do not select a metadata field. Click **Add**.
132+
- For **Copy to field**, enter a name for your new semantic text field.
133+
- For **Inference service**, use the default or select another model that's enabled in your environment.
134+
- Click **Add**.
135+
:::{note}
136+
For more information about semantic search and inference models, refer to [Elasticsearch semantic_text mapping](https://www.elastic.co/search-labs/blog/semantic-search-simplified-semantic-text).
137+
:::
138+
6. Click **Import**. File ingest begins and should complete within a few seconds.
139+
7. Once your file has been ingested to an index, add it to Knowledge Base by following the steps to [add an index](#add-an-index-knowledge-base-add-knowledge-index).
140+
141+
Refer to the following video for an example of this process (click to play video):
142+
143+
[![Add knowledge index video](https://play.vidyard.com/Q5CjXMN4R2GYLGLUy5P177.jpg)](https://videos.elastic.co/watch/Q5CjXMN4R2GYLGLUy5P177?)
144+
122145

123146

124147
### Add an index [knowledge-base-add-knowledge-index]
125148

126-
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.
149+
Add an index as a knowledge source when you want information in that index to inform AI Assistant’s responses. Common security examples include asset inventories, network configuration information, on-call matrices, threat intelligence reports, and vulnerability scans. When you update the index with new information, AI Assistant will gain access to the new information.
127150

128151
::::{important}
129152
Indices added to Knowledge Base must have at least one field mapped as [semantic text](elasticsearch://reference/elasticsearch/mapping-reference/semantic-text.md).
130153
::::
131154

132-
133155
1. To open **Security AI settings**, use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find "AI Assistant for Security." Select the **Knowledge Base** tab.
134156
2. Click **New → Index**.
135157
3. Name the knowledge source.
136158
4. Under **Sharing**, select whether this knowledge should be **Global** or **Private**.
137159
5. Under **Index**, enter the name of the index you want to use as a knowledge source.
138160
6. Under **Field**, enter the names of one or more semantic text fields within the index.
139161
7. Under **Data Description**, describe when this information should be used by AI Assistant.
140-
8. Under **Query Instruction**, describe how AI Assistant should query this index to retrieve relevant information.
141-
9. Under **Output Fields**, list the fields which should be sent to AI Assistant. If none are listed, all fields will be sent.
162+
8. Under **Query Instruction**, describe how AI Assistant should query this index to retrieve relevant documents.
163+
9. Under **Output Fields**, list the fields which AI Assistant should look at when reviewing documents in this index. If none are listed, all fields are sent.
142164

143165
:::{image} /solutions/images/security-knowledge-base-add-index-config.png
144166
:alt: Knowledge base's Edit index entry menu
145167
:::
146168

147-
Refer to the following video for an example of adding an index to Knowledge Base (click to play video).
148-
149-
150-
[![Add knowledge index video](https://play.vidyard.com/Q5CjXMN4R2GYLGLUy5P177.jpg)](https://videos.elastic.co/watch/Q5CjXMN4R2GYLGLUy5P177?)
151-
152-
153169

154-
### Add knowledge with a connector or web crawler [knowledge-base-crawler-or-connector]
170+
### Add knowledge to an index using a connector or web crawler [knowledge-base-crawler-or-connector]
155171

156172
You can use an {{es}} connector or web crawler to create an index that contains data you want to add to Knowledge Base.
157173

0 commit comments

Comments
 (0)