[ML] Add tool output processor documentation #11171
Conversation
Signed-off-by: Pavan Yekbote <pybot@amazon.com>
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
pyek-bot
requested review from
kolchfa-aws,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
| "parameters": { | ||
| "output_processors": [ | ||
| { | ||
| "type": "regex_replace", |
There was a problem hiding this comment.
maybe we should make a code change in ml-commons to support description field to make it easier for understand what each processor for.
There was a problem hiding this comment.
is it for when you do a user does get on this agent the descriptions get populated?
Signed-off-by: Pavan Yekbote <pybot@amazon.com>
|
@ylwu-amzn Addressed the comments and moved some sections around. Please review again, thanks! |
kolchfa-aws
added
Tech review
Signed-off-by: Pavan Yekbote <pybot@amazon.com>
|
|
||
| Output processors provide a powerful way to: | ||
|
|
||
| - **Transform data formats**: Convert between different data structures (strings, JSON, arrays) |
There was a problem hiding this comment.
now that there are different types of processors, you might want to write a list and explain each
There was a problem hiding this comment.
each processor is explained in its own section below, are you suggesting to maintain a table?
There was a problem hiding this comment.
yes, checkout this page, https://docs.opensearch.org/latest/search-plugins/search-pipelines/search-processors/ i think a table is great to show like how many processors and what are the types in a summary
There was a problem hiding this comment.
thanks @mingshl for the reference! I added a table as a summary.
Signed-off-by: Pavan Yekbote <pybot@amazon.com>
|
Hey @pyek-bot , let me know when this PR is ready for doc review. We have 3 days left before the release. |
Description
Adds tool output processor feature details
Issues Resolved
Closes #11157
Version
3.3
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.