综合介绍
OAK(Open Agent Kit)是一个开源工具,帮助开发者快速搭建、自定义和部署AI智能体。它能连接任何大语言模型(LLM),比如OpenAI、Google或Anthropic的模型,还支持通过插件增加功能。OAK的设计目标很明确:让AI整合变得简单。它提供模块化结构、直观的API和易用的界面组件,让开发者能迅速从创意到生产环境。无论是打造智能助手还是开发AI驱动的客户服务,OAK都提供灵活性和扩展性。网站由开发者社区推动,代码公开,用户可以自由修改,适合各种规模的项目。
功能列表
- 支持任意LLM连接:兼容OpenAI、Google、Anthropic等模型,也支持自托管模型。
- 插件扩展:通过插件添加功能,比如数据处理或实时搜索。
- 模块化设计:提供可调整的组件,方便自定义AI功能。
- 一键运行:用命令快速启动本地应用,无需复杂配置。
- 界面组件:内置聊天界面,可嵌入网站或应用。
- 开源透明:代码在GitHub公开,用户可修改或贡献。
- 数据库支持:可选集成PostgreSQL,存储数据更方便。
- 社区驱动:通过Discord获取支持或分享经验。
使用帮助
OAK的操作简单明了,既适合快速上手,也支持深度开发。以下是详细的安装和使用说明。
基本安装流程
想直接运行OAK而无需改代码或开发插件,可以按以下步骤操作:
- 启动应用
打开终端,输入命令:
npx @open-agent-kit/cli run docker
这会自动下载并启动OAK。
- 配置模型
命令行会提示选择模型(比如OpenAI的GPT-4o)和输入API密钥。按提示填入密钥,比如OPENAI_API_KEY=你的密钥
,然后回车。 - 访问应用
启动成功后,打开浏览器,输入:
http://localhost:3000
你会看到OAK的聊天界面。
- 测试运行
在界面输入“今天是星期几”,如果返回正确答案,说明安装成功。
高级安装流程
如果想改默认模型、加插件或开发新功能,可以按以下步骤操作:
创建项目
- 生成项目
在终端输入:
npx @open-agent-kit/cli create project
这会创建一个带默认配置的项目文件夹。
- 进入目录
输入cd 项目名
,进入项目目录。
设置数据库(可选)
- 运行PostgreSQL
用Docker启动数据库,输入:
docker run --name oak-db
-e POSTGRES_USER=你的用户名
-e POSTGRES_PASSWORD=你的密码
-e POSTGRES_DB=oak
-p 5432:5432 -d pgvector/pgvector:pg17
替换你的用户名
和你的密码
。
- 配置连接
复制项目中的.env.example
为.env
,编辑文件,填入数据库信息,比如:
DATABASE_URL=postgresql://你的用户名:你的密码@localhost:5432/oak?schema=public
配置环境
- 获取API密钥
- OpenAI:访问OpenAI官网,创建密钥。
- Google:参考Gemini文档。
- Anthropic:查看Anthropic文档。
- XAI:见XAI文档。
- 生成应用密钥
访问https://api.open-agent-kit.com/generate-secret.html
,生成APP_SECRET
,比如:
APP_SECRET=生成的32位密钥
- 设置环境变量
在.env
中填入密钥和其他配置,例如:
APP_URL=http://localhost:5173
OPENAI_API_KEY=你的密钥
APP_SECRET=你的应用密钥
本地开发
- 安装依赖
输入:
npm install
- 运行迁移
如果用了数据库,执行:
npm run generate
npm run migrate:deploy
- 启动应用
输入:
npm run dev
访问http://localhost:5173
,进入管理界面。
主要功能操作
连接LLM
- 在界面点击“设置”,选择模型(比如Google Gemini)。
- 输入API密钥,保存。
- 在聊天框输入问题测试,比如“1+1等于几”。
添加插件
- 在项目文件夹的
plugins
目录,添加插件代码(参考文档)。 - 运行
npm run build
打包。 - 重启应用,插件自动生效。
自定义界面
- 在管理界面,调整颜色和字体。
- 复制
<iframe>
代码,嵌入你的网站。
特色功能操作
模块化开发
- OAK的模块化设计让你能单独调整功能,比如改聊天逻辑。
- 在代码中找到
src/modules
,按需修改。
云端部署
- 用Vercel部署:在终端输入
vercel deploy
,按提示操作。 - 部署后访问返回的URL。
这些步骤让OAK从安装到使用都清晰可操作。更多细节见官方文档。
应用场景
- 智能助手
用户可以用OAK搭建个人助手,连接LLM后回答问题或处理任务。 - 客户服务
企业嵌入OAK到网站,自动回复常见咨询,提升效率。 - 教育支持
老师用OAK创建答疑工具,学生输入问题,系统返回答案。 - 数据分析
开发者加数据插件,分析业务数据并生成报告。
QA
- OAK支持哪些模型?
支持OpenAI、Google、Anthropic等主流LLM,也支持自建模型。 - 需要懂编程吗?
基本使用不需要,只需配置界面。开发插件或改代码需要JavaScript基础。 - 本地运行有成本吗?
完全免费,只有云部署或API调用才可能收费。 - 如何更新OAK?
从GitHub拉取最新代码,重新运行安装命令即可。