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 許可證獲得許可。有關詳細信息，請參閱許可證文件。

該項目是使用以下內容建構的：