rasa-pro 3.14.0.dev10__py3-none-any.whl → 3.14.0.dev12__py3-none-any.whl

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/{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")]

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

@@ -0,0 +1,117 @@
+import os
+import shutil
+import tempfile
+from typing import Any, List
+
+from pydantic import BaseModel
+
+from rasa.nlu.utils import write_json_to_file
+from rasa.shared.utils.io import read_json_file
+
+ORIGIN_DB_PATH = "db"
+CONTACTS = "contacts.json"
+TRANSACTIONS = "transactions.json"
+MY_ACCOUNT = "my_account.json"
+CARDS = "cards.json"
+
+
+class MyAccount(BaseModel):
+    account: str
+    funds: int
+    daily_limit: int
+    monthly_limit: int
+
+
+class Transaction(BaseModel):
+    datetime: str
+    recipient: str
+    sender: str
+    amount: str
+    description: str
+
+    def stringify(self) -> str:
+        from datetime import datetime
+
+        parsed_date = datetime.strptime(self.datetime, "%Y-%m-%dT%H:%M:%S.%f")
+        formatted_date = parsed_date.strftime("%Y-%m-%d %H:%M:%S")
+
+        return (
+            f"- {self.amount} from {self.sender} to "
+            f"{self.recipient}: {self.description} ({formatted_date})"
+        )
+
+
+class Contact(BaseModel):
+    name: str
+    handle: str
+
+
+class Card(BaseModel):
+    name: str
+    number: str
+    expiration_date: str
+    cvv: str
+    handle: str
+    status: str
+
+
+def get_session_db_path(session_id: str) -> str:
+    tempdir = tempfile.gettempdir()
+    project_name = "rasa-calm-demo"
+    return os.path.join(tempdir, project_name, session_id)
+
+
+def prepare_db_file(session_id: str, db: str) -> str:
+    session_db_path = get_session_db_path(session_id)
+    os.makedirs(session_db_path, exist_ok=True)
+    destination_file = os.path.join(session_db_path, db)
+    if not os.path.exists(destination_file):
+        origin_file = os.path.join(ORIGIN_DB_PATH, db)
+        shutil.copy(origin_file, destination_file)
+    return destination_file
+
+
+def read_db(session_id: str, db: str) -> Any:
+    db_file = prepare_db_file(session_id, db)
+    return read_json_file(db_file)
+
+
+def write_db(session_id: str, db: str, data: Any) -> None:
+    db_file = prepare_db_file(session_id, db)
+    write_json_to_file(db_file, data)
+
+
+def get_contacts(session_id: str) -> List[Contact]:
+    return [Contact(**item) for item in read_db(session_id, CONTACTS)]
+
+
+def get_cards(session_id: str) -> List[Card]:
+    return [Card(**item) for item in read_db(session_id, CARDS)]
+
+
+def get_transactions(session_id: str) -> List[Transaction]:
+    return [Transaction(**item) for item in read_db(session_id, TRANSACTIONS)]
+
+
+def get_account(session_id: str) -> MyAccount:
+    return MyAccount(**read_db(session_id, MY_ACCOUNT))
+
+
+def write_account(session_id: str, account: MyAccount) -> None:
+    write_db(session_id, MY_ACCOUNT, account.dict())
+
+
+def add_contact(session_id: str, contact: Contact) -> None:
+    contacts = get_contacts(session_id)
+    contacts.append(contact)
+    write_db(session_id, CONTACTS, [c.dict() for c in contacts])
+
+
+def add_transaction(session_id: str, transaction: Transaction) -> None:
+    transactions = get_transactions(session_id)
+    transactions.append(transaction)
+    write_db(session_id, TRANSACTIONS, [t.dict() for t in transactions])
+
+
+def write_contacts(session_id: str, contacts: List[Contact]) -> None:
+    write_db(session_id, CONTACTS, [c.dict() for c in contacts])

rasa/cli/project_templates/finance/actions/transfers/check_transfer_funds.py

@@ -0,0 +1,27 @@
+import re
+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 CheckTransferFunds(Action):
+    def name(self) -> str:
+        return "check_transfer_funds"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        account = get_account(tracker.sender_id)
+        amount_of_money = tracker.get_slot("amount_of_money")
+        if not amount_of_money:
+            has_sufficient_funds = False
+        else:
+            if isinstance(amount_of_money, str):
+                # Remove any non-numeric characters (except for the decimal point)
+                amount_of_money = float(re.sub(r"[^0-9.]", "", amount_of_money))
+            has_sufficient_funds = account.funds >= amount_of_money
+        return [SlotSet("has_sufficient_funds", has_sufficient_funds)]

rasa/cli/project_templates/finance/actions/transfers/check_transfer_limit.py

@@ -0,0 +1,36 @@
+from typing import Any, Dict, List, Text
+
+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 CheckTransferLimit(Action):
+    def name(self) -> Text:
+        return "check_transfer_limit"
+
+    def run(
+        self,
+        dispatcher: CollectingDispatcher,
+        tracker: Tracker,
+        domain: Dict[Text, Any],
+    ) -> List[Dict[Text, Any]]:
+        limit_type = tracker.get_slot("transfer_limit_type")
+
+        account = get_account(tracker.sender_id)
+        daily_limit = account.daily_limit
+        monthly_limit = account.monthly_limit
+
+        transfer_limit = None
+
+        if limit_type == "daily":
+            transfer_limit = daily_limit
+        elif limit_type == "monthly":
+            transfer_limit = monthly_limit
+
+        return [
+            SlotSet("transfer_limit", transfer_limit),
+            SlotSet("return_value", transfer_limit is not None),
+        ]

rasa/cli/project_templates/finance/actions/transfers/execute_recurrent_payment.py

@@ -0,0 +1,20 @@
+from typing import List
+
+from rasa_sdk import Action, Tracker
+from rasa_sdk.events import EventType, SlotSet
+from rasa_sdk.executor import CollectingDispatcher
+from rasa_sdk.types import DomainDict
+
+
+class ExecutePayment(Action):
+    def name(self) -> str:
+        return "action_execute_recurrent_payment"
+
+    def run(
+        self,
+        dispatcher: CollectingDispatcher,
+        tracker: Tracker,
+        domain: DomainDict,
+    ) -> List[EventType]:
+        # Set-up payment logic and additional checks here
+        return [SlotSet("setup_recurrent_payment_successful", True)]

rasa/cli/project_templates/finance/actions/transfers/execute_transfer.py

@@ -0,0 +1,45 @@
+import re
+from datetime import datetime
+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 Transaction, add_transaction, get_account, write_account
+
+AMOUNT_OF_MONEY_REGEX = re.compile(r"\d*[.,]*\d+")
+
+
+class ExecuteTransfer(Action):
+    def name(self) -> str:
+        return "execute_transfer"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        account = get_account(tracker.sender_id)
+
+        recipient = tracker.get_slot("recipient_account")
+        amount_of_money = tracker.get_slot("amount_of_money")
+
+        if recipient is None or amount_of_money is None:
+            return [SlotSet("transfer_successful", False)]
+
+        # just as a play case
+        if recipient == "Jack":
+            return [SlotSet("transfer_successful", False)]
+
+        if isinstance(amount_of_money, str):
+            amount_of_money = float(re.sub(r"[^0-9.]", "", amount_of_money))
+        account.funds -= amount_of_money
+        new_transaction = Transaction(
+            datetime=datetime.now().isoformat(),
+            recipient=recipient or "unknown",
+            sender="self",
+            amount=str(amount_of_money),
+            description="",
+        )
+        add_transaction(tracker.sender_id, new_transaction)
+        write_account(tracker.sender_id, account)
+        return [SlotSet("transfer_successful", True)]

rasa/cli/project_templates/finance/actions/transfers/list_transactions.py

@@ -0,0 +1,32 @@
+from datetime import datetime
+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_transactions
+
+
+class ListTransactions(Action):
+    def name(self) -> str:
+        return "list_transactions"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[str, Any]]:
+        full_transaction_list = tracker.get_slot("full_transaction_list")
+
+        transactions = get_transactions(tracker.sender_id)
+
+        # sort by date
+        transactions.sort(
+            key=lambda x: datetime.strptime(x.datetime, "%Y-%m-%dT%H:%M:%S.%f"),
+            reverse=True,
+        )
+
+        if not full_transaction_list:
+            transactions = transactions[:5]
+
+        transactions_list = "\n".join([t.stringify() for t in transactions])
+        return [SlotSet("transactions_list", transactions_list)]

