Skip to content

[8.14] [Request][ESS][8.14] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality (backport #5105) #5192

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

Merged
merged 1 commit into from
May 10, 2024
Merged

[8.14] [Request][ESS][8.14] Update docs to convey release state of AI Assistant's ES|QL-query-generating functionality (backport #5105) #5192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion docs/assistant/security-assistant.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,16 @@ The *Show anonymized* toggle controls whether you see the obfuscated or plaintex
[discrete]
[[ai-assistant-knowledge-base]]
=== Knowledge base
beta::["Do not use {esql} on production environments. This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features."]
beta::[]

The **Knowledge base** tab of the AI Assistant settings menu allows you to enable AI Assistant to answer questions about the Elastic Search Query Language ({esql}), and about alerts in your environment.

[discrete]
[[rag-for-esql]]
==== Knowledge base for {esql}

IMPORTANT: {esql} queries generated by AI Assistant might require additional validation. To ensure they're correct, refer to the {ref}/esql-language.html[{esql} documentation].

When this feature is enabled, AI Assistant can help you write an {esql} query for a particular use case, or answer general questions about {esql} syntax and usage. To enable AI Assistant to answer questions about {esql}:

. Enable the Elastic Learned Sparse EncodeR (ELSER). This model provides additional context to the third-party LLM. To learn more, refer to {ml-docs}/ml-nlp-elser.html#download-deploy-elser[Configure ELSER].
Expand Down