New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(tools): add HumanTool for human intervention during workflows #203

Closed

matiasmolinas wants to merge 49 commits into i-am-bee:main from matiasmolinas:fresh-human-tool

matiasmolinas commented Nov 29, 2024

Human intervention abstraction - Step 1

Description:
Step 1: Define the 'HumanTool' as a tool which can be equipped to any Bee and be invoked by it when it deems there is some missing information required for the following steps and hence must call out to the user to collect it. So I agree with you on the following:

Tool Name: 'HumanTool'
Tool Input: For a Bee to use this tool, it should generate a NL message asking the user for some specific information.
Tool Output: NL response from the end user
BeeAgentRunner 'HumanTool' Execution: The Runner should then execute the HumanTool by sending the NL message to the end user and wait for a response. Once the user has responded, the tool output (message from the user) is appended to the Agent memory and the loop for Action and ActionInput can continue

Closes: #121

Description

This Pull Request introduces the HumanTool to the Bee Agent Framework as part of Step 1 of the issue: Human intervention abstraction - enhancement. The tool enables Bees to interact with users during workflows to gather additional information.

Changes

Added HumanTool (src/tools/human.ts):
- Implements a tool to handle user input during workflows.
- Provides natural language (NL) input and output support.
Extended Bee Prompts (src/agents/bee/prompts.ts):
- Includes prompts for the HumanTool to integrate seamlessly with Bees.
Added Helper for Console Interaction (src/helpers/io.ts):
- Provides shared console reading functionality for tools like HumanTool.
Created an Experimental Agent (examples/agents/experimental/humantool_agent.ts):
- Demonstrates the usage of HumanTool in a real-world workflow scenario.

Checklist

I have read the contributor guide
Linting passes: yarn lint or yarn lint:fix
Formatting is applied: yarn format or yarn format:fix
Unit tests pass: yarn test:unit
E2E tests pass: yarn test:e2e
Tests are included
Documentation is changed or added
Commit messages and PR title follow conventional commits

matiasmolinas requested a review from a team as a code owner

November 29, 2024 21:41

ismaelfaro assigned vabarbosa

Author

matiasmolinas commented Dec 3, 2024

Fixing code formatting issues for consistency and readability

matiasmolinas force-pushed the fresh-human-tool branch from 62fbfe8 to be91ec6 Compare

December 3, 2024 14:12

Tomas2D requested changes

View reviewed changes

examples/agents/experimental/humantool_agent.ts Show resolved Hide resolved

matiasmolinas and others added 25 commits

December 7, 2024 05:30


          feat(tools): add HumanTool and experimental agent

a548b16

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): propagate groupId to events

82874cf

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(llms): improve type support for events

