doc: add document for dashboards assistant #8622

ruanyl · 2024-10-28T11:35:03Z

Description

Add documentation for dashboards-assistant

Issues Resolved

Closes #[insert issue number]

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2024-10-28T11:35:16Z

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

Naarcha-AWS · 2024-10-28T16:40:12Z

@ruanyl: Is this for the 2.18 release?

ruanyl · 2024-10-29T00:05:45Z

@Naarcha-AWS Yes, we have several people collaborate on the documentation, there will be upcoming changes, so marked it as draft.

vagimeli · 2024-10-29T17:18:26Z

@ruanyl Please tag me when this is ready to convert from draft. I'll start my doc review once all files are ready. Thank you.

Signed-off-by: Yulong Ruan <[email protected]>

Signed-off-by: gaobinlong <[email protected]>

* doc: Add document for dashboard assistant alert insight * fix title Signed-off-by: qianheng <[email protected]>

Signed-off-by: Liyun Xiu <[email protected]>

* add doc for alert insight agent Signed-off-by: yuye-aws <[email protected]> * add example request for alert insight API Signed-off-by: yuye-aws <[email protected]> * correct default value for question parameter for alert insight API Signed-off-by: yuye-aws <[email protected]> * add pics for alert insight UI Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]>

ruanyl · 2024-11-01T04:36:27Z

@vagimeli This PR is ready for review, thanks :)

Signed-off-by: Fanit Kolchina <[email protected]>

natebower

@kolchfa-aws @ruanyl Please see my comments and changes and let me know if you have any questions. Thanks!

natebower · 2024-11-04T20:13:55Z

_dashboards/dashboards-assistant/alert-insight.md

+
+# Alert insights
+
+This is an experimental feature and is not recommended for use in a production environment. For updates on the progress the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/).    


Suggested change

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/).

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, join the discussion on the [OpenSearch forum](https://forum.opensearch.org/).

natebower · 2024-11-04T20:15:24Z

_dashboards/dashboards-assistant/alert-insight.md

+This is an experimental feature and is not recommended for use in a production environment. For updates on the progress the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/).    
+{: .warning}
+
+The OpenSearch Dashboards Assistant alert insights help generate alert summaries and provide log patterns based on the logs that triggered the alert.


Suggested change

The OpenSearch Dashboards Assistant alert insights help generate alert summaries and provide log patterns based on the logs that triggered the alert.

OpenSearch Dashboards Assistant alert insights generate alert summaries and provide log patterns based on the logs that triggered the alert.

natebower · 2024-11-04T20:17:46Z

_dashboards/dashboards-assistant/alert-insight.md

+    - A basic alert summary agent
+    - An agent for an alert summary that includes log patterns
+
+    These agents require different prompts. The prompt for the log patterns summary must include a placeholder `${parameters.topNLogPatternData}` and additional instructions to guide the LLM on using this information effectively. Note that log patterns are available only for query monitors created using OpenSearch Dashboards.


Suggested change

These agents require different prompts. The prompt for the log patterns summary must include a placeholder `${parameters.topNLogPatternData}` and additional instructions to guide the LLM on using this information effectively. Note that log patterns are available only for query monitors created using OpenSearch Dashboards.

These agents require different prompts. The prompt for the log patterns summary must include a placeholder `${parameters.topNLogPatternData}` and additional instructions that guide the large language model (LLM) in using this information effectively. Note that log patterns are available only for query monitors created using OpenSearch Dashboards.

natebower · 2024-11-04T20:18:14Z

_dashboards/dashboards-assistant/alert-insight.md

+
+### Step 3: Create the root agents
+
+Next, create [root agents]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-tutorial/#root_agent) for agents created in the previous step.


Suggested change

Next, create [root agents]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-tutorial/#root_agent) for agents created in the previous step.

Next, create [root agents]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-tutorial/#root_agent) for the agents created in the previous step.

natebower · 2024-11-04T20:19:11Z

_dashboards/dashboards-assistant/alert-insight.md

