{"id":27072508,"url":"https://github.com/jocker-123/chatq","last_synced_at":"2025-09-12T05:38:33.303Z","repository":{"id":286224375,"uuid":"960762345","full_name":"Jocker-123/ChatQ","owner":"Jocker-123","description":"Local Retrieval-Augmented Generation (RAG) system built with FastAPI, integrating vector search, Elasticsearch, and optional web search to power LLM-based intelligent question answering using models like Mistral or GPT-4.","archived":false,"fork":false,"pushed_at":"2025-09-06T11:39:04.000Z","size":2283,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-06T13:22:51.984Z","etag":null,"topics":["chatbot","chatbot-framework","chatql-react","chatroom","clean-ui","fastapi","flutter-bloc","graphql","mqtt","nestjs","nodejs","rag","semantic-search","vector-database"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jocker-123.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-05T02:40:52.000Z","updated_at":"2025-09-06T11:39:07.000Z","dependencies_parsed_at":"2025-05-22T10:25:21.762Z","dependency_job_id":"b4a3299b-75c5-428a-9bbb-740684080cdf","html_url":"https://github.com/Jocker-123/ChatQ","commit_stats":null,"previous_names":["jocker-123/chatq"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Jocker-123/ChatQ","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jocker-123%2FChatQ","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jocker-123%2FChatQ/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jocker-123%2FChatQ/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jocker-123%2FChatQ/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jocker-123","download_url":"https://codeload.github.com/Jocker-123/ChatQ/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jocker-123%2FChatQ/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274759115,"owners_count":25343872,"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","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["chatbot","chatbot-framework","chatql-react","chatroom","clean-ui","fastapi","flutter-bloc","graphql","mqtt","nestjs","nodejs","rag","semantic-search","vector-database"],"created_at":"2025-04-05T23:18:06.888Z","updated_at":"2025-09-12T05:38:33.283Z","avatar_url":"https://github.com/Jocker-123.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"```markdown\n# ChatQ 🌐🤖\n\n![ChatQ Logo](https://img.shields.io/badge/ChatQ-FastAPI-orange?style=flat-square)\n![Release](https://img.shields.io/github/v/release/Jocker-123/ChatQ?style=flat-square)\n![License](https://img.shields.io/badge/license-MIT-brightgreen)\n\nWelcome to **ChatQ**, a Local Retrieval-Augmented Generation (RAG) system. This project leverages FastAPI and integrates cutting-edge technologies like vector search, Elasticsearch, and optional web search. With ChatQ, you can harness the power of large language models (LLMs) such as Mistral or GPT-4 for intelligent question answering.\n\n---\n\n## Table of Contents\n\n- [Features](#features)\n- [Technologies Used](#technologies-used)\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n---\n\n## Features\n\n- **Intelligent Question Answering**: Utilize LLMs to answer complex queries.\n- **Local RAG Implementation**: Combine local data retrieval with generative models for effective responses.\n- **FastAPI Framework**: Built on FastAPI for rapid deployment and high performance.\n- **Vector Search**: Implement vector-based search for precise information retrieval.\n- **Integration with Elasticsearch**: Leverage Elasticsearch for advanced search capabilities.\n- **Web Search Option**: Include an optional web search for real-time data access.\n\n---\n\n## Technologies Used\n\nChatQ combines various technologies to achieve its goals:\n\n- **FastAPI**: A modern, fast (high-performance) web framework for building APIs with Python 3.7+.\n- **Elasticsearch**: A distributed, RESTful search and analytics engine designed for horizontal scalability.\n- **Vector Databases**: Store and retrieve vectors efficiently for semantic search.\n- **LLMs**: Utilize models like Mistral and GPT-4 for natural language understanding.\n- **Langchain**: A framework for building applications powered by LLMs.\n\n---\n\n## Getting Started\n\nTo get started with ChatQ, you will need to clone the repository and install the necessary dependencies.\n\n### Prerequisites\n\n- Python 3.7 or higher\n- pip (Python package installer)\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/Jocker-123/ChatQ.git\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd ChatQ\n   ```\n\n3. Install the required packages:\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. Start the FastAPI server:\n\n   ```bash\n   uvicorn main:app --reload\n   ```\n\nYour ChatQ server should now be running at `http://localhost:8000`.\n\n---\n\n## Usage\n\nOnce the server is up, you can start making requests to the API. \n\n### Example Request\n\nYou can use tools like **Postman** or **cURL** to interact with the API. Here’s a simple example using cURL:\n\n```bash\ncurl -X POST \"http://localhost:8000/ask\" -H \"Content-Type: application/json\" -d '{\"question\": \"What is Retrieval-Augmented Generation?\"}'\n```\n\n### Example Response\n\nThe API will return a JSON response with the answer to your question:\n\n```json\n{\n  \"answer\": \"Retrieval-Augmented Generation (RAG) is a framework that combines retrieval and generation techniques to answer questions more effectively.\"\n}\n```\n\n---\n\n## Contributing\n\nWe welcome contributions to ChatQ! If you want to contribute, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or fix.\n3. Make your changes.\n4. Submit a pull request.\n\nPlease ensure your code adheres to the existing style and includes tests where applicable.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n## Contact\n\nFor any inquiries or suggestions, feel free to reach out:\n\n- **GitHub**: [Jocker-123](https://github.com/Jocker-123)\n- **Email**: your-email@example.com\n\n---\n\n## Releases\n\nFor the latest updates and releases, please check the [Releases section](https://github.com/Jocker-123/ChatQ/releases).\n\n![ChatQ Release Button](https://img.shields.io/badge/Latest%20Release-Download%20Now-blue?style=flat-square)\n\n---\n\n## Acknowledgements\n\nWe would like to thank the developers of FastAPI, Elasticsearch, and the contributors of the libraries used in this project.\n\n---\n\n## Additional Resources\n\n- [FastAPI Documentation](https://fastapi.tiangolo.com/)\n- [Elasticsearch Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html)\n- [Langchain Documentation](https://langchain.readthedocs.io/)\n\n---\n\nFeel free to explore the code and contribute to the development of ChatQ. Your feedback and suggestions are invaluable as we continue to improve this project.\n\n---\n\n![ChatQ Banner](https://www.example.com/chatq-banner.png)\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjocker-123%2Fchatq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjocker-123%2Fchatq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjocker-123%2Fchatq/lists"}