6e520b4

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(adapters): vLLM JSON Schema guided decoding (i-am-bee#207)

6d3b887

Signed-off-by: Jan Pokorný <jenompokorny@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(agents): add retry for parser errors (i-am-bee#204)

ff5ddc6

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          style(agents): fix formatting issues in humantool_agent and related f…

130ff07

…iles

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore: release 0.0.45

6bbd9c2

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(adapters): handle undefined values for CD in BAM/vLLM

b183664

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(tools)!: improve type support for events (i-am-bee#209)

65b0c4a

Emitter now must be defined manually for all new tools.

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(adapters): add Azure OpenAI LLM adapter (i-am-bee#201)

d52959f

Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          style(tools): fix formatting in HumanTool implementation

6b43a21

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(agents): separate human tool prompt from Bee default

5ddb5ca

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): revert prompts.ts to main branch version for testing

dc75d97

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): update human prompt for experimental tool

237f6fb

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          style(agents): fix code formatting for experimental human tool agent

a5a64ca

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          docs: update agents page

ce55f28

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(tools)!: make run options always partial with fallback to an emp…

178bf1d

…ty object

The "options" parameter in Tool's run method now fallbacks to an empty object to allow overrides.

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(llms)!: make "options" parameter for generate/stream always partial

6fb1736

The "options" parameter in stream/run method now fallbacks to an empty object to allow overrides.

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore: release 0.0.46

da53392

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat: example agent using IBM Granite LLM (i-am-bee#213)

6ba0263

Signed-off-by: Graham White <gwhite@uk.ibm.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore: provide correct model id for granite vllm example (i-am-bee#215)

d8314ec

Signed-off-by: MICHAEL DESMOND <mdesmond@us.ibm.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): broaden the granite runner check (i-am-bee#217)

8fe1e58

Signed-off-by: MICHAEL DESMOND <mdesmond@us.ibm.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(internals): update type for context in FrameworkError

418ac01

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(agents): extends the error-related context of LinePrefixParser

91d4d86

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): retry on a parser error

6e07751

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>

Tomas2D and others added 17 commits

December 7, 2024 05:30


          feat(agents)!: set auto retry for Bee as a default behaviour

e46c67e

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore: release 0.0.47

e7b4f2f

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(llms): correct the vllm granite model_id (i-am-bee#218)

3f55548

Signed-off-by: MICHAEL DESMOND <mdesmond@us.ibm.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          revert(agents): update constrained decoding for Bee (i-am-bee#220)

b0d0a3f

Signed-off-by: Matous Havlena <havlenma@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(agents): update system prompt for Bee (i-am-bee#199)

290dd15

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          refactor(agents): simplify humantool_agent.ts by creating a minimal w…

d0a4615

…orking example

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(agents): update \humantool_agent.ts\ to align system prompt usage…

ddfc26c

… and optimize testing

Refactored \humantool_agent.ts\ based on PR feedback:
- Retained the original system prompt to prevent unnecessary changes.
- Adjusted testing to use LLaMA instead of GPT-4 as per optimization requirements.
- Addressed issues where the model occasionally skipped tool calling.

Ref: i-am-bee#121

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(tools): improve human tool description and use default system prompt

6ccb3f1

Removed the extended prompt for the human tool, enhanced the tool description, and updated the example to use the default system prompt.

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(agents): use prompt templates from a concrete runner (i-am-bee#223)

9980b5f

Ref: i-am-bee#219

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(tools): rename CustomToolEmitter to ToolEmitter

57f7a03

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(internals): extends RestfulClient by emitting events

2a4c3e2

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat(adapters): add watsonx debug example

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore(tests): update env checks

68a6dac

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          chore: release 0.0.48

d651a4a

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          feat: preserve comments in dist

d6ebefa

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          docs(tools): update examples

df5438a

Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          style: apply Prettier formatting

2f81a3e

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>

matiasmolinas force-pushed the fresh-human-tool branch from fdeb93f to 2f81a3e Compare

December 7, 2024 08:31

matiasmolinas added 3 commits

December 7, 2024 05:49


          Merge remote-tracking branch 'origin/main' into fresh-human-tool

b01c2dd


          refactor(tools): move HumanTool to examples and remove duplicate io l…

2c2d9d6

…ogic

Signed-off-by: Matias Molinas <matias.molinas@gmail.com>


          fix(tools): prevent session closure after HumanTool usage

383b082

Ref: i-am-bee#121
Signed-off-by: Matias Molinas <matias.molinas@gmail.com>

matiasmolinas requested a review from Tomas2D

December 10, 2024 13:19

matiasmolinas added 4 commits

December 10, 2024 19:27


          Merge branch 'main' into fresh-human-tool

cd3909d


          Merge branch 'main' into fresh-human-tool

3cd1d97


          Merge branch 'main' into fresh-human-tool

91c6934


          Merge branch 'main' into fresh-human-tool

378b89f

Author

matiasmolinas commented Dec 13, 2024

There is a complex merge and an issue in one commit message that is difficult to fix. I will take the latest files, create a new branch called fresh-human-tool-new, and open a new PR.

matiasmolinas closed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet