Merge branch 'azure_openai' of https://github.com/Eloquent-Algorithmics/Automotive-AI into azure_openai

Author: Explorergt92

.env.template

@@ -1,3 +1,17 @@
+################################################################################
+### User E-mail for Authentication
+################################################################################
+
+EMAIL_ADDRESS=
+
+################################################################################
+### ELM327 OBD2 Connection
+################################################################################
+
+SERIAL_PORT=COM7
+BAUD_RATE=500000
+TIMEOUT=1
+
 ################################################################################
 ### platform.openai.com
 ################################################################################
@@ -8,38 +22,38 @@ OPENAI_PROJECT_ID=
 OPENAI_MODEL=gpt-4o-mini
 
 ################################################################################
-### Azure OpenAI
+### Azure Auth and OpenAI
 ################################################################################
 
+AUTH_TENANT_ID=
+AUTH_CLIENT_ID=
+AUTH_CLIENT_SECRET=
+
 AZURE_OPENAI_API_KEY=
 AZURE_OPENAI_ENDPOINT=
 AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME=gpt-4o-mini
-AZURE_OPENAI_API_VERSION=2024-10-21
+OPENAI_API_VERSION=2025-03-01-preview
 
 ################################################################################
-### ELM327 OBD2 Connection
+### Azure Speech
 ################################################################################
 
-SERIAL_PORT=COM7
-BAUD_RATE=500000
-TIMEOUT=1
+AZURE_SPEECH_KEY=
+AZURE_SPEECH_REGION=eastus2
+AZURE_SPEECH_VOICE=en-GB-OllieMultilingualNeural
 
 ################################################################################
-### Azure Speech
+### Bing Search
 ################################################################################
 
-AZURE_SPEECH_KEY=
-AZURE_SPEECH_REGION=
-AZURE_SPEECH_VOICE=en-US-AriaNeural
+BING_API_KEY=
 
 ################################################################################
-### Microsoft Entra ID
+### Google Custom Search
 ################################################################################
 
-EMAIL_ADDRESS=
-AUTH_CLIENT_ID=
-AUTH_CLIENT_SECRET=
-AUTH_TENANT_ID=
+GOOGLE_API_KEY=
+GOOGLE_CSE_ID=
 
 ################################################################################
 ### Twilio

markdownlint-config.json …ithub/workflows/markdownlint-config.jsonmarkdownlint-config.json renamed to .github/workflows/markdownlint-config.json markdownlint-config.json renamed to .github/workflows/markdownlint-config.json

@@ -163,4 +163,5 @@ elm.log
 .vscode
 .idea/
 *.code-workspace
-.vs/
+.vs
+*.env

.gitignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 John
+Copyright (c) 2025
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -0,0 +1,72 @@
+import os
+from azure.identity import DefaultAzureCredential, get_bearer_token_provider
+from openai import AzureOpenAI, OpenAI
+
+azure_credential = None
+openai_client = None
+openai_model_arg = None
+
+
+def get_azure_credential():
+    """
+    Get the Azure credential for authentication.
+    This function uses the DefaultAzureCredential from the azure.identity package.
+    It will first check if the credential is already set. If not, creates a new one.
+    """
+    global azure_credential
+
+    if azure_credential is None:
+        azure_credential = DefaultAzureCredential(
+            exclude_shared_token_cache_credential=True
+        )
+        return azure_credential
+
+
+def configure_openai_client():
+    """
+    Configure the OpenAI client based on environment variables set for Azure or OpenAI.
+
+    This function checks for the presence of the AZURE_OPENAI_ENDPOINT and
+    OPENAI_API_KEY environment variables.
+
+    If AZURE_OPENAI_ENDPOINT is set, it configures the client for Azure OpenAI.
+    Otherwise, it configures for standard OpenAI.
+
+    It also sets the API version and deployment name for Azure OpenAI if applicable.
+    If neither environment variable is set, it raises a ValueError.
+    """
+    global openai_client, openai_model_arg
+
+    if openai_client:
+        return openai_client, openai_model_arg
+
+    if os.getenv("AZURE_OPENAI_ENDPOINT"):
+        # Configure for Azure OpenAI
+        api_key = os.getenv("AZURE_OPENAI_API_KEY")
+        client_args = {}
+        if api_key:
+            client_args["api_key"] = api_key
+        else:
+            client_args["azure_ad_token_provider"] = get_bearer_token_provider(
+                get_azure_credential(), "https://cognitiveservices.azure.com/.default"
+            )
+
+        openai_client = AzureOpenAI(
+            api_version=os.getenv("AZURE_OPENAI_API_VERSION", "2025-03-01-preview"),
+            azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
+            **client_args
+        )
+
+        openai_model_arg = os.getenv("AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME")
+
+    elif os.getenv("OPENAI_API_KEY"):
+        # Configure for standard OpenAI
+        openai_client = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
+        openai_model_arg = os.getenv("OPENAI_MODEL") or "gpt-4o-mini"
+
+    else:
+        raise ValueError(
+            "No OpenAI configuration provided. Check your environment variables."
+        )
+
+    return openai_client, openai_model_arg

automotive_ai/_api/_openai/_openai_config.py

@@ -3,11 +3,11 @@
 sending commands to a serial device, and running diagnostic reports.
 """
 import requests
-from automotive_ai._api._nhtsa._vin_decoder import (
+from _api._nhtsa._vin_decoder import (
     parse_vin_response,
     get_vehicle_data_from_nhtsa,
 )
-from automotive_ai._api._msal._graph_api import send_email_with_attachments
+from _api._msal._graph_api import send_email_with_attachments
 from . import EMAIL_ADDRESS
 
 

automotive_ai/_utils/_serial_commands.py

@@ -2,96 +2,21 @@
 This is the main script of the application.
 """
 
-import os
 import argparse
 import sys
-from openai import OpenAI, AzureOpenAI
-from azure.identity import DefaultAzureCredential, get_bearer_token_provider
 
-from automotive_ai._api._msal import _ms_authserver
-from automotive_ai._api._msal import _graph_api
-from _audio._audio_output import tts_output, ssml_output
+from _api._msal import _graph_api, _ms_authserver
+from _audio._audio_output import ssml_output, tts_output
 from dotenv import load_dotenv
+from main import main_conversation
 from rich.console import Console
 
 console = Console()
 
 load_dotenv()
 
-openai_client = None
-openai_model_arg = None
 
-azure_credential = None
-
-
-def get_azure_credential():
-    """
-    Retrieves the Azure credential for authentication.
-    """
-    global azure_credential
-    if azure_credential is None:
-        azure_credential = DefaultAzureCredential(
-            exclude_shared_token_cache_credential=True
-        )
-    return azure_credential
-
-
-def configure_openai():
-    """
-    Configures the OpenAI client based on environment variables.
-
-    This function sets up the OpenAI client using different configurations depending on
-    the environment variables provided. It supports Azure OpenAI endpoints, and OpenAI API keys.
-
-    Raises:
-        ValueError: If required environment variables for Azure OpenAI are missing or
-        if no OpenAI configuration is provided.
-
-    Environment Variables:
-        AZURE_OPENAI_ENDPOINT: The Azure endpoint for OpenAI.
-        AZURE_OPENAI_API_KEY: The API key for Azure OpenAI.
-        AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME: The deployment name for Azure OpenAI ChatGPT.
-        AZURE_OPENAI_API_VERSION: The API version for Azure OpenAI.
-        OPENAICOM_API_KEY: The API key for OpenAI.
-        OPENAICOM_MODEL: The model name for OpenAI (default is "gpt-4o-mini").
-
-    """
-    global openai_client, openai_model_arg
-
-    client_args = {}
-    if os.getenv("AZURE_OPENAI_ENDPOINT"):
-        if os.getenv("AZURE_OPENAI_API_KEY"):
-            client_args["api_key"] = os.getenv("AZURE_OPENAI_API_KEY")
-        else:
-            client_args["azure_ad_token_provider"] = get_bearer_token_provider(
-                get_azure_credential(), "https://cognitiveservices.azure.com/.default"
-            )
-        if not os.getenv("AZURE_OPENAI_ENDPOINT"):
-            raise ValueError("AZURE_OPENAI_ENDPOINT is required for Azure OpenAI")
-        if not os.getenv("AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME"):
-            raise ValueError(
-                "AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME is required for Azure OpenAI"
-            )
-        openai_client = AzureOpenAI(
-            api_version=os.getenv("AZURE_OPENAI_API_VERSION") or "2024-10-21",
-            azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
-            **client_args,
-        )
-        openai_model_arg = os.getenv("AZURE_OPENAI_CHATGPT_DEPLOYMENT_NAME")
-
-    elif os.getenv("OPENAI_API_KEY"):
-        client_args["api_key"] = os.getenv("OPENAI_API_KEY")
-        openai_client = OpenAI(
-            **client_args,
-        )
-        openai_model_arg = os.getenv("OPENAI_MODEL") or "gpt-4o-mini"
-    else:
-        raise ValueError(
-            "No OpenAI configuration provided. Check your environment variables."
-        )
-
-
-def main():
+def main_intro():
     """
     Main function to encapsulate the script logic.
     """
@@ -112,8 +37,6 @@ def main():
 
     ssml_output(ssml_text)
 
-    configure_openai()
-
     console.print(
         "Allow me to introduce myself... I am Winston, your in car Virtual Assistant... Importing all preferences and settings.",
         style="bold green",
@@ -142,18 +65,12 @@ def main():
         "Systems now fully operational. How may I assist you today?", style="bold green"
     )
 
-    from main import main_conversation
-
     main_conversation(args, email_module.user_object_id, use_elm327)
 
-    if openai_client is None:
-        console.log("OpenAI client is not configured in app.py")
-        return
-
 
 if __name__ == "__main__":
     try:
-        main()
+        main_intro()
     except KeyboardInterrupt:
         print("\nGoodbye for now ...\n")
         sys.exit(0)