Merge pull request #138 from AET-DevOps25/feature/adjust-genai-env

Adjust env file path for genai

Author: edkaya

.env.template

@@ -1,6 +1,13 @@
-# To run this project with docker compose, you need a `.env` file with the following variables set.
+# To run this project with docker compose, you need a `.env` file with the following 4 variables set.
 
 BASE_URL="https://gpu.aet.cit.tum.de"
 GITLAB_CLIENT_SECRET="" # see https://rancher.ase.cit.tum.de/dashboard/c/c-m-nhcfjg9h/explorer/secret/team-continuous-disappointment/server-secret#data gitlab-client-secret-dev
 API_OPENAI="" # see https://rancher.ase.cit.tum.de/dashboard/c/c-m-nhcfjg9h/explorer/secret/team-continuous-disappointment/genai-secret#data
-API_OPENWEBUI="" # see https://rancher.ase.cit.tum.de/dashboard/c/c-m-nhcfjg9h/explorer/secret/team-continuous-disappointment/genai-secret#data
+API_OPENWEBUI="" # see https://rancher.ase.cit.tum.de/dashboard/c/c-m-nhcfjg9h/explorer/secret/team-continuous-disappointment/genai-secret#data
+
+# If you want to use cloud LLM models, you need to include your respective api keys (our openai key is already in rancher)
+
+API_OPENAI="" # see https://rancher.ase.cit.tum.de/dashboard/c/c-m-nhcfjg9h/explorer/secret/team-continuous-disappointment/genai-secret#data
+API_ANTHROPIC="" # your anthropic key
+API_MISTRAL="" # your mistral key
+API_HUGGINGFACEHUB="" # your huggingface api token

README.md

@@ -307,7 +307,7 @@ embeddings = OpenAIEmbeddings(
 )
 ```
 
-##### Environment Variables
+##### Environment Variables for GenAI
 
 - If you want to use cloud and local based LLM models, you need to set the respective api key in your `.env` file. Required `.env` variables:
 
@@ -322,6 +322,7 @@ API_OPENWEBUI="your openwebui key"
 # Base URL for calling local models
 BASE_URL="base url where openwebui is hosted"
 ```
+- However, you do not need to set all of these fields in your `.env` file. To run the GenAI module, you need at least the API_OPENAI, API_OPENWEBUI, and BASE_URL variables. You can find more information in the [.env.template](.env.template) file.
 
 - Example for Cloud LLM Models (defined in `genai/routes/routes.py`):
 

genai/.env.template

@@ -1,9 +1,10 @@
-from collections import namedtuple
 from os import environ, path
+from collections import namedtuple
 from dotenv import load_dotenv
 
 basedir = path.abspath(path.dirname(__file__))
-load_dotenv(path.join(basedir, ".env"))
+parent_dir = path.dirname(basedir)
+load_dotenv(path.join(parent_dir, ".env"))
 
 ConfigT = namedtuple(
     "Config",
@@ -18,10 +19,10 @@
 )
 
 Config = ConfigT(
-    api_key_openai=environ.get("API_OPENAI"),
+    api_key_openai=environ.get("API_OPENAI", ""),
     api_key_anthropic=environ.get("API_ANTHROPIC", ""),
     api_key_mistral=environ.get("API_MISTRAL", ""),
     api_key_huggingface=environ.get("API_HUGGINGFACE", ""),
-    api_key_openwebui=environ.get("API_OPENWEBUI"),
-    base_url=environ.get("BASE_URL")
+    api_key_openwebui=environ.get("API_OPENWEBUI", ""),
+    base_url=environ.get("BASE_URL", "")
 )