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

Jump to bottom

Remove experimental feature labels and flags for OS Assistant #6745

Merged
merged 6 commits into from
Mar 28, 2024
+35 −138
Merged

Remove experimental feature labels and flags for OS Assistant #6745

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9681203
Remove experimental feature labels and flags from OS Assistant-relate…
kolchfa-aws Mar 20, 2024
11bf447
Change generally available to introduced
kolchfa-aws Mar 21, 2024
b5c74a2
Remove ML settings for OS Assistant
kolchfa-aws Mar 25, 2024
aa95dc7
Merge branch 'main' into assistant-ga
kolchfa-aws Mar 26, 2024
6651fa9
Query assistant is enabled by default
kolchfa-aws Mar 28, 2024
20ee91d
Revised per SME comments
kolchfa-aws Mar 28, 2024
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
9 changes: 5 additions & 4 deletions _observing-your-data/event-analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,22 @@ To simplify query building, the **OpenSearch Assistant** toolkit offers an assis

#### Enabling Query Assistant

To enable **Query Assistant** in OpenSearch Dashboards, locate your copy of the `opensearch_dashboards.yml` file and set the following option:
By default, **Query Assistant** is enabled in OpenSearch Dashboards. To configure Query Assistant, locate your copy of the `opensearch_dashboards.yml` file and set the following option:

```
observability.query_assist.enabled: true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can keep this removed part and say if they want to disable it, they can set this setting to false.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a sentence about that on line 50.

```yaml
observability.query_assist.ppl_agent_name: "PPL agent"
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is no longer valid.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed.


To enable summarization of responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option:

```
```yaml
observability.summarize.enabled: true
observability.summarize.response_summary_agent_name: "Response summary agent"
observability.summarize.error_summary_agent_name: "Error summary agent"
```

To disable Query Assistant, add `observability.query_assist.enabled: false` to your `opensearch_dashboards.yml`.

#### Setting up Query Assistant

To set up **Query Assistant**, follow the steps in the [Getting started guide](https://github.com/opensearch-project/dashboards-assistant/blob/main/GETTING_STARTED_GUIDE.md) on GitHub. This guide provides step-by-step setup instructions for **OpenSearch Assistant** and **Query Assistant**. To set up **Query Assistant** only, use the `query-assist-agent` template included in the guide.
Expand Down
Loading