BMTools

<div align="center"> <h1><img src="https://yellow-cdn.veclightyear.com/835a84d5/73a099a0-83bf-4d56-8251-5c7678b2cfec.png" height="28px" /> BMTools</h1> </div> <p align="center"> <a href="#最新动态">最新动态</a> • <a href="#1-设置">设置</a> • <a href="#2-使用现有工具">使用方法</a> • <a href="https://arxiv.org/abs/2304.08354">论文</a> • <a href="https://bmtools.readthedocs.io/en/main/">文档</a> • <a href="https://github.com/thunlp/ToolLearningPapers">论文列表</a> • <a href="https://huggingface.co/spaces/congxin95/BMTools-demo">演示</a> • <a href="#引用">引用</a> • </p>

阅读中文版。

<br> <div align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/2f8bae2a-20a4-4ce8-8aa8-0526b7036c26.png" width="700px"> </div> <br>

BMTools是一个开源仓库，它通过工具扩展语言模型的能力，并为社区提供构建和分享工具的平台。在这个仓库中，你可以(1)通过编写Python函数轻松构建插件 (2)使用外部ChatGPT插件。

这个项目受到开源项目LangChain的启发，并针对ChatGPT-Plugins等开源工具的使用进行了优化，力求成为ChatGPT插件的开源学术版本。

• 有关新功能和进一步开发，请访问XAgent。

• 使用BMTools操作元分析工具的演示。

<div align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/b78904d9-8ad7-410d-adfa-64eb91e7b227.gif" width="700px"> </div>

最新动态

• [2023/5/28] 我们发布了ToolBench，这是一个大规模工具学习基准，同时附带一个强大的模型。

• [2023/5/25] 论文中使用的部分评估数据已在data-test发布，我们还创建了大规模SFT（100k+）高质量工具使用训练数据，可在data-sft获取。

• [2023/5/19] 新增支持三种工具：百度地图、谷歌学术搜索和Zillow

• [2023/5/18] WebCPM被ACL 2023接收，这是WebGPT的中文版本。

• [更早] BMTools现已支持Auto-GPT和BabyAGI。

1. 设置

git clone git@github.com:OpenBMB/BMTools.git
cd BMTools
pip install --upgrade pip
pip install -r requirements.txt
python setup.py develop

支持CPM-Bee：

git clone -b main --single-branch https://github.com/OpenBMB/CPM-Bee.git
cp -rf CPM-Bee/src/cpm_live bmtools/models/

2. 使用现有工具

2.1 设置工具

2.1.1 本地工具

将你的API密钥添加到secret_keys.sh，然后启动本地工具

source secret_keys.sh
python host_local_tools.py

然后将插件的URL设置为http://127.0.0.1:8079/tools/{tool_name}/（记得在末尾加上/）。

2.1.2 使用在线ChatGPT插件

只需使用指向.well-known/ai-plugin.json的URL加载它 例如，将URL设置为https://www.klarna.com/，其中https://www.klarna.com/.well-known/ai-plugin.json是一个有效的配置。

2.2 使用单个工具

from bmtools.agent.singletool import load_single_tools, STQuestionAnswerer

tool_name, tool_url = 'klarna',  'https://www.klarna.com/'
tool_name, tool_config = load_single_tools(tool_name, tool_url)
print(tool_name, tool_config)
stqa =  STQuestionAnswerer()

agent = stqa.load_tools(tool_name, tool_config)
agent("{你的问题}")

2.3 使用多个工具

我们可以同时使用多个工具。基本上，语言模型会递归地执行这个过程。它会将整个工具视为一个API，向其发送问题，然后工具会调用其子API来解决问题并将结果返回给父工具。

尝试使用以下脚本来实现这个功能：

from bmtools.agent.tools_controller import load_valid_tools, MTQuestionAnswerer
tools_mappings = {
    "klarna": "https://www.klarna.com/",
    "chemical-prop": "http://127.0.0.1:8079/tools/chemical-prop/",
    "wolframalpha": "http://127.0.0.1:8079/tools/wolframalpha/",
}

tools = load_valid_tools(tools_mappings)

qa =  MTQuestionAnswerer(openai_api_key='', all_tools=tools)

