{"id":13405509,"url":"https://github.com/arc53/DocsGPT","last_synced_at":"2025-03-14T10:30:48.229Z","repository":{"id":65680516,"uuid":"596516907","full_name":"arc53/DocsGPT","owner":"arc53","description":"DocsGPT is an open-source genAI tool that helps users get reliable answers from knowledge source, while avoiding hallucinations. It enables private and reliable information retrieval, with tooling and agentic system capability built in.","archived":false,"fork":false,"pushed_at":"2025-03-12T21:03:10.000Z","size":84388,"stargazers_count":15435,"open_issues_count":52,"forks_count":1644,"subscribers_count":89,"default_branch":"main","last_synced_at":"2025-03-12T22:00:41.225Z","etag":null,"topics":["ai","chatgpt","docsgpt","hacktoberfest","information-retrieval","language-model","llm","machine-learning","natural-language-processing","python","pytorch","rag","react","semantic-search","transformers","web-app"],"latest_commit_sha":null,"homepage":"https://app.docsgpt.cloud/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arc53.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"arc53"}},"created_at":"2023-02-02T11:03:23.000Z","updated_at":"2025-03-12T21:03:16.000Z","dependencies_parsed_at":"2023-10-22T15:24:51.747Z","dependency_job_id":"68dd452f-23d4-4d4d-8854-9eaa383afd01","html_url":"https://github.com/arc53/DocsGPT","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2FDocsGPT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2FDocsGPT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2FDocsGPT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arc53%2FDocsGPT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arc53","download_url":"https://codeload.github.com/arc53/DocsGPT/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243561863,"owners_count":20311190,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","chatgpt","docsgpt","hacktoberfest","information-retrieval","language-model","llm","machine-learning","natural-language-processing","python","pytorch","rag","react","semantic-search","transformers","web-app"],"created_at":"2024-07-30T19:02:04.201Z","updated_at":"2025-03-14T10:30:48.222Z","avatar_url":"https://github.com/arc53.png","language":"TypeScript","funding_links":["https://github.com/sponsors/arc53"],"categories":["Python","Web apps","A01_文本生成_文本对话","AI Agent","Repositories for intermediate/Advanced Coders","Meta","Chatbots \u0026 Virtual Companions","TypeScript","Extend ChatGPT Feature","精选开源项目合集","HarmonyOS","Repos","chatgpt","Table of Contents","UIs","🧠 AI Applications \u0026 Platforms","Open-source repos","AI Agent Frameworks \u0026 SDKs","MCP Servers","5. Retrieval-Augmented Generation (RAG) \u0026 Knowledge"],"sub_categories":["Hosted and self-hosted","大语言对话模型及数据","File","Other","GPT工具","Windows Manager","RAG","Web applications","Tools","Multi-Agent Collaboration Systems","Agent Platforms"],"readme":"\u003ch1 align=\"center\"\u003e\n  DocsGPT  🦖\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eOpen-Source RAG Assistant\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"left\"\u003e\n  \u003cstrong\u003e\u003ca href=\"https://www.docsgpt.cloud/\"\u003eDocsGPT\u003c/a\u003e\u003c/strong\u003e is an open-source genAI tool that helps users get reliable answers from any knowledge source, while avoiding hallucinations. It enables quick and reliable information retrieval, with tooling and agentic system capability built in.\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \n  \u003ca href=\"https://github.com/arc53/DocsGPT\"\u003e![link to main GitHub showing Stars number](https://img.shields.io/github/stars/arc53/docsgpt?style=social)\u003c/a\u003e\n  \u003ca href=\"https://github.com/arc53/DocsGPT\"\u003e![link to main GitHub showing Forks number](https://img.shields.io/github/forks/arc53/docsgpt?style=social)\u003c/a\u003e\n  \u003ca href=\"https://github.com/arc53/DocsGPT/blob/main/LICENSE\"\u003e![link to license file](https://img.shields.io/github/license/arc53/docsgpt)\u003c/a\u003e\n  \u003ca href=\"https://www.bestpractices.dev/projects/9907\"\u003e\u003cimg src=\"https://www.bestpractices.dev/projects/9907/badge\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://discord.gg/n5BX8dh8rU\"\u003e![link to discord](https://img.shields.io/discord/1070046503302877216)\u003c/a\u003e\n  \u003ca href=\"https://twitter.com/docsgptai\"\u003e![X (formerly Twitter) URL](https://img.shields.io/twitter/follow/docsgptai)\u003c/a\u003e\n\n  \u003ca href=\"https://docs.docsgpt.cloud/quickstart\"\u003e⚡️ Quickstart\u003c/a\u003e • \u003ca href=\"https://app.docsgpt.cloud/\"\u003e☁️ Cloud Version\u003c/a\u003e • \u003ca href=\"https://discord.gg/n5BX8dh8rU\"\u003e💬 Discord\u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://docs.docsgpt.cloud/\"\u003e📖 Documentation\u003c/a\u003e • \u003ca href=\"https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md\"\u003e👫 Contribute\u003c/a\u003e • \u003ca href=\"https://blog.docsgpt.cloud/\"\u003e🗞 Blog\u003c/a\u003e\n  \u003cbr\u003e\n\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://d3dg1063dc54p9.cloudfront.net/videos/demov7.gif\" alt=\"video-example-of-docs-gpt\" width=\"800\" height=\"450\"\u003e\n\u003c/div\u003e\n\u003ch3 align=\"left\"\u003e\n  \u003cstrong\u003eKey Features:\u003c/strong\u003e\n\u003c/h3\u003e\n\u003cul align=\"left\"\u003e\n    \u003cli\u003e\u003cstrong\u003e🗂️ Wide Format Support:\u003c/strong\u003e Reads PDF, DOCX, CSV, XLSX, EPUB, MD, RST, HTML, MDX, JSON, PPTX, and images.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🌐 Web \u0026 Data Integration:\u003c/strong\u003e Ingests from URLs, sitemaps, Reddit, GitHub and web crawlers.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e✅ Reliable Answers:\u003c/strong\u003e Get accurate, hallucination-free responses with source citations viewable in a clean UI.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🔑 Streamlined API Keys:\u003c/strong\u003e  Generate keys linked to your settings, documents, and models, simplifying chatbot and integration setup.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🔗 Actionable Tooling:\u003c/strong\u003e Connect to APIs, tools, and other services to enable LLM actions.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🧩 Pre-built Integrations:\u003c/strong\u003e Use readily available HTML/React chat widgets, search tools, Discord/Telegram bots, and more.\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🔌 Flexible Deployment:\u003c/strong\u003e Works with major LLMs (OpenAI, Google, Anthropic) and local models (Ollama, llama_cpp).\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003e🏢 Secure \u0026 Scalable:\u003c/strong\u003e Run privately and securely with Kubernetes support, designed for enterprise-grade reliability.\u003c/li\u003e\n\u003c/ul\u003e\n\n## Roadmap\n\n- [x] Full GoogleAI compatibility (Jan 2025)\n- [x] Add tools (Jan 2025)\n- [x] Manually updating chunks in the app UI (Feb 2025)\n- [x] Devcontainer for easy development (Feb 2025)\n- [ ] Anthropic Tool compatibility\n- [ ] Add triggerable actions / tools (webhook)\n- [ ] Add OAuth 2.0 authentication for tools and sources\n- [ ] Chatbots menu re-design to handle tools, scheduling, and more\n\nYou can find our full roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!\n\n### Production Support / Help for Companies:\n\nWe're eager to provide personalized assistance when deploying your DocsGPT to a live environment.\n\n[Get a Demo :wave:](https://www.docsgpt.cloud/contact)⁠\n\n[Send Email :email:](mailto:support@docsgpt.cloud?subject=DocsGPT%20support%2Fsolutions)\n\n## Join the Lighthouse Program 🌟\n\nCalling all developers and GenAI innovators! The **DocsGPT Lighthouse Program** connects technical leaders actively deploying or extending DocsGPT in real-world scenarios. Collaborate directly with our team to shape the roadmap, access priority support, and build enterprise-ready solutions with exclusive community insights.  \n\n[Learn More \u0026 Apply →](https://docs.google.com/forms/d/1KAADiJinUJ8EMQyfTXUIGyFbqINNClNR3jBNWq7DgTE)\n\n\n## QuickStart\n\n\u003e [!Note]\n\u003e Make sure you have [Docker](https://docs.docker.com/engine/install/) installed\n\nA more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available in our documentation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/arc53/DocsGPT.git\n   cd DocsGPT\n   ```\n\n**For macOS and Linux:**\n\n2. **Run the setup script:**\n\n   ```bash\n   ./setup.sh\n   ```\n\nThis interactive script will guide you through setting up DocsGPT. It offers four options: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider.  The script will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option.\n\n**For Windows:**\n\n2. **Follow the Docker Deployment Guide:**\n\n   Please refer to the [Docker Deployment documentation](https://docs.docsgpt.cloud/Deploying/Docker-Deploying) for detailed step-by-step instructions on setting up DocsGPT using Docker. \n\n**Navigate to http://localhost:5173/**\n\nTo stop DocsGPT, open a terminal in the `DocsGPT` directory and run:\n\n```bash\ndocker compose -f deployment/docker-compose.yaml down\n```\n(or use the specific `docker compose down` command shown after running `setup.sh`).\n\n\u003e [!Note]\n\u003e For development environment setup instructions, please refer to the [Development Environment Guide](https://docs.docsgpt.cloud/Deploying/Development-Environment).\n\n## Contributing\n\nPlease refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for information about how to get involved. We welcome issues, questions, and pull requests.\n\n## Architecture\n\n![Architecture chart](https://github.com/user-attachments/assets/fc6a7841-ddfc-45e6-b5a0-d05fe648cbe2)\n\n## Project Structure\n\n- Application - Flask app (main application).\n\n- Extensions - Extensions, like react widget or discord bot.\n\n- Frontend - Frontend uses \u003ca href=\"https://vitejs.dev/\"\u003eVite\u003c/a\u003e and \u003ca href=\"https://react.dev/\"\u003eReact\u003c/a\u003e.\n\n- Scripts - Miscellaneous scripts.\n\n## Code Of Conduct\n\nWe as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file for more information about contributing.\n\n\n## Many Thanks To Our Contributors⚡\n\n\u003ca href=\"https://github.com/arc53/DocsGPT/graphs/contributors\" alt=\"View Contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=arc53/DocsGPT\" alt=\"Contributors\" /\u003e\n\u003c/a\u003e\n\n## License\n\nThe source code license is [MIT](https://opensource.org/license/mit/), as described in the [LICENSE](LICENSE) file.\n\n\u003cp\u003eThis project is supported by:\u003c/p\u003e\n\u003cp\u003e\n  \u003ca href=\"https://www.digitalocean.com/?utm_medium=opensource\u0026utm_source=DocsGPT\"\u003e\n    \u003cimg src=\"https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg\" width=\"201px\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farc53%2FDocsGPT","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farc53%2FDocsGPT","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farc53%2FDocsGPT/lists"}