From 9681203066385adcb356655405db337960b82b40 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Wed, 20 Mar 2024 16:40:47 -0400 Subject: [PATCH 1/5] Remove experimental feature labels and flags from OS Assistant-related pages Signed-off-by: Fanit Kolchina --- _automating-configurations/index.md | 2 +- _dashboards/dashboards-assistant/index.md | 5 +---- _ml-commons-plugin/agents-tools/agents-tools-tutorial.md | 5 +---- _ml-commons-plugin/agents-tools/index.md | 7 +------ _ml-commons-plugin/agents-tools/tools/agent-tool.md | 5 +---- _ml-commons-plugin/agents-tools/tools/cat-index-tool.md | 5 +---- .../agents-tools/tools/index-mapping-tool.md | 5 +---- _ml-commons-plugin/agents-tools/tools/index.md | 2 +- _ml-commons-plugin/agents-tools/tools/ml-model-tool.md | 5 +---- .../agents-tools/tools/neural-sparse-tool.md | 5 +---- _ml-commons-plugin/agents-tools/tools/ppl-tool.md | 5 +---- _ml-commons-plugin/agents-tools/tools/rag-tool.md | 5 +---- .../agents-tools/tools/search-alerts-tool.md | 5 +---- .../agents-tools/tools/search-anomaly-detectors.md | 5 +---- .../agents-tools/tools/search-anomaly-results.md | 5 +---- _ml-commons-plugin/agents-tools/tools/search-index-tool.md | 5 +---- .../agents-tools/tools/search-monitors-tool.md | 5 +---- _ml-commons-plugin/agents-tools/tools/vector-db-tool.md | 5 +---- .../agents-tools/tools/visualization-tool.md | 5 +---- _ml-commons-plugin/api/agent-apis/delete-agent.md | 5 +---- _ml-commons-plugin/api/agent-apis/execute-agent.md | 5 +---- _ml-commons-plugin/api/agent-apis/get-agent.md | 5 +---- _ml-commons-plugin/api/agent-apis/index.md | 5 +---- _ml-commons-plugin/api/agent-apis/register-agent.md | 5 +---- _ml-commons-plugin/api/agent-apis/search-agent.md | 5 +---- _ml-commons-plugin/opensearch-assistant.md | 7 +------ _observing-your-data/event-analytics.md | 3 --- 27 files changed, 26 insertions(+), 105 deletions(-) diff --git a/_automating-configurations/index.md b/_automating-configurations/index.md index a7462ad16a..78e738a320 100644 --- a/_automating-configurations/index.md +++ b/_automating-configurations/index.md @@ -8,7 +8,7 @@ redirect_from: /automating-configurations/ --- # Automating configurations -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } You can automate complex OpenSearch setup and preprocessing tasks by providing templates for common use cases. For example, automating machine learning (ML) setup tasks streamlines the use of OpenSearch ML offerings. diff --git a/_dashboards/dashboards-assistant/index.md b/_dashboards/dashboards-assistant/index.md index dd62347c31..963e47bd86 100644 --- a/_dashboards/dashboards-assistant/index.md +++ b/_dashboards/dashboards-assistant/index.md @@ -6,14 +6,11 @@ has_children: false has_toc: false --- -This is an experimental feature and is not recommended for use in a production environment. For updates on the feature's progress or to leave feedback, go to the [`dashboards-assistant` repository](https://github.com/opensearch-project/dashboards-assistant) on GitHub or the associated [OpenSearch forum thread](https://forum.opensearch.org/t/feedback-opensearch-assistant/16741). -{: .warning} - Note that machine learning models are probabilistic and that some may perform better than others, so the OpenSearch Assistant may occasionally produce inaccurate information. We recommend evaluating outputs for accuracy as appropriate to your use case, including reviewing the output or combining it with other verification factors. {: .important} # OpenSearch Assistant for OpenSearch Dashboards -Introduced 2.12 +**Generally available 2.13** {: .label .label-purple } The OpenSearch Assistant toolkit helps you create AI-powered assistants for OpenSearch Dashboards without requiring you to have specialized query tools or skills. diff --git a/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md b/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md index bc2b7443de..31178b47ab 100644 --- a/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md +++ b/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md @@ -7,12 +7,9 @@ nav_order: 10 --- # Agents and tools tutorial -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The following tutorial illustrates creating a flow agent for retrieval-augmented generation (RAG). A flow agent runs its configured tools sequentially, in the order specified. In this example, you'll create an agent with two tools: 1. `VectorDBTool`: The agent will use this tool to retrieve OpenSearch documents relevant to the user question. You'll ingest supplementary information into an OpenSearch index. To facilitate vector search, you'll deploy a text embedding model that translates text into vector embeddings. OpenSearch will translate the ingested documents into embeddings and store them in the index. When you provide a user question to the agent, the agent will construct a query from the question, run vector search on the OpenSearch index, and pass the relevant retrieved documents to the `MLModelTool`. diff --git a/_ml-commons-plugin/agents-tools/index.md b/_ml-commons-plugin/agents-tools/index.md index 016a077c62..40114c29c9 100644 --- a/_ml-commons-plugin/agents-tools/index.md +++ b/_ml-commons-plugin/agents-tools/index.md @@ -7,12 +7,9 @@ nav_order: 27 --- # Agents and tools -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. A _tool_ performs a set of specific tasks. Some examples of tools are the `VectorDBTool`, which supports vector search, and the `CATIndexTool`, which executes the `cat indices` operation. For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/). ## Agents @@ -171,8 +168,6 @@ plugins.ml_commons.rag_pipeline_feature_enabled: true ``` {% include copy.html %} -For more information about ways to enable experimental features, see [Experimental feature flags]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/experimental/). - ## Next steps - For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/). diff --git a/_ml-commons-plugin/agents-tools/tools/agent-tool.md b/_ml-commons-plugin/agents-tools/tools/agent-tool.md index 272456d693..d76ce65149 100644 --- a/_ml-commons-plugin/agents-tools/tools/agent-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/agent-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Agent tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `AgentTool` runs any agent. ## Step 1: Set up an agent for AgentTool to run diff --git a/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md b/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md index 77b28ed527..4aa4cf567a 100644 --- a/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # CAT Index tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `CatIndexTool` retrieves index information for the OpenSearch cluster, similarly to the [CAT Indices API]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-indices/). ## Step 1: Register a flow agent that will run the CatIndexTool diff --git a/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md b/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md index f27b0592a8..4e8b683ebf 100644 --- a/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Index Mapping tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `IndexMappingTool` retrieves mapping and setting information for indexes in your cluster. ## Step 1: Register a flow agent that will run the IndexMappingTool diff --git a/_ml-commons-plugin/agents-tools/tools/index.md b/_ml-commons-plugin/agents-tools/tools/index.md index fe6d574d63..cbb8ca907f 100644 --- a/_ml-commons-plugin/agents-tools/tools/index.md +++ b/_ml-commons-plugin/agents-tools/tools/index.md @@ -10,7 +10,7 @@ redirect_from: --- # Tools -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } A _tool_ performs a set of specific tasks. The following table lists all tools that OpenSearch supports. diff --git a/_ml-commons-plugin/agents-tools/tools/ml-model-tool.md b/_ml-commons-plugin/agents-tools/tools/ml-model-tool.md index c0f8aeab86..ceeda40528 100644 --- a/_ml-commons-plugin/agents-tools/tools/ml-model-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/ml-model-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # ML Model tool -**Introduced 2.12** +plugins.ml_commons.rag_pipeline_feature_enabled: true {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `MLModelTool` runs a machine learning (ML) model and returns inference results. ## Step 1: Create a connector for a model diff --git a/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md b/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md index bc1fd4845e..6bb950d8cb 100644 --- a/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Neural Sparse Search tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `NeuralSparseSearchTool` performs sparse vector retrieval. For more information about neural sparse search, see [Neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/). ## Step 1: Register and deploy a sparse encoding model diff --git a/_ml-commons-plugin/agents-tools/tools/ppl-tool.md b/_ml-commons-plugin/agents-tools/tools/ppl-tool.md index f153ca88f3..ccff96be9a 100644 --- a/_ml-commons-plugin/agents-tools/tools/ppl-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/ppl-tool.md @@ -9,12 +9,9 @@ grand_parent: Agents and tools --- # PPL tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `PPLTool` translates natural language into a PPL query. The tool provides an `execute` flag to specify whether to run the query. If you set the flag to `true`, the `PPLTool` runs the query and returns the query and the results. ## Prerequisite diff --git a/_ml-commons-plugin/agents-tools/tools/rag-tool.md b/_ml-commons-plugin/agents-tools/tools/rag-tool.md index ae3ad1281a..e736fc89f5 100644 --- a/_ml-commons-plugin/agents-tools/tools/rag-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/rag-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # RAG tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `RAGTool` performs retrieval-augmented generation (RAG). For more information about RAG, see [Conversational search]({{site.url}}{{site.baseurl}}/search-plugins/conversational-search/). RAG calls a large language model (LLM) and supplements its knowledge by providing relevant OpenSearch documents along with the user question. To retrieve relevant documents from an OpenSearch index, you'll need a text embedding model that facilitates vector search. diff --git a/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md b/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md index 387ef1cbab..340f3cff8c 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Search Alerts tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `SearchAlertsTool` retrieves information about generated alerts. For more information about alerts, see [Alerting]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/index/). ## Step 1: Register a flow agent that will run the SearchAlertsTool diff --git a/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md b/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md index de93a404a3..9266bdaf8b 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md +++ b/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Search Anomaly Detectors tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `SearchAnomalyDetectorsTool` retrieves information about anomaly detectors set up on your cluster. For more information about anomaly detectors, see [Anomaly detection]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/). ## Step 1: Register a flow agent that will run the SearchAnomalyDetectorsTool diff --git a/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md b/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md index bce27bba55..0f35da4b55 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md +++ b/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Search Anomaly Results tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `SearchAnomalyResultsTool` retrieves information about anomaly detector results. For more information about anomaly detectors, see [Anomaly detection]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/). ## Step 1: Register a flow agent that will run the SearchAnomalyResultsTool diff --git a/_ml-commons-plugin/agents-tools/tools/search-index-tool.md b/_ml-commons-plugin/agents-tools/tools/search-index-tool.md index 86ecbfc609..b320bd1601 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-index-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-index-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Search Index tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `SearchIndexTool` searches an index using a query written in query domain-specific language (DSL) and returns the query results. ## Step 1: Register a flow agent that will run the SearchIndexTool diff --git a/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md b/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md index 2b746d3453..6cd0f415df 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Search Monitors tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `SearchMonitorsTool` retrieves information about alerting monitors set up on your cluster. For more information about alerting monitors, see [Monitors]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/monitors/). ## Step 1: Register a flow agent that will run the SearchMonitorsTool diff --git a/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md b/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md index d8b8083df3..20e86ebcd2 100644 --- a/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md @@ -10,13 +10,10 @@ grand_parent: Agents and tools # Vector DB tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - The `VectorDBTool` performs dense vector retrieval. For more information about OpenSearch vector database capabilities, see [neural search]({{site.url}}{{site.baseurl}}/search-plugins/neural-search/). ## Step 1: Register and deploy a sparse encoding model diff --git a/_ml-commons-plugin/agents-tools/tools/visualization-tool.md b/_ml-commons-plugin/agents-tools/tools/visualization-tool.md index 1407232555..cbe6db57f8 100644 --- a/_ml-commons-plugin/agents-tools/tools/visualization-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/visualization-tool.md @@ -9,12 +9,9 @@ grand_parent: Agents and tools --- # Visualization tool -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - Use the `VisualizationTool` to find visualizations relevant to a question. ## Step 1: Register a flow agent that will run the VisualizationTool diff --git a/_ml-commons-plugin/api/agent-apis/delete-agent.md b/_ml-commons-plugin/api/agent-apis/delete-agent.md index 0327c3bf04..0768f69cbb 100644 --- a/_ml-commons-plugin/api/agent-apis/delete-agent.md +++ b/_ml-commons-plugin/api/agent-apis/delete-agent.md @@ -7,12 +7,9 @@ nav_order: 50 --- # Delete an agent -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - You can use this API to delete an agent based on the `agent_id`. ## Path and HTTP methods diff --git a/_ml-commons-plugin/api/agent-apis/execute-agent.md b/_ml-commons-plugin/api/agent-apis/execute-agent.md index 8302ac265f..53c3d3c76c 100644 --- a/_ml-commons-plugin/api/agent-apis/execute-agent.md +++ b/_ml-commons-plugin/api/agent-apis/execute-agent.md @@ -7,12 +7,9 @@ nav_order: 20 --- # Execute an agent -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - When an agent is executed, it runs the tools with which it is configured. ### Path and HTTP methods diff --git a/_ml-commons-plugin/api/agent-apis/get-agent.md b/_ml-commons-plugin/api/agent-apis/get-agent.md index be49a87502..c37c1d85af 100644 --- a/_ml-commons-plugin/api/agent-apis/get-agent.md +++ b/_ml-commons-plugin/api/agent-apis/get-agent.md @@ -7,12 +7,9 @@ nav_order: 20 --- # Get an agent -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - You can retrieve agent information using the `agent_id`. ## Path and HTTP methods diff --git a/_ml-commons-plugin/api/agent-apis/index.md b/_ml-commons-plugin/api/agent-apis/index.md index 4b6954a79f..1221c9406c 100644 --- a/_ml-commons-plugin/api/agent-apis/index.md +++ b/_ml-commons-plugin/api/agent-apis/index.md @@ -9,12 +9,9 @@ redirect_from: /ml-commons-plugin/api/agent-apis/ --- # Agent APIs -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. For more information, see [Agents and tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/). ML Commons supports the following agent-level APIs: diff --git a/_ml-commons-plugin/api/agent-apis/register-agent.md b/_ml-commons-plugin/api/agent-apis/register-agent.md index 75a63d40cf..e9ae88cf13 100644 --- a/_ml-commons-plugin/api/agent-apis/register-agent.md +++ b/_ml-commons-plugin/api/agent-apis/register-agent.md @@ -7,12 +7,9 @@ nav_order: 10 --- # Register an agent -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - Use this API to register an agent. Agents may be of the following types: diff --git a/_ml-commons-plugin/api/agent-apis/search-agent.md b/_ml-commons-plugin/api/agent-apis/search-agent.md index c5df482ac2..eabdf5879b 100644 --- a/_ml-commons-plugin/api/agent-apis/search-agent.md +++ b/_ml-commons-plugin/api/agent-apis/search-agent.md @@ -7,12 +7,9 @@ nav_order: 30 --- # Search for an agent -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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 [GitHub issue](https://github.com/opensearch-project/ml-commons/issues/1161). -{: .warning} - Use this command to search for agents you've already created. You can provide any OpenSearch search query in the request body. ## Path and HTTP methods diff --git a/_ml-commons-plugin/opensearch-assistant.md b/_ml-commons-plugin/opensearch-assistant.md index 3a8e0c8703..a4b84ed359 100644 --- a/_ml-commons-plugin/opensearch-assistant.md +++ b/_ml-commons-plugin/opensearch-assistant.md @@ -7,12 +7,9 @@ nav_order: 28 --- # OpenSearch Assistant Toolkit -**Introduced 2.12** +**Generally available 2.13** {: .label .label-purple } -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} - The OpenSearch Assistant Toolkit helps you create AI-powered assistants for OpenSearch Dashboards. The toolkit includes the following elements: - [**Agents and tools**]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/): _Agents_ interface with a large language model (LLM) and execute high-level tasks, such as summarization or generating Piped Processing Language (PPL) queries from natural language. The agent's high-level tasks consist of low-level tasks called _tools_, which can be reused by multiple agents. @@ -36,8 +33,6 @@ To enable OpenSearch Assistant, perform the following steps: ``` {% include copy.html %} -For more information about ways to enable experimental features, see [Experimental feature flags]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/experimental/). - ## Next steps - For more information about the OpenSearch Assistant UI, see [OpenSearch Assistant for OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/dashboards-assistant/index/) \ No newline at end of file diff --git a/_observing-your-data/event-analytics.md b/_observing-your-data/event-analytics.md index dd936b7d27..d85079e470 100644 --- a/_observing-your-data/event-analytics.md +++ b/_observing-your-data/event-analytics.md @@ -30,9 +30,6 @@ For more information about building PPL queries, see [Piped Processing Language] ### OpenSearch Dashboards Query Assistant -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} - Note that machine learning models are probabilistic and that some may perform better than others, so the OpenSearch Assistant may occasionally produce inaccurate information. We recommend evaluating outputs for accuracy as appropriate to your use case, including reviewing the output or combining it with other verification factors. {: .important} From 11bf4475ad3714354d1f83fae6afcbb779bf06cb Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 21 Mar 2024 12:09:53 -0400 Subject: [PATCH 2/5] Change generally available to introduced Signed-off-by: Fanit Kolchina --- _ml-commons-plugin/agents-tools/agents-tools-tutorial.md | 2 +- _ml-commons-plugin/agents-tools/index.md | 2 +- _ml-commons-plugin/agents-tools/tools/agent-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/cat-index-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/index-mapping-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/index.md | 2 +- _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/ppl-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/rag-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/search-alerts-tool.md | 2 +- .../agents-tools/tools/search-anomaly-detectors.md | 2 +- _ml-commons-plugin/agents-tools/tools/search-anomaly-results.md | 2 +- _ml-commons-plugin/agents-tools/tools/search-index-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/search-monitors-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/vector-db-tool.md | 2 +- _ml-commons-plugin/agents-tools/tools/visualization-tool.md | 2 +- _ml-commons-plugin/api/agent-apis/delete-agent.md | 2 +- _ml-commons-plugin/api/agent-apis/execute-agent.md | 2 +- _ml-commons-plugin/api/agent-apis/get-agent.md | 2 +- _ml-commons-plugin/api/agent-apis/index.md | 2 +- _ml-commons-plugin/api/agent-apis/register-agent.md | 2 +- _ml-commons-plugin/api/agent-apis/search-agent.md | 2 +- _ml-commons-plugin/custom-local-models.md | 2 +- _ml-commons-plugin/ml-dashboard.md | 2 +- _ml-commons-plugin/opensearch-assistant.md | 2 +- _ml-commons-plugin/pretrained-models.md | 2 +- _ml-commons-plugin/using-ml-models.md | 2 +- 27 files changed, 27 insertions(+), 27 deletions(-) diff --git a/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md b/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md index 31178b47ab..ad97d6d992 100644 --- a/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md +++ b/_ml-commons-plugin/agents-tools/agents-tools-tutorial.md @@ -7,7 +7,7 @@ nav_order: 10 --- # Agents and tools tutorial -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } The following tutorial illustrates creating a flow agent for retrieval-augmented generation (RAG). A flow agent runs its configured tools sequentially, in the order specified. In this example, you'll create an agent with two tools: diff --git a/_ml-commons-plugin/agents-tools/index.md b/_ml-commons-plugin/agents-tools/index.md index 40114c29c9..d39a07ba54 100644 --- a/_ml-commons-plugin/agents-tools/index.md +++ b/_ml-commons-plugin/agents-tools/index.md @@ -7,7 +7,7 @@ nav_order: 27 --- # Agents and tools -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. A _tool_ performs a set of specific tasks. Some examples of tools are the `VectorDBTool`, which supports vector search, and the `CATIndexTool`, which executes the `cat indices` operation. For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/). diff --git a/_ml-commons-plugin/agents-tools/tools/agent-tool.md b/_ml-commons-plugin/agents-tools/tools/agent-tool.md index d76ce65149..272af51e4d 100644 --- a/_ml-commons-plugin/agents-tools/tools/agent-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/agent-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Agent tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md b/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md index 4aa4cf567a..50ccf28b9b 100644 --- a/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/cat-index-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # CAT Index tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md b/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md index 4e8b683ebf..8649d2d74d 100644 --- a/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/index-mapping-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Index Mapping tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/index.md b/_ml-commons-plugin/agents-tools/tools/index.md index cbb8ca907f..8db522006e 100644 --- a/_ml-commons-plugin/agents-tools/tools/index.md +++ b/_ml-commons-plugin/agents-tools/tools/index.md @@ -10,7 +10,7 @@ redirect_from: --- # Tools -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } A _tool_ performs a set of specific tasks. The following table lists all tools that OpenSearch supports. diff --git a/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md b/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md index 6bb950d8cb..9fee4dcbd2 100644 --- a/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Neural Sparse Search tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/ppl-tool.md b/_ml-commons-plugin/agents-tools/tools/ppl-tool.md index ccff96be9a..72d8ba30b5 100644 --- a/_ml-commons-plugin/agents-tools/tools/ppl-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/ppl-tool.md @@ -9,7 +9,7 @@ grand_parent: Agents and tools --- # PPL tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } The `PPLTool` translates natural language into a PPL query. The tool provides an `execute` flag to specify whether to run the query. If you set the flag to `true`, the `PPLTool` runs the query and returns the query and the results. diff --git a/_ml-commons-plugin/agents-tools/tools/rag-tool.md b/_ml-commons-plugin/agents-tools/tools/rag-tool.md index e736fc89f5..1f6fafe49a 100644 --- a/_ml-commons-plugin/agents-tools/tools/rag-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/rag-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # RAG tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md b/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md index 340f3cff8c..76f9e4b4dc 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-alerts-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Search Alerts tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md b/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md index 9266bdaf8b..9f31dea057 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md +++ b/_ml-commons-plugin/agents-tools/tools/search-anomaly-detectors.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Search Anomaly Detectors tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md b/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md index 0f35da4b55..2f2728e32d 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md +++ b/_ml-commons-plugin/agents-tools/tools/search-anomaly-results.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Search Anomaly Results tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/search-index-tool.md b/_ml-commons-plugin/agents-tools/tools/search-index-tool.md index b320bd1601..b023522893 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-index-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-index-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Search Index tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md b/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md index 6cd0f415df..77b51d4964 100644 --- a/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/search-monitors-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Search Monitors tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md b/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md index 20e86ebcd2..9093541cbb 100644 --- a/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/vector-db-tool.md @@ -10,7 +10,7 @@ grand_parent: Agents and tools # Vector DB tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } diff --git a/_ml-commons-plugin/agents-tools/tools/visualization-tool.md b/_ml-commons-plugin/agents-tools/tools/visualization-tool.md index cbe6db57f8..98457932c2 100644 --- a/_ml-commons-plugin/agents-tools/tools/visualization-tool.md +++ b/_ml-commons-plugin/agents-tools/tools/visualization-tool.md @@ -9,7 +9,7 @@ grand_parent: Agents and tools --- # Visualization tool -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } Use the `VisualizationTool` to find visualizations relevant to a question. diff --git a/_ml-commons-plugin/api/agent-apis/delete-agent.md b/_ml-commons-plugin/api/agent-apis/delete-agent.md index 0768f69cbb..ddde8fb19b 100644 --- a/_ml-commons-plugin/api/agent-apis/delete-agent.md +++ b/_ml-commons-plugin/api/agent-apis/delete-agent.md @@ -7,7 +7,7 @@ nav_order: 50 --- # Delete an agent -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } You can use this API to delete an agent based on the `agent_id`. diff --git a/_ml-commons-plugin/api/agent-apis/execute-agent.md b/_ml-commons-plugin/api/agent-apis/execute-agent.md index 53c3d3c76c..27d50bced0 100644 --- a/_ml-commons-plugin/api/agent-apis/execute-agent.md +++ b/_ml-commons-plugin/api/agent-apis/execute-agent.md @@ -7,7 +7,7 @@ nav_order: 20 --- # Execute an agent -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } When an agent is executed, it runs the tools with which it is configured. diff --git a/_ml-commons-plugin/api/agent-apis/get-agent.md b/_ml-commons-plugin/api/agent-apis/get-agent.md index c37c1d85af..6190406649 100644 --- a/_ml-commons-plugin/api/agent-apis/get-agent.md +++ b/_ml-commons-plugin/api/agent-apis/get-agent.md @@ -7,7 +7,7 @@ nav_order: 20 --- # Get an agent -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } You can retrieve agent information using the `agent_id`. diff --git a/_ml-commons-plugin/api/agent-apis/index.md b/_ml-commons-plugin/api/agent-apis/index.md index 1221c9406c..72bf6082ce 100644 --- a/_ml-commons-plugin/api/agent-apis/index.md +++ b/_ml-commons-plugin/api/agent-apis/index.md @@ -9,7 +9,7 @@ redirect_from: /ml-commons-plugin/api/agent-apis/ --- # Agent APIs -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } You can automate machine learning (ML) tasks using agents and tools. An _agent_ orchestrates and runs ML models and tools. For more information, see [Agents and tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/index/). diff --git a/_ml-commons-plugin/api/agent-apis/register-agent.md b/_ml-commons-plugin/api/agent-apis/register-agent.md index e9ae88cf13..820bb923f7 100644 --- a/_ml-commons-plugin/api/agent-apis/register-agent.md +++ b/_ml-commons-plugin/api/agent-apis/register-agent.md @@ -7,7 +7,7 @@ nav_order: 10 --- # Register an agent -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } Use this API to register an agent. diff --git a/_ml-commons-plugin/api/agent-apis/search-agent.md b/_ml-commons-plugin/api/agent-apis/search-agent.md index eabdf5879b..3d950cde8f 100644 --- a/_ml-commons-plugin/api/agent-apis/search-agent.md +++ b/_ml-commons-plugin/api/agent-apis/search-agent.md @@ -7,7 +7,7 @@ nav_order: 30 --- # Search for an agent -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } Use this command to search for agents you've already created. You can provide any OpenSearch search query in the request body. diff --git a/_ml-commons-plugin/custom-local-models.md b/_ml-commons-plugin/custom-local-models.md index f96f784196..d3a2a3326a 100644 --- a/_ml-commons-plugin/custom-local-models.md +++ b/_ml-commons-plugin/custom-local-models.md @@ -7,7 +7,7 @@ nav_order: 120 --- # Custom local models -**Generally available 2.9** +**Introduced 2.9** {: .label .label-purple } To use a custom model locally, you can upload it to the OpenSearch cluster. diff --git a/_ml-commons-plugin/ml-dashboard.md b/_ml-commons-plugin/ml-dashboard.md index 3195aff8de..20c4e636bb 100644 --- a/_ml-commons-plugin/ml-dashboard.md +++ b/_ml-commons-plugin/ml-dashboard.md @@ -7,7 +7,7 @@ redirect_from: --- # Managing ML models in OpenSearch Dashboards -**Generally available 2.9** +**Introduced 2.9** {: .label .label-purple } Administrators of machine learning (ML) clusters can use OpenSearch Dashboards to manage and check the status of ML models running inside a cluster. This can help ML developers provision nodes to ensure their models run efficiently. diff --git a/_ml-commons-plugin/opensearch-assistant.md b/_ml-commons-plugin/opensearch-assistant.md index a4b84ed359..0a058d73a0 100644 --- a/_ml-commons-plugin/opensearch-assistant.md +++ b/_ml-commons-plugin/opensearch-assistant.md @@ -7,7 +7,7 @@ nav_order: 28 --- # OpenSearch Assistant Toolkit -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } The OpenSearch Assistant Toolkit helps you create AI-powered assistants for OpenSearch Dashboards. The toolkit includes the following elements: diff --git a/_ml-commons-plugin/pretrained-models.md b/_ml-commons-plugin/pretrained-models.md index c68f9c8bab..8847d36291 100644 --- a/_ml-commons-plugin/pretrained-models.md +++ b/_ml-commons-plugin/pretrained-models.md @@ -7,7 +7,7 @@ nav_order: 120 --- # OpenSearch-provided pretrained models -**Generally available 2.9** +**Introduced 2.9** {: .label .label-purple } OpenSearch provides a variety of open-source pretrained models that can assist with a range of machine learning (ML) search and analytics use cases. You can upload any supported model to the OpenSearch cluster and use it locally. diff --git a/_ml-commons-plugin/using-ml-models.md b/_ml-commons-plugin/using-ml-models.md index 5c23e19ab6..db50626721 100644 --- a/_ml-commons-plugin/using-ml-models.md +++ b/_ml-commons-plugin/using-ml-models.md @@ -10,7 +10,7 @@ redirect_from: --- # Using ML models within OpenSearch -**Generally available 2.9** +**Introduced 2.9** {: .label .label-purple } To integrate machine learning (ML) models into your OpenSearch cluster, you can upload and serve them locally. Choose one of the following options: From b5c74a2cf898cf7988d1c51bce346bad5f3a7253 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Mon, 25 Mar 2024 14:31:50 -0400 Subject: [PATCH 3/5] Remove ML settings for OS Assistant Signed-off-by: Fanit Kolchina --- _automating-configurations/index.md | 2 +- _dashboards/dashboards-assistant/index.md | 5 +---- _ml-commons-plugin/agents-tools/index.md | 16 ---------------- _observing-your-data/event-analytics.md | 2 +- 4 files changed, 3 insertions(+), 22 deletions(-) diff --git a/_automating-configurations/index.md b/_automating-configurations/index.md index 78e738a320..ef9cb4f850 100644 --- a/_automating-configurations/index.md +++ b/_automating-configurations/index.md @@ -8,7 +8,7 @@ redirect_from: /automating-configurations/ --- # Automating configurations -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } You can automate complex OpenSearch setup and preprocessing tasks by providing templates for common use cases. For example, automating machine learning (ML) setup tasks streamlines the use of OpenSearch ML offerings. diff --git a/_dashboards/dashboards-assistant/index.md b/_dashboards/dashboards-assistant/index.md index 963e47bd86..3801c19483 100644 --- a/_dashboards/dashboards-assistant/index.md +++ b/_dashboards/dashboards-assistant/index.md @@ -10,7 +10,7 @@ Note that machine learning models are probabilistic and that some may perform be {: .important} # OpenSearch Assistant for OpenSearch Dashboards -**Generally available 2.13** +**Introduced 2.13** {: .label .label-purple } The OpenSearch Assistant toolkit helps you create AI-powered assistants for OpenSearch Dashboards without requiring you to have specialized query tools or skills. @@ -46,9 +46,6 @@ A screenshot of the interface is shown in the following image. OpenSearch Assistant interface -For more information about ways to enable experimental features, see [Experimental feature flags]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/experimental/). -{: .note} - ## Configuring OpenSearch Assistant You can use the OpenSearch Dashboards interface to configure OpenSearch Assistant. Go to the [Getting started guide](https://github.com/opensearch-project/dashboards-assistant/blob/main/GETTING_STARTED_GUIDE.md) for step-by-step instructions. For the chatbot template, go to the [Flow Framework plugin](https://github.com/opensearch-project/flow-framework) documentation. You can modify this template to use your own model and customize the chatbot tools. diff --git a/_ml-commons-plugin/agents-tools/index.md b/_ml-commons-plugin/agents-tools/index.md index d39a07ba54..ba88edef2f 100644 --- a/_ml-commons-plugin/agents-tools/index.md +++ b/_ml-commons-plugin/agents-tools/index.md @@ -152,22 +152,6 @@ POST /_plugins/_ml/agents/_register It is important to provide thorough descriptions of the tools so that the LLM can decide in which situations to use those tools. {: .tip} -## Enabling the feature - -To enable agents and tools, configure the following setting: - -```yaml -plugins.ml_commons.agent_framework_enabled: true -``` -{% include copy.html %} - -For conversational agents, you also need to enable RAG for use in conversational search. To enable RAG, configure the following setting: - -```yaml -plugins.ml_commons.rag_pipeline_feature_enabled: true -``` -{% include copy.html %} - ## Next steps - For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/). diff --git a/_observing-your-data/event-analytics.md b/_observing-your-data/event-analytics.md index d85079e470..0628f2ad41 100644 --- a/_observing-your-data/event-analytics.md +++ b/_observing-your-data/event-analytics.md @@ -60,7 +60,7 @@ To set up **Query Assistant**, follow the steps in the [Getting started guide](h ## Saving a visualization -After Dashboards generates a visualization, save it if you want to revisit it or include it in an [operational panel]({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels). To save a visualization, expand the **Save** dropdown menu in the upper-right corner, enter a name for the visualization, and then select the **Save** button. You can reopen saved visualizations on the event analytics page. +After Dashboards generates a visualization, save it if you want to revisit it or include it in an [operational panel]({{site.url}}{{site.baseurl}}/observing-your-data/operational-panels/). To save a visualization, expand the **Save** dropdown menu in the upper-right corner, enter a name for the visualization, and then select the **Save** button. You can reopen saved visualizations on the event analytics page. ## Creating event analytics visualizations and adding them to dashboards From 6651fa9b5cf36196f243a4ac732d1028aad22f2f Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 28 Mar 2024 12:52:09 -0400 Subject: [PATCH 4/5] Query assistant is enabled by default Signed-off-by: Fanit Kolchina --- _observing-your-data/event-analytics.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/_observing-your-data/event-analytics.md b/_observing-your-data/event-analytics.md index 0628f2ad41..9d900f090c 100644 --- a/_observing-your-data/event-analytics.md +++ b/_observing-your-data/event-analytics.md @@ -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 +```yaml observability.query_assist.ppl_agent_name: "PPL agent" ``` 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. From 20ee91d2636ef23eb0b77bf85ca0bcea9f7cf170 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Thu, 28 Mar 2024 12:58:39 -0400 Subject: [PATCH 5/5] Revised per SME comments Signed-off-by: Fanit Kolchina --- _observing-your-data/event-analytics.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/_observing-your-data/event-analytics.md b/_observing-your-data/event-analytics.md index 9d900f090c..b8fe72964c 100644 --- a/_observing-your-data/event-analytics.md +++ b/_observing-your-data/event-analytics.md @@ -39,13 +39,7 @@ To simplify query building, the **OpenSearch Assistant** toolkit offers an assis #### Enabling Query Assistant -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: - -```yaml -observability.query_assist.ppl_agent_name: "PPL agent" -``` - -To enable summarization of responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option: +By default, **Query Assistant** is enabled in OpenSearch Dashboards. To enable summarization of responses, locate your copy of the `opensearch_dashboards.yml` file and set the following option: ```yaml observability.summarize.enabled: true