Powerful-Auto-Researcher(PAR)

👋 Introduction 👋

Hello! I am a beginner developer who is greatly interested in the rapidly emerging field of LLMs.

This is an experimental project in its early stages, created for the purpose of studying LLM prompting and Python for my own study.
However, I believe it to be quite an intriguing idea, and I wish to receive ample feedback and opinions from the brilliant developers on GitHub, while honing my development skills!!

There's a new update! The performance is better than expected compared to the previous version, so I've rewritten the README!

Thank you for starred this project!

Thank you for coming by, and please keep an eye out for future updates!

😉 Help Me & Discuss Me 😉

If you would like to see the results of the document generation, please leave a comment in the designated issue. I will be happy to provide you with the generated documents for your review. Or you can freely leave any comments in Dicussions!

🌠 Contents 🌠

Before getting start, strongly recommend that you read through the contents thoroughly!

1. OverView
2. How Does It Work?
3. All Flow Chart

🚀 HOW TO START 🚀

❗WARNING❗❗WARNING❗❗WARNING❗

This project may use so many tokens, so be careful!

❗WARNING❗❗WARNING❗❗WARNING❗

🤝 Main Third-party libraries 🤝

1. LangChain(Main Interface)

2. LangGraph(Recursive structure and Clear flow)

3. LangSmith(Debugging)

4. Anthropic(Language Model)

5. OpenAI(Embedding Model)

6. Tavily API(Main Search Engine)

7. PineCone(Vector Store)

• Vector store provided by LangChain, freely usable with any vector store supported by LangChain. For testing, please use an any Online Vector Store!

8. MongoDB(BaseStore)

• 2024.04.06 added -> In the future, will use ParentDocumentRetriever.

9. YouTube Search(Main Search Engine)

10. Wikipedia(Main Search Engine)

11. arXiv(Main Search Engine)

12. Brave Search(Main Search Engine)

13. AskNews(Main Search Engine)

🎯 Try it 🎯

The main libraries required for running the project can be found in the requirements.txt file.

1. Clone this repository

git clone https://github.com/MIRACLE-cowf/Powerful-Auto-Researcher.git

2. Move to the cloned repository

cd Powerful-Auto-Researcher

3. Inside the Powerful-Auto-Researcher, fill in the necessary API keys in the .env file

   • LangChain
   • AskNews
   • Anthropic
   • Tavily
   • Brave Search
   • AskNews
   • PineCone
   • Mongo DB

4. Install the required libraries

pip install -r requirements.txt 

5. Run main.py

python3 -m main

✅ Update Log ✅

2024.05.30

• Update New Version with New README

2024.04.11

• Now you can find new test cases that have been added after each update in the issue tracker!

2024.04.10

• New updates are now being managed through the GitHub issue tracker. You can check it!
• Project changes, bug tracking, feature requests, and more can be effectively tracked and documented using issues.
• In addition to the update log, various topics will be managed systematically through the use of issues.
• Please refer to the GitHub issues for future updates and changes.

2024.04.06

• With the official support for Tool Calling from Anthropic and the corresponding update to LangChain, the function calling has been changed from using XML tags to the official function calling method.
• With the availability of official tool calling, there have been modifications to the LangSmith prompts and several new classes have been introduced for structured output.
• In the Retrieve Vector DB stage, I plan to use LangChain's ParentDocumentRetrieve beyond simple similarity search, so preliminary work has been done to enable the use of MongoDB.
• To fetch the Raw content and AI responses from the Tavily API, I have customized the TavilySearchResults function in LangChain.
• For smooth usage of Anthropic's agent, I have customized the OutputParser provided by LangChain.

2024.04.02

• Project First Init

🔥 FeedBack 🔥

As a beginner developer, I am greatly seeking diverse feedback from the brilliant developers on GitHub!

I would appreciate any kind of feedback, regardless of the type, be it Python syntax, structure, prompting, readme, etc.!

Or you can freely leave comment at Issue or Dicussion!

적극적인 피드백 부탁드립니다!

Thank you!
miracle.cowf@gmail.com