reportAI

报告人工智能

reportAI 是一个基于 Python 的工具，可使用 AI 生成全面的 PDF 研究报告。只需以结构化格式输入与 AI 模型的对话，reportAI 就会生成一份详细的报告，其中包含执行摘要、格式正确的部分、表格和图形。使用巧妙实施的技术来删除报告中任何重复的内容，确保所有内容开门见山，同时具有描述性，而不会对报告内容造成任何重复。最终输出是大约 9-15 页的 PDF，具体取决于生成报告时传递的消息数量。

特征

• 从人工智能生成的对话中生成详细的研究报告。
• 生成带有标题、表格和图形的部分。
• 可通过环境变量自定义。
• 只需最少的设置即可轻松使用。

安装

1. 克隆存储库：

git clone https://github.com/AdirthaBorgohain/reportAI.git
cd reportAI

2. 安装所需的依赖项：

pip install -r requirements.txt

注意：您需要python>=3.10才能运行该项目，而无需对代码库进行任何更改

3. 使用必要的 API 密钥和模型配置设置 .env（在report_ai目录内）文件：

 OPENAI_API_KEY ={YOUR OPENAI API KEY}

ANTHROPIC_API_KEY ={YOUR ANTHROPIC API KEY}

LLM ={CHOICE OF LLM TO USE. Valid values are 'gpt', 'claude'}

GPT_MODEL ={GPT MODEL TO USE IN CASE LLM IS SET TO 'gpt'. Valid values are 'gpt-3.5-turbo', 'gpt-4-turbo', 'gpt-4o'}

CLAUDE_MODEL ={CLAUDE MODEL TO USE IN CASE LLM IS SET TO 'claude'. Valid values are 'claude-3-haiku', 'claude-3-opus'}

用法

查看main.py以获取有关如何使用对话生成报告的示例。

报告样本

使用main.py中的消息生成的示例报告可以在report_ai/reports/sample.pdf中找到。

以下是示例报告的一些屏幕截图：

贡献

1. 分叉存储库。
2. 创建一个新的功能分支（ git checkout -b feature/new-feature ）。
3. 提交您的更改（ git commit -m 'Add some new feature' ）。
4. 推送到分支（ git push origin feature/new-feature ）。
5. 打开拉取请求。

执照

该项目根据 Apache 2.0 许可证获得许可。有关详细信息，请参阅许可证文件。

该项目是使用以下内容构建的：