docs: add full zh translations for site
Co-authored-by: Fu-Jie <33599649+Fu-Jie@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
67
docs/plugins/actions/export-to-excel.zh.md
Normal file
67
docs/plugins/actions/export-to-excel.zh.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Export to Excel（导出到 Excel）
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v1.0.0</span>
|
||||
|
||||
将聊天记录导出为 Excel 表格，便于分析、归档和分享。
|
||||
|
||||
---
|
||||
|
||||
## 概览
|
||||
|
||||
Export to Excel 插件可以把你的聊天记录下载为 Excel 文件，适用于：
|
||||
|
||||
- 归档重要对话
|
||||
- 分析聊天数据
|
||||
- 与同事共享对话内容
|
||||
- 将 AI 辅助的研究整理成文档
|
||||
|
||||
## 功能特性
|
||||
|
||||
- :material-file-excel: **Excel 导出**：标准 `.xlsx` 格式
|
||||
- :material-table: **格式化输出**：整洁的表格结构
|
||||
- :material-download: **一键下载**：即时生成文件
|
||||
- :material-history: **完整历史**：导出完整会话内容
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
1. 下载插件文件：[`export_to_excel.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/export_to_excel)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 启用插件
|
||||
|
||||
---
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 打开想要导出的对话
|
||||
2. 点击消息操作栏中的 **Export** 按钮
|
||||
3. Excel 文件会自动下载
|
||||
|
||||
---
|
||||
|
||||
## 导出格式
|
||||
|
||||
生成的 Excel 文件包含：
|
||||
|
||||
| 列 | 说明 |
|
||||
|--------|-------------|
|
||||
| Timestamp | 消息发送时间 |
|
||||
| Role | 角色（用户 / 助手） |
|
||||
| Content | 消息文本内容 |
|
||||
| Model | 使用的模型（助手消息） |
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 无需额外 Python 依赖（使用内置库）
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/export_to_excel){ .md-button }
|
||||
151
docs/plugins/actions/index.zh.md
Normal file
151
docs/plugins/actions/index.zh.md
Normal file
@@ -0,0 +1,151 @@
|
||||
# Action 插件
|
||||
|
||||
Action 插件会在聊天界面的消息下方添加自定义按钮，让你一键触发特定功能。
|
||||
|
||||
## 什么是 Actions？
|
||||
|
||||
Actions 是交互式插件，能够：
|
||||
|
||||
- :material-gesture-tap: 在消息操作栏添加按钮
|
||||
- :material-export: 生成并导出内容（思维导图、图表、文件等）
|
||||
- :material-api: 与外部服务和 API 交互
|
||||
- :material-animation-play: 创建可视化或交互内容
|
||||
|
||||
---
|
||||
|
||||
## 可用的 Action 插件
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-brain:{ .lg .middle } **Smart Mind Map**
|
||||
|
||||
---
|
||||
|
||||
智能分析文本并生成交互式、精美的思维导图。
|
||||
|
||||
**版本：** 0.7.2
|
||||
|
||||
[:octicons-arrow-right-24: 查看文档](smart-mind-map.md)
|
||||
|
||||
- :material-chart-bar:{ .lg .middle } **Smart Infographic**
|
||||
|
||||
---
|
||||
|
||||
使用 AntV 可视化引擎，将文本转成专业的信息图。
|
||||
|
||||
**版本：** 1.0.0
|
||||
|
||||
[:octicons-arrow-right-24: 查看文档](smart-infographic.md)
|
||||
|
||||
- :material-card-text:{ .lg .middle } **Knowledge Card**
|
||||
|
||||
---
|
||||
|
||||
快速生成精美的学习记忆卡片，适合学习与记忆。
|
||||
|
||||
**版本：** 0.2.0
|
||||
|
||||
[:octicons-arrow-right-24: 查看文档](knowledge-card.md)
|
||||
|
||||
- :material-file-excel:{ .lg .middle } **Export to Excel**
|
||||
|
||||
---
|
||||
|
||||
将聊天记录导出为 Excel 电子表格，方便分析或归档。
|
||||
|
||||
**版本：** 1.0.0
|
||||
|
||||
[:octicons-arrow-right-24: 查看文档](export-to-excel.md)
|
||||
|
||||
- :material-text-box-search:{ .lg .middle } **Summary**
|
||||
|
||||
---
|
||||
|
||||
对长文本进行精简总结，提取要点。
|
||||
|
||||
**版本：** 1.0.0
|
||||
|
||||
[:octicons-arrow-right-24: 查看文档](summary.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## 快速安装
|
||||
|
||||
1. 下载需要的 `.py` 插件文件
|
||||
2. 前往 **Admin Panel** → **Settings** → **Functions**
|
||||
3. 上传文件并完成配置
|
||||
4. 在聊天消息中使用对应的 Action 按钮
|
||||
|
||||
---
|
||||
|
||||
## 开发模板
|
||||
|
||||
想要自己编写 Action 插件？可以参考下面的模板：
|
||||
|
||||
```python
|
||||
"""
|
||||
title: My Custom Action
|
||||
author: Your Name
|
||||
version: 1.0.0
|
||||
description: Description of your action plugin
|
||||
"""
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
from typing import Optional, Dict, Any
|
||||
|
||||
class Action:
|
||||
class Valves(BaseModel):
|
||||
# 在这里添加你的配置项
|
||||
show_status: bool = Field(
|
||||
default=True,
|
||||
description="Show status updates during processing"
|
||||
)
|
||||
|
||||
def __init__(self):
|
||||
self.valves = self.Valves()
|
||||
|
||||
async def action(
|
||||
self,
|
||||
body: dict,
|
||||
__user__: Optional[Dict[str, Any]] = None,
|
||||
__event_emitter__: Optional[Any] = None,
|
||||
__request__: Optional[Any] = None,
|
||||
) -> Optional[dict]:
|
||||
"""
|
||||
当用户点击 Action 按钮时触发的主方法。
|
||||
|
||||
Args:
|
||||
body: 包含会话数据的消息体
|
||||
__user__: 当前用户信息
|
||||
__event_emitter__: 用于发送通知或状态更新
|
||||
__request__: FastAPI 请求对象
|
||||
|
||||
Returns:
|
||||
修改后的 body 字典或 None
|
||||
"""
|
||||
# 发送状态更新
|
||||
if __event_emitter__ and self.valves.show_status:
|
||||
await __event_emitter__({
|
||||
"type": "status",
|
||||
"data": {"description": "Processing...", "done": False}
|
||||
})
|
||||
|
||||
# 插件逻辑
|
||||
messages = body.get("messages", [])
|
||||
if messages:
|
||||
last_message = messages[-1].get("content", "")
|
||||
# 在这里处理消息...
|
||||
|
||||
# 完成状态
|
||||
if __event_emitter__ and self.valves.show_status:
|
||||
await __event_emitter__({
|
||||
"type": "status",
|
||||
"data": {"description": "Done!", "done": True}
|
||||
})
|
||||
|
||||
return body
|
||||
```
|
||||
|
||||
更多详情可查看 [插件开发指南](../../development/plugin-guide.md)。
|
||||
88
docs/plugins/actions/knowledge-card.zh.md
Normal file
88
docs/plugins/actions/knowledge-card.zh.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# Knowledge Card（知识卡片）
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v0.2.0</span>
|
||||
|
||||
快速生成精美的学习记忆卡片，适合学习和速记。
|
||||
|
||||
---
|
||||
|
||||
## 概览
|
||||
|
||||
Knowledge Card 插件（又名 Flash Card / 闪记卡）会把内容转成视觉友好的记忆卡片，帮助你高效学习和记忆。无论备考、理解新概念或复习要点，都能用它快速生成学习素材。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- :material-card-text: **精美卡片**：现代简洁的版式，便于阅读
|
||||
- :material-animation-play: **可交互**：点击翻转查看答案
|
||||
- :material-export: **可导出**：支持保存离线学习
|
||||
- :material-palette: **可定制**：多种主题与样式
|
||||
- :material-translate: **多语言**：支持多语言内容
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
1. 下载插件文件：[`knowledge_card.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/knowledge-card)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 启用插件
|
||||
|
||||
---
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 与 AI 就你想学习的主题进行对话
|
||||
2. 点击消息操作栏的 **Flash Card** 按钮
|
||||
3. 插件会分析内容并生成卡片
|
||||
4. 点击卡片翻面查看答案
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|---------|-------------|
|
||||
| `cards_per_message` | integer | `5` | 每条消息最多生成的卡片数量 |
|
||||
| `theme` | string | `"modern"` | 视觉主题 |
|
||||
| `show_hints` | boolean | `true` | 是否在卡片上显示提示 |
|
||||
|
||||
---
|
||||
|
||||
## 示例
|
||||
|
||||
=== "问题面"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ What is the capital of │
|
||||
│ France? │
|
||||
│ │
|
||||
│ [Click to flip] │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
|
||||
=== "答案面"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ Paris │
|
||||
│ │
|
||||
│ The city of lights, │
|
||||
│ located on the Seine │
|
||||
│ │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 无需额外 Python 依赖
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/knowledge-card){ .md-button }
|
||||
107
docs/plugins/actions/smart-infographic.zh.md
Normal file
107
docs/plugins/actions/smart-infographic.zh.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# Smart Infographic（智能信息图）
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v1.0.0</span>
|
||||
|
||||
基于 AntV 信息图引擎，将长文本一键转成专业、美观的信息图。
|
||||
|
||||
---
|
||||
|
||||
## 概览
|
||||
|
||||
Smart Infographic 使用 AI 分析文本，并基于 AntV 可视化引擎生成专业的信息图。它会自动提取要点，并用合适的图表/结构呈现。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- :material-robot: **AI 转换**：自动分析文本逻辑，提取要点并生成结构化图表
|
||||
- :material-palette: **专业模板**：内置 AntV 官方模板：列表、树、思维导图、对比表、流程图、统计图等
|
||||
- :material-magnify: **自动匹配图标**：根据内容自动选择最合适的 Material Design Icons
|
||||
- :material-download: **多格式导出**：支持下载 **SVG**、**PNG**、**独立 HTML**
|
||||
- :material-theme-light-dark: **主题支持**：适配深色/浅色模式
|
||||
- :material-cellphone-link: **响应式**：桌面与移动端都能良好展示
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
1. 下载插件文件：[`infographic.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/infographic)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 可选：根据需要配置插件选项
|
||||
4. 启用插件
|
||||
|
||||
---
|
||||
|
||||
## 支持的模板类型
|
||||
|
||||
| 分类 | 模板名称 | 典型场景 |
|
||||
|:---------|:--------------|:---------|
|
||||
| **列表与层级** | `list-grid`, `tree-vertical`, `mindmap` | 特性列表、组织结构、头脑风暴 |
|
||||
| **序列与关系** | `sequence-roadmap`, `relation-circle` | 路线图、循环流程、步骤拆解 |
|
||||
| **对比与分析** | `compare-binary`, `compare-swot`, `quadrant-quarter` | 优劣势、SWOT、象限分析 |
|
||||
| **图表与数据** | `chart-bar`, `chart-line`, `chart-pie` | 趋势、分布、指标对比 |
|
||||
|
||||
---
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 在聊天中输入需要可视化的文本
|
||||
2. 点击消息操作栏的 **Infographic**（📊）按钮
|
||||
3. 等待 AI 分析并生成信息图
|
||||
4. 预览结果，可用下载按钮保存
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|---------|-------------|
|
||||
| `SHOW_STATUS` | boolean | `true` | 是否展示实时的分析/生成状态 |
|
||||
| `MODEL_ID` | string | `""` | 指定用于分析的 LLM 模型，留空则使用当前会话模型 |
|
||||
| `MIN_TEXT_LENGTH` | integer | `100` | 触发分析的最小字符数 |
|
||||
| `CLEAR_PREVIOUS_HTML` | boolean | `false` | 是否清空之前生成的图表 |
|
||||
| `MESSAGE_COUNT` | integer | `1` | 参与分析的最近消息条数 |
|
||||
|
||||
---
|
||||
|
||||
## 语法示例（高级用法）
|
||||
|
||||
也可以直接输入信息图语法进行渲染：
|
||||
|
||||
```infographic
|
||||
infographic list-grid
|
||||
data
|
||||
title 🚀 Plugin Benefits
|
||||
desc Why use the Smart Infographic plugin
|
||||
items
|
||||
- label Fast Generation
|
||||
desc Convert text to charts in seconds
|
||||
- label Beautiful Design
|
||||
desc Uses AntV professional design standards
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 无需额外 Python 依赖（使用 OpenWebUI 内置依赖）
|
||||
|
||||
---
|
||||
|
||||
## 常见问题
|
||||
|
||||
??? question "没有生成信息图？"
|
||||
请确认文本长度至少 100 字符（可通过 `MIN_TEXT_LENGTH` 调整）。
|
||||
|
||||
??? question "模板与内容不匹配？"
|
||||
AI 会根据内容结构自动选择模板，如需指定可使用高级语法。
|
||||
|
||||
??? question "导出失败？"
|
||||
确认浏览器支持 HTML5 Canvas 和 SVG，尝试刷新页面。
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/infographic){ .md-button }
|
||||
91
docs/plugins/actions/smart-mind-map.zh.md
Normal file
91
docs/plugins/actions/smart-mind-map.zh.md
Normal file
@@ -0,0 +1,91 @@
|
||||
# Smart Mind Map（智能思维导图）
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v0.7.2</span>
|
||||
|
||||
智能分析文本内容，生成交互式思维导图，帮助你更直观地理解信息结构。
|
||||
|
||||
---
|
||||
|
||||
## 概览
|
||||
|
||||
Smart Mind Map 会将文本转换成漂亮的交互式思维导图。插件会用 AI 分析内容结构，生成层级化的可视化，帮助快速梳理复杂信息。
|
||||
|
||||
## 功能特性
|
||||
|
||||
- :material-brain: **AI 分析**：智能提取关键概念与关联关系
|
||||
- :material-gesture-swipe: **交互导航**：支持缩放、平移、展开/折叠
|
||||
- :material-palette: **精美样式**：现代化配色，支持自定义主题
|
||||
- :material-download: **导出**：可保存为图片或结构化数据
|
||||
- :material-translate: **多语言**：支持多语言文本分析
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
1. 下载插件文件：[`smart_mind_map.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 启用插件
|
||||
|
||||
---
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 先与 AI 对话并生成回复
|
||||
2. 点击消息操作栏中的 **Mind Map** 按钮
|
||||
3. 等待思维导图生成
|
||||
4. 交互使用：
|
||||
- **缩放**：滚轮缩放
|
||||
- **平移**：按住拖动
|
||||
- **展开/折叠**：点击节点显示或隐藏子节点
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|---------|-------------|
|
||||
| `show_status` | boolean | `true` | 是否显示处理状态更新 |
|
||||
| `max_depth` | integer | `5` | 思维导图的最大层级 |
|
||||
| `theme` | string | `"default"` | 可视化的主题配色 |
|
||||
|
||||
---
|
||||
|
||||
## 输出示例
|
||||
|
||||
插件会在聊天中嵌入交互式 HTML 思维导图：
|
||||
|
||||
```
|
||||
📊 Mind Map Generated
|
||||
├── Main Topic
|
||||
│ ├── Subtopic 1
|
||||
│ │ ├── Detail A
|
||||
│ │ └── Detail B
|
||||
│ ├── Subtopic 2
|
||||
│ └── Subtopic 3
|
||||
└── Related Concepts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 无需额外 Python 依赖
|
||||
|
||||
---
|
||||
|
||||
## 常见问题
|
||||
|
||||
??? question "思维导图不显示？"
|
||||
请确认浏览器支持 HTML5 Canvas，并且已开启 JavaScript。
|
||||
|
||||
??? question "生成时间过长？"
|
||||
对超长文本，AI 分析会更耗时。建议拆分内容后再生成。
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map){ .md-button }
|
||||
82
docs/plugins/actions/summary.zh.md
Normal file
82
docs/plugins/actions/summary.zh.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# Summary（摘要）
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v1.0.0</span>
|
||||
|
||||
为长文本生成简洁摘要，并提取关键要点。
|
||||
|
||||
---
|
||||
|
||||
## 概览
|
||||
|
||||
Summary 插件可以快速理解长文本，生成精炼摘要并列出关键点，适合：
|
||||
|
||||
- 总结长文章或文档
|
||||
- 从对话中提炼要点
|
||||
- 为复杂主题制作快速概览
|
||||
|
||||
## 功能特性
|
||||
|
||||
- :material-text-box-search: **智能摘要**：AI 驱动的内容分析
|
||||
- :material-format-list-bulleted: **关键点**：提取重要信息
|
||||
- :material-content-copy: **便捷复制**：一键复制摘要
|
||||
- :material-tune: **长度可调**：可选择摘要详略程度
|
||||
|
||||
---
|
||||
|
||||
## 安装
|
||||
|
||||
1. 下载插件文件：[`summary.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/summary)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 启用插件
|
||||
|
||||
---
|
||||
|
||||
## 使用方法
|
||||
|
||||
1. 获取一段较长的 AI 回复或粘贴长文本
|
||||
2. 点击消息操作栏的 **Summary** 按钮
|
||||
3. 查看生成的摘要与关键点
|
||||
|
||||
---
|
||||
|
||||
## 配置项
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|---------|-------------|
|
||||
| `summary_length` | string | `"medium"` | 摘要长度（short/medium/long） |
|
||||
| `include_key_points` | boolean | `true` | 是否提取并列出关键点 |
|
||||
| `language` | string | `"auto"` | 输出语言 |
|
||||
|
||||
---
|
||||
|
||||
## 输出示例
|
||||
|
||||
```markdown
|
||||
## Summary
|
||||
|
||||
This document discusses the implementation of a new feature
|
||||
for the application, focusing on user experience improvements
|
||||
and performance optimizations.
|
||||
|
||||
### Key Points
|
||||
|
||||
- ✅ New user interface design improves accessibility
|
||||
- ✅ Backend optimizations reduce load times by 40%
|
||||
- ✅ Mobile responsiveness enhanced
|
||||
- ✅ Integration with third-party services simplified
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 使用当前会话的 LLM 模型进行摘要
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/summary){ .md-button }
|
||||
Reference in New Issue
Block a user