Data

Tools

Indexes

Applications

Experiments

Open Source Science

custom-gpt-researcher

https://github.com/maihoangbichtram/custom-gpt-researcher

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: maihoangbichtram
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 94.1 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

#### [![Website](https://img.shields.io/badge/Official%20Website-platform.sh-teal?style=for-the-badge&logo=world&logoColor=white&color=0891b2)](https://main-bvxea6i-bkwpxl2cinmus.eu.platformsh.site/docs)

Psychology Knowledge Base

Custom GPT Researcher generates/collects unstructured data from web sources. GraphRAG indexes unstructured data into knowledge graph.

Demo

https://main-bvxea6i-bkwpxl2cinmus.eu.platformsh.site/docs

Architecture

Features

  • Generate research reports using web and local documents.
  • Generate reports exceeding 1000 words.
  • Aggregate over 20 sources for objective conclusions.
  • Maintains memory and context throughout research.
  • Export reports to .md format.

Getting Started

Installation

  1. Install Python 3.11 or later. Guide.

  2. Clone the project and navigate to the directory:

    bash git clone https://github.com/maihoangbichtram/custom-gpt-researcher.git gpt-researcher cd gpt-researcher

  3. Set up API keys by exporting them or storing them in a .env file.

    bash Copy .env.example to .env

  4. Configure GraphRAG bash cp ./rag_interface/settings.yaml ./rag cp -r ./rag_interface/prompts ./rag

  5. Activate the virtual environment

    bash poetry shell

  6. Install dependencies and start the server:

    bash poetry lock && poetry install python -m uvicorn main:app --reload

Visit http://localhost:8000 to start.

For other setups (e.g., Poetry or virtual environments), check the Getting Started page.

Add Local Documents to research

You can instruct the GPT Researcher to run research tasks based on your local documents. Currently supported file formats are: plain text(.txt).

Add the env variable DOC_PATH pointing to the folder where your documents are located.

bash export DOC_PATH="./rag/input"

How it works

Website

Deployment

Check out .platform.app.yaml as an example how to deploy.

Note: persistent mounts/disk needed for /rag, /.output, /.config, and /outputs.

Back to Top

Owner

  • Name: Tram Mai
  • Login: maihoangbichtram
  • Kind: user

Student at Centria University of Applied Sciences, Information Technology

GitHub Events

Total
  • Watch event: 1
  • Push event: 28
  • Public event: 1
  • Fork event: 1
Last Year
  • Watch event: 1
  • Push event: 28
  • Public event: 1
  • Fork event: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Dependencies

Dockerfile docker
  • gpt-researcher-install latest build
  • install-browser latest build
  • python 3.11.4-slim-bullseye build
docker-compose.yml docker
  • gptresearcher/gpt-researcher latest
  • gptresearcher/gpt-researcher-tests latest
  • gptresearcher/gptr-nextjs latest
frontend/nextjs/Dockerfile docker
  • nginx latest build
  • node 18.17.0-alpine build
docs/package.json npm
  • @docusaurus/core 0.0.0-4193
  • @docusaurus/preset-classic 0.0.0-4193
  • @easyops-cn/docusaurus-search-local ^0.21.1
  • @mdx-js/react ^1.6.21
  • @svgr/webpack ^5.5.0
  • clsx ^1.1.1
  • file-loader ^6.2.0
  • hast-util-is-element 1.1.0
  • minimatch 3.0.5
  • react ^17.0.1
  • react-dom ^17.0.1
  • rehype-katex 4
  • remark-math 3
  • trim ^0.0.3
  • url-loader ^4.1.1
