Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🧑‍💻 refactor: Enhance Error Handling and Introduce Alternate Variables for Configuration #19

Merged
merged 4 commits into from
Apr 3, 2024
Merged

🧑‍💻 refactor: Enhance Error Handling and Introduce Alternate Variables for Configuration #19

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a8f653
fix: correctly handle embedding errors
danny-avila Apr 3, 2024
60a588c
chore: log query error
danny-avila Apr 3, 2024
1fc7f75
refactor: add override environment variables to be used as default
danny-avila Apr 3, 2024
866c65b
chore: rename OPENAI_BASEURL to RAG_OPENAI_BASEURL as standard
danny-avila Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: add override environment variables to be used as default
  • Loading branch information
@danny-avila
danny-avila committed Apr 3, 2024
commit 1fc7f75a9e082484a520cb75ff2d4b9fd75bb294
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@ uvicorn main:app

The following environment variables are required to run the application:

- `OPENAI_API_KEY`: The API key for OpenAI API Embeddings (if using default settings).
- `RAG_OPENAI_API_KEY`: The API key for OpenAI API Embeddings (if using default settings).
- Note: `OPENAI_API_KEY` will work but `RAG_OPENAI_API_KEY` will override it in order to not conflict with LibreChat setting.
- `OPENAI_BASEURL`: (Optional) The base URL for your OpenAI API Embeddings
- `RAG_OPENAI_PROXY`: (Optional) Proxy for OpenAI API Embeddings
- `POSTGRES_DB`: (Optional) The name of the PostgreSQL database.
- `POSTGRES_USER`: (Optional) The username for connecting to the PostgreSQL database.
- `POSTGRES_PASSWORD`: (Optional) The password for connecting to the PostgreSQL database.
Expand All @@ -65,8 +68,11 @@ The following environment variables are required to run the application:
- huggingface: "sentence-transformers/all-MiniLM-L6-v2"
- huggingfacetei: "http://huggingfacetei:3000". Hugging Face TEI uses model defined on TEI service launch.
- ollama: "nomic-embed-text"
- `AZURE_OPENAI_API_KEY`: (Optional) The API key for Azure OpenAI service.
- `AZURE_OPENAI_ENDPOINT`: (Optional) The endpoint URL for Azure OpenAI service, including the resource. Example: `https://example-resource.azure.openai.com/`.
- `RAG_AZURE_OPENAI_API_KEY`: (Optional) The API key for Azure OpenAI service.
- Note: `AZURE_OPENAI_API_KEY` will work but `RAG_AZURE_OPENAI_API_KEY` will override it in order to not conflict with LibreChat setting.
- `RAG_AZURE_OPENAI_ENDPOINT`: (Optional) The endpoint URL for Azure OpenAI service, including the resource.
- Example: `https://example-resource.azure.openai.com`.
- Note: `AZURE_OPENAI_ENDPOINT` will work but `RAG_AZURE_OPENAI_ENDPOINT` will override it in order to not conflict with LibreChat setting.
- `HF_TOKEN`: (Optional) if needed for `huggingface` option.
- `OLLAMA_BASE_URL`: (Optional) defaults to `http://ollama:11434`.

Expand Down
23 changes: 18 additions & 5 deletions config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
load_dotenv(find_dotenv())


def get_env_variable(var_name: str, default_value: str = None) -> str:
def get_env_variable(var_name: str, default_value: str = None, required: bool = False) -> str:
value = os.getenv(var_name)
if value is None:
if default_value is None:
if default_value is None and required:
raise ValueError(f"Environment variable '{var_name}' not found.")
return default_value
return value
Expand Down Expand Up @@ -130,8 +130,13 @@ async def dispatch(self, request, call_next):
## Credentials

OPENAI_API_KEY = get_env_variable("OPENAI_API_KEY", "")
RAG_OPENAI_API_KEY = get_env_variable("RAG_OPENAI_API_KEY", OPENAI_API_KEY)
OPENAI_BASEURL = get_env_variable("OPENAI_BASEURL", None)
RAG_OPENAI_PROXY = get_env_variable("RAG_OPENAI_PROXY", None)
AZURE_OPENAI_API_KEY = get_env_variable("AZURE_OPENAI_API_KEY", "")
RAG_AZURE_OPENAI_API_KEY = get_env_variable("RAG_AZURE_OPENAI_API_KEY", AZURE_OPENAI_API_KEY)
AZURE_OPENAI_ENDPOINT = get_env_variable("AZURE_OPENAI_ENDPOINT", "")
RAG_AZURE_OPENAI_ENDPOINT = get_env_variable("RAG_AZURE_OPENAI_ENDPOINT", AZURE_OPENAI_ENDPOINT).rstrip("/")
HF_TOKEN = get_env_variable("HF_TOKEN", "")
OLLAMA_BASE_URL = get_env_variable("OLLAMA_BASE_URL", "http://ollama:11434")

Expand All @@ -140,10 +145,18 @@ async def dispatch(self, request, call_next):

def init_embeddings(provider, model):
if provider == "openai":
return OpenAIEmbeddings(model=model, api_key=OPENAI_API_KEY)
return OpenAIEmbeddings(
model=model,
api_key=RAG_OPENAI_API_KEY,
openai_api_base=OPENAI_BASEURL,
openai_proxy=RAG_OPENAI_PROXY
)
elif provider == "azure":
return AzureOpenAIEmbeddings(model=model,
api_key=AZURE_OPENAI_API_KEY) # AZURE_OPENAI_ENDPOINT is being grabbed from the environment
return AzureOpenAIEmbeddings(
model=model,
api_key=RAG_AZURE_OPENAI_API_KEY,
azure_endpoint=RAG_AZURE_OPENAI_ENDPOINT
)
elif provider == "huggingface":
return HuggingFaceEmbeddings(model_name=model, encode_kwargs={
'normalize_embeddings': True})
Expand Down