Fix typo (#7921)

* gathering potential documentation attempts

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

* considering the dashboard tutorial

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

* place holder for js data structure usage

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

* data-structures placeholder

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

* Updating index links

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

* adding old doc to be merged

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

* Starting to link things together

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

* fix broken link

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

* respond to vale

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

* more vale violations

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

* name files consistently with docs site and fix links.

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

* vale

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

* Minor tweaks.  Moved Ubi under SEARCH.

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

* add label for versining of spec and OS version

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

* try to sort out vale error

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

* Converting mermaid diagrams to png's

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

* Updating query_id mermaid code

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

* Better way to ignore the mermaid scripts in the md files

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

* description updates

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

* schema.md updating (still need to update the mermaid diagram)

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

* schema updates

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

* updates

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

* Rebuilding main

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

* merging in images

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

* Updating UBI spec number

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

* Use released version

Signed-off-by: Eric Pugh <[email protected]>

* Update _search-plugins/index.md

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

* Update _search-plugins/ubi/index.md

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

* Update _search-plugins/ubi/index.md

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

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

* Addressing PR feedback

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

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

* Update _search-plugins/ubi/data-structures.md

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

* Update _search-plugins/ubi/data-structures.md

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

* Update _search-plugins/ubi/data-structures.md

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

* Update _search-plugins/ubi/data-structures.md

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

* Adding dsl intro

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

* Adding intro sentence

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

* Title adjust

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Addressing PR feedback

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

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

* Addressing pr feedback

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

* Addressing PR feedback

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

* Fixing vale errors

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

* Apply suggestions from code review

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

* Finishing initial pr feedback

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

* Next round of PR feedback

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

* Describing chorus workbench link

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

* Adding captions for result tables

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

* PR clean up

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

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Adding a few more suggestions

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

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* updating query filter for laptos

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* PR feedback

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

* Update _search-plugins/ubi/ubi-dashboard-tutorial.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* PR feedback

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

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: RasonJ <[email protected]>

* Apply suggestions from code review

Edits to all files to comply with OpenSearch standards; nav_order updates

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Missed a file - more commits to the sql-query topic

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/sql-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Cleaned up the sample query topic

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/dsl-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/dsl-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Accepted editorial suggestions.

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update index.md

Reformatted table info

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/dsl-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Signed-off-by: Heather Halter <[email protected]>

* Update index.md

Signed-off-by: Heather Halter <[email protected]>

* Update schemas.md

Signed-off-by: Heather Halter <[email protected]>

* Update index.md

Added a missing link and fixed the table.

Signed-off-by: Heather Halter <[email protected]>

* Update index.md

Changed the bold to italics

Signed-off-by: Heather Halter <[email protected]>

* Update ubi-dashboard-tutorial.md

Removed unnecessary note tag.

Signed-off-by: Heather Halter <[email protected]>

* Update schemas.md

Inserted comma

Signed-off-by: Heather Halter <[email protected]>

* Update sql-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

There were some hidden comments that I found in this file.

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/sql-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/sql-queries.md

Signed-off-by: Heather Halter <[email protected]>

* Apply suggestions from code review

Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/ubi/schemas.md

Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

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

* Update schemas.md

Removed links on 'object_id' and 'query_id'

Signed-off-by: Heather Halter <[email protected]>

* Update sql-queries.md

removed a note tag and fixed line 326

Signed-off-by: Heather Halter <[email protected]>

* Update sql-queries.md

One more table heading

Signed-off-by: Heather Halter <[email protected]>

* found a typo

Signed-off-by: Eric Pugh <[email protected]>

---------

Signed-off-by: RasonJ <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: RasonJ <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>

_ml-commons-plugin/agents-tools/index.md

@@ -130,7 +130,7 @@ POST /_plugins/_ml/agents/_register
     {
       "type": "VectorDBTool",
       "name": "VectorDBTool",
-      "description": "A tool to search opensearch index with natural language quesiotn. If you don't know answer for some question, you should always try to search data with this tool. Action Input: <natrual language question>",
+      "description": "A tool to search opensearch index with natural language question. If you don't know answer for some question, you should always try to search data with this tool. Action Input: <natrual language question>",
       "parameters": {
         "model_id": "YOUR_TEXT_EMBEDDING_MODEL_ID",
         "index": "my_test_data",
@@ -157,4 +157,4 @@ It is important to provide thorough descriptions of the tools so that the LLM ca
 - For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/).
 - For a step-by-step tutorial, see [Agents and tools tutorial]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/agents-tools-tutorial/).
 - For supported APIs, see [Agent APIs]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/agent-apis/).
-- To use agents and tools in configuration automation, see [Automating configurations]({{site.url}}{{site.baseurl}}/automating-configurations/index/).
+- To use agents and tools in configuration automation, see [Automating configurations]({{site.url}}{{site.baseurl}}/automating-configurations/index/).

_ml-commons-plugin/api/agent-apis/register-agent.md

@@ -161,7 +161,7 @@ POST /_plugins/_ml/agents/_register
     {
       "type": "VectorDBTool",
       "name": "VectorDBTool",
-      "description": "A tool to search opensearch index with natural language quesiotn. If you don't know answer for some question, you should always try to search data with this tool. Action Input: <natrual language question>",
+      "description": "A tool to search opensearch index with natural language question. If you don't know answer for some question, you should always try to search data with this tool. Action Input: <natrual language question>",
       "parameters": {
         "model_id": "<embedding_model_id>",
         "index": "<your_knn_index>",
@@ -190,4 +190,4 @@ OpenSearch responds with an agent ID that you can use to refer to the agent:
 {
   "agent_id": "bpV_Zo0BRhAwb9PZqGja"
 }
-```
+```