quantumrag 0.1.0__tar.gz

quantumrag-0.1.0/.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{yaml,yml,toml}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

quantumrag-0.1.0/.env.example

@@ -0,0 +1,45 @@
+# QuantumRAG 환경 변수 설정
+# 이 파일을 복사하여 .env 파일을 만드세요:
+#   cp .env.example .env
+
+# ============================================================
+# LLM API 키 (방법 1: SDK 기본 환경 변수)
+# ============================================================
+# OpenAI — embedding, generation(simple/medium), hype 에서 사용
+OPENAI_API_KEY="sk-proj-your-openai-key-here"
+
+# Anthropic — generation(complex) 티어에서 사용
+ANTHROPIC_API_KEY=sk-ant-your-anthropic-key-here
+
+# Gemini — generation(complex) 티어에서 사용
+GOOGLE_API_KEY="AIza-your-google-api-key-here"
+
+# ============================================================
+# LLM API 키 (방법 2: QuantumRAG 전용 환경 변수)
+# 위 SDK 기본 변수보다 우선순위가 높습니다.
+# 프로바이더별로 다른 키를 사용해야 할 때 유용합니다.
+# ============================================================
+# QUANTUMRAG_MODELS__EMBEDDING__API_KEY=sk-proj-...
+# QUANTUMRAG_MODELS__EMBEDDING__BASE_URL=https://your-azure-endpoint.com
+# QUANTUMRAG_MODELS__GENERATION__SIMPLE__API_KEY=sk-proj-...
+# QUANTUMRAG_MODELS__GENERATION__MEDIUM__API_KEY=sk-proj-...
+# QUANTUMRAG_MODELS__GENERATION__COMPLEX__API_KEY=sk-ant-...
+# QUANTUMRAG_MODELS__GENERATION__COMPLEX__API_KEY=AIza-...  # Gemini 사용 시
+# QUANTUMRAG_MODELS__HYPE__API_KEY=sk-proj-...
+
+# ============================================================
+# Reranker API 키 (유료 reranker 사용 시)
+# ============================================================
+# COHERE_API_KEY=your-cohere-key-here
+# JINA_API_KEY=your-jina-key-here
+
+# ============================================================
+# Ollama (로컬 LLM 사용 시)
+# ============================================================
+# OLLAMA_HOST=http://localhost:11434
+
+# ============================================================
+# QuantumRAG HTTP API 서버
+# ============================================================
+# QUANTUMRAG_API_KEY=your-secret-api-key-for-http-server
+# QUANTUMRAG_CORS_ORIGINS=https://myapp.com,https://admin.myapp.com

quantumrag-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+dist/
+build/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# QuantumRAG data
+quantumrag_data/
+test_scenario_data/
+*.db
+*.lance/
+
+# Config with secrets (*.example 파일은 추적됨)
+.env
+quantumrag.yaml
+quantumrag-local.yaml
+
+# OS
+.DS_Store
+Thumbs.db
+
+.claude

quantumrag-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

quantumrag-0.1.0/CHANGELOG.md

@@ -0,0 +1,100 @@
+# Changelog
+
+All notable changes to QuantumRAG will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-03-25
+
+### Added
+
+**Core Engine**
+- Engine class as single entry point for all RAG functionality
+- Sync and async interfaces for all operations
+- Adaptive complexity routing (Simple/Medium/Complex query paths)
+- Configurable via YAML, environment variables, and code arguments
+
+**Triple Index Architecture**
+- Original Embedding index (cosine similarity via LanceDB)
+- HyPE (Hypothetical Prompt Embeddings) index for question-to-question matching
+- Contextual BM25 index (tantivy-py) with Korean morphology support
+- Reciprocal Rank Fusion (RRF) with configurable weights
+
+**Document Ingestion**
+- Multi-format parsing: PDF, DOCX, PPTX, XLSX, HTML, Markdown, CSV, HWP/HWPX, plain text
+- Three chunking strategies: fixed-size, semantic, structural (auto-detection)
+- Contextual prefix generation for enhanced BM25 indexing
+- Quality scoring (0.0-1.0) for parsed documents
+- Incremental indexing (hash-based change detection)
+
+**Retrieval Pipeline**
+- Triple Index fusion search with RRF scoring
+- FlashRank reranking (CPU, free)
+- Extractive context compression
+- Metadata-based filtering
+- Full processing trace for debugging
+
+**Generation**
+- Source-grounded generation with inline citations [1], [2]
+- Korean/English bilingual prompt system
+- Confidence assessment (strongly_supported, partially_supported, insufficient_evidence)
+- "I don't know" responses when evidence is insufficient
+- Streaming support (SSE)
+
+**LLM Providers**
+- OpenAI (GPT-4.1 family, embeddings)
+- Anthropic (Claude family)
+- Ollama (local models, no API key needed)
+- Automatic retry with exponential backoff
+- Cost tracking and usage monitoring
+
+**Korean Language Support**
+- HWP/HWPX document parsing
+- Kiwi morphology analyzer integration
+- EUC-KR/CP949 encoding detection and conversion
+- Korean-aware query routing (substring matching for agglutinative morphology)
+
+**HTTP API (FastAPI)**
+- POST /v1/ingest, /v1/query, /v1/query/stream
+- GET /v1/documents, /v1/status
+- DELETE /v1/documents/:id
+- POST /v1/evaluate, /v1/feedback
+- API key authentication
+- Rate limiting
+- CORS configuration
+
+**Evaluation System**
+- Synthetic QA pair generation (template-based, zero cost)
+- Retrieval Recall@K metric
+- Faithfulness metric (sentence-level)
+- Answer Relevancy metric
+- Latency percentiles (P50, P95, P99)
+- Weakness analysis with improvement suggestions
+
+**CLI (Typer)**
+- `quantumrag init` - Initialize project
+- `quantumrag ingest <path>` - Ingest documents
+- `quantumrag query "<question>"` - Query with citations
+- `quantumrag status` - Show index status
+- `quantumrag serve` - Start HTTP API server
+- Rich progress bars and formatted output
+
+**Advanced Features**
+- Plugin system with hook-based extensibility
+- Multi-tenant support with isolated storage
+- Semantic cache with TTL and similarity matching
+- Batch query processing with concurrency control
+- Query tracing and cost tracking (observability)
+- Access control (ACL) at document level
+
+**Connectors**
+- Local file system
+- URL/web page
+- Google Drive (OAuth2)
+- Notion (API)
+- AWS S3
+
+**Cloud Connectors**
+- Query decomposition for complex multi-hop queries
+- Speculative RAG for parallel sub-query processing

