-
Notifications
You must be signed in to change notification settings - Fork 505
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.
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
Add query assist documentation to Observability #6419
Changes from 2 commits
8344898
aba121a
989028a
dc09f31
4b9f314
c73538d
b05775e
b337adc
d999a9e
c423514
8bc17e5
c6e2dcf
856adb6
acf7b1f
d456738
c91b284
3ebbb70
6339ed4
5eb833e
a2bd1b4
32a60f4
c678781
ba8b45e
ad5735e
c738d05
5e58566
2e6ea7a
bc02e48
b27995c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,31 @@ | |
|
||
For more information about building PPL queries, see [Piped Processing Language]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index). | ||
|
||
### OpenSearch Query Assist | ||
Check failure on line 31 in _observing-your-data/event-analytics.md GitHub Actions / style-job
|
||
|
||
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [OpenSearch forum thread](https://forum.opensearch.org/t/feedback-opensearch-assistant/16741). | ||
{: .warning} | ||
|
||
To make building queries easier, the OpenSearch Assistant Toolkit provides an assistant to help convert natural language queries to PPL. | ||
|
||
![Sample OpenSearch Query Assist View]({{site.url}}{{site.baseurl}}/images/log-explorer-query-assist.png) | ||
vagimeli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#### Enabling OpenSearch Query Assist | ||
Check failure on line 40 in _observing-your-data/event-analytics.md GitHub Actions / style-job
|
||
To enable **OpenSearch Query Assist** in OpenSearch Dashboards, locate your copy of the `opensearch_dashboards.yml` file and set the following option: | ||
``` | ||
observability.query_assist.enabled: true | ||
observability.query_assist.ppl_agent_name: "PPL agent" | ||
lezzago marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
To enable the option to summarize the responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "To enable summarization of responses"? |
||
``` | ||
observability.summarize.enabled: true | ||
observability.summarize.response_summary_agent_name: "Response summary agent" | ||
observability.summarize.error_summary_agent_name: "Error summary agent" | ||
``` | ||
|
||
#### How to setup OpenSearch Query Assist | ||
Check failure on line 53 in _observing-your-data/event-analytics.md GitHub Actions / style-job
|
||
For a guide to setup the query assist, follow the getting started guide [here](https://github.com/opensearch-project/dashboards-assistant/blob/main/GETTING_STARTED_GUIDE.md). This guide shows how to setup OpenSearch Assistant and Query Assist. To only setup Query Assist, use only the `query-assist-agent` template called out in the guide. | ||
Check failure on line 54 in _observing-your-data/event-analytics.md GitHub Actions / style-job
Check failure on line 54 in _observing-your-data/event-analytics.md GitHub Actions / style-job
|
||
|
||
## Saving a visualization | ||
|
||
After Dashboards generates a visualization, you must save it if you want to return to it at a later time or if you want to add it to an [operational panel]({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be "OpenSearch Query Assistant"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revised throughout