feat: adding support for Azure OpenAI in Semantic Kernel

samples/python/agents/semantickernel/.envexample

@@ -0,0 +1,9 @@
+# For OpenAI (standard)
+OPENAI_API_KEY="your_api_key_here"
+OPENAI_CHAT_MODEL_ID="your-model-id"
+
+# For Azure OpenAI
+AZURE_OPENAI_API_KEY="your-azure-api-key-here"
+AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
+AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="your-chat-deployment-name"
+AZURE_OPENAI_API_VERSION="2024-12-01-preview"

samples/python/agents/semantickernel/README.md

@@ -53,13 +53,26 @@ sequenceDiagram
 cd samples/python/agents/semantickernel
 ```
 
-2. **Create an environment file (.env) with your API key and the model ID (e.g., "gpt-4.1"):**:
+2. **Configure environment variables**:
 
+Create a `.env` file based on `.envexample`. The agent automatically detects whether to use Azure OpenAI or standard OpenAI based on which environment variables are set.
+
+**For OpenAI (standard):**
 ```bash
 OPENAI_API_KEY="your_api_key_here"
 OPENAI_CHAT_MODEL_ID="your-model-id"
 ```
 
+**For Azure OpenAI:**
+```bash
+AZURE_OPENAI_API_KEY="your-azure-api-key-here"
+AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
+AZURE_OPENAI_CHAT_DEPLOYMENT_NAME="your-deployment-name"
+AZURE_OPENAI_API_VERSION="2024-12-01-preview"
+```
+
+> Note: The agent will use Azure OpenAI if all four Azure variables are set, otherwise it will use standard OpenAI if both OpenAI variables are set.
+
 3. **Set up the Python Environment**:
 
 > Note: pin the Python version to your desired version (3.10+)

samples/python/agents/semantickernel/agent.py

@@ -11,6 +11,7 @@
 from pydantic import BaseModel
 from semantic_kernel.agents import ChatCompletionAgent, ChatHistoryAgentThread
 from semantic_kernel.connectors.ai.open_ai import (
+    AzureChatCompletion,
     OpenAIChatCompletion,
     OpenAIChatPromptExecutionSettings,
 )
@@ -22,7 +23,6 @@
 )
 from semantic_kernel.functions import KernelArguments, kernel_function
 
-
 if TYPE_CHECKING:
     from semantic_kernel.contents import ChatMessageContent
 
@@ -65,7 +65,7 @@ def get_exchange_rate(
             rate = data['rates'][currency_to]
             return f'1 {currency_from} = {rate} {currency_to}'
         except Exception as e:
-            return f'Currency API call failed: {str(e)}'
+            return f'Currency API call failed: {e!s}'
 
 
 # endregion
@@ -93,18 +93,33 @@ class SemanticKernelTravelAgent:
     SUPPORTED_CONTENT_TYPES = ['text', 'text/plain']
 
     def __init__(self):
-        api_key = os.getenv('OPENAI_API_KEY', None)
-        if not api_key:
-            raise ValueError('OPENAI_API_KEY environment variable not set.')
-
-        model_id = os.getenv('OPENAI_CHAT_MODEL_ID', 'gpt-4.1')
-
-        # Define a CurrencyExchangeAgent to handle currency-related tasks
+        # Check Azure OpenAI environment variables and create variables if all are set
+        azure_vars = [
+            os.getenv('AZURE_OPENAI_ENDPOINT'),
+            os.getenv('AZURE_OPENAI_API_KEY'), 
+            os.getenv('AZURE_OPENAI_CHAT_DEPLOYMENT_NAME'),
+            os.getenv('AZURE_OPENAI_API_VERSION')
+        ]
+
+        # Check if OpenAI environment variables are available
+        openai_vars = [
+            os.getenv('OPENAI_API_KEY'),
+            os.getenv('OPENAI_MODEL_ID')
+        ]
+
+        if all(azure_vars):            
+           chat_service = AzureChatCompletion()
+        elif all(openai_vars):            
+            chat_service = OpenAIChatCompletion()
+        else:
+            raise ValueError(
+                'Either Azure OpenAI environment variables (AZURE_OPENAI_ENDPOINT, '
+                'AZURE_OPENAI_API_KEY, AZURE_OPENAI_CHAT_DEPLOYMENT_NAME, AZURE_OPENAI_API_VERSION) or OpenAI '
+                'environment variables (OPENAI_API_KEY, OPENAI_MODEL_ID) must be set.'
+            )
+
         currency_exchange_agent = ChatCompletionAgent(
-            service=OpenAIChatCompletion(
-                api_key=api_key,
-                ai_model_id=model_id,
-            ),
+            service=chat_service,
             name='CurrencyExchangeAgent',
             instructions=(
                 'You specialize in handling currency-related requests from travelers. '
@@ -117,10 +132,7 @@ def __init__(self):
 
         # Define an ActivityPlannerAgent to handle activity-related tasks
         activity_planner_agent = ChatCompletionAgent(
-            service=OpenAIChatCompletion(
-                api_key=api_key,
-                ai_model_id=model_id,
-            ),
+            service=chat_service,
             name='ActivityPlannerAgent',
             instructions=(
                 'You specialize in planning and recommending activities for travelers. '
@@ -133,10 +145,7 @@ def __init__(self):
 
         # Define the main TravelManagerAgent to delegate tasks to the appropriate agents
         self.agent = ChatCompletionAgent(
-            service=OpenAIChatCompletion(
-                api_key=api_key,
-                ai_model_id=model_id,
-            ),
+            service=chat_service,
             name='TravelManagerAgent',
             instructions=(
                 "Your role is to carefully analyze the traveler's request and forward it to the appropriate agent based on the "
@@ -301,4 +310,4 @@ async def _ensure_thread_exists(self, session_id: str) -> None:
             self.thread = ChatHistoryAgentThread(thread_id=session_id)
 
 
-# endregion
+# endregion