quantumrag-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We 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, caste, color, religion, or sexual
+identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery, and sexual attention or advances
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+**conduct@quantumrag.dev**.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

quantumrag-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# Contributing to QuantumRAG
+
+Thank you for your interest in contributing to QuantumRAG! This guide will help you get started.
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/quantumrag/quantumrag.git
+cd quantumrag
+
+# Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate  # or .venv\Scripts\activate on Windows
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/
+
+# Run linting
+ruff check quantumrag/ tests/
+```
+
+## Project Structure
+
+```
+quantumrag/
+  core/           # Core engine (models, config, storage, ingest, retrieve, generate)
+  api/            # FastAPI HTTP server
+  cli/            # Typer CLI interface
+  connectors/     # External data source connectors
+  korean/         # Korean language support (morphology, encoding)
+  plugins/        # Plugin system
+tests/
+  unit/           # Unit tests
+  integration/    # Integration tests (require external services)
+  benchmarks/     # Performance benchmarks
+```
+
+## Making Changes
+
+1. **Create a branch** from `main`:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Write code** following existing patterns:
+   - Use type hints everywhere
+   - Follow the existing code style (ruff enforced)
+   - Add docstrings for public APIs
+   - Use lazy imports for optional dependencies
+
+3. **Write tests** for new functionality:
+   - Unit tests go in `tests/unit/`
+   - Mock external services (LLM, embedding APIs)
+   - Aim for >80% coverage on new code
+
+4. **Run checks** before submitting:
+   ```bash
+   ruff check quantumrag/ tests/
+   pytest tests/ -q
+   ```
+
+5. **Submit a Pull Request** with:
+   - Clear description of what changed and why
+   - Link to related issue (if any)
+   - Test results
+
+## Code Style
+
+- **Python 3.10+** — use modern syntax (`X | Y` unions, not `Optional[X]`)
+- **Pydantic v2** for data models
+- **structlog** for logging
+- **Protocol classes** for interfaces (not ABCs)
+- **Lazy imports** for optional dependencies (lancedb, tantivy, etc.)
+
+## Adding a New Parser
+
+```python
+# quantumrag/core/ingest/parser/my_format.py
+from quantumrag.core.models import Document
+
+class MyFormatParser:
+    supported_extensions = {".myext"}
+
+    def parse(self, path: Path) -> Document:
+        # Parse your format and return a Document
+        ...
+```
+
+## Adding a Plugin
+
+See the plugin system documentation in `quantumrag/plugins/registry.py`.
+
+## Reporting Issues
+
+- Use GitHub Issues
+- Include Python version, OS, and QuantumRAG version
+- Provide minimal reproduction steps
+
+## Code of Conduct
+
+Be respectful, constructive, and inclusive. We welcome contributions from everyone regardless of background or experience level.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache License 2.0.

quantumrag-0.1.0/Dockerfile

@@ -0,0 +1,32 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends build-essential && \
+    rm -rf /var/lib/apt/lists/*
+
+# Copy project files
+COPY pyproject.toml README.md LICENSE ./
+COPY quantumrag/ quantumrag/
+
+# Install QuantumRAG with all dependencies
+RUN pip install --no-cache-dir ".[all,api]"
+
+# Create data directory
+RUN mkdir -p /data/quantumrag
+
+# Default config
+ENV QUANTUMRAG_STORAGE__DATA_DIR=/data/quantumrag
+ENV QUANTUMRAG_LANGUAGE=auto
+
+# Expose API port
+EXPOSE 8000
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+    CMD python -c "import httpx; httpx.get('http://localhost:8000/v1/status').raise_for_status()" || exit 1
+
+# Run the API server
+CMD ["quantumrag", "serve", "--host", "0.0.0.0", "--port", "8000"]

quantumrag-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 QuantumRAG Team
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.