rasa/cli/project_templates/finance/config.yml

@@ -1,5 +1,11 @@
+# Rasa Assistant Configuration
+# This file controls your assistant'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
 assistant_id: placeholder_default
 
 pipeline:

rasa/cli/project_templates/finance/credentials.yml

@@ -1,14 +1,11 @@
 # This file contains the credentials for the voice & chat platforms
 # which your bot is using.
 # https://rasa.com/docs/rasa-pro/connectors/messaging-and-voice-channels/
+
 rest:
-socketio:
-  bot_message_evt: bot_uttered
-  session_persistence: true
-  user_message_evt: user_uttered
+#  # you don't need to provide anything here - this channel doesn't
+#  # require any credentials
 
-rasa:
-  url: "http://localhost:5002/api"
 
 #facebook:
 #  verify: "<verify>"
@@ -30,3 +27,7 @@ rasa:
 #  token: "<bot token>"
 #  webhook_url: "<callback URL>"
 
+# This entry is needed if you are using Rasa Enterprise. The entry represents credentials
+# for the Rasa Enterprise "channel", i.e. Talk to your bot and Share with guest testers.
+rasa:
+  url: "http://localhost:5002/api"

rasa/cli/project_templates/finance/data/accounts/check_balance.yml

@@ -3,8 +3,7 @@ flows:
     description: |
       Guides the user through retrieving their account balance by requesting an
       account number or an account name and returning the balance on the selected account
