🤖 AI Document Analyzer

AI-Powered Document Analyzer: Revolutionizing Document-Reporting with Artificial Intelligence

sequenceDiagram
    actor User

    box lightyellow System
      participant Service
    end

    box lightpink Third-Party
      participant OpenAI
    end

    Note left of User: Copy docs to<br>./documents<br>dir
    Note left of User: Add OpenAI API<br>key to .env file

    User ->> Service: run<br>`make analyze-doc \<br>--question \<br>"How is John Galt?"`

    Service ->> Service: Parse documents<br>to .txt format

    Service ->> OpenAI: Upload<br>.txt files
    OpenAI ->> Service: OK

    Service ->> OpenAI: <br><br>Send prompt<br>to model
      Note right of OpenAI: Run AI model
    OpenAI ->> Service: Analyze<br>response

    Service ->> Service: Write down report<br>to /output dir
    Service ->> User: Analyze<br>done

Loading

How to run

• Install Docker 🐳 and Make Ⓜ️
• Add your docs to the ./documents directory
• Add your OPEN_AI_API_KEY to .env file

make analyze-doc
python3 script.py --question "How is John Galt?"
# Report saved to ai_report_2025-01-21_16:46:01.887051

Improvements

• check if the file is already processed before parse
• check if the file is already processed before upload
• expire uploaded file after used

References

• https://cookbook.openai.com/
• https://github.com/f/awesome-chatgpt-prompts?tab=readme-ov-file#act-as-book-summarizer
• https://github.com/openai/openai-python
• https://platform.openai.com/docs/guides/prompt-engineering
• https://platform.openai.com/docs/guides/structured-outputs
• https://platform.openai.com/docs/libraries

---

Made in Brazil