Add doc for scratchpad tools #11167
Add doc for scratchpad tools #11167
Conversation
Signed-off-by: Mingshi Liu <[email protected]>
|
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. |
kolchfa-aws
added
In progress
Signed-off-by: Mingshi Liu <[email protected]>
mingshl
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
kolchfa-aws
added
Tech review
Signed-off-by: Mingshi Liu <[email protected]>
|
|
||
| Parameter | Type | Required/Optional | Description | ||
| :--- | :--- | :--- | :--- | ||
| `notes` | String | Required (at execution) | The content to write to the scratchpad |
There was a problem hiding this comment.
why notes parameter here is marked as required, but on line 107, notes is optional?
There was a problem hiding this comment.
the notes field is optional in registering the tool but it's required when executing
There was a problem hiding this comment.
can you clarify that in the doc? it's kinda confusing and the execution/registration flow is not explained
There was a problem hiding this comment.
+1 Or we can combine into one table and mentioned optional during registration, required during execution
There was a problem hiding this comment.
@pyek-bot remembered that the tool has strict schema, so the notes field is required when executing, it can be empty string but it's a required field by schema. I have to make two tables to explain when register in agents, the notes field is optional, but in executing the tools by api, it's required.
check out this new commit and see this is easier to understand.
There was a problem hiding this comment.
@nathaliellenaa I am sure if this is a bug in execute API.
when I check the trace of agent execution, the tool can have no parameters, but if you use the same tool with tool execute api, you cannot pass empty parameters, I think there is strong validations there. If there is, I think we should take this validation off, there are use cases of tool execution will no parameter.
There was a problem hiding this comment.
Thanks Mingshi for catching this, will take a look
Signed-off-by: Mingshi Liu <[email protected]>
Signed-off-by: Mingshi Liu <[email protected]>
mingshl
added
Doc review
There was a problem hiding this comment.
@kolchfa-aws Editorial review complete. I've left my changes so that you can see them while reviewing. Otherwise, LGTM. Thanks!
There was a problem hiding this comment.
@kolchfa-aws Editorial review complete. I've left my changes so that you can see them while reviewing. Otherwise, LGTM. Thanks!
Signed-off-by: Nathan Bower <[email protected]>
|
@kolchfa-aws Editorial changes committed. |
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
…n-website into main-add-scratchpad
5 participants
Description
Add doc for scratchpad tools
Issues Resolved
Closes #11146
Version
_List the OpenSearch version to which this PR applies, e.g. 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.