Skip to content

Latest commit

 

History

History
207 lines (144 loc) · 8.21 KB

README_CN.md

File metadata and controls

207 lines (144 loc) · 8.21 KB
Raw

中文 ｜ English


Qwen-Agent是一个开发框架。开发者可基于本框架开发Agent应用，充分利用基于通义千问模型（Qwen）的指令遵循、工具使用、规划、记忆能力。本项目也提供了浏览器助手、代码解释器、自定义助手等示例应用。

开始上手

安装

# 安装依赖
git clone https://github.com/QwenLM/Qwen-Agent.git
cd Qwen-Agent
pip install -e ./

准备：模型服务

Qwen-Agent支持接入阿里云DashScope服务提供的Qwen模型服务，也支持通过OpenAI API方式接入开源的Qwen模型服务。

如果希望接入DashScope提供的模型服务，只需配置相应的环境变量DASHSCOPE_API_KEY为您的DashScope API Key。

如果希望自行部署OpenAI API模型服务，请参考Qwen1.5项目README中的部署章节，启动一个与OpenAI兼容的API服务。

快速开发

框架提供了LLM和prompts等基础原子组件、以及Agent等高级抽象组件。以下示例以Assistant这个组件为例，演示如何增加自定义工具、快速开发一个带有设定、知识库和工具使用能力的Agent：

import json
import os
import urllib.parse

import json5

from qwen_agent.agents import Assistant
from qwen_agent.tools.base import BaseTool, register_tool

llm_cfg = {
    # 如果使用DashScope提供的模型服务：
    'model': 'qwen-max',
    'model_server': 'dashscope',
    # 'api_key': 'YOUR_DASHSCOPE_API_KEY',
    # 如果此处未设置`api_key`，则它将从`DASHSCOPE_API_KEY`环境变量读取。

    # 如果使用自行部署的OpenAI API模型服务：
    # 'model': 'Qwen/Qwen1.5-72B-Chat',
    # 'model_server': 'http://localhost:8000/v1',  # api_base
    # 'api_key': 'EMPTY',

    # （可选）模型的推理超参：
    'generate_cfg': {
        'top_p': 0.8
    }
}
system = '你扮演一个天气预报助手，你具有查询天气和画图能力。' + \
          '你需要查询相应地区的天气，然后调用给你的画图工具绘制一张城市的图，并从给定的诗词文档中选一首相关的诗词来描述天气，不要说文档以外的诗词。'


# 增加一个名为my_image_gen的自定义工具：
@register_tool('my_image_gen')
class MyImageGen(BaseTool):
    description = 'AI绘画（图像生成）服务，输入文本描述和图像分辨率，返回根据文本信息绘制的图片URL。'
    parameters = [{
        'name': 'prompt',
        'type': 'string',
        'description': '详细描述了希望生成的图像具有什么内容，例如人物、环境、动作等细节描述，使用英文',
        'required': True
    }]

    def call(self, params: str, **kwargs) -> str:
        prompt = json5.loads(params)['prompt']
        prompt = urllib.parse.quote(prompt)
        return json.dumps(
            {'image_url': f'https://image.pollinations.ai/prompt/{prompt}'},
            ensure_ascii=False)


tools = ['my_image_gen', 'amap_weather']  # amap_weather是框架预置的工具
bot = Assistant(llm=llm_cfg,
                system_message=system,
                function_list=tools,
                files=[os.path.abspath('poem.pdf')])

messages = []
while True:
    query = input('user question: ')
    messages.append({'role': 'user', 'content': query})
    response = []
    for response in bot.run(messages=messages):
        print('bot response:', response)
    messages.extend(response)

框架中还提供了更多的原子组件供开发者组合。更多的迷你开发案例见examples目录。

示例应用：BrowserQwen

我们在Qwen-Agent的基础上开发了一个较为复杂的Agent应用，名为BrowserQwen的Chrome浏览器扩展，它具有以下主要功能：

  • 与Qwen讨论当前网页或PDF文档的内容。
  • BrowserQwen会记录您浏览过的网页和PDF/Word/PPT材料，帮助您了解多个页面的内容、总结浏览过的内容、自动化繁琐的文字工作。
  • 集成各种插件，包括可用于数学问题求解、数据分析与可视化、处理文件等的代码解释器（Code Interpreter）。

BrowserQwen 功能演示

可查看以下几个演示视频，了解BrowserQwen的核心功能和基本操作：

  • 根据浏览过的网页、PDFs进行长文创作 video
  • 提取浏览内容使用代码解释器画图 video
  • 上传文件、多轮对话利用代码解释器分析数据 video

工作台 - 创作模式

根据浏览过的网页、PDFs素材进行长文创作

调用插件辅助富文本创作

工作台 - 对话模式

多网页问答

使用代码解释器绘制数据图表

浏览器助手

网页问答

PDF文档问答

BrowserQwen 使用说明

第一步 - 部署本地数据库服务

在这一步，您需要在您的本地机器上（即您可以打开Chrome浏览器的那台机器），部署维护个人浏览历史、对话历史的数据库服务。

如果您使用DashScope提供的模型服务的话，请执行以下命令启动数据库服务：

# 启动数据库服务，通过 --llm 参数指定您希望通过DashScope使用的具体模型
# 参数 --llm 可以是如下之一，按资源消耗从小到大排序：
#   - qwen1.5-7b/14b/72b-chat （与开源的Qwen1.5-7B/14B/72B-Chat相同模型）
#   - qwen-turbo, qwen-plus, qwen-max （推荐使用qwen-max）
# 您需要将YOUR_DASHSCOPE_API_KEY替换为您的真实API-KEY。
python run_server.py --llm qwen-max --model_server dashscope --workstation_port 7864 --api_key YOUR_DASHSCOPE_API_KEY

如果您没有在使用DashScope、而是部署了自己的模型服务的话，请执行以下命令：

# 指定模型服务，并启动数据库服务。
# 示例: 假设Qwen/Qwen1.5-72B-Chat已经通过vLLM部署于http://localhost:8000，则可用以下参数指定模型服务：
#   --llm Qwen/Qwen1.5-72B-Chat --model_server http://localhost:8000/v1 --api_key EMPTY
python run_server.py --llm {MODEL} --model_server {API_BASE} --workstation_port 7864 --api_key {API_KEY}

现在您可以访问 http://127.0.0.1:7864/ 来使用工作台（Workstation）的创作模式（Editor模式）和对话模式（Chat模式）了。

第二步 - 安装浏览器助手

安装BrowserQwen的Chrome插件（又称Chrome扩展程序）：

  1. 打开Chrome浏览器，在浏览器的地址栏中输入 chrome://extensions/ 并按下回车键；
  2. 确保右上角的 开发者模式 处于打开状态，之后点击 加载已解压的扩展程序 上传本项目下的 browser_qwen 目录并启用；
  3. 单击谷歌浏览器右上角扩展程序图标，将BrowserQwen固定在工具栏。

注意，安装Chrome插件后，需要刷新页面，插件才能生效。

当您想让Qwen阅读当前网页的内容时：

  1. 请先点击屏幕上的 Add to Qwen's Reading List 按钮，以授权Qwen在后台分析本页面。
  2. 再单击浏览器右上角扩展程序栏的Qwen图标，便可以和Qwen交流当前页面的内容了。

免责声明

本项目正处于快速迭代中，可能会偶尔出现不兼容旧版本的情况。

重要提示：代码解释器未进行沙盒隔离，会在部署环境中执行代码。请避免向Qwen发出危险指令，切勿将该代码解释器直接用于生产目的。