+```
+{% include copy-curl.html %}
+
+The created `os_insight` agent provides alert insights related to OpenSearch cluster metrics. For insights about alerts unrelated to OpenSearch cluster metrics, you need to register an agent with [this template](https://github.com/opensearch-project/flow-framework/blob/main/sample-templates/create-knowledge-base-alert-agent.json) and change the agent name to `KB_For_Alert_Insight`.


Suggested change

The created `os_insight` agent provides alert insights related to OpenSearch cluster metrics. For insights about alerts unrelated to OpenSearch cluster metrics, you need to register an agent with [this template](https://github.com/opensearch-project/flow-framework/blob/main/sample-templates/create-knowledge-base-alert-agent.json) and change the agent name to `KB_For_Alert_Insight`.

The `os_insight` agent provides alert insights related to OpenSearch cluster metrics. For insights about alerts unrelated to OpenSearch cluster metrics, you need to register an agent with [this template](https://github.com/opensearch-project/flow-framework/blob/main/sample-templates/create-knowledge-base-alert-agent.json) and change the agent name to `KB_For_Alert_Insight`.

_dashboards/dashboards-assistant/text-to-visualization.md

natebower · 2024-11-04T20:47:48Z

_dashboards/dashboards-assistant/text-to-visualization.md

+
+    <img src="{{site.url}}{{site.baseurl}}/images/dashboards-assistant/t2viz-start.png" alt="Create a visualization by selecting natural language">
+
+1. From the data sources dropdown list, select a data source, as shown in the following image. 


Should "data sources" be formatted as a UI element? (Data sources)

No, this is an unnamed text box

_dashboards/dashboards-assistant/text-to-visualization.md

_dashboards/dashboards-assistant/data-summary.md

_dashboards/dashboards-assistant/suggest-anomaly-detector.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

Signed-off-by: Yulong Ruan <[email protected]>

* fix doc for alert summary and insight Signed-off-by: yuye-aws <[email protected]> * fix doc Signed-off-by: yuye-aws <[email protected]> * change main branch to 2.x branch Signed-off-by: yuye-aws <[email protected]> * small fix Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]>

Signed-off-by: Fanit Kolchina <[email protected]>

natebower

@kolchfa-aws Two hyphenation changes. Thanks!

natebower · 2024-11-05T16:15:19Z

_dashboards/dashboards-assistant/alert-insight.md

@@ -32,7 +32,7 @@ assistant.alertInsight.enabled: true

 ### Step 2: Create the agents

-To orchestrate alert insights, you'll need to create the necessary [agents]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/#agents). To create an agent, send a `POST /_plugins/_ml/agents/_register` request and provide the agent template as a payload. For example, to create an alert summary agent, send the following request:
+To orchestrate alert insights, you'll need to create the necessary [agents]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/#agents). Create a workflow template for creating all necessary text to visualization agents by sending the following request:


"text-to-visualization agents"

natebower · 2024-11-05T16:16:14Z

_dashboards/dashboards-assistant/text-to-visualization.md


-To orchestrate text to visualization, create an `os_query_assist_ppl` agent. To create an agent, send a `POST /_plugins/_ml/agents/_register` request and provide the agent template as a payload. For more information, see [Configuring OpenSearch Assistant]({{site.url}}{{site.baseurl}}/dashboards/dashboards-assistant/index/#configuring-opensearch-assistant).
+To orchestrate text to visualization, you'll need to create the necessary [agents]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/#agents). Create a workflow template for creating all necessary text to visualization agents by sending the following request:


"text-to-visualization agents"

Signed-off-by: Fanit Kolchina <[email protected]>

kolchfa-aws

LGTM

Signed-off-by: Fanit Kolchina <[email protected]>

…mentation-website into add-dashboards-assistant-doc

* doc: add document for dashboards assistant text to visualization Signed-off-by: Yulong Ruan <[email protected]> * Add documentation for suggest anomaly detector feature (#1) Signed-off-by: gaobinlong <[email protected]> * doc: Add document for dashboard assistant alert insight (opensearch-project#2) * doc: Add document for dashboard assistant alert insight * fix title Signed-off-by: qianheng <[email protected]> * Add data summary documentation (opensearch-project#3) Signed-off-by: Liyun Xiu <[email protected]> * add doc for alert insight agent (opensearch-project#4) * add doc for alert insight agent Signed-off-by: yuye-aws <[email protected]> * add example request for alert insight API Signed-off-by: yuye-aws <[email protected]> * correct default value for question parameter for alert insight API Signed-off-by: yuye-aws <[email protected]> * add pics for alert insight UI Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * minor rewording Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Change to data summary feature Signed-off-by: Fanit Kolchina <[email protected]> * add instruction on how to create t2viz agents with flow template Signed-off-by: Yulong Ruan <[email protected]> * fix doc for alert summary and insight (opensearch-project#5) * fix doc for alert summary and insight Signed-off-by: yuye-aws <[email protected]> * fix doc Signed-off-by: yuye-aws <[email protected]> * change main branch to 2.x branch Signed-off-by: yuye-aws <[email protected]> * small fix Signed-off-by: yuye-aws <[email protected]> --------- Signed-off-by: yuye-aws <[email protected]> * Rewording agent creation steps Signed-off-by: Fanit Kolchina <[email protected]> * Editorial comment and rewording Signed-off-by: Fanit Kolchina <[email protected]> * Image sizes Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: gaobinlong <[email protected]> Signed-off-by: qianheng <[email protected]> Signed-off-by: Liyun Xiu <[email protected]> Signed-off-by: yuye-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: gaobinlong <[email protected]> Co-authored-by: qianheng <[email protected]> Co-authored-by: Liyun Xiu <[email protected]> Co-authored-by: yuye-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>

github-actions bot assigned kolchfa-aws Oct 28, 2024

Naarcha-AWS assigned vagimeli and unassigned kolchfa-aws Oct 28, 2024

xluo-aws mentioned this pull request Oct 29, 2024

[DOC][AI Assistant] Add documentation for AI Assistant #8119

Open

4 tasks

vagimeli added the v2.18.0 label Oct 29, 2024

ruanyl changed the title ~~doc: add document for dashboards assistant text to visualization~~ doc: add document for dashboards assistant Oct 30, 2024

ruanyl and others added 2 commits November 1, 2024 12:31

doc: add document for dashboards assistant text to visualization

6f88b8c

Signed-off-by: Yulong Ruan <[email protected]>

Add documentation for suggest anomaly detector feature (#1)

54cb14f

Signed-off-by: gaobinlong <[email protected]>

ruanyl force-pushed the add-dashboards-assistant-doc branch from b07cb5e to 685e460 Compare November 1, 2024 04:33

qianheng-aws and others added 3 commits November 1, 2024 12:35

doc: Add document for dashboard assistant alert insight (#2)

a0fb310

* doc: Add document for dashboard assistant alert insight * fix title Signed-off-by: qianheng <[email protected]>

Add data summary documentation (#3)

cd4e7c4

Signed-off-by: Liyun Xiu <[email protected]>

ruanyl force-pushed the add-dashboards-assistant-doc branch from 685e460 to 08a8508 Compare November 1, 2024 04:35

ruanyl marked this pull request as ready for review November 1, 2024 04:35

ruanyl requested review from kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable and epugh as code owners November 1, 2024 04:35

kolchfa-aws assigned kolchfa-aws and unassigned vagimeli Nov 1, 2024

kolchfa-aws added 2 commits November 4, 2024 15:08

Doc review

98c71ff

Signed-off-by: Fanit Kolchina <[email protected]>

minor rewording

10eda92

Signed-off-by: Fanit Kolchina <[email protected]>

natebower reviewed Nov 4, 2024

View reviewed changes

kolchfa-aws reviewed Nov 4, 2024

View reviewed changes

_dashboards/dashboards-assistant/data-summary.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed Nov 4, 2024

View reviewed changes

_dashboards/dashboards-assistant/suggest-anomaly-detector.md Outdated Show resolved Hide resolved

kolchfa-aws reviewed Nov 4, 2024

View reviewed changes

_dashboards/dashboards-assistant/suggest-anomaly-detector.md Outdated Show resolved Hide resolved

kolchfa-aws and others added 5 commits November 4, 2024 15:54

Apply suggestions from code review

d0e2e49

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>

Change to data summary feature

3faf58d

Signed-off-by: Fanit Kolchina <[email protected]>

add instruction on how to create t2viz agents with flow template

882f0a8

Signed-off-by: Yulong Ruan <[email protected]>

Rewording agent creation steps

93688a3

Signed-off-by: Fanit Kolchina <[email protected]>

natebower reviewed Nov 5, 2024

View reviewed changes

kolchfa-aws and others added 2 commits November 5, 2024 11:21

Editorial comment and rewording

f8e678d

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'main' into add-dashboards-assistant-doc

1b0135c

kolchfa-aws approved these changes Nov 5, 2024

View reviewed changes

kolchfa-aws and others added 3 commits November 5, 2024 12:50

Image sizes

656efd4

Signed-off-by: Fanit Kolchina <[email protected]>

Merge branch 'add-dashboards-assistant-doc' of github.com:ruanyl/docu…

77b509a

…mentation-website into add-dashboards-assistant-doc

Merge branch 'main' into add-dashboards-assistant-doc

612a6fd

kolchfa-aws merged commit 9a62529 into opensearch-project:main Nov 5, 2024
5 checks passed

yuye-aws mentioned this pull request Nov 12, 2024

[DOC] Correct document for dashboards assistant #8733

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add document for dashboards assistant #8622

doc: add document for dashboards assistant #8622

ruanyl commented Oct 28, 2024 •

edited by Naarcha-AWS

Loading

github-actions bot commented Oct 28, 2024

Naarcha-AWS commented Oct 28, 2024

ruanyl commented Oct 29, 2024

vagimeli commented Oct 29, 2024

ruanyl commented Nov 1, 2024

natebower left a comment

natebower Nov 4, 2024

natebower Nov 4, 2024

natebower Nov 4, 2024

natebower Nov 4, 2024

natebower Nov 4, 2024

natebower Nov 4, 2024

kolchfa-aws Nov 4, 2024

natebower left a comment

natebower Nov 5, 2024

natebower Nov 5, 2024

kolchfa-aws left a comment


		# Alert insights

		This is an experimental feature and is not recommended for use in a production environment. For updates on the progress the feature or if you want to leave feedback, join the discussion in the [OpenSearch forum](https://forum.opensearch.org/).

	The OpenSearch Dashboards Assistant alert insights help generate alert summaries and provide log patterns based on the logs that triggered the alert.
	OpenSearch Dashboards Assistant alert insights generate alert summaries and provide log patterns based on the logs that triggered the alert.

	These agents require different prompts. The prompt for the log patterns summary must include a placeholder `${parameters.topNLogPatternData}` and additional instructions to guide the LLM on using this information effectively. Note that log patterns are available only for query monitors created using OpenSearch Dashboards.
	These agents require different prompts. The prompt for the log patterns summary must include a placeholder `${parameters.topNLogPatternData}` and additional instructions that guide the large language model (LLM) in using this information effectively. Note that log patterns are available only for query monitors created using OpenSearch Dashboards.


		### Step 3: Create the root agents

		Next, create [root agents]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-tutorial/#root_agent) for agents created in the previous step.

	The created `os_insight` agent provides alert insights related to OpenSearch cluster metrics. For insights about alerts unrelated to OpenSearch cluster metrics, you need to register an agent with [this template](https://github.com/opensearch-project/flow-framework/blob/main/sample-templates/create-knowledge-base-alert-agent.json) and change the agent name to `KB_For_Alert_Insight`.
	The `os_insight` agent provides alert insights related to OpenSearch cluster metrics. For insights about alerts unrelated to OpenSearch cluster metrics, you need to register an agent with [this template](https://github.com/opensearch-project/flow-framework/blob/main/sample-templates/create-knowledge-base-alert-agent.json) and change the agent name to `KB_For_Alert_Insight`.


		<img src="{{site.url}}{{site.baseurl}}/images/dashboards-assistant/t2viz-start.png" alt="Create a visualization by selecting natural language">

		1. From the data sources dropdown list, select a data source, as shown in the following image.


		To orchestrate text to visualization, create an `os_query_assist_ppl` agent. To create an agent, send a `POST /_plugins/_ml/agents/_register` request and provide the agent template as a payload. For more information, see [Configuring OpenSearch Assistant]({{site.url}}{{site.baseurl}}/dashboards/dashboards-assistant/index/#configuring-opensearch-assistant).
		To orchestrate text to visualization, you'll need to create the necessary [agents]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/#agents). Create a workflow template for creating all necessary text to visualization agents by sending the following request:

doc: add document for dashboards assistant #8622

doc: add document for dashboards assistant #8622

Conversation

ruanyl commented Oct 28, 2024 • edited by Naarcha-AWS Loading

Description

Issues Resolved

Version

Frontend features

Checklist

github-actions bot commented Oct 28, 2024

Naarcha-AWS commented Oct 28, 2024

ruanyl commented Oct 29, 2024

vagimeli commented Oct 29, 2024

ruanyl commented Nov 1, 2024

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws left a comment

Choose a reason for hiding this comment

ruanyl commented Oct 28, 2024 •

edited by Naarcha-AWS

Loading