# noteLLM

**Repository Path**: Sckaro/note-llm

## Basic Information

- **Project Name**: noteLLM
- **Description**: Python大模型应用项目--适用于快速构建Markdown笔记。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-07
- **Last Updated**: 2025-11-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# noteLLM - 智能网页笔记生成器

技术栈：Python、Flask、LangChain、爬虫（简单）

[![Python](https://img.shields.io/badge/Python-3.7%2B-blue)](#)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](#)

noteLLM 是一个基于大语言模型的智能网页笔记生成器，可以根据网页URL自动生成结构化的Markdown笔记。项目支持两种处理模式：基于规则的内容提取和基于大语言模型的智能生成。

## 🌟 特性

- **双模式处理**：支持普通网页内容提取和基于LLM的智能笔记生成
- **智能内容提取**：自动过滤广告、导航栏等无关内容
- **结构化输出**：生成符合规范的Markdown格式笔记
- **Web界面操作**：提供友好的Web界面供用户操作
- **易于扩展**：模块化设计，方便添加新功能

## 🛠 技术栈

- **后端**：Python + Flask
- **前端**：HTML/CSS/JavaScript
- **AI/LLM**：LangChain + 阿里云百炼平台(Qwen-Plus模型)
- **网页解析**：BeautifulSoup + Requests

## 📁 项目结构

```
noteLLM/
├── frontend/           # 前端静态文件目录
│   └── index.html      # 主页面
├── src/                # 源代码目录
│   ├── app/            # Flask应用
│   ├── GC/             # LLM相关组件
│   ├── loader/         # 网页加载器
│   └── utils/          # 工具函数
├── web_notes/          # 生成的Markdown笔记存储目录
├── main.py             # 应用入口
└── 奇思妙想.md          # 项目说明文档
```

## ⚙️ 安装与配置

### 环境要求

- Python 3.7+
- pip包管理器

### 安装依赖

```bash
pip install -r requirements.txt
```

### 配置环境变量

项目需要配置阿里云百炼平台的API密钥：

```bash
export OPENAI_API_KEY=your_api_key_here
```

或者在 `src/GC/noteAgent_LLM.py` 文件中修改：

```python
llm = ChatOpenAI(
    api_key="your_api_key_here",  # 替换为你的API密钥
    base_url="https://dashscope.aliyuncs.com/compatible-mode/v1",
    model="qwen-plus",
    temperature=0.2
)
```

## 🚀 快速开始

1. 启动应用：
   ```bash
   python main.py
   ```

2. 在浏览器中访问 `http://localhost:8080`

3. 输入要生成笔记的网页URL

4. 选择处理模式并等待生成结果

5. 下载生成的Markdown笔记

## 🔧 使用说明

项目提供两种处理方式：

1. **基于规则的处理** (`/generate/web`)：
   - 适用于技术博客类网站
   - 直接提取网页内容并转换为Markdown格式
   - 处理速度快，无需调用外部API

2. **基于LLM的处理** (`/generate/ai`)：
   - 适用于各种类型的网页
   - 使用大语言模型理解网页内容并生成结构化笔记
   - 生成质量更高，但需要调用外部API

## 📖 开发指南

### 主要模块说明

- `src/app/web.py` - Flask Web应用，提供API接口和前端页面服务
- `src/GC/noteAgent.py` - 基于规则的笔记生成器
- `src/GC/noteAgent_LLM.py` - 基于LLM的笔记生成器
- `src/loader/web_loader_llm.py` - 网页内容加载和预处理
- `src/utils/file_operate.py` - 文件操作工具

### API接口

- `GET /` - 返回前端页面
- `POST /generate/web` - 基于规则的笔记生成接口
- `POST /generate/ai` - 基于LLM的笔记生成接口
- `GET /download/<filename>` - 笔记文件下载接口

## 🤝 贡献

欢迎提交Issue和Pull Request来改进本项目。

## 📄 许可证

本项目采用MIT许可证，详情请参见[LICENSE](LICENSE)文件。