kssrag 0.1.0__tar.gz → 0.1.2__tar.gz

{kssrag-0.1.0 → kssrag-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kssrag
-Version: 0.1.0
+Version: 0.1.2
 Summary: A flexible Retrieval-Augmented Generation framework by Ksschkw
 Home-page: https://github.com/Ksschkw/kssrag
 Author: Ksschkw
@@ -22,7 +22,6 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: fastapi>=0.104.0
 Requires-Dist: uvicorn>=0.24.0
 Requires-Dist: python-dotenv>=1.0.0
@@ -55,7 +54,6 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
-Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-dist
@@ -65,6 +63,8 @@ Dynamic: summary
 # 🚀 KSS RAG - Knowledge Retrieval Augmented Generation Framework
 
 > Built by [Ksschkw](https://github.com/Ksschkw)
+\
+> View at: [PyPi](https://pypi.org/project/kssrag/0.1.1/)
 
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
@@ -118,10 +118,10 @@ print(response)
 export OPENROUTER_API_KEY="your_key_here"
 
 # Query documents
-python -m kssrag.cli query --file document.txt --query "Main ideas?"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Main ideas?"
 
 # Start API server
-python -m kssrag.cli server --file document.txt --port 8000
+python -m kssrag.cli server --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --port 8000
 ```
 
 ## 🐳 Docker Deployment
@@ -265,7 +265,7 @@ python -m pytest --cov=kssrag tests/
 **CLI Command Not Found**
 ```bash
 # Use module syntax on Windows
-python -m kssrag.cli query --file document.txt --query "Your question"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Your question"
 ```
 
 **FAISS Windows Issues**

{kssrag-0.1.0 → kssrag-0.1.2}/README.md

@@ -1,6 +1,8 @@
 # 🚀 KSS RAG - Knowledge Retrieval Augmented Generation Framework
 
 > Built by [Ksschkw](https://github.com/Ksschkw)
+\
+> View at: [PyPi](https://pypi.org/project/kssrag/0.1.1/)
 
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
@@ -54,10 +56,10 @@ print(response)
 export OPENROUTER_API_KEY="your_key_here"
 
 # Query documents
-python -m kssrag.cli query --file document.txt --query "Main ideas?"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Main ideas?"
 
 # Start API server
-python -m kssrag.cli server --file document.txt --port 8000
+python -m kssrag.cli server --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --port 8000
 ```
 
 ## 🐳 Docker Deployment
@@ -201,7 +203,7 @@ python -m pytest --cov=kssrag tests/
 **CLI Command Not Found**
 ```bash
 # Use module syntax on Windows
-python -m kssrag.cli query --file document.txt --query "Your question"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Your question"
 ```
 
 **FAISS Windows Issues**

{kssrag-0.1.0 → kssrag-0.1.2}/kssrag/cli.py

@@ -1,5 +1,6 @@
 import argparse
 import sys
+import os  # Add this import if not already present
 from .utils.document_loaders import load_document, load_json_documents
 from .core.chunkers import TextChunker, JSONChunker, PDFChunker
 from .core.vectorstores import BM25VectorStore, FAISSVectorStore, TFIDFVectorStore, HybridVectorStore, HybridOfflineVectorStore
@@ -24,6 +25,7 @@ def main():
                              choices=["bm25", "faiss", "tfidf", "hybrid_online", "hybrid_offline"], 
                              help="Vector store type")
     query_parser.add_argument("--top-k", type=int, default=config.TOP_K, help="Number of results to retrieve")
+    query_parser.add_argument("--system-prompt", type=str, help="Path to a file containing the system prompt or the prompt text itself")
     
     # Server command
     server_parser = subparsers.add_parser("server", help="Start the RAG API server")
@@ -35,12 +37,23 @@ def main():
                               help="Vector store type")
     server_parser.add_argument("--port", type=int, default=config.SERVER_PORT, help="Port to run server on")
     server_parser.add_argument("--host", type=str, default=config.SERVER_HOST, help="Host to run server on")
+    server_parser.add_argument("--system-prompt", type=str, help="Path to a file containing the system prompt or the prompt text itself")
     
     args = parser.parse_args()
+    vector_store_type = args.vector_store if hasattr(args, 'vector_store') else config.VECTOR_STORE_TYPE
     
     # Validate config
     validate_config()
     
+    def load_system_prompt(prompt_arg):
+        """Load system prompt from file or use as text"""
+        if not prompt_arg:
+            return None
+        if os.path.exists(prompt_arg):
+            with open(prompt_arg, 'r', encoding='utf-8') as f:
+                return f.read()
+        return prompt_arg
+    
     if args.command == "query":
         # Load and process document
         if args.format == "text":
@@ -78,7 +91,8 @@ def main():
         # Create retriever and agent
         retriever = SimpleRetriever(vector_store)
         llm = OpenRouterLLM()
-        agent = RAGAgent(retriever, llm)
+        system_prompt = load_system_prompt(args.system_prompt)
+        agent = RAGAgent(retriever, llm, system_prompt=system_prompt)
         
         # Query and print response
         response = agent.query(args.query, top_k=args.top_k)
@@ -122,7 +136,8 @@ def main():
         # Create retriever and agent
         retriever = SimpleRetriever(vector_store)
         llm = OpenRouterLLM()
-        agent = RAGAgent(retriever, llm)
+        system_prompt = load_system_prompt(args.system_prompt)
+        agent = RAGAgent(retriever, llm, system_prompt=system_prompt)
         
         # Create and run server
         from .server import create_app

{kssrag-0.1.0 → kssrag-0.1.2}/kssrag/core/vectorstores.py

@@ -13,6 +13,13 @@ from typing import List, Dict, Any, Optional
 from ..utils.helpers import logger
 from ..config import config
 
+FAISS_AVAILABLE = False
+try:
+    import faiss
+    FAISS_AVAILABLE = True
+except ImportError:
+    pass
+
 class BaseVectorStore:
     """Base class for vector stores"""
     
@@ -104,6 +111,8 @@ class BM25VectorStore(BaseVectorStore):
 import tempfile
 class FAISSVectorStore(BaseVectorStore):
     def __init__(self, persist_path: Optional[str] = None, model_name: Optional[str] = None):
+        if not FAISS_AVAILABLE:
+            raise ImportError("FAISS is not available. Please install it with 'pip install faiss-cpu' or use a different vector store.")
         super().__init__(persist_path)
         self.model_name = model_name or config.FAISS_MODEL_NAME
         

kssrag-0.1.2/kssrag/utils/helpers.py

@@ -0,0 +1,85 @@
+import logging
+import importlib
+
+# Set up logging
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(levelname)s:KSSRAG:%(message)s'
+)
+logger = logging.getLogger("KSSRAG")
+
+
+def setup_faiss():
+    """Handle FAISS initialization with proper error handling and fallbacks"""
+    faiss_available = False
+    faiss_avx_type = "standard"
+    
+    # Only try to import FAISS if it's actually needed
+    from ..config import config
+    if config.VECTOR_STORE_TYPE in ["faiss", "hybrid_online"]:
+        try:
+            # Try different FAISS versions in order of preference
+            faiss_import_attempts = [
+                ("AVX512-SPR", "faiss.swigfaiss_avx512_spr"),
+                ("AVX512", "faiss.swigfaiss_avx512"),
+                ("AVX2", "faiss.swigfaiss_avx2"),
+                ("Standard", "faiss.swigfaiss")
+            ]
+            
+            for avx_type, import_path in faiss_import_attempts:
+                try:
+                    logger.info(f"Loading faiss with {avx_type} support.")
+                    # Dynamic import
+                    import importlib
+                    faiss_module = importlib.import_module(import_path)
+                    # Make the FAISS symbols available globally
+                    globals().update({name: getattr(faiss_module, name) for name in dir(faiss_module) if not name.startswith('_')})
+                    
+                    faiss_available = True
+                    faiss_avx_type = avx_type
+                    logger.info(f"Successfully loaded faiss with {avx_type} support.")
+                    break
+                    
+                except ImportError as e:
+                    logger.info(f"Could not load library with {avx_type} support due to: {repr(e)}")
+                    continue
+                    
+            if not faiss_available:
+                logger.warning("Could not load any FAISS version. FAISS-based vector stores will be disabled.")
+                
+        except Exception as e:
+            logger.error(f"Failed to initialize FAISS: {str(e)}")
+            faiss_available = False
+    
+    return faiss_available, faiss_avx_type
+
+# Initialize FAISS only when needed
+FAISS_AVAILABLE, FAISS_AVX_TYPE = setup_faiss()
+
+# Your signature in the code
+def kss_signature():
+    return "Built with HATE by Ksschkw (github.com/Ksschkw)"
+
+def validate_config():
+    """Validate the configuration"""
+    from ..config import config
+    
+    if not config.OPENROUTER_API_KEY:
+        logger.warning("OPENROUTER_API_KEY not set. LLM functionality will not work.")
+    
+    if config.VECTOR_STORE_TYPE in ["faiss", "hybrid_online"] and not FAISS_AVAILABLE:
+        logger.warning(f"FAISS not available. Falling back to HYBRID_OFFLINE vector store.")
+        config.VECTOR_STORE_TYPE = "hybrid_offline"
+        
+    return True
+
+
+def import_custom_component(import_path: str):
+    """Import a custom component from a string path"""
+    try:
+        module_path, class_name = import_path.rsplit('.', 1)
+        module = importlib.import_module(module_path)
+        return getattr(module, class_name)
+    except (ImportError, AttributeError, ValueError) as e:
+        logger.error(f"Failed to import custom component {import_path}: {str(e)}")
+        raise

