xlang-ai/OpenAgents 源码下载与部署教程

项目概述

[COLM 2024] OpenAgents: An Open Platform for Language Agents in the Wild

项目地址

https://github.com/xlang-ai/OpenAgents

项目页面预览

关键指标

• Stars：4666
• 主要语言：Python
• License：Apache License 2.0
• 最近更新：2024-11-18T09:39:29Z
• 默认分支：main

本站高速下载（国内可用）

• 源码压缩包下载：点击下载（本站镜像）
• SHA256：15c3b03fb72994587218089345bd5169d0e45ebe08ec42acdcf8836213873354

安装部署要点（README 精选）

Combined Plugin Usage

Harness the power of synergy! Plugins Agent supports the concurrent use of multiple plugins. Planning a trip? Seamlessly integrate functionalities from Klook, Currency converter, and WeatherViz.

💻 Localhost Deployment

We’ve released the OpenAgents platform code. Feel free to deploy on your own localhost!

Here is a brief system design of OpenAgents:

Docker

Please follow the following steps to use the docker-compose to deploy the OpenAgents platform.

Note: the docker is under development, so there may be functions not working properly as expected and slower response. Please feel free to open an issue if you have any questions. If you want a more robust version, currently we recommend you to deploy from source code.

1. If you want to use kaggle’s dataset, you must modify the information in the Dockerfile to your correct information.

ENV KAGGLE_USER="" \
    KAGGLE_KEY="" 

1. If you are not running locally, you need to modify the accessible IP to the backend service in frontend/Dockerfile

ENV NEXT_PUBLIC_BACKEND_ENDPOINT http://x.x.x.x:8000

1. Run the docker compose build command in the project root directory.
2. If you use openai unofficial services, such as FastChat, you need to modify OPENAI_API_BASE in docker-compose.yml;otherwise you only to put your OPENAI_API_KEY in docker-compose.yml
3. After completing the above steps, you can run docker compose up -d to start all services.

Notice:
1. If you want to use GPU, you need install Nvidia Container Toolkit,and uncomment the the docker-compose.yml Lines 56-62.
2. Use Auto Plugin will download the weight file from huggingface. In some areas, connection timeout may occur. Please solve the network problem by yourself.

常用命令（从 README 提取）

ENV KAGGLE_USER="" \
    KAGGLE_KEY=""

ENV NEXT_PUBLIC_BACKEND_ENDPOINT http://x.x.x.x:8000

├── backend  # backend code
│   ├── README.md  # backend README for setup
│   ├── api  # RESTful APIs, to be called by the frontend
│   ├── app.py  # main flask app
│   ├── display_streaming.py  # rendering the streaming response
│   ├── kernel_publisher.py  # queue for code execution
│   ├── main.py  # main entry for the backend
│   ├── memory.py  # memory(storage) for the backend
│   ├── schemas.py  # constant definitions
│   ├── setup_script.sh  # one-click setup script for the backend
│   ├── static  # static files, e.g., cache and figs
│   └── utils  # utilities
├── frontend  # frontend code
│   ├── README.md  # frontend README for setup
│   ├── components  # React components
│   ├── hooks  # custom React hooks
│   ├── icons  # icon assets
│   ├── next-env.d.ts  # TypeScript declarations for Next.js environment variables
│   ├── next-i18next.config.js  # configuration settings for internationalization
│   ├── next.config.js  # configuration settings for Next.js
│   ├── package-lock.json  # generated by npm that describes the exact dependency tree
│   ├── package.json  # manifest file that describes the dependencies
│   ├── pages  # Next.js pages
│   ├── postcss.config.js  # configuration settings for PostCSS
│   ├── prettier.config.js  # configuration settings for Prettier
│   ├── public  # static assets
│   ├── styles  # global styles
│   ├── tailwind.config.js  # configuration settings for Tailwind CSS
│   ├── tsconfig.json  # configuration settings for TypeScript
│   ├── types  # type declarations
│   ├── utils  # utilities or helper functions
│   ├── vitest.config.ts  # configuration settings for ViTest
│   └── webot_extension.zip  # Chrome extension for Web Agent
└── real_agents  # language agents
    ├── adapters  # shared components for the three agents to adapt to the backend
    ├── data_agent  # data agent implementation
    ├── plugins_agent  # plugins agent implementation
    └── web_agent  # web agent implementation

通用部署说明（适用于大多数项目）

1. 下载源码并阅读 README
2. 安装依赖（pip/npm/yarn 等）
3. 配置环境变量（API Key、模型路径、数据库等）
4. 启动服务并测试访问
5. 上线建议：Nginx 反代 + HTTPS + 进程守护（systemd / pm2）

免责声明与版权说明

本文仅做开源项目整理与教程索引，源码版权归原作者所有，请遵循对应 License 合规使用。