ppagent 0.0.34 → 0.0.35

package/README.md

@@ -1,8 +1,76 @@
 
 
+## 简介
 
+> PPAgent是一个用于连接大模型和消息客户端的中间件，可以用来实现如钉钉、飞书等平台对接大模型、智能体的功能。
+> 文档地址：[https://doc.ppagent.cn](http://doc.ppagent.cn)
+> 配置页面地址：[https://ppagent.cn](https://ppagent.cn) 第一次打开加载资源较多，请耐心等待。
 
-# 安装注意事项
+PPAgent可以作为一个SDK，用于开发后端项目，也支持通过插件的方式对其功能进行扩展，还支持通过可视化的方式进行方便的配置使用。
 
-- windows powershell下ffmpeg-static $Env:FFMPEG_BINARIES_URL="https://cdn.npmmirror.com/binaries/ffmpeg-static"
-- linux下 export FFMPEG_BINARIES_URL=https://cdn.npmmirror.com/binaries/ffmpeg-static
+![简介](./images/index-intro.png)
+
+## 核心概念
+
+### 消息源
+
+> 消息源顾名思义就是消息的来源，如QQ、微信、钉钉、飞书等。本框架内置了常见的消息源，也支持通过插件扩展更多的消息源支持。
+
+![支持的消息源](./images/sources.png)
+
+#### 消息源特性
+
+- 支持多实例
+- 统一消息结构，可二开为消息网关
+- 支持图片、文字、声音、文件、地理位置、卡片消息等各种类型
+- 大部分数据源对
+- 钉钉、飞书均支持流式发送
+
+![流式回复](./images/index-stream.png)
+
+### 后端模型
+
+> 后端模型是用来对用户的消息进行响应的模型，当前主要是指大语言模型或者基于大语言模型的智能体。本框架中内置了众多常见的大模型和智能体后端接口支持。
+
+![支持的模型](./images/models.png)
+
+- 支持多实例
+  ![多实例](./images/index-models.png)
+- 多模态支持
+- OpenAI兼容模型支持
+- 支持思考过程
+
+![思考过程](./images/index-feishu-stream.png)
+
+- 统一大模型输出接口，可二开为大模型网关
+
+### 智能体
+
+- 内置历史消息管理
+- 消息拆分发送
+- 图片提取发送
+- 技能叠加，实现语音文字转换、消息总结等各类功能
+- 黑白名单，可针对群组、个人分别设置
+- 区分思考过程和最终回复
+- 设置发送间隔
+- 排队发送
+
+### 插件
+
+- 支持在线安装、更新、卸载插件
+
+## 常见场景
+- 客服助手。自动回复，对接知识库等，或通过技能的开发实现转人工等操作。
+- 企业内部助手。如对接项目管理平台、工单平台等，提供智能化服务
+- 个人助手
+- 群助理。活跃群气氛
+- AI专家团队的消息交互
+- 通过开发技能实现聊天记录持久化、自动清洗到知识库
+- ...
+
+## 支持的部署方式
+
+> 框架的部署主要指服务端。另外我们提供了线上的前端配置页面，可以对接私有化部署的服务端，提供便捷的配置服务
+
+- [本地化直接部署](https://doc.ppagent.cn/starter/install_code.html)
+- [Docker部署](https://doc.ppagent.cn/starter/install_docker.html)

package/package.json

@@ -1,11 +1,28 @@
 {
   "name": "ppagent",
-  "version": "0.0.34",
+  "version": "0.0.35",
   "description": "an agent manager",
   "types": "dist/lib.d.ts",
   "main": "dist/lib.js",
   "type": "module",
   "displayName": "PP智能体对接工具",
+  "scripts": {
+    "lint": "eslint .",
+    "build": "esbuild \"src/**/*.ts\" --platform=node --outdir=build --resolve-extensions=.js --out-extension:.js=.js --format=esm",
+    "build:docker": "docker build . -t pp-agent --build-arg APP_ENV=production --progress=plain",
+    "start": "node build",
+    "tsx": "cross-env NODE_ENV=development tsx src/index.ts",
+    "dev": "cross-env NODE_ENV=development tsx watch src/index.ts",
+    "prod": "cross-env NODE_ENV=production tsx watch src/index.ts",
+    "deno": "deno --unstable-sloppy-imports --allow-env --allow-sys --allow-read --allow-write --allow-net --inspect src/index.ts | pino-pretty --colorize",
+    "lib": "node build.lib.js",
+    "test": "vitest",
+    "test:watch": "vitest -w",
+    "predocs:build":"typedoc",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ppagent/ppagent.git"
@@ -116,22 +133,5 @@
     "typescript-eslint": "^8.3.0",
     "vitepress": "^1.6.3",
     "vitest": "^2.0.5"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "build": "esbuild \"src/**/*.ts\" --platform=node --outdir=build --resolve-extensions=.js --out-extension:.js=.js --format=esm",
-    "build:docker": "docker build . -t pp-agent --build-arg APP_ENV=production --progress=plain",
-    "start": "node build",
-    "tsx": "cross-env NODE_ENV=development tsx src/index.ts",
-    "dev": "cross-env NODE_ENV=development tsx watch src/index.ts",
-    "prod": "cross-env NODE_ENV=production tsx watch src/index.ts",
-    "deno": "deno --unstable-sloppy-imports --allow-env --allow-sys --allow-read --allow-write --allow-net --inspect src/index.ts | pino-pretty --colorize",
-    "lib": "node build.lib.js",
-    "test": "vitest",
-    "test:watch": "vitest -w",
-    "predocs:build": "typedoc",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
   }
 }