feat:compatible to workflows

Author: sachi-atlan

quickstart/ai_giphy/app/activities.py

@@ -12,19 +12,35 @@
 
 class AIGiphyActivities(ActivitiesInterface):
     @activity.defn
-    async def run_ai_agent(self, input_string: str) -> Dict[str, Any]:
+    async def run_ai_agent(self, config: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Runs the AI agent with the given input string.
+        Runs the AI agent with the given input string and configuration.
 
         Args:
-            input_string (str): The input to send to the AI agent.
+            config (Dict[str, Any]): Configuration dictionary containing:
+                - ai_input_string (str): The input to send to the AI agent
+                - openai_api_key (str, optional): OpenAI API key (falls back to env var)
+                - openai_model_name (str, optional): OpenAI model name (falls back to env var, then default)
+                - openai_base_url (str, optional): OpenAI base URL (falls back to env var)
+                - giphy_api_key (str, optional): Giphy API key (falls back to env var)
+                - smtp_host (str, optional): SMTP host (falls back to env var, then default)
+                - smtp_port (int, optional): SMTP port (falls back to env var, then default)
+                - smtp_username (str, optional): SMTP username (falls back to env var, then default)
+                - smtp_password (str, optional): SMTP password (falls back to env var)
+                - smtp_sender (str, optional): SMTP sender email (falls back to env var)
 
         Returns:
             Dict[str, Any]: The output from the AI agent.
         """
         try:
+            input_string = config.get(
+                "ai_input_string", "Fetch a cat gif and send it to [email protected]"
+            )
             logger.info(f"Received input for AI agent: {input_string}")
-            chain = get_chain()
+
+            # Extract config for get_chain (exclude ai_input_string)
+            chain_config = {k: v for k, v in config.items() if k != "ai_input_string"}
+            chain = get_chain(chain_config)
             result = chain.invoke({"input": input_string})
             logger.info(f"AI agent execution successful. Output: {result}")
             return result

quickstart/ai_giphy/app/ai_agent.py

@@ -2,6 +2,7 @@
 import os
 import smtplib
 from email.mime.text import MIMEText
+from typing import Any, Dict, Optional
 
 import requests
 from application_sdk.observability.logger_adaptor import get_logger
@@ -14,36 +15,42 @@
 load_dotenv()
 logger = get_logger(__name__)
 
-SMTP_HOST = os.getenv("SMTP_HOST", "smtp.sendgrid.net")
-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]")
+# Default values from environment variables (with defaults where applicable)
+_DEFAULT_SMTP_HOST = os.getenv("SMTP_HOST", "smtp.sendgrid.net")
+_DEFAULT_SMTP_PORT = int(os.getenv("SMTP_PORT", "587"))
+_DEFAULT_SMTP_USERNAME = os.getenv("SMTP_USERNAME", "apikey")
+_DEFAULT_SMTP_PASSWORD = os.getenv("SMTP_PASSWORD")
+_DEFAULT_SMTP_SENDER = os.getenv("SMTP_SENDER", "[email protected]")
+_DEFAULT_GIPHY_API_KEY = os.getenv("GIPHY_API_KEY")
+_DEFAULT_OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
+_DEFAULT_OPENAI_MODEL_NAME = os.getenv("OPENAI_MODEL_NAME", "gpt-4.1-mini")
+_DEFAULT_OPENAI_BASE_URL = os.getenv("OPENAI_BASE_URL")
 
-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:
+def _fetch_gif_impl(search_term: str, config: Optional[Dict[str, Any]] = None) -> str:
     """
     Fetches a random GIF from Giphy API based on the search term.
 
     Args:
         search_term (str): The search query to find a relevant GIF.
+        config (Optional[Dict[str, Any]]): Configuration dictionary with giphy_api_key.
 
     Returns:
         str: URL of the fetched GIF. Returns a fallback GIF URL if the fetch fails.
     """
-    if not GIPHY_API_KEY:
+    # Priority: config -> env vars -> None
+    giphy_api_key = None
+    if config:
+        giphy_api_key = config.get("giphy_api_key")
+    giphy_api_key = giphy_api_key or _DEFAULT_GIPHY_API_KEY
+
+    if not giphy_api_key:
         raise ValueError(
-            "GIPHY_API_KEY is not set, please set it in the environment variables for the application. "
+            "GIPHY_API_KEY is not set, please set it in the workflow_args or 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"
+    url = f"https://api.giphy.com/v1/gifs/random?api_key={giphy_api_key}&tag={search_term}&rating=pg"
     try:
         response = requests.get(url, timeout=5)
         response.raise_for_status()
@@ -56,17 +63,42 @@ def fetch_gif(search_term: str) -> str:
         return "https://media.giphy.com/media/3o7abAHdYvZdBNnGZq/giphy.gif"
 
 
-def send_email_with_gify(to: str, gify_url: str):
+def _send_email_with_gify_impl(
+    to: str, gify_url: str, config: Optional[Dict[str, Any]] = None
+):
     """
     Send an email to the given recipient with the specified subject and body.
+
+    Args:
+        to (str): Recipient email address.
+        gify_url (str): URL of the GIF to include.
+        config (Optional[Dict[str, Any]]): Configuration dictionary with SMTP settings.
     """
-    if not SMTP_PASSWORD:
+    # Priority: config -> env vars -> defaults
+    if config:
+        smtp_host = config.get("smtp_host") or _DEFAULT_SMTP_HOST
+        smtp_port = config.get("smtp_port")
+        if smtp_port is None:
+            smtp_port = _DEFAULT_SMTP_PORT
+        else:
+            smtp_port = int(smtp_port)
+        smtp_username = config.get("smtp_username") or _DEFAULT_SMTP_USERNAME
+        smtp_password = config.get("smtp_password") or _DEFAULT_SMTP_PASSWORD
+        smtp_sender = config.get("smtp_sender") or _DEFAULT_SMTP_SENDER
+    else:
+        smtp_host = _DEFAULT_SMTP_HOST
+        smtp_port = _DEFAULT_SMTP_PORT
+        smtp_username = _DEFAULT_SMTP_USERNAME
+        smtp_password = _DEFAULT_SMTP_PASSWORD
+        smtp_sender = _DEFAULT_SMTP_SENDER
+
+    if not smtp_password:
         raise ValueError(
-            "SMTP_PASSWORD is not set, please set it in the environment variables for the application. "
+            "SMTP_PASSWORD is not set, please set it in the workflow_args or environment variables for the application. "
             "For reference, please refer to the README.md file and .env.example file."
         )
 
-    sender = SMTP_SENDER
+    sender = smtp_sender
     subject = "Your Surprise GIF!"
     body = f"""
         <html>
@@ -84,32 +116,84 @@ def send_email_with_gify(to: str, gify_url: str):
     msg["To"] = to
 
     try:
-        with smtplib.SMTP(SMTP_HOST, SMTP_PORT) as server:
+        with smtplib.SMTP(smtp_host, smtp_port) as server:
             server.starttls()
-            server.login(SMTP_USERNAME, SMTP_PASSWORD)  # pyright: ignore[reportArgumentType]
+            server.login(smtp_username, smtp_password)  # pyright: ignore[reportArgumentType]
             server.send_message(msg)
         return "Email sent successfully"
     except Exception as e:
         logger.error(f"Failed to send email: {e}")
         raise
 
 
-def get_chain():
-    # 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."
+def get_chain(config: Optional[Dict[str, Any]] = None):
+    """
+    Creates and returns an AI agent chain with tools.
+
+    Args:
+        config (Optional[Dict[str, Any]]): Configuration dictionary containing:
+            - openai_api_key (str, optional): OpenAI API key (falls back to env var)
+            - openai_model_name (str, optional): OpenAI model name (falls back to env var, then default)
+            - openai_base_url (str, optional): OpenAI base URL (falls back to env var)
+            - giphy_api_key (str, optional): Giphy API key (falls back to env var)
+            - smtp_host (str, optional): SMTP host (falls back to env var, then default)
+            - smtp_port (int, optional): SMTP port (falls back to env var, then default)
+            - smtp_username (str, optional): SMTP username (falls back to env var, then default)
+            - smtp_password (str, optional): SMTP password (falls back to env var)
+            - smtp_sender (str, optional): SMTP sender email (falls back to env var)
+
+    Returns:
+        AgentExecutor: The configured AI agent executor.
+    """
+    # Priority: config -> env vars -> defaults
+    if config:
+        openai_api_key = config.get("openai_api_key") or _DEFAULT_OPENAI_API_KEY
+        openai_model_name = (
+            config.get("openai_model_name") or _DEFAULT_OPENAI_MODEL_NAME
         )
+        openai_base_url = config.get("openai_base_url") or _DEFAULT_OPENAI_BASE_URL
+    else:
+        openai_api_key = _DEFAULT_OPENAI_API_KEY
+        openai_model_name = _DEFAULT_OPENAI_MODEL_NAME
+        openai_base_url = _DEFAULT_OPENAI_BASE_URL
 
-    # Optional: Only used if someone is using a proxy / Azure / custom gateway
-    openai_base_url = os.getenv("OPENAI_BASE_URL", None)
+    if not openai_api_key:
+        raise ValueError(
+            "OPENAI_API_KEY is not set, please set it in the workflow_args or environment variables for the application."
+        )
 
     local_llm = ChatOpenAI(
-        api_key=OPENAI_API_KEY,
-        model=OPENAI_MODEL_NAME,
+        api_key=openai_api_key,
+        model=openai_model_name,
         base_url=openai_base_url,  # Passing None is allowed and simply ignored
     )
 
+    # Create closures that capture the config
+    def fetch_gif(search_term: str) -> str:
+        """
+        Fetches a random GIF from Giphy API based on the search term.
+
+        Args:
+            search_term (str): The search query to find a relevant GIF.
+
+        Returns:
+            str: URL of the fetched GIF. Returns a fallback GIF URL if the fetch fails.
+        """
+        return _fetch_gif_impl(search_term, config)
+
+    def send_email_with_gify(to: str, gify_url: str):
+        """
+        Send an email to the given recipient with the specified GIF.
+
+        Args:
+            to (str): Recipient email address.
+            gify_url (str): URL of the GIF to include in the email.
+
+        Returns:
+            str: Success message if email is sent successfully.
+        """
+        return _send_email_with_gify_impl(to, gify_url, config)
+
     local_tools = [
         StructuredTool.from_function(fetch_gif),
         StructuredTool.from_function(send_email_with_gify),

quickstart/ai_giphy/app/workflow.py

@@ -41,13 +41,36 @@ async def run(self, workflow_config: Dict[str, Any]) -> None:
         ai_input_string: str = workflow_args.get(
             "ai_input_string", "Fetch a cat gif and send it to [email protected]"
         )
+        giphy_api_key: str = workflow_args.get("giphy_api_key")
+        smtp_host: str = workflow_args.get("smtp_host")
+        smtp_port: int = workflow_args.get("smtp_port")
+        smtp_username: str = workflow_args.get("smtp_username")
+        smtp_password: str = workflow_args.get("smtp_password")
+        smtp_sender: str = workflow_args.get("smtp_sender")
+        openai_api_key: str = workflow_args.get("openai_api_key")
+        openai_model_name: str = workflow_args.get("openai_model_name")
+        openai_base_url: str = workflow_args.get("openai_base_url")
 
         logger.info(f"Starting AI Giphy workflow with input: {ai_input_string}")
 
+        # Prepare config dict with all configuration values
+        agent_config = {
+            "ai_input_string": ai_input_string,
+            "giphy_api_key": giphy_api_key,
+            "smtp_host": smtp_host,
+            "smtp_port": smtp_port,
+            "smtp_username": smtp_username,
+            "smtp_password": smtp_password,
+            "smtp_sender": smtp_sender,
+            "openai_api_key": openai_api_key,
+            "openai_model_name": openai_model_name,
+            "openai_base_url": openai_base_url,
+        }
+
         # Execute the AI agent activity
         agent_output = await workflow.execute_activity(
             activities_instance.run_ai_agent,
-            ai_input_string,
+            agent_config,
             start_to_close_timeout=timedelta(
                 seconds=60
             ),  # Increased timeout for potentially longer AI tasks