FinAnGPT-Pro 项目使用教程

FinAnGPT-Pro 项目使用教程

FinAnGPT-Pro A script for creating your very own AI-Powered stock screener 项目地址: https://gitcode.com/gh_mirrors/fi/FinAnGPT-Pro

1. 项目的目录结构及介绍

FinAnGPT-Pro 是一个开源项目，用于创建一个基于 AI 的股票筛选器。以下是项目的目录结构及文件介绍：

.
├── src/
│   ├── models/
│   │   └── StockFinancials.ts         # 定义股票财务数据模型
│   └── services/
│       ├── databases/
│       │   ├── bigQuery.ts            # BigQuery 数据库服务
│       │   └── mongo.ts               # MongoDB 数据库服务
│       ├── fundamentalApi/
│       │   └── EodhdClient.ts         # EOD Historical Data API 客户端
│       └── llmApi/
│           ├── clients/
│           │   ├── OllamaServiceClient.ts  # Ollama 服务客户端
│           │   └── RequestyServiceClient.ts  # Requesty 服务客户端
│           └── logs/
│               ├── ollamaChatLogs.ts   # Ollama 聊天日志
│               └── requestyChatLogs.ts # Requesty 聊天日志
├── tickers.csv                         # 预设的股票列表文件
├── .env                               # 环境变量配置文件
├── upload.ts                          # 上传财务数据到数据库的脚本
├── chat.ts                            # 启动聊天界面的脚本
└── README.md                          # 项目说明文件

2. 项目的启动文件介绍

项目的启动文件主要有两个：

• upload.ts：用于上传财务数据到数据库。你可以修改该文件来指定上传特定股票的数据，或者上传预设的股票列表。

• chat.ts：用于启动聊天界面，允许用户使用自然语言查询股票数据。

3. 项目的配置文件介绍

项目的配置文件为 .env，它包含以下环境变量：

• CLOUD_DB：MongoDB 云数据库的连接字符串。
• LOCAL_DB：MongoDB 本地数据库的连接字符串。
• EODHD_API_KEY：EOD Historical Data API 的密钥。
• REQUESTY_API_KEY：Requesty API 的密钥。
• GOOGLE_APPLICATION_CREDENTIALS_JSON：Google Cloud 平台服务账户凭证的 JSON 内容。
• OLLAMA_SERVICE_URL：Ollama 服务的 URL（可选，如果使用本地 LLM 能力时需要）。

确保正确配置这些环境变量，并保护好你的 API 密钥和服务账户凭证，不要将它们硬编码在代码中或提交到代码仓库中。

FinAnGPT-Pro A script for creating your very own AI-Powered stock screener 项目地址: https://gitcode.com/gh_mirrors/fi/FinAnGPT-Pro