Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AI Assistant statement #3922

Merged
merged 3 commits into from
Sep 12, 2023
Merged

Update AI Assistant statement #3922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
37ccdfd
Update/add statements
joepeeples Sep 12, 2023
0dcbbba
Merge branch 'main' into 3921-ai-assistant-statement
joepeeples Sep 12, 2023
e94c857
Add new toolbar button
joepeeples Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assistant/images/ai-assistant-button.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 12 additions & 3 deletions docs/assistant/security-assistant.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ A connector for OpenAI or Azure OpenAI Service powers AI Assistant.
[role="screenshot"]
image::images/assistant.gif[Animation of AI Assistant chat window,90%]

[IMPORTANT]
IMPORTANT: The Elastic AI Assistant is designed to enhance your analysis with smart dialogues. Its capabilities are still developing. Users should exercise caution as the quality of its responses might vary. Your insights and feedback will help us improve this feature. Always cross-verify AI-generated advice for accuracy.

[TIP]
====
This is an initial release of the Elastic AI Assistant, designed to enhance your analysis with smart dialogues. Its capabilities are still developing. Users should exercise caution as the quality of its responses might vary. Your insights and feedback will help us improve this feature. Always cross-verify AI-generated advice for accuracy.
When choosing a third-party provider to use with AI Assistant, remember that different services may impose rate limits on their APIs. This may negatively affect AI Assistant performance. In addition, different models support various context lengths. Models with larger context lengths will provide a better experience when using the AI Assistant.

For example, refer to OpenAI's documentation on https://platform.openai.com/docs/guides/rate-limits/[rate limits] and https://help.openai.com/en/articles/7127966-what-is-the-difference-between-the-gpt-4-models[GPT-4 models] for more information on their available options.
====

.Requirements
Expand Down Expand Up @@ -62,7 +66,12 @@ You can do this in {kib} from *{stack-manage-app}* -> *{connectors-ui}*, or from
[[start-chatting]]
== Start chatting

To open AI Assistant, press *Cmd + ;* (or *Ctrl + ;* on Windows) from anywhere in the {security-app}. This opens the *Welcome* chat interface, where you can ask general questions about {elastic-sec}.
To open AI Assistant, select the **AI Assistant** button in the top toolbar from anywhere in the {security-app}. You can also use the keyboard shortcut *Cmd + ;* (or *Ctrl + ;* on Windows).

[role="screenshot"]
image::images/ai-assistant-button.png[AI Assistant button,150]

This opens the *Welcome* chat interface, where you can ask general questions about {elastic-sec}.

You can also chat with AI Assistant from several particular pages in {elastic-sec} where you can easily send context-specific data and prompts to AI Assistant.

Expand Down