{kssrag-0.1.0 → kssrag-0.1.2}/kssrag.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kssrag
-Version: 0.1.0
+Version: 0.1.2
 Summary: A flexible Retrieval-Augmented Generation framework by Ksschkw
 Home-page: https://github.com/Ksschkw/kssrag
 Author: Ksschkw
@@ -22,7 +22,6 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: fastapi>=0.104.0
 Requires-Dist: uvicorn>=0.24.0
 Requires-Dist: python-dotenv>=1.0.0
@@ -55,7 +54,6 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
-Dynamic: license-file
 Dynamic: project-url
 Dynamic: provides-extra
 Dynamic: requires-dist
@@ -65,6 +63,8 @@ Dynamic: summary
 # 🚀 KSS RAG - Knowledge Retrieval Augmented Generation Framework
 
 > Built by [Ksschkw](https://github.com/Ksschkw)
+\
+> View at: [PyPi](https://pypi.org/project/kssrag/0.1.1/)
 
 ![Python Version](https://img.shields.io/badge/python-3.8%2B-blue)
 ![License](https://img.shields.io/badge/license-MIT-green)
@@ -118,10 +118,10 @@ print(response)
 export OPENROUTER_API_KEY="your_key_here"
 
 # Query documents
-python -m kssrag.cli query --file document.txt --query "Main ideas?"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Main ideas?"
 
 # Start API server
-python -m kssrag.cli server --file document.txt --port 8000
+python -m kssrag.cli server --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --port 8000
 ```
 
 ## 🐳 Docker Deployment
@@ -265,7 +265,7 @@ python -m pytest --cov=kssrag tests/
 **CLI Command Not Found**
 ```bash
 # Use module syntax on Windows
-python -m kssrag.cli query --file document.txt --query "Your question"
+python -m kssrag.cli query --file document.txt --system-prompt custom_prompt.txt(`or just insert plain text here in quotes`) --query "Your question"
 ```
 
 **FAISS Windows Issues**

{kssrag-0.1.0 → kssrag-0.1.2}/kssrag.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-LICENSE
 README.md
 setup.py
 ./kssrag/__init__.py

{kssrag-0.1.0 → kssrag-0.1.2}/setup.py

@@ -6,7 +6,7 @@ long_description = (here / "README.md").read_text(encoding="utf-8")
 
 setup(
     name="kssrag",
-    version="0.1.0",
+    version="0.1.2",
     description="A flexible Retrieval-Augmented Generation framework by Ksschkw",
     long_description=long_description,
     long_description_content_type="text/markdown",

kssrag-0.1.0/kssrag/utils/helpers.py

@@ -1,55 +0,0 @@
-import logging
-import importlib
-
-# Set up logging
-logging.basicConfig(
-    level=logging.INFO,
-    format='%(levelname)s:KSSRAG:%(message)s'
-)
-logger = logging.getLogger("KSSRAG")
-
-# Your signature in the code
-def kss_signature():
-    return "Built with HATE by Ksschkw (github.com/Ksschkw)"
-
-def validate_config():
-    """Validate the configuration"""
-    from ..config import config
-    
-    if not config.OPENROUTER_API_KEY:
-        logger.warning("OPENROUTER_API_KEY not set. LLM functionality will not work.")
-    
-    return True
-
-def import_custom_component(import_path: str):
-    """Import a custom component from a string path"""
-    try:
-        module_path, class_name = import_path.rsplit('.', 1)
-        module = importlib.import_module(module_path)
-        return getattr(module, class_name)
-    except (ImportError, AttributeError, ValueError) as e:
-        logger.error(f"Failed to import custom component {import_path}: {str(e)}")
-        raise
-
-# import os
-# import logging
-# from .utils.helpers import logger
-
-# def setup_faiss():
-#     """Handle FAISS initialization with proper error handling"""
-#     try:
-#         # Try to load with AVX2 support first
-#         logger.info("Loading faiss with AVX2 support.")
-#         from faiss.swigfaiss_avx2 import *
-#         logger.info("Successfully loaded faiss with AVX2 support.")
-#         return True
-#     except ImportError as e:
-#         logger.info(f"Could not load library with AVX2 support due to:\n{repr(e)}")
-#         logger.info("Falling back to standard FAISS without AVX2 support")
-#         try:
-#             from faiss.swigfaiss import *
-#             logger.info("Successfully loaded standard faiss.")
-#             return False
-#         except ImportError as e:
-#             logger.error(f"Failed to load any FAISS version: {repr(e)}")
-#             raise