docs: add role and tools to getting started cli experience #211
Conversation
|
FYI @mmurad2 - if this wasn't what you were envisioning let me know, happy to iterate on this |
|
this is a new one 😄
(source) |
Signed-off-by: Paul S. Schweigert <[email protected]> Fixes i-am-bee#148 We have found that bees perform best when: * they use fewer number of tools, and * they are provided explicit instructions/role Here we updated the getting started section of the README to incorporate those recommendations into the simple example. We update the system prompt to provide explicit instructions, and we remove the search tool as it isn't needed for weather-related queries. It also adds some tips related to these two points to the appropriate section. Additionally, it adds a yarn helper method to run the simple example: `yarn run quickstart` Signed-off-by: Paul S. Schweigert <[email protected]>
|
|
||
| ➡️ you can run this example after local installation, using the command `yarn start examples/agents/simple.ts` | ||
| ➡️ you can run this example after local installation, using the command `yarn run quickstart` |
| @@ -86,6 +101,8 @@ console.log(`Agent 🤖 : `, response.result.text); | |||
| > | |||
| > Documentation is available at https://i-am-bee.github.io/bee-agent-framework/ | |||
|
|
|||
| ➡️ See a more [advanced example](/examples/agents/bee.ts) | |||
| tools: [new OpenMeteoTool()], // for more explore 'bee-agent-framework/tools' | ||
| templates: { | ||
| system: BeeSystemPrompt.fork((old) => ({ | ||
| ...old, | ||
| defaults: { | ||
| instructions: | ||
| "You are a helpful assistant that uses tools to answer weather-related questions.", | ||
| }, | ||
| })), | ||
| }, |
There was a problem hiding this comment.
This definitely should not be part of README. Keep the example as is.
Ok, I think I misunderstood the ask here. Do we currently have a way to create an agent from the command line? I believe all the examples I saw here are running an existing source code file (e.g. Would there be a way to use the API here? That seems like the ideal way to add this kind of functionality, but I'm assuming that would need the whole stack and not just the framework, so might not be an option here... |
|
Why would you use an API in the framework? API is built on top of the framework. Maybe consult details in the related issue. |
Signed-off-by: Paul S. Schweigert [email protected]
Which issue(s) does this pull-request address?
Closes: #148
Description
We have found that bees perform best when:
Here we updated the getting started section of the README to incorporate those recommendations into the simple example. We update the system prompt to provide explicit instructions, and we remove the search tool as it isn't needed for weather-related queries. It also adds some tips related to these two points to the appropriate section.
Additionally, it adds a yarn helper method to run the simple example:
yarn run quickstartChecklist
yarn lintoryarn lint:fixyarn formatoryarn format:fixyarn test:unityarn test:e2eno tests included as this is a documentation change