Skip to content

Commit

Permalink
Expand AI Assistant query advice (#4294)
Browse files Browse the repository at this point in the history
* first pass at incorporating Dhru's input

* incorporates edits

* Update docs/assistant/security-assistant.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* Update docs/assistant/security-assistant.asciidoc

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>

* incorporates feedback

* Update docs/assistant/security-assistant.asciidoc

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>

---------

Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
  • Loading branch information
3 people authored Nov 30, 2023
1 parent f14246c commit b37854d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/assistant/security-assistant.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,4 +177,17 @@ To enable the knowledge base:
. Turn on the *Knowledge Base* option.
. Click *Save*. The knowledge base is now active.
+
When the knowledge base is active, a quick prompt for {esql} queries becomes available. It provides a good starting point for your {esql} conversations and questions.
When the knowledge base is active, a quick prompt for {esql} queries becomes available. It provides a good starting point for your {esql} conversations and questions.

[discrete]
[[ai-assistant-queries]]
### Get the most from your queries

Elastic AI Assistant helps you take full advantage of the {elastic-sec} platform to improve your security operations. Its ability to assist you depends on the specificity and detail of your questions. The more context and detail you provide, the more tailored and useful its responses will be.

To maximize its usefulness, consider using more detailed prompts or asking for additional information. For instance, after asking for an {esql} query example, you could ask a follow-up question like, “Could you give me some other examples?” You can also ask for clarification or further exposition, for example "Please provide comments explaining the query you just gave."

In addition to practical advice, AI Assistant can offer conceptual advice, tips, and best practices for enhancing your security measures. You can ask it, for example:

* “How do I set up a {ml} job in {elastic-sec} to detect anomalies in network traffic volume over time?”
* “I need to monitor for unusual file creation patterns that could indicate ransomware activity. How would I construct this query using EQL?”

0 comments on commit b37854d

Please sign in to comment.