Hugging Face's logo

Spaces:
zej97
/
AI-Research-Assistant
Runtime error

App Files Community
2
AI-Research-Assistant / README.md
zej97's picture
zej97
Upload folder using huggingface_hub
8bd159c
preview code
|
raw
history blame
3.2 kB
metadata
title: AI-Research-Assistant
app_file: app.py
sdk: gradio
sdk_version: 3.38.0
duplicated_from: zej97/AI-Research-Assistant

15th Aug, 2023 Fix: HttpError. (Sorry for the late update. I'm currently working on my dissertation...) 21th Aug, 2023 Fix: Report History is only displayed after clicking and will be rest after refreshing.

Inspired by gpt-researcher. This project endeavors to develop an AI research assistant capable of generating research reports effortlessly for researchers. For instance, researchers can request the AI research assistant to compose a report on the latest advancements in the field of superconductors as of 2023, which is currently a trending topic. The AI research assistant will subsequently compile a report based on the relevant information obtained from the internet. Now, AIRA also offers support for academic English polishing.

Example1-1 Example1-2 Example1-3

The currently supported agents encompass a wide range of fields, including finance, business analysis, clinical medicine, basic medicine, travel, academic research and sociology.

In addition to official api, this project offers an alternative approach to generating research reports by utilizing a third-party API. For access to this third-party API, please refer to chimeragpt or GPT-API-free. Before running the project, kindly ensure that you set the environment variables OPENAI_API_KEY and OPENAI_API_BASE.

$ export OPENAI_API_KEY = your_api_key
$ export OPENAI_API_BASE = your_api_base

or you can set the api key and base in .env file.

Installation

  1. Clone the repository

    $ git clone git@github.com:paradoxtown/ai_research_assistant.git
$ cd ai_research_assistant

  2. Install the dependencies

    $ pip install -r requirements.txt

  3. Export evnironment variables

    $ export OPENAI_API_KEY = your_api_key
$ export OPENAI_API_BASE = your_api_base

    or modify the .env file.

  4. Run the project

    $ python app.py

TODO

  • Switch Google Search to DuckDuckGo
  • Literature review
  • Third-party API
  • Prettify report
  • Add medical agent and social agent
  • Add option for users to customize the number of words and temperature
  • Copy and download buttons
  • Allows the user to choose the degree of research.
  • Wikipedia Understanding
Happy researching! 🚀