chatbot-api  by fuzhengwei

Java project for ChatGPT-based Q&A assistant

created 2 years ago
556 stars

Top 58.5% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a comprehensive, open-source AI Q&A assistant system for Java developers. It addresses the need for automated technical support and knowledge dissemination, particularly for platforms like knowledge-sharing communities. The system integrates web scraping, ChatGPT API, Domain-Driven Design (DDD) principles, and Docker deployment, offering a complete, albeit small-scale, workflow for learning and implementation.

How It Works

The system employs a DDD architecture to structure its components, including web scraping for data acquisition and ChatGPT API integration for AI-powered responses. It automates the process of answering technical questions, potentially by integrating with platforms like "knowledge planets" (likely referring to a specific community or forum). The workflow covers data collection, AI interaction, and deployment via Docker, demonstrating a full lifecycle for a microservice.

Quick Start & Requirements

  • Install/Run: The project is Java-based, implying a typical Spring Boot application build and execution. Docker deployment is also supported.
  • Prerequisites: Java (version 3.6+ recommended), Maven/Gradle for building, Docker for deployment. OpenAI API key is required for ChatGPT integration. TensorFlow is mentioned for potential model training/usage, with specific installation instructions for macOS M1.
  • Resources: Setup involves cloning the repository, building the Java project, and potentially configuring API keys and Docker.
  • Links:

Highlighted Details

  • Full workflow demonstration: Covers web scraping, AI API integration, DDD, Docker packaging, and deployment.
  • Educational focus: Accompanied by video courses that guide users through code line-by-line.
  • Architectural practice: Employs Domain-Driven Design (DDD) principles.
  • Cross-platform potential: Mentions macOS and M1 chip specifics for TensorFlow.

Maintenance & Community

The project is authored by "小傅哥" (Xiao Fu Ge), a prominent technical blogger and educator with a significant online following. Community engagement is encouraged via WeChat and a dedicated "knowledge planet."

Licensing & Compatibility

The project is licensed under the Apache License 2.0. However, it explicitly prohibits commercial sales by training institutions or individuals without written authorization from the author.

Limitations & Caveats

The project is primarily educational and may not be production-ready without further hardening. The Apache 2.0 license has a non-commercial use restriction for specific entities, which could impact certain adoption scenarios. The dependency on external APIs (like OpenAI) means operational costs and potential rate limits apply.

Health Check
Last commit

1 year ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
7 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.