Fundamental_Analysis/frontend/public/user-guide.md
Lv, Qi abe47c4bc8 refactor(report): switch to HTML+Gotenberg for high-quality PDF export
- Feat: Add Gotenberg service to docker-compose for headless PDF rendering
- Feat: Implement /generate-pdf endpoint in report-generator-service
- Feat: Add PDF generation proxy route in api-gateway
- Refactor(frontend): Rewrite PDFExportButton to generate HTML with embedded styles and images
- Feat(frontend): Auto-crop React Flow screenshots to remove whitespace
- Style: Optimize report print layout with CSS (margins, image sizing)
- Chore: Remove legacy react-pdf code and font files
2025-11-30 22:43:22 +08:00

73 lines
4.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Fundamental Analysis Platform 用户指南 (v2.1 - Dynamic Refactor)
日期: 2025-11-30
版本: 2.1
## 1. 简介
Fundamental Analysis Platform 是一个基于 AI Agent 的深度基本面投研平台,旨在通过自动化工作流聚合多源金融数据,并利用 LLM大语言模型生成专业的财务分析报告。
v2.1 版本引入了动态配置架构、增强的实时日志流和结构化的数据报表展示,提供了更稳定和可视化的分析体验。
## 2. 核心功能
### 2.1 仪表盘 (Dashboard)
平台首页,提供简洁的分析入口。
* **股票代码**: 支持输入 A股 (如 `600519.SS`)、美股 (如 `AAPL`) 或港股代码。
* **市场选择**: 下拉选择 CN (中国)、US (美国) 或 HK (香港)。
* **开始分析**: 点击“生成分析报告”按钮即可启动分析流程。
### 2.2 分析报告页 (Report View)
核心工作区,采用**双栏布局**:左侧为实时状态监控,右侧为多标签页详情展示。
#### 左侧:工作流状态 (Workflow Status)
* **可视化 DAG (Visualizer)**:
* 展示当前的分析任务依赖图。节点显示**人类可读的任务名称** (如 "新闻分析", "财务数据获取")。
* **节点颜色**: 灰色(等待)、蓝色(运行中)、绿色(完成)、红色(失败)。
* **动态连线**: 任务运行时显示流光动画,指示数据流向。
* **实时日志 (Real-time Logs)**:
* 位于左侧底部(或独立面板),实时滚动展示所有后台任务的执行日志。
* **历史回放**: 即使刷新页面或断线重连,系统也会自动拉取完整的历史日志,确保信息不丢失。
#### 右侧:详情面板 (Detail Tabs)
右侧区域根据分析流程动态生成多个标签页:
* **Overview (总览)**:
* 展示整体分析进度、任务完成统计和总耗时。
* 如果任务失败,会在此处显示具体的错误信息摘要。
* **任务详情页 (Task Tabs)**:
* 每个工作流节点(如 "Financial Data", "News Analysis")都有独立的标签页。
* **智能渲染**:
* **分析报告**: AI 生成的文本以 Markdown 格式渲染,支持富文本排版。
* **财务数据**: 原始财务数据(特别是 Tushare A股数据现在自动转换为**结构化 Markdown 表格**,按年份和报表类型分组,数值经过格式化(如 "14.20 亿"),便于阅读。
* **Inspector (调试器)**: 点击右上角的 "Inspector" 按钮,可以打开侧边栏,查看该任务的输入/输出文件差异 (Diff) 和上下文信息,方便调试。
### 2.3 系统配置 (Config)
集中管理平台的所有外部连接和参数。
* **AI Provider**:
* 管理 LLM 供应商 (OpenAI, Anthropic, Local Ollama 等)。
* 支持配置 API Key、Base URL 和模型选择。
* **数据源配置 (Dynamic Data Sources)**:
* **动态加载**: 支持的数据源列表Tushare, Finnhub, AlphaVantage 等)及其配置项由后端动态下发,无需升级前端即可支持新数据源。
* **功能**: 支持输入 Token/Key并提供 **"Test Connection" (测试连接)** 按钮以验证配置是否有效。
* **分析模板**:
* 查看当前的分析流程模板及各模块使用的 Prompt。
* **系统状态**:
* 监控微服务集群 (API Gateway, Orchestrator 等) 的健康状态。
## 3. 快速开始
1. 进入 **配置页** -> **AI Provider**,添加您的 OpenAI API Key。
2. 进入 **配置页** -> **数据源配置**,选择 **Tushare** (或其他源),输入 Token 并点击 **Test Connection** 确认连通性,最后保存。
3. 回到 **首页**,输入 `600519.SS`,选择 `CN` 市场。
4. 点击 **生成分析报告**
5. 在报告页观察左侧 DAG 运行状态,随着任务完成,点击右侧对应的标签页查看数据和分析结果。
## 4. 常见问题
* **Q: 报告生成卡住怎么办?**
* A: 检查左侧“实时日志”,查看是否有 API 连接超时或配额耗尽的错误。也可以在 "Overview" 标签页查看是否有任务标记为失败。
* **Q: 如何添加本地模型?**
* A: 在 AI Provider 页添加新的 ProviderBase URL 填入 `http://localhost:11434/v1` (Ollama 默认地址)。
* **Q: 为什么看不到某些数据源?**
* A: 数据源列表由后端服务动态注册。请确保对应的 Provider 微服务(如 `tushare-provider-service`)已正常启动并注册到网关。