Add doc for scratchpad tools #11167
Add doc for scratchpad tools #11167
Conversation
Signed-off-by: Mingshi Liu <mingshl@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. |
kolchfa-aws
added
In progress
Signed-off-by: Mingshi Liu <mingshl@amazon.com>
mingshl
requested review from
kolchfa-aws,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
kolchfa-aws
added
Tech review
| {: .label .label-purple } | ||
| <!-- vale on --> | ||
|
|
||
| The scratchpad tools consist of `WriteToScratchPadTool` and `ReadFromScratchPadTool`, which enable agents to store and retrieve intermediate thoughts and results in persistent memory. These tools allow agents to break down complex tasks into smaller steps, maintain state across interactions, and facilitate communication between multiple agents. |
There was a problem hiding this comment.
persistent memory here implies that the contents of scratchpad are persisted across runs, but this is not case
| Parameter | Type | Required/Optional | Description | ||
| :--- | :--- | :--- | :--- | ||
| `question` | String | Required | The research question or task for the agent to work on | ||
| `notes` | String | Optional | Specific notes to write to the scratchpad (when using WriteToScratchPadTool directly) |
There was a problem hiding this comment.
can u show an example for this?
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.