Merge branch 'main' into giphy-apps-pkg

Author: sachi-atlan

quickstart/ai_giphy/.env.example

@@ -9,7 +9,6 @@ SMTP_PASSWORD=your_smtp_password_or_api_key
 SMTP_SENDER=your_sender_email (e.g., [email protected])
 
 # Azure OpenAI Configuration (used by the AI agent)
-APP_AZURE_OPENAI_API_KEY=your_azure_openai_api_key
-APP_AZURE_OPENAI_API_VERSION=your_azure_openai_api_version
-APP_AZURE_OPENAI_ENDPOINT=your_azure_openai_endpoint
-APP_AZURE_OPENAI_DEPLOYMENT_NAME=your_azure_openai_deployment_name
+OPENAI_API_KEY=your_openai_api_key
+OPENAI_MODEL_NAME=your_model_name
+OPENAI_BASE_URL=your_custom_base_url

quickstart/ai_giphy/README.md

@@ -12,7 +12,7 @@ https://github.com/user-attachments/assets/fd23ce3b-d63d-480d-a4fe-4258fc5de5c7
 - [Temporal CLI](https://docs.temporal.io/cli)
 - Giphy API key
 - SMTP credentials (e.g., SendGrid)
-- Azure OpenAI API credentials
+- OpenAI API key
 
 ### Installation Guides
 - [macOS Setup Guide](https://github.com/atlanhq/application-sdk/blob/main/docs/docs/setup/MAC.md)
@@ -70,11 +70,10 @@ SMTP_USERNAME=your_smtp_username (e.g., apikey for SendGrid)
 SMTP_PASSWORD=your_smtp_password_or_api_key
 SMTP_SENDER=your_sender_email (e.g., [email protected])
 
-# Azure OpenAI Configuration (used by the AI agent)
-APP_AZURE_OPENAI_API_KEY=your_azure_openai_api_key
-APP_AZURE_OPENAI_API_VERSION=your_azure_openai_api_version
-APP_AZURE_OPENAI_ENDPOINT=your_azure_openai_endpoint
-APP_AZURE_OPENAI_DEPLOYMENT_NAME=your_azure_openai_deployment_name
+# OpenAI Configuration (used by the AI agent)
+OPENAI_API_KEY=your_openai_api_key
+OPENAI_MODEL_NAME=your_model_name (optional, defaults to gpt-4.1-mini)
+OPENAI_BASE_URL=your_custom_base_url (optional, for custom gateways)
 
 ```
 

quickstart/ai_giphy/app/ai_agent.py

@@ -9,7 +9,7 @@
 from langchain import hub
 from langchain.agents import AgentExecutor, create_tool_calling_agent
 from langchain_core.tools import StructuredTool
-from langchain_openai import AzureChatOpenAI
+from langchain_openai import ChatOpenAI
 
 load_dotenv()
 logger = get_logger(__name__)
@@ -18,9 +18,14 @@
 SMTP_PORT = int(os.getenv("SMTP_PORT", "587"))
 SMTP_USERNAME = os.getenv("SMTP_USERNAME", "apikey")
 SMTP_PASSWORD = os.getenv("SMTP_PASSWORD")
+SMTP_SENDER = os.getenv("SMTP_SENDER", "[email protected]")
 GIPHY_API_KEY = os.getenv("GIPHY_API_KEY")
 SMTP_SENDER = os.getenv("SMTP_SENDER", "[email protected]")
 
+OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
+OPENAI_MODEL_NAME = os.getenv("OPENAI_MODEL_NAME", "gpt-4.1-mini")
+OPENAI_BASE_URL = os.getenv("OPENAI_BASE_URL")
+
 
 def fetch_gif(search_term: str) -> str:
     """
@@ -34,7 +39,8 @@ def fetch_gif(search_term: str) -> str:
     """
     if not GIPHY_API_KEY:
         raise ValueError(
-            "GIPHY_API_KEY is not set, please set it in the environment variables for the application. For reference, please refer to the README.md file and .env.example file"
+            "GIPHY_API_KEY is not set, please set it in the environment variables for the application. "
+            "For reference, please refer to the README.md file and .env.example file."
         )
 
     url = f"https://api.giphy.com/v1/gifs/random?api_key={GIPHY_API_KEY}&tag={search_term}&rating=pg"
@@ -46,16 +52,18 @@ def fetch_gif(search_term: str) -> str:
         return gif_url
     except Exception as e:
         logger.error(f"Failed to fetch GIF: {e}")
+        # Fallback GIF
         return "https://media.giphy.com/media/3o7abAHdYvZdBNnGZq/giphy.gif"
 
 
 def send_email_with_gify(to: str, gify_url: str):
     """
-    Send an email to the given recipient with the specified subject and body
+    Send an email to the given recipient with the specified subject and body.
     """
     if not SMTP_PASSWORD:
         raise ValueError(
-            "SMTP_PASSWORD is not set, please set it in the environment variables for the application. For reference, please refer to the README.md file and .env.example file"
+            "SMTP_PASSWORD is not set, please set it in the environment variables for the application. "
+            "For reference, please refer to the README.md file and .env.example file."
         )
 
     sender = SMTP_SENDER
@@ -68,53 +76,45 @@ def send_email_with_gify(to: str, gify_url: str):
                 <p>Enjoy!</p>
             </body>
         </html>
-        """
+    """
+
     msg = MIMEText(body, "html")
     msg["Subject"] = subject
     msg["From"] = sender
     msg["To"] = to
 
     try:
-        host = SMTP_HOST
-        port = SMTP_PORT
-        username = SMTP_USERNAME
-        password = SMTP_PASSWORD
-        with smtplib.SMTP(host, port) as server:
+        with smtplib.SMTP(SMTP_HOST, SMTP_PORT) as server:
             server.starttls()
-            server.login(username, password)  # pyright: ignore[reportArgumentType]
+            server.login(SMTP_USERNAME, SMTP_PASSWORD)  # pyright: ignore[reportArgumentType]
             server.send_message(msg)
-            return "Email sent successfully"
+        return "Email sent successfully"
     except Exception as e:
         logger.error(f"Failed to send email: {e}")
         raise
 
 
 def get_chain():
-    # Check for required Azure OpenAI environment variables
-    required_azure_vars = [
-        "APP_AZURE_OPENAI_API_KEY",
-        "APP_AZURE_OPENAI_API_VERSION",
-        "APP_AZURE_OPENAI_ENDPOINT",
-        "APP_AZURE_OPENAI_DEPLOYMENT_NAME",
-    ]
+    # Only API key is required. Base URL is optional.
+    if not os.getenv("OPENAI_API_KEY"):
+        raise ValueError(
+            "OPENAI_API_KEY is not set, please set it in the environment variables for the application."
+        )
 
-    for var in required_azure_vars:
-        if not os.getenv(var):
-            raise ValueError(
-                f"{var} is not set, please set it in the environment variables for the application. For reference, please refer to the README.md file and .env.example file"
-            )
-
-    local_llm = AzureChatOpenAI(
-        api_key=os.getenv("APP_AZURE_OPENAI_API_KEY"),
-        api_version=os.getenv("APP_AZURE_OPENAI_API_VERSION"),
-        azure_endpoint=os.getenv("APP_AZURE_OPENAI_ENDPOINT"),
-        azure_deployment=os.getenv("APP_AZURE_OPENAI_DEPLOYMENT_NAME"),
+    # Optional: Only used if someone is using a proxy / Azure / custom gateway
+    openai_base_url = os.getenv("OPENAI_BASE_URL", None)
+
+    local_llm = ChatOpenAI(
+        api_key=OPENAI_API_KEY,
+        model=OPENAI_MODEL_NAME,
+        base_url=openai_base_url,  # Passing None is allowed and simply ignored
     )
 
     local_tools = [
         StructuredTool.from_function(fetch_gif),
         StructuredTool.from_function(send_email_with_gify),
     ]
+
     try:
         prompt = hub.pull("hwchase17/openai-tools-agent")
         agent = create_tool_calling_agent(local_llm, local_tools, prompt)

quickstart/ai_giphy/tests/test_ai_agent.py

@@ -14,18 +14,21 @@ def mock_env_vars(self):
             patch("app.ai_agent.SMTP_PORT", "587"),
             patch("app.ai_agent.SMTP_USERNAME", "test_user"),
             patch("app.ai_agent.SMTP_PASSWORD", "test_password"),
-            patch("os.environ.get") as mock_env_get,
+            patch("app.ai_agent.OPENAI_API_KEY", "test_openai_key"),
+            patch("app.ai_agent.OPENAI_MODEL_NAME", "gpt-4.1-mini"),
+            patch("app.ai_agent.OPENAI_BASE_URL", None),
+            patch("app.ai_agent.os.getenv") as mock_getenv,
         ):
-            # Mock Azure OpenAI environment variables
-            env_vars = {
-                "APP_AZURE_OPENAI_API_KEY": "test_azure_key",
-                "APP_AZURE_OPENAI_API_VERSION": "2023-05-15",
-                "APP_AZURE_OPENAI_ENDPOINT": "https://test.openai.azure.com/",
-                "APP_AZURE_OPENAI_DEPLOYMENT_NAME": "test-deployment",
-            }
-            mock_env_get.side_effect = lambda key, default=None: env_vars.get(
-                key, default
-            )
+            # Mock os.getenv for get_chain() function
+            def getenv_side_effect(key, default=None):
+                env_vars = {
+                    "OPENAI_API_KEY": "test_openai_key",
+                    "OPENAI_MODEL_NAME": "gpt-4.1-mini",
+                    "OPENAI_BASE_URL": None,
+                }
+                return env_vars.get(key, default)
+
+            mock_getenv.side_effect = getenv_side_effect
 
             yield
 
@@ -85,7 +88,7 @@ def test_send_email_with_gify_failure() -> None:
     def test_get_chain_success() -> None:
         """Test successful creation of AI agent chain."""
         with (
-            patch("app.ai_agent.AzureChatOpenAI") as mock_llm,
+            patch("app.ai_agent.ChatOpenAI") as mock_llm,
             patch("app.ai_agent.hub.pull") as mock_hub_pull,
             patch("app.ai_agent.create_tool_calling_agent") as mock_create_agent,
             patch("app.ai_agent.AgentExecutor") as mock_agent_executor,
@@ -106,10 +109,9 @@ def test_get_chain_success() -> None:
 
             assert result == mock_executor
             mock_llm.assert_called_once_with(
-                api_key="test_azure_key",
-                api_version="2023-05-15",
-                azure_endpoint="https://test.openai.azure.com/",
-                azure_deployment="test-deployment",
+                api_key="test_openai_key",
+                model="gpt-4.1-mini",
+                base_url=None,
             )
             mock_hub_pull.assert_called_once_with("hwchase17/openai-tools-agent")
             mock_create_agent.assert_called_once()
@@ -119,7 +121,7 @@ def test_get_chain_success() -> None:
     def test_get_chain_failure() -> None:
         """Test get_chain raises exception when agent creation fails."""
         with (
-            patch("app.ai_agent.AzureChatOpenAI"),
+            patch("app.ai_agent.ChatOpenAI"),
             patch("app.ai_agent.hub.pull", side_effect=Exception("Hub Error")),
         ):
             with pytest.raises(Exception, match="Hub Error"):

quickstart/ai_giphy/tests/test_ai_giphy.py

@@ -18,18 +18,21 @@ def mock_env_vars(self):
             patch("app.ai_agent.SMTP_PORT", "587"),
             patch("app.ai_agent.SMTP_USERNAME", "test_user"),
             patch("app.ai_agent.SMTP_PASSWORD", "test_password"),
-            patch("os.environ.get") as mock_env_get,
+            patch("app.ai_agent.OPENAI_API_KEY", "test_openai_key"),
+            patch("app.ai_agent.OPENAI_MODEL_NAME", "gpt-4.1-mini"),
+            patch("app.ai_agent.OPENAI_BASE_URL", None),
+            patch("app.ai_agent.os.getenv") as mock_getenv,
         ):
-            # Mock Azure OpenAI environment variables
-            env_vars = {
-                "APP_AZURE_OPENAI_API_KEY": "test_azure_key",
-                "APP_AZURE_OPENAI_API_VERSION": "2023-05-15",
-                "APP_AZURE_OPENAI_ENDPOINT": "https://test.openai.azure.com/",
-                "APP_AZURE_OPENAI_DEPLOYMENT_NAME": "test-deployment",
-            }
-            mock_env_get.side_effect = lambda key, default=None: env_vars.get(
-                key, default
-            )
+            # Mock os.getenv for get_chain() function
+            def getenv_side_effect(key, default=None):
+                env_vars = {
+                    "OPENAI_API_KEY": "test_openai_key",
+                    "OPENAI_MODEL_NAME": "gpt-4.1-mini",
+                    "OPENAI_BASE_URL": None,
+                }
+                return env_vars.get(key, default)
+
+            mock_getenv.side_effect = getenv_side_effect
 
             yield
 
@@ -94,7 +97,7 @@ async def test_ai_agent_tools_integration() -> None:
         with (
             patch("requests.get") as mock_requests,
             patch("smtplib.SMTP") as mock_smtp,
-            patch("app.ai_agent.AzureChatOpenAI"),
+            patch("app.ai_agent.ChatOpenAI"),
             patch("app.ai_agent.hub.pull"),
             patch("app.ai_agent.create_tool_calling_agent"),
             patch("app.ai_agent.AgentExecutor"),