Skip to content

[DOC] Minor mistakes in agentic-search and agents-tools documentations #11190

@akolarkunnu

Description

@akolarkunnu

What do you want to do?
Mistakes:

  1. Link - https://docs.opensearch.org/latest/vector-search/ai-search/agentic-search/#step-1-enable-the-agentic-search-feature-flag
    Comma is not required in the sample command, it will throw exception with comma. Please remove the comma:
    PUT _cluster/settings
    {
    "persistent" : {
    "plugins.neural_search.agentic_search_enabled": true,
    }
    }

  2. Link -https://docs.opensearch.org/latest/vector-search/ai-search/agentic-search/#step-4-create-a-search-pipeline
    Give link to QueryPlanningTool (https://docs.opensearch.org/latest/ml-commons-plugin/agents-tools/tools/query-planning-tool/) in the below text, so that reader can easily navigate to that link to learn more about QueryPlanningTool:
    "Create a search pipeline with an agentic query translator search request processor and pass the agent ID created with the QueryPlanningTool:"

  3. Link - https://docs.opensearch.org/latest/ml-commons-plugin/agents-tools/agents-tools-tutorial/#step-2-create-an-ingest-pipeline
    Copy links are not provided in the sample commands in this section.

  • Request a change to existing documentation

Tell us about your request. Provide a summary of the request.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
3.0

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Metadata

Metadata

Assignees

Labels

Backlog - DEVDeveloper assigned to issue is responsible for creating PR.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions