Merge pull request #628 from danielaskdd/Fix-parms-missing-for-openai

Fix parms missing for openai
HKUDS · Jan 23, 2025 · 63bd066 · 63bd066
2 parents e485d7f + 0920942
commit 63bd066
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 365 deletions.
diff --git a/.env.example b/.env.example
@@ -14,10 +14,13 @@ LLM_MODEL=mistral-nemo:latest
 
 # OpenAI alike example
 # LLM_BINDING=openai
-# LLM_BINDING_HOST=https://localhost:11434/api
 # LLM_MODEL=deepseek-chat
+# LLM_BINDING_HOST=https://api.deepseek.com
 # LLM_BINDING_API_KEY=your_api_key
 
+# for OpenAI LLM (LLM_BINDING_API_KEY take priority)
+# OPENAI_API_KEY=your_api_key
+
 # Lollms example
 # LLM_BINDING=lollms
 # LLM_BINDING_HOST=http://host.docker.internal:9600
@@ -55,8 +58,7 @@ LOG_LEVEL=INFO
 # Optional Timeout
 #TIMEOUT=30
 
-
-# Optional for Azure
+# Optional for Azure (LLM_BINDING_HOST, LLM_BINDING_API_KEY take priority)
 # AZURE_OPENAI_API_VERSION=2024-08-01-preview
 # AZURE_OPENAI_DEPLOYMENT=gpt-4o
 # AZURE_OPENAI_API_KEY=myapikey

diff --git a/README.md b/README.md
@@ -925,7 +925,7 @@ def extract_queries(file_path):
 ## API
 LightRag can be installed with API support to serve a Fast api interface to perform data upload and indexing/Rag operations/Rescan of the input folder etc..
 
-The documentation can be found [here](docs/LightRagAPI.md)
+The documentation can be found [here](lightrag/api/README.md)
 
 ## Star History
 

diff --git a/docs/LightRagAPI.md b/docs/LightRagAPI.md