[Feature Request] Toolkits Refactoring

WHALEEYE commented 1 month ago

Required prerequisites

[X] I have searched the Issue Tracker and Discussions that this hasn't already been reported. (+1 or comment there if it has.)
[ ] Consider asking first in a Discussion.

Motivation

The current style of toolkits is quite chaotic, we need to make it more standardized to ensure the code quality and also for the ease of adding future tools.

Solution

No response

Alternatives

No response

Additional context

No response

lightaime commented 1 month ago

Part of the refactoring:

[ ] Support tool names: https://github.com/camel-ai/camel/issues/946 by @yiyiyi0817
[ ] Add a AllToolKit class to have all tools in once place: https://github.com/camel-ai/camel/issues/947 @ZackYule
[ ] Support tool search in ToolKit: https://github.com/camel-ai/camel/pull/603, https://github.com/camel-ai/camel/issues/948 @Wendong-Fan
[ ] Support auto tool schema or docstring generation for OpenAIFunction: https://github.com/camel-ai/camel/issues/949 @Zhangzeyu97 @Wendong-Fan
[ ] A unify api key management for tools: https://github.com/camel-ai/camel/issues/950 @NeilJohnson0930 @WHALEEYE
[ ] Support conditional tool calling: https://github.com/camel-ai/camel/issues/951 @yiyiyi0817 @zhiyu-01 @WHALEEYE @ZackYule
[ ] Tool calling execution modes: https://github.com/camel-ai/camel/issues/1008https://github.com/camel-ai/camel/issues/1008 @Zhangzeyu97 @WHALEEYE
[ ] Add tools for GAIA benchmark: https://github.com/camel-ai/camel/issues/1014 @CaelumF @yuzhenmao
[ ] Add function calling benchmark and tools: https://github.com/camel-ai/camel/issues/1013 @CaelumF @yuzhenmao

ZackYule commented 3 weeks ago

I have a couple of detail questions regarding the Toolkits refactoring that might be worth considering：

Q1: Would it make sense to replace BaseToolkit classes that don’t require any configuration with functional tools instead? This way, we could avoid exposing classes without actual tool methods in the ToolManager, streamlining the structure.

Q2: I think it might be better if the tool list returned by ToolManager is List[str] when intended for user interaction, and list[OpenAIFunction] when used by the agent. Since list_toolkits is primarily for users, it seems reasonable for it to return List[str]. As for search_toolkits, should it be designed for user use or for the agent?

ZackYule commented 3 weeks ago

Below are the current ways we use tools, and I believe it would be helpful to consider unifying these approaches while also supporting developers in customizing their own tools.

There’s also one more point to consider: the OpenAPIToolkit doesn’t currently support the management approach used by toolkits_manager.

Perhaps it would be a good idea to revisit and discuss these details again. @lightaime @yiyiyi0817 @zhiyu-01

1. Without `toolkit_manager`

No configuration needed

tools_list = [
  *SEARCH_FUNCS,
  *MathToolkit().get_tools(),
]

Configuration needed

toolkit = GithubToolkit(repo_name=repo_name)

tools_list = [
  *SEARCH_FUNCS,
  *WEATHER_FUNCS,
  *toolkit.get_tools(),
]

2. With `toolkits_manager`

No configuration needed

tools_list = manager.get_toolkits(names=manager.search_toolkits('weather'))

Configuration needed

camel_github_toolkit = GithubToolkit(repo_name='camel-ai/camel')

tools_list = manager.register_tool([camel_github_toolkit, ])

Custom tools

def div(a: int, b: int) -> float:
    r"""Divides two numbers.
    Args:
        a (int): The dividend in the division.
        b (int): The divisor in the division.
    Returns:
        float: The quotient of the division.
    Raises:
        ValueError: If the divisor is zero.
    """
    if b == 0:
        raise ValueError("Division by zero is not allowed.")
    return a / b

tools_list = manager.register_tool([div, ])

camel-ai / camel