remove unused AZURE_OPENAI_API_KEY

Author: Pavan-Microsoft

docs/workshop/docs/workshop/.env.sample

@@ -1,3 +1,2 @@
 AZURE_AI_SEARCH_API_KEY=""
-AZURE_OPENAI_API_KEY=""
 

docs/workshop/docs/workshop/Challenge-3-and-4/Challenge-3.md

@@ -57,10 +57,8 @@ One of the easiest and most fun changes you can make to the app is updating the
    ![Azure Portal Settings > Configuration](../img/portal-app-api-env.png)
 5. Locate the following environment variables:
    - `AZURE_AI_SEARCH_API_KEY`
-   - `AZURE_OPENAI_API_KEY`
 6. Copy their values and paste them into your local `\workshop\docs\workshop\.env.sample` file:
    `AZURE_AI_SEARCH_API_KEY=your-key-from-portal`
-   `AZURE_OPENAI_API_KEY=your-other-key-from-portal`
 7. Rename the .env.sample file to .env
 8. Open a terminal or command prompt.
 9. Navigate to the project directory where `start.cmd` is located:

docs/workshop/docs/workshop/Challenge-3-and-4/knowledge_mining_api.ipynb

@@ -115,7 +115,6 @@
     "    def __init__(self):\n",
     "        self.azure_openai_deployment_model = os.getenv(\"AZURE_OPENAI_DEPLOYMENT_MODEL\")\n",
     "        self.azure_openai_endpoint = os.getenv(\"AZURE_OPENAI_ENDPOINT\")\n",
-    "        self.azure_openai_api_key = os.getenv(\"AZURE_OPENAI_API_KEY\")\n",
     "        self.azure_openai_api_version = os.getenv(\"AZURE_OPENAI_API_VERSION\")\n",
     "        self.azure_ai_search_endpoint = os.getenv(\"AZURE_AI_SEARCH_ENDPOINT\")\n",
     "        self.azure_ai_search_api_key = os.getenv(\"AZURE_AI_SEARCH_API_KEY\")\n",

docs/workshop/docs/workshop/Challenge-6/Content_safety_evaluation.ipynb

@@ -210,7 +210,6 @@
    "source": [
     "model_config = {\n",
     "    \"azure_endpoint\": os.environ.get(\"AZURE_OPENAI_ENDPOINT\"),\n",
-    "    \"api_key\": os.environ.get(\"AZURE_OPENAI_API_KEY\"),\n",
     "    \"azure_deployment\": os.environ.get(\"AZURE_OPENAI_DEPLOYMENT_MODEL\"),\n",
     "    \"api_version\": os.environ.get(\"AZURE_OPENAI_API_VERSION\"),\n",
     "}"

src/api/services/history_service.py

@@ -62,20 +62,17 @@ def init_openai_client(self):
                     "AZURE_OPENAI_ENDPOINT or AZURE_OPENAI_RESOURCE is required")
 
             endpoint = self.azure_openai_endpoint or f"https://{self.azure_openai_resource}.openai.azure.com/"
-            api_key = self.azure_openai_api_key
             ad_token_provider = None
 
-            if not api_key:
-                logger.debug("Using Azure AD authentication for OpenAI")
-                ad_token_provider = get_bearer_token_provider(
-                    DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")
+            logger.debug("Using Azure AD authentication for OpenAI")
+            ad_token_provider = get_bearer_token_provider(
+                DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")
 
             if not self.azure_openai_deployment_name:
                 raise ValueError("AZURE_OPENAI_MODEL is required")
 
             return AsyncAzureOpenAI(
                 api_version=self.azure_openai_api_version,
-                api_key=api_key,
                 azure_ad_token_provider=ad_token_provider,
                 default_headers={"x-ms-useragent": user_agent},
                 azure_endpoint=endpoint,

src/tests/api/common/config/test_config.py

@@ -13,7 +13,6 @@ def mock_env_vars():
         "SQLDB_USER_MID": "test_mid",
         "AZURE_OPENAI_ENDPOINT": "https://openai.test",
         "AZURE_OPENAI_DEPLOYMENT_MODEL": "gpt-4",
-        "AZURE_OPENAI_API_KEY": "test_key",
         "AZURE_OPENAI_API_VERSION": "2023-03-15-preview",
         "AZURE_OPENAI_RESOURCE": "test_resource",
         "AZURE_AI_SEARCH_ENDPOINT": "https://search.test",

src/tests/api/helpers/test_chat_helper.py

@@ -27,7 +27,6 @@ def test_process_rag_response_success(self, mock_azure_openai, mock_config):
 
         # Mock the config
         mock_config.return_value.azure_openai_endpoint = "https://test-endpoint"
-        mock_config.return_value.azure_openai_api_key = "test-key"
         mock_config.return_value.azure_openai_api_version = "2023-05-15"
         mock_config.return_value.azure_openai_deployment_model = "gpt-4"
 
@@ -62,7 +61,6 @@ def test_process_rag_response_with_code_blocks(self, mock_azure_openai, mock_con
 
         # Mock the config
         mock_config.return_value.azure_openai_endpoint = "https://test-endpoint"
-        mock_config.return_value.azure_openai_api_key = "test-key"
         mock_config.return_value.azure_openai_api_version = "2023-05-15"
         mock_config.return_value.azure_openai_deployment_model = "gpt-4"
 
@@ -85,7 +83,6 @@ def test_process_rag_response_error(self, mock_azure_openai, mock_config):
 
         # Mock the config
         mock_config.return_value.azure_openai_endpoint = "https://test-endpoint"
-        mock_config.return_value.azure_openai_api_key = "test-key"
         mock_config.return_value.azure_openai_api_version = "2023-05-15"
 
         # Test the function
@@ -110,7 +107,6 @@ def test_process_rag_response_invalid_json(self, mock_azure_openai, mock_config)
 
         # Mock the config
         mock_config.return_value.azure_openai_endpoint = "https://test-endpoint"
-        mock_config.return_value.azure_openai_api_key = "test-key"
         mock_config.return_value.azure_openai_api_version = "2023-05-15"
 
         # Test the function

src/tests/api/services/test_history_service.py

@@ -57,7 +57,6 @@ def test_init(self, history_service, mock_config_instance):
         assert history_service.azure_cosmosdb_database == mock_config_instance.azure_cosmosdb_database
         assert history_service.azure_cosmosdb_account == mock_config_instance.azure_cosmosdb_account
         assert history_service.azure_openai_endpoint == mock_config_instance.azure_openai_endpoint
-        assert history_service.azure_openai_api_key == mock_config_instance.azure_openai_api_key
         assert history_service.chat_history_enabled
 
     def test_init_cosmosdb_client_enabled(self, history_service):
@@ -106,7 +105,6 @@ def test_init_openai_client_no_deployment_name(self, history_service):
 
     def test_init_openai_client_no_api_key(self, history_service):
         """Test OpenAI client initialization with no API key"""
-        history_service.azure_openai_api_key = None
         with patch("services.history_service.get_bearer_token_provider", return_value="token_provider"):
             with patch("services.history_service.AsyncAzureOpenAI", return_value="openai_client"):
                 client = history_service.init_openai_client()