rasa-pro 3.9.18__py3-none-any.whl

rasa/cli/license.py

@@ -0,0 +1,65 @@
+import argparse
+from typing import List
+
+import rasa.shared.utils.cli
+from rasa.cli import SubParsersAction
+
+
+def add_subparser(
+    subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]
+) -> None:
+    """Add license parser.
+
+    Args:
+        subparsers: subparser we are going to attach to
+        parents: Parent parsers, needed to ensure tree structure in argparse
+    """
+    license_parser = subparsers.add_parser(
+        "license",
+        parents=parents,
+        help="Displays licensing information.",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="Display licensing information.",
+    )
+    license_parser.set_defaults(func=display_license_information)
+
+
+def display_license_information(_: argparse.Namespace) -> None:
+    """Display licensing information to stdout."""
+    rasa.shared.utils.cli.print_info(
+        "By installing and using this software, you agree to be "
+        "bound by the terms and conditions of the Developer Terms "
+        "available at https://rasa.com/developer-terms. "
+        "Please review the Developer Terms carefully before proceeding.\n\n"
+        "Rasa Pro relies on several 3rd-party dependencies. "
+        "The ones below require a license disclorure:\n",
+        PSYCOPG2_LICENSE_DISCLOSURE,
+    )
+
+
+PSYCOPG2_LICENSE_DISCLOSURE = """
+psycopg2 & psycopg2-binary
+--------------------------
+
+psycopg2 and the LGPL
+
+psycopg2 is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+psycopg2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+
+In addition, as a special exception, the copyright holders give permission to link this program with the OpenSSL library (or with modified versions of OpenSSL that use the same license as OpenSSL), and distribute linked combinations including the two.
+
+You must obey the GNU Lesser General Public License in all respects for all of the code used other than OpenSSL. If you modify file(s) with this exception, you may extend this exception to your version of the file(s), but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version. If you delete this exception statement from all source files in the program, then also delete it here.
+
+You should have received a copy of the GNU Lesser General Public License along with psycopg2 (see the doc/ directory.) If not, see https://www.gnu.org/licenses/. Alternative licenses
+
+The following BSD-like license applies (at your option) to the files following the pattern psycopg/adapter*.{h,c} and psycopg/microprotocol*.{h,c}:
+
+Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
+
+The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
+
+Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
+
+This notice may not be removed or altered from any source distribution.
+"""  # noqa: E501

rasa/cli/markers.py

@@ -0,0 +1,78 @@
+import argparse
+from pathlib import Path
+from typing import List, Text
+
+from rasa.cli import SubParsersAction
+from rasa.cli.arguments.default_arguments import add_domain_param
+from rasa.shared.core.domain import Domain
+from rasa.shared.utils.cli import print_error_and_exit
+
+from rasa.markers.upload import upload
+
+
+def add_subparser(
+    subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]
+) -> None:
+    """Add all marker parsers.
+
+    Args:
+        subparsers: subparser we are going to attach to
+        parents: Parent parsers, needed to ensure tree structure in argparse
+    """
+    markers_parser = subparsers.add_parser(
+        "markers",
+        parents=parents,
+        conflict_handler="resolve",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        help="Rasa Studio commands.",
+    )
+    marker_subparser = markers_parser.add_subparsers()
+
+    _add_upload_subparser(marker_subparser, parents)
+
+
+def _add_upload_subparser(
+    marker_sub_parsers: SubParsersAction, parents: List[argparse.ArgumentParser]
+) -> None:
+    marker_upload_sub_parser = marker_sub_parsers.add_parser(
+        "upload",
+        parents=parents,
+        conflict_handler="resolve",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        help="Upload Markers to Rasa Pro Services",
+    )
+
+    marker_upload_sub_parser.set_defaults(func=_upload_markers)
+
+    marker_upload_sub_parser.add_argument(
+        "--config",
+        default="markers.yml",
+        type=Path,
+        help="The marker configuration file(s) containing marker definitions. "
+        "This can be a single YAML file, or a directory that contains several "
+        "files with marker definitions in it. The content of these files will "
+        "be read and merged together.",
+    )
+
+    marker_upload_sub_parser.add_argument(
+        "--rasa-pro-services-url",
+        default="",
+        type=Text,
+        help="The URL of the Rasa Pro Services instance to upload markers to."
+        "Specified URL should not contain a trailing slash.",
+    )
+
+    add_domain_param(marker_upload_sub_parser)
+
+
+def _upload_markers(args: argparse.Namespace) -> None:
+    markers_path = args.config
+    domain_path = args.domain
+    url = args.rasa_pro_services_url
+
+    domain = Domain.load(domain_path) if domain_path else None
+
+    if domain is None:
+        print_error_and_exit("No domain specified. Skipping validation.")
+
+    upload(url=url, domain=domain, markers_path=markers_path)

