diff --git a/README-zh.md b/README-zh.md index 2ed0b276..931ec16a 100644 --- a/README-zh.md +++ b/README-zh.md @@ -352,7 +352,8 @@ class QueryParam: user_prompt: str | None = None """User-provided prompt for the query. - If proivded, this will be use instead of the default vaulue from prompt template. + Addition instructions for LLM. If provided, this will be inject into the prompt template. + It's purpose is the let user customize the way LLM generate the response. """ enable_rerank: bool = True diff --git a/README.md b/README.md index 720637de..9bf8f04b 100644 --- a/README.md +++ b/README.md @@ -353,7 +353,8 @@ class QueryParam: user_prompt: str | None = None """User-provided prompt for the query. - If proivded, this will be use instead of the default vaulue from prompt template. + Addition instructions for LLM. If provided, this will be inject into the prompt template. + It's purpose is the let user customize the way LLM generate the response. """ enable_rerank: bool = True diff --git a/lightrag/base.py b/lightrag/base.py index a6420069..b9ebeca8 100644 --- a/lightrag/base.py +++ b/lightrag/base.py @@ -154,7 +154,8 @@ class QueryParam: user_prompt: str | None = None """User-provided prompt for the query. - If proivded, this will be use instead of the default vaulue from prompt template. + Addition instructions for LLM. If provided, this will be inject into the prompt template. + It's purpose is the let user customize the way LLM generate the response. """ enable_rerank: bool = os.getenv("RERANK_BY_DEFAULT", "true").lower() == "true"