agent = qa.build_runner()

agent("9H-咔唑-3-甲醛中有多少个苯环？sin(x)*exp(x)的图像是什么样的？它从0到1的积分是多少？")

2.4 使用网页演示

1. 在web_demo.py开头的映射中添加你的插件

2. 启动网页演示

python web_demo.py

3. 使用自定义工具

3.1 本地开发工具

要在本地开发工具，你需要编写一个Python函数来构建工具并将其注册到注册表中。

例如，你可以编写一个能执行Python代码并返回结果的工具。以下是示例代码：

from bmtools.tools import Tool
from pydantic import BaseModel

class ExecutionQuery(BaseModel):
    code: str

class ExecutionResult(BaseModel):
    result: str

def build_python_tool(config) -> Tool:
    tool = Tool(
        "PythonTool",
        "一个可以执行Python代码的插件",
        name_for_model="python", 
        description_for_model="一个可以执行Python代码的插件",
        contact_email="your@email",
    )

    @tool.post("/execute")
    def execute_python_code(query : ExecutionQuery) -> ExecutionResult:
        return ExecutionResult(
            result=eval(query.code)
        )
    
    return tool

然后你需要使用以下代码将工具注册到注册表中：

from bmtools.tools import register

@register("python")
def register_python_tool():
    return build_python_tool

这里我们将工具注册为名称"python"。

3.2 为BMTools贡献

开发完工具后，你可以按照以下步骤为BMTools做出贡献：

1. Fork这个仓库
2. 在bmtools/tools/{tool_name}中创建一个文件夹
3. 在文件夹中添加一个api.py：bmtools/tools/{tool_name}/api.py和一个__init__.py：bmtools/tools/{tool_name}/__init__.py
4. 使用第3.1节中的代码在你创建的__init__.py文件中注册工具
5. 在bmtools/tools下的__init__.py文件中导入你的工具
6. 添加一个test.py来自动测试你的工具
7. 在你的文件夹中添加一个readme.md，包含简短介绍、贡献者信息或任何你想让其他人知道的内容

4. 优化你的工具提示

你编写的函数将被转换为与OpenAI插件兼容的接口。AI模型将读取工具的名称、描述以及工具API的名称和描述。你可以调整以下方面，使AI模型更好地理解你的API：

• (1) name_for_model（告诉模型这个工具是什么）
• (2) description_for_model（这将在工具被调用之前显示给模型，你可以包含如何使用API的信息）
• (3) 每个API函数的函数名，以及@tool.get()中的名称。最好这两个名称匹配，因为名称在模型的API选择中起着重要作用
• (4) 函数的文档字符串（可以建议模型是否使用此API）
• (5) 函数的返回值，可以为模型提供错误消息以指导其下一步操作，如重试或指示首选的下一步
• (6) 减少API函数中的错误

一个简单的参考示例是Wolfram Alpha API。

引用

如果你在研究中使用了BMTools，请引用：

@misc{qin2023tool,
      title={Tool Learning with Foundation Models}, 
      author={Yujia Qin and Shengding Hu and Yankai Lin and Weize Chen and Ning Ding and Ganqu Cui and Zheni Zeng and Yufei Huang and Chaojun Xiao and Chi Han and Yi Ren Fung and Yusheng Su and Huadong Wang and Cheng Qian and Runchu Tian and Kunlun Zhu and Shihao Liang and Xingyu Shen and Bokai Xu and Zhen Zhang and Yining Ye and Bowen Li and Ziwei Tang and Jing Yi and Yuzhang Zhu and Zhenning Dai and Lan Yan and Xin Cong and Yaxi Lu and Weilin Zhao and Yuxiang Huang and Junxi Yan and Xu Han and Xian Sun and Dahai Li and Jason Phang and Cheng Yang and Tongshuang Wu and Heng Ji and Zhiyuan Liu and Maosong Sun},
      year={2023},
      eprint={2304.08354},

archivePrefix={arXiv}, primaryClass={cs.CL} }

## 星标历史

<br>
<div align="center">

<img src="https://api.star-history.com/svg?repos=OpenBMB/BMTools&type=Date" width="600px">

</div>
<br>