frontend/nextjs/package.json npm
  • @types/jsdom ^21.1.6 development
  • @types/node ^20 development
  • @types/react ^18 development
  • @types/react-dom ^18 development
  • eslint ^8 development
  • eslint-config-next 14.2.3 development
  • postcss ^8 development
  • prettier ^3.2.5 development
  • prettier-plugin-tailwindcss ^0.6.0 development
  • tailwindcss ^3.4.1 development
  • typescript ^5 development
  • @chakra-ui/react ^2.4.9
  • @emotion/react ^11.10.5
  • @emotion/styled ^11.10.5
  • @langchain/langgraph-sdk ^0.0.1-rc.12
  • @mozilla/readability ^0.5.0
  • @testing-library/jest-dom ^5.16.5
  • @testing-library/react ^13.4.0
  • @testing-library/user-event ^13.5.0
  • axios ^1.3.2
  • eventsource-parser ^1.1.2
  • framer-motion ^9.0.2
  • jsdom ^24.1.0
  • next 14.2.3
  • next-plausible ^3.12.0
  • react ^18
  • react-dom ^18
  • react-dropzone ^14.2.3
  • react-hot-toast ^2.4.1
  • react-scripts 5.0.1
  • remark ^15.0.1
  • remark-html ^16.0.1
  • remark-parse ^11.0.0
  • together-ai ^0.6.0-alpha.3
  • web-vitals ^2.1.4
  • zod ^3.0.0
  • zod-to-json-schema ^3.23.0
multi_agents/package.json npm
  • @langchain/langgraph-sdk ^0.0.1-rc.13
graphrag_extra/setup.py pypi
multi_agents/requirements.txt pypi
  • gpt_researcher *
  • json5 *
  • langgraph *
  • langgraph-cli *
  • loguru *
  • python-dotenv *
  • weasyprint *
pyproject.toml pypi
  • PyMuPDF >=1.23.6
  • SQLAlchemy >=2.0.28
  • aiofiles >=23.2.1
  • arxiv >=2.0.0
  • autopep8 ^2.3.1
  • beautifulsoup4 >=4.12.2
  • chromadb ^0.5.18
  • colorama >=0.4.6
  • duckduckgo_search >=4.1.1
  • fastapi >=0.104.1
  • fastapi-utilities ^0.3.0
  • firebase-admin ^6.6.0
  • graphrag ^0.5.0
  • graphrag-extra *
  • htmldocx ^0.0.6
  • jinja2 >=3.1.2
  • json-repair ^0.30
  • json5 ^0.9.25
  • langchain ^0.3
  • langchain-chroma ^0.1.4
  • langchain-openai ^0.2
  • langchain_community ^0.3
  • langgraph >=0.0.29,<0.3
  • loguru ^0.7.2
  • lxml >=4.9.2
  • markdown >=3.5.1
  • md2pdf >=1.0.1
  • mistune ^3.0.2
  • openai >=1.3.3
  • permchain >=0.0.6
  • pydantic >=2.5.1
  • python >=3.10,<3.13
  • python-docx ^1.1.0
  • python-dotenv >=1.0.0
  • python-multipart >=0.0.6
  • python-slugify ^8.0.4
  • pyyaml >=6.0.1
  • requests >=2.31.0
  • tavily-python >=0.2.8
  • tiktoken >=0.7.0
  • unstructured >=0.13,<0.16
  • uvicorn >=0.24.0.post1
  • websockets ^13.1
requirements.txt pypi
  • PyMuPDF *
  • aiofiles *
  • arxiv *
  • beautifulsoup4 *
  • colorama *
  • fastapi *
  • gpt-researcher *
  • htmldocx *
  • jinja2 *
  • json5 *
  • json_repair *
  • langchain *
  • langchain-ollama *
  • langchain-openai *
  • langchain_community *
  • langgraph *
  • loguru *
  • lxml_html_clean *
  • markdown *
  • md2pdf *
  • mistune *
  • pydantic *
  • python-docx *
  • python-dotenv *
  • python-multipart *
  • pyyaml *
  • requests *
  • tiktoken *
  • unstructured *
  • uvicorn *
  • websockets *
setup.py pypi