feat: 更新模块文档,添加详细说明和使用示例
This commit is contained in:
@@ -1,3 +1,36 @@
|
||||
"""MineNASAI - 基于NAS的智能个人AI助理"""
|
||||
"""MineNASAI - 基于NAS的智能个人AI助理
|
||||
|
||||
MineNASAI 是一个部署在家用 NAS 上的智能 AI 助理系统,支持:
|
||||
- 多渠道接入(飞书、企业微信等)
|
||||
- 多 LLM 后端(OpenAI、Anthropic、Gemini、国产模型等)
|
||||
- 智能任务路由与复杂度评估
|
||||
- 安全的工具执行与权限管理
|
||||
- Web 终端管理界面
|
||||
|
||||
模块结构:
|
||||
- core: 核心基础设施(配置、日志、缓存、监控、数据库)
|
||||
- agent: AI Agent 运行时和工具管理
|
||||
- gateway: 消息网关和渠道接入
|
||||
- llm: 多模型 LLM 客户端
|
||||
- scheduler: 定时任务调度
|
||||
- webtui: Web 管理界面
|
||||
|
||||
快速开始:
|
||||
>>> from minenasai.core import get_settings, setup_logging
|
||||
>>> from minenasai.llm import get_llm_manager
|
||||
>>> from minenasai.agent import get_agent_runtime
|
||||
>>>
|
||||
>>> # 初始化
|
||||
>>> settings = get_settings()
|
||||
>>> setup_logging(settings)
|
||||
>>>
|
||||
>>> # 获取 LLM 管理器
|
||||
>>> llm_manager = get_llm_manager()
|
||||
>>>
|
||||
>>> # 获取 Agent 运行时
|
||||
>>> agent = await get_agent_runtime()
|
||||
"""
|
||||
|
||||
__version__ = "0.1.0"
|
||||
__author__ = "MineNASAI Team"
|
||||
__license__ = "MIT"
|
||||
|
||||
Reference in New Issue
Block a user