-    name: check an account balance
+    name: check account balance
     steps:
-      - collect: account
-        description: "The account number to check balance for"
-      - action: action_check_balance
+      - action: check_balance
+      - action: utter_current_balance

rasa/cli/project_templates/finance/data/accounts/download_statements.yml

@@ -0,0 +1,26 @@
+flows:
+  download_statements:
+    name: download account statements
+    description: Allow users to download their monthly account statements in PDF or CSV format.
+    steps:
+      - collect: statement_month
+        description: "The specific month the user wants the account statement for."
+        utter: utter_ask_statement_month
+      - collect: statement_year
+        description: "The specific year of the account statement requested by the user."
+        utter: utter_ask_statement_year
+      - collect: statement_format
+        description: "The preferred file format for the statement: PDF or CSV."
+      - collect: confirmation
+        description: "Confirms whether the user wishes to proceed; accepts True or False, yes or no."
+        utter: utter_ask_statement_download_confirmation
+        ask_before_filling: true
+        next:
+          - if: not slots.confirmation
+            then:
+              - action: utter_statement_download_cancelled
+                next: END
+          - else: initiate_download
+      - id: initiate_download
+        action: utter_statement_download_complete
+        next: END

rasa/cli/project_templates/finance/data/bills/bill_pay_reminder.yml

@@ -0,0 +1,25 @@
+flows:
+  bill_pay_reminder:
+    name: set up bill payment reminder
+    description: Help users set up automatic reminders for recurring bill payments.
+    steps:
+      - collect: biller_name
+        description: The name of the company or person the bill is paid to.
+      - collect: bill_due_date
+        description: The date the bill is due.
+      - collect: reminder_frequency
+        description: How often the reminder should be sent (once, monthly, weekly).
+      - id: confirm_reminder
+        collect: confirmation
+        utter: utter_ask_bill_pay_reminder_confirmation
+        description: Asks the user to confirm setting the reminder.
+        ask_before_filling: true
+        next:
+          - if: not slots.confirmation
+            then:
+              - action: utter_bill_pay_reminder_cancelled
+                next: END
+          - else: setup_bill_pay_reminder
+      - id: setup_bill_pay_reminder
+        action: utter_bill_pay_reminder_complete
+        next: END

rasa/cli/project_templates/finance/data/cards/activate_card.yml

@@ -0,0 +1,35 @@
+flows:
+  activate_card:
+    description: Activates user's card.
+    name: activate card
+    steps:
+      - action: utter_start_activate_card
+
+      - id: get_bank_card_number
+        collect: bank_card_number
+        description: The number of the card user wants to activate
+        ask_before_filling: true
+
+      - action: check_that_card_exists
+        next:
+          - if: not slots.return_value
+            then:
+              - action: utter_bank_card_not_found
+                next: get_bank_card_number
+          - else: activation_confirmation
+
+      - id: activation_confirmation
+        collect: confirmation
+        description: "Confirms the request for a card activation; accepts True or False, yes or no."
+        utter: utter_ask_activate_card_confirmation
+        ask_before_filling: true
+        next:
+          - if: not slots.confirmation
+            then:
+              - action: utter_activate_card_cancelled
+                next: END
+          - else: execute_activation
+
+      - id: execute_activation
+        action: utter_activate_card_successful
+        next: END