rasa/cli/project_templates/calm/actions/action_template.py

@@ -0,0 +1,27 @@
+# This files contains your custom actions which can be used to run
+# custom Python code.
+#
+# See this guide on how to implement these action:
+# https://rasa.com/docs/rasa-pro/concepts/custom-actions
+
+
+# This is a simple example for a custom action which utters "Hello World!"
+
+# from typing import Any, Text, Dict, List
+#
+# from rasa_sdk import Action, Tracker
+# from rasa_sdk.executor import CollectingDispatcher
+#
+#
+# class ActionHelloWorld(Action):
+#
+#     def name(self) -> Text:
+#         return "action_hello_world"
+#
+#     def run(self, dispatcher: CollectingDispatcher,
+#             tracker: Tracker,
+#             domain: Dict[Text, Any]) -> List[Dict[Text, Any]]:
+#
+#         dispatcher.utter_message(text="Hello World!")
+#
+#         return []

rasa/cli/project_templates/calm/actions/add_contact.py

@@ -0,0 +1,30 @@
+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 add_contact, get_contacts, Contact
+
+
+class AddContact(Action):
+    def name(self) -> str:
+        return "add_contact"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[Text, 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/calm/actions/db.py

@@ -0,0 +1,57 @@
+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"
+
+
+class Contact(BaseModel):
+    name: str
+    handle: str
+
+
+def get_session_db_path(session_id: str) -> str:
+    tempdir = tempfile.gettempdir()
+    project_name = "calm_starter"
+    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 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 write_contacts(session_id: str, contacts: List[Contact]) -> None:
+    write_db(session_id, CONTACTS, [c.dict() for c in contacts])

rasa/cli/project_templates/calm/actions/list_contacts.py

@@ -0,0 +1,22 @@
+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_contacts
+
+
+class ListContacts(Action):
+    def name(self) -> str:
+        return "list_contacts"
+
+    def run(
+        self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict[str, Any]
+    ) -> List[Dict[Text, 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/calm/actions/remove_contact.py

@@ -0,0 +1,35 @@
+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_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[Text, 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/calm/config.yml

@@ -0,0 +1,12 @@
+recipe: default.v1
+language: en
+pipeline:
+- name: SingleStepLLMCommandGenerator
+  llm:
+    model_name: gpt-4
+    request_timeout: 7
+    max_tokens: 256
+
+policies:
+- name: FlowPolicy
+- name: IntentlessPolicy

rasa/cli/project_templates/calm/credentials.yml

@@ -0,0 +1,33 @@
+# 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:
+#  # you don't need to provide anything here - this channel doesn't
+#  # require any credentials
+
+
+#facebook:
+#  verify: "<verify>"
+#  secret: "<your secret>"
+#  page-access-token: "<your page access token>"
+
+#slack:
+#  slack_token: "<your slack token>"
+#  slack_channel: "<the slack channel>"
+#  slack_signing_secret: "<your slack signing secret>"
+
+#socketio:
+#  user_message_evt: <event name for user message>
+#  bot_message_evt: <event name for bot messages>
+#  session_persistence: <true/false>
+
+#mattermost:
+#  url: "https://<mattermost instance>/api/v4"
+#  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/calm/data/flows/add_contact.yml

@@ -0,0 +1,31 @@
+flows:
+  add_contact:
+    description: add a contact to your contact list
+    name: add a contact
+    steps:
+      - collect: "add_contact_handle"
+        description: "a user handle starting with @"
+      - collect: "add_contact_name"
+        description: "a name of a person"
+      - collect: "add_contact_confirmation"
+        ask_before_filling: true
+        next:
+          - if: "slots.add_contact_confirmation is not true"
+            then:
+              - action: utter_add_contact_cancelled
+                next: END
+          - else: add_contact
+      - id: add_contact
+        action: add_contact
+        next:
+          - if: "slots.return_value = 'success'"
+            then:
+              - action: utter_contact_added
+                next: END
+          - if: "slots.return_value = 'already_exists'"
+            then:
+              - action: utter_contact_already_exists
+                next: END
+          - else:
+              - action: utter_add_contact_error
+                next: END

rasa/cli/project_templates/calm/data/flows/list_contacts.yml

@@ -0,0 +1,14 @@
+flows:
+  list_contacts:
+    name: list your contacts
+    description: show your contact list
+    steps:
+      - action: list_contacts
+        next:
+          - if: "slots.contacts_list"
+            then:
+              - action: utter_list_contacts
+                next: END
+          - else:
+              - action: utter_no_contacts
+                next: END

rasa/cli/project_templates/calm/data/flows/remove_contact.yml

@@ -0,0 +1,29 @@
+flows:
+  remove_contact:
+    name: remove a contact
+    description: remove a contact from your contact list
+    steps:
+      - collect: "remove_contact_handle"
+        description: "a contact handle starting with @"
+      - collect: "remove_contact_confirmation"
+        ask_before_filling: true
+        next:
+          - if: "slots.remove_contact_confirmation is not true"
+            then:
+              - action: utter_remove_contact_cancelled
+                next: END
+          - else: remove_contact
+      - id: "remove_contact"
+        action: remove_contact
+        next:
+          - if: "slots.return_value == 'success'"
+            then:
+              - action: utter_remove_contact_success
+                next: END
+          - if: "slots.return_value == 'not_found'"
+            then:
+              - action: utter_contact_not_in_list
+                next: END
+          - else:
+              - action: utter_remove_contact_error
+                next: END

rasa/cli/project_templates/calm/db/contacts.json

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "Joe",
+    "handle": "@JoeMyers"
+  },
+  {
+    "name": "Mary",
+    "handle": "@MaryLu"
+  }
+]

rasa/cli/project_templates/calm/domain/add_contact.yml

@@ -0,0 +1,39 @@
+version: "3.1"
+
+actions:
+  - add_contact
+
+slots:
+  add_contact_confirmation:
+    type: bool
+    mappings:
+      - type: from_llm
+  add_contact_name:
+    type: text
+    mappings:
+      - type: from_llm
+  add_contact_handle:
+    type: text
+    mappings:
+      - type: from_llm
+
+responses:
+  utter_ask_add_contact_confirmation:
+    - text: Do you want to add {add_contact_name}({add_contact_handle}) to your contacts?
+      buttons:
+        - payload: "/SetSlots(add_contact_confirmation=true)"
+          title: Yes
+        - payload: "/SetSlots(add_contact_confirmation=false)"
+          title: No, cancel
+  utter_ask_add_contact_handle:
+    - text: What's the handle of the user you want to add?
+  utter_ask_add_contact_name:
+    - text: What's the name of the user you want to add?
+  utter_add_contact_error:
+    - text: "Something went wrong, please try again."
+  utter_add_contact_cancelled:
+    - text: "Okay, I am cancelling this adding of a contact."
+  utter_contact_already_exists:
+    - text: "There's already a contact with that handle in your list."
+  utter_contact_added:
+    - text: "Contact added successfully."

rasa/cli/project_templates/calm/domain/list_contacts.yml

@@ -0,0 +1,17 @@
+version: "3.1"
+
+actions:
+  - list_contacts
+
+slots:
+  contacts_list:
+    type: text
+    mappings:
+      - type: custom
+        action: list_contacts
+
+responses:
+  utter_no_contacts:
+    - text: "You have no contacts in your list."
+  utter_list_contacts:
+    - text: "You currently have the following contacts:\n{contacts_list}"

rasa/cli/project_templates/calm/domain/remove_contact.yml

@@ -0,0 +1,38 @@
+version: "3.1"
+
+actions:
+  - remove_contact
+
+slots:
+  remove_contact_name:
+    type: text
+    mappings:
+      - type: custom
+        action: remove_contact
+  remove_contact_handle:
+    type: text
+    mappings:
+      - type: from_llm
+  remove_contact_confirmation:
+    type: text
+    mappings:
+      - type: from_llm
+
+responses:
+  utter_ask_remove_contact_handle:
+    - text: What's the handle of the user you want to remove?
+  utter_contact_not_in_list:
+    - text: "That contact is not in your list."
+  utter_remove_contact_error:
+    - text: "Something went wrong, please try again."
+  utter_remove_contact_success:
+     - text: "Removed {remove_contact_handle}({remove_contact_name}) from your contacts."
+  utter_ask_remove_contact_confirmation:
+    - buttons:
+        - payload: "/SetSlots(remove_contact_confirmation=true)"
+          title: Yes
+        - payload: "/SetSlots(remove_contact_confirmation=false)"
+          title: No, cancel the removal
+      text: "Should I remove {remove_contact_handle} from your contact list?"
+  utter_remove_contact_cancelled:
+    - text: "Okay, I am cancelling this removal of a contact."

rasa/cli/project_templates/calm/domain/shared.yml

@@ -0,0 +1,10 @@
+version: "3.1"
+
+slots:
+  return_value:
+    type: any
+    mappings:
+      - type: custom
+        action: add_contact
+      - type: custom
+        action: remove_contact

rasa/cli/project_templates/calm/e2e_tests/cancelations/user_cancels_during_a_correction.yml

@@ -0,0 +1,16 @@
+test_cases:
+  - test_case: user cancels adding a contact during the correction
+    steps:
+      - user: I want to add a new contact
+      - utter: utter_ask_add_contact_handle
+      - user: it's @foo
+      - slot_was_set:
+          - add_contact_handle: "@foo"
+      - utter: utter_ask_add_contact_name
+      - user: Wait, no, the handle is @bar
+      - slot_was_set:
+          - add_contact_handle: "@bar"
+      - utter: utter_corrected_previous_input
+      - utter: utter_ask_add_contact_name
+      - user: I changed my mind, stop.
+      - utter: utter_flow_cancelled_rasa

rasa/cli/project_templates/calm/e2e_tests/cancelations/user_changes_mind_on_a_whim.yml

@@ -0,0 +1,7 @@
+test_cases:
+  - test_case: user changes mind based on new info
+    steps:
+      - user: I want to add contact
+      - utter: utter_ask_add_contact_handle
+      - user: Stop
+      - utter: utter_flow_cancelled_rasa

rasa/cli/project_templates/calm/e2e_tests/corrections/user_corrects_contact_handle.yml

@@ -0,0 +1,20 @@
+test_cases:
+  - test_case: user corrects the handle
+    steps:
+      - user: I want to add a new contact
+      - utter: utter_ask_add_contact_handle
+      - user: it's @foo
+      - slot_was_set:
+          - add_contact_handle: "@foo"
+      - utter: utter_ask_add_contact_name
+      - user: Wait, no, the handle is @bar
+      - slot_was_set:
+          - add_contact_handle: "@bar"
+      - utter: utter_corrected_previous_input
+      - utter: utter_ask_add_contact_name
+      - user: It's Barbar
+      - slot_was_set:
+          - add_contact_name: "Barbar"
+      - utter: utter_ask_add_contact_confirmation
+      - user: Yes
+      - utter: utter_contact_added

rasa/cli/project_templates/calm/e2e_tests/corrections/user_corrects_contact_name.yml

@@ -0,0 +1,19 @@
+test_cases:
+  - test_case: user corrects the handle
+    steps:
+      - user: I want to add a new contact
+      - utter: utter_ask_add_contact_handle
+      - user: it's @jane
+      - slot_was_set:
+          - add_contact_handle: "@jane"
+      - utter: utter_ask_add_contact_name
+      - user: It's Jane Bar
+      - slot_was_set:
+          - add_contact_name: "Jane Bar"
+      - user: Wait, it's Jane Foo
+      - slot_was_set:
+          - add_contact_name: "Jane Foo"
+      - utter: utter_corrected_previous_input
+      - utter: utter_ask_add_contact_confirmation
+      - user: Yes
+      - utter: utter_contact_added

rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_adds_contact_to_their_list.yml

@@ -0,0 +1,15 @@
+test_cases:
+  - test_case: user adds a contact to their list
+    steps:
+      - user: I want to add someone to my contact list
+      - utter: utter_ask_add_contact_handle
+      - user: it's @barts
+      - slot_was_set:
+          - add_contact_handle: "@barts"
+      - utter: utter_ask_add_contact_name
+      - user: just Bart
+      - slot_was_set:
+          - add_contact_name: Bart
+      - utter: utter_ask_add_contact_confirmation
+      - user: Yes
+      - utter: utter_contact_added

rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_lists_contacts.yml

@@ -0,0 +1,5 @@
+test_cases:
+  - test_case: user lists their contacts
+    steps:
+      - user: Please show me my contacts
+      - utter: utter_list_contacts

rasa/cli/project_templates/calm/e2e_tests/happy_paths/user_removes_contact.yml

@@ -0,0 +1,11 @@
+test_cases:
+  - test_case: user removes a contact
+    steps:
+      - user: I want to remove contact
+      - utter: utter_ask_remove_contact_handle
+      - user: "@MaryLu"
+      - slot_was_set:
+          - remove_contact_handle: "@MaryLu"
+      - utter: utter_ask_remove_contact_confirmation
+      - user: Yes
+      - utter: utter_remove_contact_success