rasa-pro 3.14.0a15__py3-none-any.whl → 3.14.0a17__py3-none-any.whl

rasa/builder/template_cache.py

@@ -1,11 +1,18 @@
+import asyncio
 import os
+import shutil
+import tarfile
+import tempfile
 from pathlib import Path
+from typing import Generator
 
 import aiofiles
-import aiofiles.os
-import aioshutil
+import aiohttp
 import structlog
+from sanic import Sanic
 
+import rasa.version
+from rasa.builder.logging_utils import capture_exception_with_context
 from rasa.cli.scaffold import ProjectTemplateName
 
 structlogger = structlog.get_logger()
@@ -13,15 +20,64 @@ structlogger = structlog.get_logger()
 CACHE_BUCKET_URL = "https://trained-templates.s3.us-east-1.amazonaws.com"
 
 # Root directory for storing downloaded template caches on disk.
-_CACHE_ROOT_DIR = Path(os.getenv("RASA_TEMPLATE_CACHE_DIR", "/templates"))
+_CACHE_ROOT_DIR = Path(
+    os.getenv(
+        "RASA_TEMPLATE_CACHE_DIR",
+        Path.home().joinpath(".rasa", "template-cache").as_posix(),
+    )
+)
 
 
 def _template_cache_dir(template: ProjectTemplateName) -> Path:
     """Return the local cache directory for a given template and version."""
