From cd84faa4a778c9dec4c66480f4e3aa76ef91031f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 7 Aug 2024 14:06:17 +0000 Subject: [PATCH] Fix typo (#7921) * gathering potential documentation attempts Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * considering the dashboard tutorial Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * place holder for js data structure usage Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * data-structures placeholder Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Updating index links Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * adding old doc to be merged Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Starting to link things together Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * fix broken link Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * respond to vale Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * more vale violations Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * name files consistently with docs site and fix links. Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * vale Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Minor tweaks. Moved Ubi under SEARCH. Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * add label for versining of spec and OS version Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * try to sort out vale error Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Converting mermaid diagrams to png's Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Updating query_id mermaid code Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Better way to ignore the mermaid scripts in the md files Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * description updates Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * schema.md updating (still need to update the mermaid diagram) Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * schema updates Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * updates Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Rebuilding main Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * merging in images Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Updating UBI spec number Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Use released version Signed-off-by: Eric Pugh * Update _search-plugins/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/index.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Addressing PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/data-structures.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Adding dsl intro Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Adding intro sentence Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Title adjust Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Addressing PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Addressing pr feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Addressing PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Fixing vale errors Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Finishing initial pr feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Next round of PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Describing chorus workbench link Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Adding captions for result tables Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * PR clean up Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Adding a few more suggestions Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * updating query filter for laptos Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Update _search-plugins/ubi/ubi-dashboard-tutorial.md Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * PR feedback Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> * Apply suggestions from code review Edits to all files to comply with OpenSearch standards; nav_order updates Signed-off-by: Heather Halter * Apply suggestions from code review Missed a file - more commits to the sql-query topic Signed-off-by: Heather Halter * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter * Apply suggestions from code review Cleaned up the sample query topic Signed-off-by: Heather Halter * Apply suggestions from code review Signed-off-by: Heather Halter * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter * Apply suggestions from code review Accepted editorial suggestions. Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update index.md Reformatted table info Signed-off-by: Heather Halter * Update _search-plugins/ubi/dsl-queries.md Signed-off-by: Heather Halter * Apply suggestions from code review Signed-off-by: Heather Halter * Update index.md Signed-off-by: Heather Halter * Update schemas.md Signed-off-by: Heather Halter * Update index.md Added a missing link and fixed the table. Signed-off-by: Heather Halter * Update index.md Changed the bold to italics Signed-off-by: Heather Halter * Update ubi-dashboard-tutorial.md Removed unnecessary note tag. Signed-off-by: Heather Halter * Update schemas.md Inserted comma Signed-off-by: Heather Halter * Update sql-queries.md Signed-off-by: Heather Halter * Apply suggestions from code review There were some hidden comments that I found in this file. Co-authored-by: Nathan Bower Signed-off-by: Heather Halter * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter * Update _search-plugins/ubi/sql-queries.md Signed-off-by: Heather Halter * Apply suggestions from code review Signed-off-by: Heather Halter * Update _search-plugins/ubi/schemas.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update schemas.md Removed links on 'object_id' and 'query_id' Signed-off-by: Heather Halter * Update sql-queries.md removed a note tag and fixed line 326 Signed-off-by: Heather Halter * Update sql-queries.md One more table heading Signed-off-by: Heather Halter * found a typo Signed-off-by: Eric Pugh --------- Signed-off-by: RasonJ <145287540+RasonJ@users.noreply.github.com> Signed-off-by: Eric Pugh Signed-off-by: Heather Halter Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: RasonJ <145287540+RasonJ@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Heather Halter Co-authored-by: Nathan Bower (cherry picked from commit ca1c9d9da8908b17e8787747cb4768af197ffa8e) Signed-off-by: github-actions[bot] --- _ml-commons-plugin/agents-tools/index.md | 4 ++-- _ml-commons-plugin/api/agent-apis/register-agent.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_ml-commons-plugin/agents-tools/index.md b/_ml-commons-plugin/agents-tools/index.md index 009906d4cf..1fa86bdf67 100644 --- a/_ml-commons-plugin/agents-tools/index.md +++ b/_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: ", + "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: ", "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/). \ No newline at end of file +- To use agents and tools in configuration automation, see [Automating configurations]({{site.url}}{{site.baseurl}}/automating-configurations/index/). diff --git a/_ml-commons-plugin/api/agent-apis/register-agent.md b/_ml-commons-plugin/api/agent-apis/register-agent.md index 820bb923f7..339c25bf0e 100644 --- a/_ml-commons-plugin/api/agent-apis/register-agent.md +++ b/_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: ", + "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: ", "parameters": { "model_id": "", "index": "", @@ -190,4 +190,4 @@ OpenSearch responds with an agent ID that you can use to refer to the agent: { "agent_id": "bpV_Zo0BRhAwb9PZqGja" } -``` \ No newline at end of file +```