diff --git a/.env.example b/.env.example index 2055a7f8..7d5c0fe5 100644 --- a/.env.example +++ b/.env.example @@ -57,4 +57,4 @@ LOG_LEVEL=INFO # AZURE_OPENAI_ENDPOINT=https://myendpoint.openai.azure.com # AZURE_EMBEDDING_DEPLOYMENT=text-embedding-3-large -# AZURE_EMBEDDING_API_VERSION=2023-05-15 \ No newline at end of file +# AZURE_EMBEDDING_API_VERSION=2023-05-15 diff --git a/docker-compose.yml b/docker-compose.yml index ab9a4f97..a4713279 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -19,4 +19,4 @@ services: - "host.docker.internal:host-gateway" networks: lightrag_net: - driver: bridge \ No newline at end of file + driver: bridge diff --git a/docs/DockerDeployment.md b/docs/DockerDeployment.md index fa9120c0..ab3fd854 100644 --- a/docs/DockerDeployment.md +++ b/docs/DockerDeployment.md @@ -5,7 +5,7 @@ A lightweight Knowledge Graph Retrieval-Augmented Generation system with multipl ## šŸš€ Installation ### Prerequisites -- Python 3.10+ +- Python 3.10+ - Git - Docker (optional for Docker deployment) @@ -171,4 +171,4 @@ pip install -r requirements.txt git pull .\venv\Scripts\Activate pip install -r requirements.txt -``` \ No newline at end of file +``` diff --git a/docs/LightRagAPI.md b/docs/LightRagAPI.md index 15b5185d..6c82be66 100644 --- a/docs/LightRagAPI.md +++ b/docs/LightRagAPI.md @@ -358,4 +358,4 @@ This intelligent caching mechanism: - Documents already in the database are not re-vectorized - Only new documents in the input directory will be processed - This optimization significantly reduces startup time for subsequent runs -- The working directory (`--working-dir`) stores the vectorized documents database \ No newline at end of file +- The working directory (`--working-dir`) stores the vectorized documents database diff --git a/lightrag/api/README.md b/lightrag/api/README.md index 15b5185d..6c82be66 100644 --- a/lightrag/api/README.md +++ b/lightrag/api/README.md @@ -358,4 +358,4 @@ This intelligent caching mechanism: - Documents already in the database are not re-vectorized - Only new documents in the input directory will be processed - This optimization significantly reduces startup time for subsequent runs -- The working directory (`--working-dir`) stores the vectorized documents database \ No newline at end of file +- The working directory (`--working-dir`) stores the vectorized documents database diff --git a/lightrag/api/lightrag_server.py b/lightrag/api/lightrag_server.py index 149f35fb..ae47bb47 100644 --- a/lightrag/api/lightrag_server.py +++ b/lightrag/api/lightrag_server.py @@ -38,36 +38,38 @@ def get_default_host(binding_type: str) -> str: binding_type, "http://localhost:11434" ) # fallback to ollama if unknown + from dotenv import load_dotenv -import os + def get_env_value(env_key: str, default: Any, value_type: type = str) -> Any: """ Get value from environment variable with type conversion - + Args: env_key (str): Environment variable key default (Any): Default value if env variable is not set value_type (type): Type to convert the value to - + Returns: Any: Converted value from environment or default """ value = os.getenv(env_key) if value is None: return default - + if value_type == bool: - return value.lower() in ('true', '1', 'yes') + return value.lower() in ("true", "1", "yes") try: return value_type(value) except ValueError: return default + def display_splash_screen(args: argparse.Namespace) -> None: """ Display a colorful splash screen showing LightRAG server configuration - + Args: args: Parsed command line arguments """ @@ -81,61 +83,61 @@ def display_splash_screen(args: argparse.Namespace) -> None: # Server Configuration ASCIIColors.magenta("\nšŸ“” Server Configuration:") - ASCIIColors.white(f" ā”œā”€ Host: ", end="") + ASCIIColors.white(" ā”œā”€ Host: ", end="") ASCIIColors.yellow(f"{args.host}") - ASCIIColors.white(f" ā”œā”€ Port: ", end="") + ASCIIColors.white(" ā”œā”€ Port: ", end="") ASCIIColors.yellow(f"{args.port}") - ASCIIColors.white(f" ā”œā”€ SSL Enabled: ", end="") + ASCIIColors.white(" ā”œā”€ SSL Enabled: ", end="") ASCIIColors.yellow(f"{args.ssl}") if args.ssl: - ASCIIColors.white(f" ā”œā”€ SSL Cert: ", end="") + ASCIIColors.white(" ā”œā”€ SSL Cert: ", end="") ASCIIColors.yellow(f"{args.ssl_certfile}") - ASCIIColors.white(f" ā””ā”€ SSL Key: ", end="") + ASCIIColors.white(" ā””ā”€ SSL Key: ", end="") ASCIIColors.yellow(f"{args.ssl_keyfile}") # Directory Configuration ASCIIColors.magenta("\nšŸ“‚ Directory Configuration:") - ASCIIColors.white(f" ā”œā”€ Working Directory: ", end="") + ASCIIColors.white(" ā”œā”€ Working Directory: ", end="") ASCIIColors.yellow(f"{args.working_dir}") - ASCIIColors.white(f" ā””ā”€ Input Directory: ", end="") + ASCIIColors.white(" ā””ā”€ Input Directory: ", end="") ASCIIColors.yellow(f"{args.input_dir}") # LLM Configuration ASCIIColors.magenta("\nšŸ¤– LLM Configuration:") - ASCIIColors.white(f" ā”œā”€ Binding: ", end="") + ASCIIColors.white(" ā”œā”€ Binding: ", end="") ASCIIColors.yellow(f"{args.llm_binding}") - ASCIIColors.white(f" ā”œā”€ Host: ", end="") + ASCIIColors.white(" ā”œā”€ Host: ", end="") ASCIIColors.yellow(f"{args.llm_binding_host}") - ASCIIColors.white(f" ā””ā”€ Model: ", end="") + ASCIIColors.white(" ā””ā”€ Model: ", end="") ASCIIColors.yellow(f"{args.llm_model}") # Embedding Configuration ASCIIColors.magenta("\nšŸ“Š Embedding Configuration:") - ASCIIColors.white(f" ā”œā”€ Binding: ", end="") + ASCIIColors.white(" ā”œā”€ Binding: ", end="") ASCIIColors.yellow(f"{args.embedding_binding}") - ASCIIColors.white(f" ā”œā”€ Host: ", end="") + ASCIIColors.white(" ā”œā”€ Host: ", end="") ASCIIColors.yellow(f"{args.embedding_binding_host}") - ASCIIColors.white(f" ā”œā”€ Model: ", end="") + ASCIIColors.white(" ā”œā”€ Model: ", end="") ASCIIColors.yellow(f"{args.embedding_model}") - ASCIIColors.white(f" ā””ā”€ Dimensions: ", end="") + ASCIIColors.white(" ā””ā”€ Dimensions: ", end="") ASCIIColors.yellow(f"{args.embedding_dim}") # RAG Configuration ASCIIColors.magenta("\nāš™ļø RAG Configuration:") - ASCIIColors.white(f" ā”œā”€ Max Async Operations: ", end="") + ASCIIColors.white(" ā”œā”€ Max Async Operations: ", end="") ASCIIColors.yellow(f"{args.max_async}") - ASCIIColors.white(f" ā”œā”€ Max Tokens: ", end="") + ASCIIColors.white(" ā”œā”€ Max Tokens: ", end="") ASCIIColors.yellow(f"{args.max_tokens}") - ASCIIColors.white(f" ā””ā”€ Max Embed Tokens: ", end="") + ASCIIColors.white(" ā””ā”€ Max Embed Tokens: ", end="") ASCIIColors.yellow(f"{args.max_embed_tokens}") # System Configuration ASCIIColors.magenta("\nšŸ› ļø System Configuration:") - ASCIIColors.white(f" ā”œā”€ Log Level: ", end="") + ASCIIColors.white(" ā”œā”€ Log Level: ", end="") ASCIIColors.yellow(f"{args.log_level}") - ASCIIColors.white(f" ā”œā”€ Timeout: ", end="") + ASCIIColors.white(" ā”œā”€ Timeout: ", end="") ASCIIColors.yellow(f"{args.timeout if args.timeout else 'None (infinite)'}") - ASCIIColors.white(f" ā””ā”€ API Key: ", end="") + ASCIIColors.white(" ā””ā”€ API Key: ", end="") ASCIIColors.yellow("Set" if args.key else "Not Set") # Server Status @@ -153,7 +155,7 @@ def display_splash_screen(args: argparse.Namespace) -> None: ASCIIColors.yellow(f"{protocol}://localhost:{args.port}/docs") ASCIIColors.white(" ā””ā”€ Alternative Documentation (local): ", end="") ASCIIColors.yellow(f"{protocol}://localhost:{args.port}/redoc") - + ASCIIColors.yellow("\nšŸ“ Note:") ASCIIColors.white(""" Since the server is running on 0.0.0.0: - Use 'localhost' or '127.0.0.1' for local access @@ -174,10 +176,10 @@ def display_splash_screen(args: argparse.Namespace) -> None: # Usage Examples ASCIIColors.magenta("\nšŸ“š Quick Start Guide:") - ASCIIColors.cyan(""" + ASCIIColors.cyan(""" 1. Access the Swagger UI: Open your browser and navigate to the API documentation URL above - + 2. API Authentication:""") if args.key: ASCIIColors.cyan(""" Add the following header to your requests: @@ -185,12 +187,12 @@ def display_splash_screen(args: argparse.Namespace) -> None: """) else: ASCIIColors.cyan(" No authentication required\n") - + ASCIIColors.cyan(""" 3. Basic Operations: - POST /upload_document: Upload new documents to RAG - POST /query: Query your document collection - GET /collections: List available collections - + 4. Monitor the server: - Check server logs for detailed operation information - Use healthcheck endpoint: GET /health @@ -202,21 +204,20 @@ def display_splash_screen(args: argparse.Namespace) -> None: ASCIIColors.white(""" API Key authentication is enabled. Make sure to include the X-API-Key header in all your requests. """) - - ASCIIColors.green("Server is ready to accept connections! šŸš€\n") + ASCIIColors.green("Server is ready to accept connections! šŸš€\n") def parse_args() -> argparse.Namespace: """ Parse command line arguments with environment variable fallback - + Returns: argparse.Namespace: Parsed arguments """ # Load environment variables from .env file load_dotenv() - + parser = argparse.ArgumentParser( description="LightRAG FastAPI Server with separate working and input directories" ) @@ -240,13 +241,13 @@ def parse_args() -> argparse.Namespace: parser.add_argument( "--host", default=get_env_value("HOST", "0.0.0.0"), - help="Server host (default: from env or 0.0.0.0)" + help="Server host (default: from env or 0.0.0.0)", ) parser.add_argument( "--port", type=int, default=get_env_value("PORT", 9621, int), - help="Server port (default: from env or 9621)" + help="Server port (default: from env or 9621)", ) # Directory configuration @@ -262,7 +263,9 @@ def parse_args() -> argparse.Namespace: ) # LLM Model configuration - default_llm_host = get_env_value("LLM_BINDING_HOST", get_default_host(temp_args.llm_binding)) + default_llm_host = get_env_value( + "LLM_BINDING_HOST", get_default_host(temp_args.llm_binding) + ) parser.add_argument( "--llm-binding-host", default=default_llm_host, @@ -276,7 +279,9 @@ def parse_args() -> argparse.Namespace: ) # Embedding model configuration - default_embedding_host = get_env_value("EMBEDDING_BINDING_HOST", get_default_host(temp_args.embedding_binding)) + default_embedding_host = get_env_value( + "EMBEDDING_BINDING_HOST", get_default_host(temp_args.embedding_binding) + ) parser.add_argument( "--embedding-binding-host", default=default_embedding_host, @@ -306,7 +311,7 @@ def parse_args() -> argparse.Namespace: "--max-async", type=int, default=get_env_value("MAX_ASYNC", 4, int), - help="Maximum async operations (default: from env or 4)" + help="Maximum async operations (default: from env or 4)", ) parser.add_argument( "--max-tokens", @@ -347,7 +352,7 @@ def parse_args() -> argparse.Namespace: "--ssl", action="store_true", default=get_env_value("SSL", False, bool), - help="Enable HTTPS (default: from env or False)" + help="Enable HTTPS (default: from env or False)", ) parser.add_argument( "--ssl-certfile", @@ -628,8 +633,7 @@ def create_app(args): logging.info(f"Successfully indexed file: {file_path}") else: logging.warning(f"No content extracted from file: {file_path}") - - + @asynccontextmanager async def lifespan(app: FastAPI): """Lifespan context manager for startup and shutdown events""" diff --git a/lightrag/api/requirements.txt b/lightrag/api/requirements.txt index 0d5b82f6..f68b0e19 100644 --- a/lightrag/api/requirements.txt +++ b/lightrag/api/requirements.txt @@ -9,6 +9,7 @@ ollama openai pipmaster python-dotenv +python-dotenv python-multipart tenacity tiktoken @@ -16,4 +17,3 @@ torch tqdm transformers uvicorn -python-dotenv \ No newline at end of file