LightRAG/lightrag/constants.py

"""
Centralized configuration constants for LightRAG.

This module defines default values for configuration constants used across
different parts of the LightRAG system. Centralizing these values ensures
consistency and makes maintenance easier.
"""

# Default values for environment variables
DEFAULT_MAX_GLEANING = 1
DEFAULT_FORCE_LLM_SUMMARY_ON_MERGE = 4
DEFAULT_WOKERS = 2
DEFAULT_TIMEOUT = 150

# Query and retrieval configuration defaults
DEFAULT_TOP_K = 40
DEFAULT_CHUNK_TOP_K = 10
DEFAULT_MAX_ENTITY_TOKENS = 10000
DEFAULT_MAX_RELATION_TOKENS = 10000
DEFAULT_MAX_TOTAL_TOKENS = 32000
DEFAULT_HISTORY_TURNS = 0
DEFAULT_ENABLE_RERANK = True
DEFAULT_COSINE_THRESHOLD = 0.2
DEFAULT_RELATED_CHUNK_NUMBER = 10

# Separator for graph fields
GRAPH_FIELD_SEP = "<SEP>"

# Logging configuration defaults
DEFAULT_LOG_MAX_BYTES = 10485760  # Default 10MB
DEFAULT_LOG_BACKUP_COUNT = 5  # Default 5 backups
DEFAULT_LOG_FILENAME = "lightrag.log"  # Default log filename
feat: Centralize configuration and update defaults This commit introduces `lightrag/constants.py` to centralize default values for various configurations across the API and core components. Key changes: - Added `constants.py` to centralize default values - Improved the `get_env_value` function in `api/config.py` to correctly handle string "None" as a None value and to catch `TypeError` during value conversion. - Updated the default `SUMMARY_LANGUAGE` to "English" - Set default `WORKERS` to 2 2025-05-06 22:00:43 +08:00			`"""`
			`Centralized configuration constants for LightRAG.`

			`This module defines default values for configuration constants used across`
			`different parts of the LightRAG system. Centralizing these values ensures`
			`consistency and makes maintenance easier.`
			`"""`

			`# Default values for environment variables`
Add max_gleaning to env 2025-07-01 17:13:33 +08:00			`DEFAULT_MAX_GLEANING = 1`
feat: remove deprecated MAX_TOKEN_SUMMARY parameter to prevent LLM output truncation - Remove MAX_TOKEN_SUMMARY parameter and related configurations - Eliminate forced token-based truncation in entity/relationship descriptions - Switch to fragment-count based summarization logic using FORCE_LLM_SUMMARY_ON_MERGE - Update FORCE_LLM_SUMMARY_ON_MERGE default from 6 to 4 for better summarization - Clean up documentation, environment examples, and API display code - Preserve backward compatibility by graceful parameter removal This change resolves issues where LLMs were forcibly truncating entity relationship descriptions mid-sentence, leading to incomplete and potentially inaccurate knowledge graph content. The new approach allows LLMs to generate complete descriptions while still providing summarization when multiple fragments need to be merged. Breaking Change: None - parameter removal is backward compatible Fixes: Entity relationship description truncation issues 2025-07-15 12:26:33 +08:00			`DEFAULT_FORCE_LLM_SUMMARY_ON_MERGE = 4`
feat: Centralize configuration and update defaults This commit introduces `lightrag/constants.py` to centralize default values for various configurations across the API and core components. Key changes: - Added `constants.py` to centralize default values - Improved the `get_env_value` function in `api/config.py` to correctly handle string "None" as a None value and to catch `TypeError` during value conversion. - Updated the default `SUMMARY_LANGUAGE` to "English" - Set default `WORKERS` to 2 2025-05-06 22:00:43 +08:00			`DEFAULT_WOKERS = 2`
			`DEFAULT_TIMEOUT = 150`

feat: centralize environment variable defaults in constants.py 2025-07-15 16:11:50 +08:00			`# Query and retrieval configuration defaults`
			`DEFAULT_TOP_K = 40`
			`DEFAULT_CHUNK_TOP_K = 10`
			`DEFAULT_MAX_ENTITY_TOKENS = 10000`
			`DEFAULT_MAX_RELATION_TOKENS = 10000`
			`DEFAULT_MAX_TOTAL_TOKENS = 32000`
Set DEFAULT_HISTORY_TURNS to 0 2025-07-16 02:20:27 +08:00			`DEFAULT_HISTORY_TURNS = 0`
feat: centralize environment variable defaults in constants.py 2025-07-15 16:11:50 +08:00			`DEFAULT_ENABLE_RERANK = True`
Centralize query parameters into LightRAG class This commit refactors query parameter management by consolidating settings like `top_k`, token limits, and thresholds into the `LightRAG` class, and consistently sourcing parameters from a single location. 2025-07-15 23:56:49 +08:00			`DEFAULT_COSINE_THRESHOLD = 0.2`
Increase default related chunk number from 5 to 10 2025-07-16 00:22:34 +08:00			`DEFAULT_RELATED_CHUNK_NUMBER = 10`
feat: centralize environment variable defaults in constants.py 2025-07-15 16:11:50 +08:00
feat: Optimize document deletion performance - To enhance performance during document deletion, new batch-get methods, `get_nodes_by_chunk_ids` and `get_edges_by_chunk_ids`, have been added to the graph storage layer (`BaseGraphStorage` and its implementations). The [`adelete_by_doc_id`](lightrag/lightrag.py:1681) function now leverages these methods to avoid unnecessary iteration over the entire knowledge graph, significantly improving efficiency. - Graph storage updated: Networkx, Neo4j, Postgres AGE 2025-06-25 12:37:57 +08:00			`# Separator for graph fields`
			`GRAPH_FIELD_SEP = "<SEP>"`

feat: Centralize configuration and update defaults This commit introduces `lightrag/constants.py` to centralize default values for various configurations across the API and core components. Key changes: - Added `constants.py` to centralize default values - Improved the `get_env_value` function in `api/config.py` to correctly handle string "None" as a None value and to catch `TypeError` during value conversion. - Updated the default `SUMMARY_LANGUAGE` to "English" - Set default `WORKERS` to 2 2025-05-06 22:00:43 +08:00			`# Logging configuration defaults`
			`DEFAULT_LOG_MAX_BYTES = 10485760 # Default 10MB`
			`DEFAULT_LOG_BACKUP_COUNT = 5 # Default 5 backups`
			`DEFAULT_LOG_FILENAME = "lightrag.log" # Default log filename`