opensearch-project · kolchfa-aws · Mar 28, 2024 · Mar 20, 2024 · Mar 21, 2024 · Mar 25, 2024
@@ -8,7 +8,7 @@ redirect_from: /automating-configurations/
 ---
 
 # Automating configurations
-**Introduced 2.12**
+**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.

@@ -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
+**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.
@@ -49,9 +46,6 @@ A screenshot of the interface is shown in the following image.
 
 <img width="700" src="{{site.url}}{{site.baseurl}}/images/dashboards/opensearch-assistant-full-frame.png" alt="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. 

@@ -7,12 +7,9 @@ nav_order: 10
 ---
 
 # Agents and tools tutorial
-**Introduced 2.12**
+**Introduced 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`.

@@ -7,12 +7,9 @@ nav_order: 27
 ---
 
 # Agents and tools
-**Introduced 2.12**
+**Introduced 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
@@ -155,24 +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 %}
-
-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/).

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Agent tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # CAT Index tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Index Mapping tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,7 +10,7 @@ redirect_from:
 ---
 
 # Tools
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 
 A _tool_ performs a set of specific tasks. The following table lists all tools that OpenSearch supports.

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # ML Model tool
-**Introduced 2.12**
+plugins.ml_commons.rag_pipeline_feature_enabled: true
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Neural Sparse Search tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -9,12 +9,9 @@ grand_parent: Agents and tools
 ---
 
 # PPL tool
-**Introduced 2.12**
+**Introduced 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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # RAG tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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.

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Search Alerts tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Search Anomaly Detectors tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Search Anomaly Results tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Search Index tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Search Monitors tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -10,13 +10,10 @@ grand_parent: Agents and tools
 
 <!-- vale off -->
 # Vector DB tool
-**Introduced 2.12**
+**Introduced 2.13**
 {: .label .label-purple }
 <!-- vale on -->
 
-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

@@ -9,12 +9,9 @@ grand_parent: Agents and tools
 ---
 
 # Visualization tool
-**Introduced 2.12**
+**Introduced 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

@@ -7,12 +7,9 @@ nav_order: 50
 ---
 
 # Delete an agent
-**Introduced 2.12**
+**Introduced 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

@@ -7,12 +7,9 @@ nav_order: 20
 ---
 
 # Execute an agent
-**Introduced 2.12**
+**Introduced 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

@@ -7,12 +7,9 @@ nav_order: 20
 ---
 
 # Get an agent
-**Introduced 2.12**
+**Introduced 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

@@ -9,12 +9,9 @@ redirect_from: /ml-commons-plugin/api/agent-apis/
 ---
 
 # Agent APIs
-**Introduced 2.12**
+**Introduced 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:

@@ -7,12 +7,9 @@ nav_order: 10
 ---
 
 # Register an agent
-**Introduced 2.12**
+**Introduced 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:

@@ -7,12 +7,9 @@ nav_order: 30
 ---
 
 # Search for an agent
-**Introduced 2.12**
+**Introduced 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

@@ -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.