-    return _CACHE_ROOT_DIR / template.value
+    return _CACHE_ROOT_DIR / rasa.version.__version__ / template.value
 
 
-async def _copytree(src: Path, dst: Path) -> None:
+def _cache_root_dir() -> Path:
+    return Path(
+        os.getenv(
+            "RASA_TEMPLATE_CACHE_DIR",
+            Path.home().joinpath(".rasa", "template-cache").as_posix(),
+        )
+    )
+
+
+def _safe_tar_members(
+    tar: tarfile.TarFile, destination_directory: Path
+) -> Generator[tarfile.TarInfo, None, None]:
+    """Yield safe members for extraction to prevent path traversal and links.
+
+    Args:
+        tar: Open tar file handle
+        destination_directory: Directory to which files will be extracted
+
+    Yields:
+        Members that are safe to extract within destination_directory
+    """
+    base_path = destination_directory.resolve()
+
+    for member in tar.getmembers():
+        name = member.name
+        # Skip empty names and absolute paths
+        if not name or name.startswith("/") or name.startswith("\\"):
+            continue
+
+        # Disallow symlinks and hardlinks
+        if member.issym() or member.islnk():
+            continue
+
+        # Compute the final path and ensure it's within base_path
+        target_path = (base_path / name).resolve()
+        try:
+            target_path.relative_to(base_path)
+        except ValueError:
+            # Member would escape the destination directory
+            continue
+
+        yield member
+
+
+def _copytree(src: Path, dst: Path) -> None:
     """Copy directory tree from src to dst, merging into dst.
 
     Existing files are overwritten. Hidden files and directories are included, as
@@ -31,14 +87,132 @@ async def _copytree(src: Path, dst: Path) -> None:
     for root, dirs, files in os.walk(src):
         rel_path = Path(root).relative_to(src)
         target_dir = dst / rel_path
-        await aiofiles.os.makedirs(target_dir, exist_ok=True)
+        target_dir.mkdir(parents=True, exist_ok=True)
         for filename in files:
             src_file = Path(root) / filename
             dst_file = target_dir / filename
-            await aioshutil.copy2(src_file, dst_file)
+            shutil.copy2(src_file, dst_file)
+
+
+async def download_cache_for_template(
+    template: ProjectTemplateName, target_dir: str
+) -> None:
+    # get a temp path for the cache file download
+    temporary_cache_file = tempfile.NamedTemporaryFile(suffix=".tar.gz", delete=False)
+
+    try:
+        url = f"{CACHE_BUCKET_URL}/{rasa.version.__version__}-{template.value}.tar.gz"
+        async with aiohttp.ClientSession() as session:
+            async with session.get(url) as response:
+                response.raise_for_status()
+                async with aiofiles.open(temporary_cache_file.name, "wb") as f:
+                    async for chunk in response.content.iter_chunked(1024 * 1024):
+                        await f.write(chunk)
+
+        # extract the cache to the project folder using safe member filtering
+        with tarfile.open(temporary_cache_file.name, "r:gz") as tar:
+            destination = Path(target_dir)
+            destination.mkdir(parents=True, exist_ok=True)
+            tar.extractall(
+                path=destination,
+                members=_safe_tar_members(tar, destination),
+            )
+
+        structlogger.info(
+            "project_generator.download_cache_for_template.success",
+            template=template,
+            event_info=(
+                "Downloaded cache for template, extracted to target directory."
+            ),
+            target_dir=target_dir,
+        )
+    except aiohttp.ClientResponseError as e:
+        if e.status == 403:
+            structlogger.debug(
+                "project_generator.download_cache_for_template.no_cache_found",
+                template=template,
+                event_info=("No cache found for template, continuing without it."),
+                target_dir=target_dir,
+            )
+        else:
+            capture_exception_with_context(
+                e,
+                "project_generator.download_cache_for_template.response_error",
+                extra={
+                    "template": template.value,
+                    "status": str(e.status),
+                    "target_dir": target_dir,
+                },
+            )
+    except Exception as exc:
+        capture_exception_with_context(
+            exc,
+            "project_generator.download_cache_for_template.unexpected_error",
+            extra={"template": template.value, "target_dir": target_dir},
+        )
+    finally:
+        # Clean up the temporary file
+        try:
+            Path(temporary_cache_file.name).unlink(missing_ok=True)
+        except Exception as exc:
+            structlogger.debug(
+                "project_generator.download_cache_for_template.cleanup_error",
+                error=str(exc),
+                template=template,
+                event_info=("Failed to cleanup cache for template, ignoring."),
+            )
+
+
+async def background_download_template_caches(
+    app: Sanic, loop: asyncio.AbstractEventLoop
+) -> None:
+    """Kick off background downloads of template caches if enabled."""
+    try:
+        structlogger.info(
+            "builder.main.background_cache_download.start",
+            event_info=(
+                "Starting background download of template caches for this " "version"
+            ),
+        )
+
+        # Ensure cache root exists
+        _cache_root_dir().mkdir(parents=True, exist_ok=True)
+
+        async def _download(template: ProjectTemplateName) -> None:
+            try:
+                target_dir = _template_cache_dir(template)
+                if target_dir.exists() and any(target_dir.iterdir()):
+                    structlogger.debug(
+                        "builder.main.background_cache_download.skipped",
+                        template=template,
+                        event_info=(
+                            "Skipping download of template cache because it "
+                            "already exists."
+                        ),
+                        target_dir=target_dir,
+                    )
+                    return
+
+                target_dir.mkdir(parents=True, exist_ok=True)
+                await download_cache_for_template(template, target_dir.as_posix())
+            except Exception as exc:
+                structlogger.debug(
+                    "builder.main.background_cache_download.error",
+                    template=template,
+                    error=str(exc),
+                )
+
+        # schedule downloads concurrently without blocking startup
+        for template in ProjectTemplateName:
+            loop.create_task(_download(template))
+    except Exception as exc:
+        structlogger.debug(
+            "builder.main.background_cache_download.unexpected_error",
+            error=str(exc),
+        )
 
 
-async def copy_cache_for_template_if_available(
+def copy_cache_for_template_if_available(
     template: ProjectTemplateName, project_folder: Path
 ) -> None:
     """Copy a previously downloaded cache for `template` into `project_folder`.
