reportAI

レポートAI

reportAI は、AI を使用して包括的な PDF 調査レポートを生成する Python ベースのツールです。 AI モデルとの会話を構造化された形式で入力するだけで、reportAI が概要、適切にフォーマットされたセクション、表、図を備えた詳細なレポートを作成します。レポート内で繰り返されるコンテンツを重複排除するために巧みに実装された技術を使用することで、レポート コンテンツに繰り返しが生じることなく、すべてのコンテンツが要点を直接的に示しながら説明的になることが保証されます。最終出力は、レポート生成のために渡されたメッセージの数に応じて、約 9 ～ 15 ページの PDF になります。

特徴

• AI が生成した会話から詳細な調査レポートを生成します。
• ヘッダー、表、図を含むセクションを作成します。
• 環境変数を介してカスタマイズ可能。
• 最小限のセットアップで簡単に使用できます。

インストール

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 ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。

このプロジェクトは以下を使用して構築されています。