@@ -48,7 +222,7 @@ async def copy_cache_for_template_if_available(
     try:
         cache_dir = _template_cache_dir(template)
         if cache_dir.exists() and any(cache_dir.iterdir()):
-            await _copytree(cache_dir, project_folder)
+            _copytree(cache_dir, project_folder)
             structlogger.info(
                 "project_generator.copy_cache_for_template.success",
                 template=template,

rasa/cli/project_templates/basic/README.md

@@ -0,0 +1,23 @@
+# Basic Rasa Template
+
+A simple, general-purpose conversational agent template that provides essential conversational capabilities.
+
+## 🚀 What's Included
+
+This template provides a foundation for building conversational agents with:
+- **Basic conversational flows**: Greetings, help, feedback, and human handoff
+- **Help system**: Users can ask for assistance and get guided responses
+- **Feedback collection**: Gather user feedback to improve the agent
+- **Human handoff**: Seamlessly transfer conversations to human agents when needed
+
+## 📁 Directory Structure
+
+```
+├── actions/          # Custom Python logic for agent actions
+├── data/            # Conversational flows and training data
+├── domain/          # Agent configuration (slots, responses, actions)
+├── docs/            # Knowledge base documents (optional)
+├── prompts/         # LLM prompts for enhanced responses
+└── config.yml       # Training pipeline configuration
+```
+

rasa/cli/project_templates/basic/actions/actions.md

@@ -0,0 +1,10 @@
+## 📂 `actions/` – The Agent's Toolkit
+
+This folder contains Python files that define custom actions your agent can perform. Actions are pieces of code that run when your agent needs to do something beyond just responding with text.
+
+**What you'll find:**
+- `action_human_handoff.py`: Handles transferring the conversation to a human agent when needed.
+
+**Edit Python files in this folder** to add new custom logic, integrate with APIs, or perform calculations and data processing.
+
+Learn more about custom actions in the [Rasa documentation](https://rasa.com/docs/pro/build/custom-actions).

rasa/cli/project_templates/basic/config.yml

@@ -1,11 +1,11 @@
-# Rasa Assistant Configuration
-# This file controls your assistant's language, message processing pipeline, and conversation policies.
+# Rasa Agent Configuration
+# This file controls your agent's language, message processing pipeline, and conversation policies.
 # For full documentation, see: https://rasa.com/docs/pro/build/configuring-assistant
 recipe: default.v1
 language: en
 
-# The assistant project unique identifier
-# This default value must be replaced with a unique assistant name within your deployment
+# The agent project unique identifier  
+# This default value must be replaced with a unique agent name within your deployment
 assistant_id: placeholder_default
 
 pipeline:

rasa/cli/project_templates/basic/data/data.md

@@ -1,9 +1,8 @@
-## 📂 `data/` – The agent's Business Logic
+## 📂 `data/` – The Agent's Business Logic
 
-This folder holds files that define your agent’s skills using "flows". Each flow is a step-by-step conversation pattern (like a recipe) for handling a user goal (e.g., checking a balance, updating an address).
+This folder holds files that define your agent’s skills using "flows". [1](https://rasa.com/docs/pro/build/writing-flows) Each flow is a step-by-step conversation pattern (like a recipe) for handling a user goal (e.g., checking a balance, updating an address).
 
-**What you’ll find:**
-- Each YAML file = one or more skills.
-- Flows are made of steps: collecting info, calling actions, and responding.
+**What you'll find:**
+- **general/**: Basic conversational flows (greetings, help, feedback, human handoff)
 
-**Edit txt files in this folder** to add new skills, change existing flows, or adjust what the agent asks.
+**Edit YAML files in this folder** to add new skills, change existing flows, or adjust what the agent asks.

rasa/cli/project_templates/basic/domain/domain.md

@@ -1,9 +1,11 @@
-## 📂 `domain/` – The agent’s Brain
+## 📂 `domain/` – The Agent's Brain
 
-This folder contains YAML files that define the agent’s:
-- **Slots**: The agent’s memory (e.g., user's name, account number, address).
-- **Responses**: The messages your bot can say to users (e.g., greetings, confirmations).
-- **Actions**: Custom logic your agent can run (e.g., checking a balance).
+This folder contains YAML files that define the agent's:
+- **Slots**: The agent's memory (e.g., user's name, session info) [1](https://rasa.com/docs/reference/primitives/slots/).
+- **Responses**: The messages your agent can say to users (e.g., greetings, confirmations) [2](https://rasa.com/docs/reference/primitives/responses).
+- **Actions**: Custom logic your agent can run (e.g., handling feedback, human handoff) [3](https://rasa.com/docs/reference/primitives/custom-actions).
 
+**What you'll find:**
+- **general/**: Basic conversational domain elements (greetings, help, feedback)
 
 You can organize the domain as one big file or many small ones. Rasa will automatically merge everything during training [1](https://rasa.com/docs/reference/config/domain).

rasa/cli/project_templates/basic/domain/general/show_faqs.yml

@@ -3,7 +3,7 @@ version: "3.1"
 responses:
   utter_top_faqs:
     - text: |
-        Try out some of these questions to trigger agent search:
+        Try out some of these questions you can use to get me to search your knowledge base:
         
         - 🤖 What is Rasa?
         - 💬 What is CALM?

rasa/cli/project_templates/basic/endpoints.yml

@@ -60,7 +60,7 @@ model_groups:
       - provider: openai
         model: gpt-4o-2024-11-20
         timeout: 7
-        max_tokens: 256
+        max_completion_tokens: 256
   - id: openai-embeddings
     models:
       - provider: openai

rasa/cli/project_templates/finance/README.md

@@ -0,0 +1,26 @@
+# Finance Banking Agent Template
+
+A lightweight banking conversational agent template for the fictional **Fenlo Bank** that handles account management, card services, and money transfers.
+
+## 🚀 What's Included
+
+This template provides a banking assistant with:
+- **Account Management**: Balance checking and statement downloads
+- **Card Services**: Card activation, blocking, replacement, and listing  
+- **Money Transfers**: Account-to-account transfers and third-party payments
+- **Contact Management**: Add, list, and remove trusted contacts
+- **Bill Management**: Bill payment reminders and scheduling
+- **Banking Knowledge**: FAQ system with Fenlo Bank documentation
+
+## 📁 Directory Structure
+
+```
+├── actions/         # Custom Python logic for banking operations
+├── data/            # Banking conversation flows and training data
+├── domain/          # Banking agent configuration
+├── db/              # Mock JSON database for testing
+├── docs/            # Fenlo Bank knowledge base and FAQ documents
+├── prompts/         # LLM prompts for enhanced banking responses
+└── config.yml       # Training pipeline configuration
+```
+

rasa/cli/project_templates/finance/actions/__init__.py

@@ -1,46 +0,0 @@
-# Account actions
-from actions.accounts.action_ask_account import ActionAskAccount
-from actions.accounts.action_check_balance import ActionCheckBalance
-
-# General actions
-from actions.action_session_start import ActionSessionStart
-
-# Card actions
-from actions.cards.action_ask_card import ActionAskCard
-from actions.cards.action_check_card_existence import ActionCheckCardExistence
-from actions.cards.action_update_card_status import ActionUpdateCardStatus
-
-# Transfer actions
-from actions.transfers.action_add_payee import ActionAddPayee
-from actions.transfers.action_ask_account_from import ActionAskAccountFrom
-from actions.transfers.action_check_payee_existence import ActionCheckPayeeExistence
-from actions.transfers.action_check_sufficient_funds import ActionCheckSufficientFunds
-from actions.transfers.action_list_payees import ActionListPayees
-from actions.transfers.action_process_immediate_payment import (
-    ActionProcessImmediatePayment,
-)
-from actions.transfers.action_remove_payee import ActionRemovePayee
-from actions.transfers.action_schedule_payment import ActionSchedulePayment
-from actions.transfers.action_validate_payment_date import ActionValidatePaymentDate
-
-__all__ = [
-    # General actions
-    "ActionSessionStart",
-    # Account actions
-    "ActionAskAccount",
-    "ActionCheckBalance",
-    # Card actions
-    "ActionAskCard",
-    "ActionCheckCardExistence",
-    "ActionUpdateCardStatus",
-    # Transfer actions
-    "ActionAddPayee",
-    "ActionAskAccountFrom",
-    "ActionCheckPayeeExistence",
-    "ActionCheckSufficientFunds",
-    "ActionListPayees",
-    "ActionProcessImmediatePayment",
-    "ActionRemovePayee",
-    "ActionSchedulePayment",
-    "ActionValidatePaymentDate",
-]

rasa/cli/project_templates/finance/actions/accounts/check_balance.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict, List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+
+from actions.db import get_account
+
+
+class CheckBalance(Action):
+    def name(self) -> str:
+        return "check_balance"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        account = get_account(tracker.sender_id)
+        return [SlotSet("current_balance", account.funds)]

rasa/cli/project_templates/finance/actions/actions.md

@@ -0,0 +1,15 @@
+## 📂 `actions/` – The Agent's Toolkit
+
+This folder contains Python files that define custom banking actions your agent can perform. Actions handle complex banking operations, database interactions, and business logic validation.
+
+**What you'll find:**
+- **accounts/**: Account-related actions (balance checking, account validation)
+- **cards/**: Card management actions (card existence checks, status updates)
+- **transfers/**: Payment and transfer actions (payee management, fund transfers, scheduling)
+- **contacts/**: Contact and advisor management
+- `database.py`: Core database interactions with banking data
+- `action_session_start.py`: Session initialization for banking context
+
+**Edit Python files in this folder** to add new banking features, modify business rules, or integrate with external banking APIs and systems.
+
+Learn more about custom actions in the [Rasa documentation](https://rasa.com/docs/pro/build/custom-actions).

rasa/cli/project_templates/finance/actions/{transfers/action_process_immediate_payment.py → cards/check_that_card_exists.py}

@@ -5,9 +5,9 @@ from rasa_sdk.events import SlotSet
 from rasa_sdk.executor import CollectingDispatcher
 
 
-class ActionProcessImmediatePayment(Action):
+class ActionCheckThatCardExists(Action):
     def name(self) -> Text:
-        return "action_process_immediate_payment"
+        return "check_that_card_exists"
 
     def run(
         self,
@@ -15,4 +15,7 @@ class ActionProcessImmediatePayment(Action):
         tracker: Tracker,
         domain: Dict[Text, Any],
     ) -> List[Dict[Text, Any]]:
-        return [SlotSet("payment_processed", True)]
+        # For example purposes, we assume the card exists; in a real situation,
+        # fetch this info from a database or service.
+        # card_number = tracker.get_slot("bank_card_number")
+        return [SlotSet("return_value", True)]

rasa/cli/project_templates/finance/actions/cards/list_cards.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+
+from actions.db import get_cards
+
+
+class ListCards(Action):
+    def name(self) -> str:
+        return "list_cards"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        cards = get_cards(tracker.sender_id)
+        if len(cards) > 0:
+            cards_list = "".join([f"- {c.name} ({c.handle}) \n" for c in cards])
+            return [SlotSet("cards_list", cards_list)]
+        else:
+            return [SlotSet("cards_list", None)]

rasa/cli/project_templates/finance/actions/contacts/add_contact.py

@@ -0,0 +1,30 @@
+from typing import Any, Dict, List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+
+from actions.db import Contact, add_contact, get_contacts
+
+
+class AddContact(Action):
+    def name(self) -> str:
+        return "add_contact"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        contacts = get_contacts(tracker.sender_id)
+        name = tracker.get_slot("add_contact_name")
+        handle = tracker.get_slot("add_contact_handle")
+
+        if name is None or handle is None:
+            return [SlotSet("return_value", "data_not_present")]
+
+        existing_handles = {c.handle for c in contacts}
+        if handle in existing_handles:
+            return [SlotSet("return_value", "already_exists")]
+
+        new_contact = Contact(name=name, handle=handle)
+        add_contact(tracker.sender_id, new_contact)
+        return [SlotSet("return_value", "success")]

rasa/cli/project_templates/finance/actions/contacts/list_contacts.py

@@ -0,0 +1,22 @@
+from typing import Any, Dict, List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+
+from actions.db import get_contacts
+
+
+class ListContacts(Action):
+    def name(self) -> str:
+        return "list_contacts"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        contacts = get_contacts(tracker.sender_id)
+        if len(contacts) > 0:
+            contacts_list = "".join([f"- {c.name} ({c.handle}) \n" for c in contacts])
+            return [SlotSet("contacts_list", contacts_list)]
+        else:
+            return [SlotSet("contacts_list", None)]

rasa/cli/project_templates/finance/actions/contacts/remove_contact.py

@@ -0,0 +1,35 @@
+from typing import Any, Dict, List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+
+from actions.db import get_contacts, write_contacts
+
+
+class RemoveContact(Action):
+    def name(self) -> str:
+        return "remove_contact"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        contacts = get_contacts(tracker.sender_id)
+        handle = tracker.get_slot("remove_contact_handle")
+
+        if handle is not None:
+            contact_indices_with_handle = [
+                i for i, c in enumerate(contacts) if c.handle == handle
+            ]
+            if len(contact_indices_with_handle) == 0:
+                return [SlotSet("return_value", "not_found")]
+            else:
+                removed_contact = contacts.pop(contact_indices_with_handle[0])
+                write_contacts(tracker.sender_id, contacts)
+                return [
+                    SlotSet("return_value", "success"),
+                    SlotSet("remove_contact_name", removed_contact.name),
+                ]
+
+        else:
+            return [SlotSet("return_value", "missing_handle")]