rasa-pro 3.11.3a1.dev2__py3-none-any.whl

rasa/cli/project_templates/default/domain.yml

@@ -0,0 +1,34 @@
+version: "3.1"
+
+intents:
+  - greet
+  - goodbye
+  - affirm
+  - deny
+  - mood_great
+  - mood_unhappy
+  - bot_challenge
+
+responses:
+  utter_greet:
+  - text: "Hey! How are you?"
+
+  utter_cheer_up:
+  - text: "Here is something to cheer you up:"
+    image: "https://i.imgur.com/nGF1K8f.jpg"
+
+  utter_did_that_help:
+  - text: "Did that help you?"
+
+  utter_happy:
+  - text: "Great, carry on!"
+
+  utter_goodbye:
+  - text: "Bye"
+
+  utter_iamabot:
+  - text: "I am a bot, powered by Rasa."
+
+session_config:
+  session_expiration_time: 60
+  carry_over_slots_to_new_session: true

rasa/cli/project_templates/default/endpoints.yml

@@ -0,0 +1,42 @@
+# This file contains the different endpoints your bot can use.
+
+# Server where the models are pulled from.
+# https://rasa.com/docs/rasa-pro/production/model-storage#fetching-models-from-a-server
+
+#models:
+#  url: http://my-server.com/models/default_core@latest
+#  wait_time_between_pulls:  10   # [optional](default: 100)
+
+# Server which runs your custom actions.
+# https://rasa.com/docs/rasa-pro/concepts/custom-actions
+
+#action_endpoint:
+#  url: "http://localhost:5055/webhook"
+
+# Tracker store which is used to store the conversations.
+# By default the conversations are stored in memory.
+# https://rasa.com/docs/rasa-pro/production/tracker-stores
+
+#tracker_store:
+#    type: redis
+#    url: <host of the redis instance, e.g. localhost>
+#    port: <port of your redis instance, usually 6379>
+#    db: <number of your database within redis, e.g. 0>
+#    password: <password used for authentication>
+#    use_ssl: <whether or not the communication is encrypted, default false>
+
+#tracker_store:
+#    type: mongod
+#    url: <url to your mongo instance, e.g. mongodb://localhost:27017>
+#    db: <name of the db within your mongo instance, e.g. rasa>
+#    username: <username used for authentication>
+#    password: <password used for authentication>
+
+# Event broker which all conversation events should be streamed to.
+# https://rasa.com/docs/rasa-pro/production/event-brokers
+
+#event_broker:
+#  url: localhost
+#  username: username
+#  password: password
+#  queue: queue

rasa/cli/project_templates/default/tests/test_stories.yml

@@ -0,0 +1,91 @@
+#### This file contains tests to evaluate that your bot behaves as expected.
+#### If you want to learn more, please see the docs: https://rasa.com/docs/rasa-pro/nlu-based-assistants/testing-your-assistant
+
+stories:
+- story: happy path 1
+  steps:
+  - user: |
+      hello there!
+    intent: greet
+  - action: utter_greet
+  - user: |
+      amazing
+    intent: mood_great
+  - action: utter_happy
+
+- story: happy path 2
+  steps:
+  - user: |
+      hello there!
+    intent: greet
+  - action: utter_greet
+  - user: |
+      amazing
+    intent: mood_great
+  - action: utter_happy
+  - user: |
+      bye-bye!
+    intent: goodbye
+  - action: utter_goodbye
+
+- story: sad path 1
+  steps:
+  - user: |
+      hello
+    intent: greet
+  - action: utter_greet
+  - user: |
+      not good
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      yes
+    intent: affirm
+  - action: utter_happy
+
+- story: sad path 2
+  steps:
+  - user: |
+      hello
+    intent: greet
+  - action: utter_greet
+  - user: |
+      not good
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      not really
+    intent: deny
+  - action: utter_goodbye
+
+- story: sad path 3
+  steps:
+  - user: |
+      hi
+    intent: greet
+  - action: utter_greet
+  - user: |
+      very terrible
+    intent: mood_unhappy
+  - action: utter_cheer_up
+  - action: utter_did_that_help
+  - user: |
+      no
+    intent: deny
+  - action: utter_goodbye
+
+- story: say goodbye
+  steps:
+  - user: |
+      bye-bye!
+    intent: goodbye
+  - action: utter_goodbye
+
+- story: bot challenge
+  steps:
+  - user: |
+      are you a bot?
+    intent: bot_challenge
+  - action: utter_iamabot

rasa/cli/project_templates/tutorial/actions/actions.py

@@ -0,0 +1,22 @@
+from typing import Any, Text, Dict, List
+from rasa_sdk import Action, Tracker
+from rasa_sdk.executor import CollectingDispatcher
+from rasa_sdk.events import SlotSet
+
+
+class ActionCheckSufficientFunds(Action):
+    def name(self) -> Text:
+        return "action_check_sufficient_funds"
+
+    def run(
+        self,
+        dispatcher: CollectingDispatcher,
+        tracker: Tracker,
+        domain: Dict[Text, Any],
+    ) -> List[Dict[Text, Any]]:
+        # hard-coded balance for tutorial purposes. in production this
+        # would be retrieved from a database or an API
+        balance = 1000
+        transfer_amount = tracker.get_slot("amount")
+        has_sufficient_funds = transfer_amount <= balance
+        return [SlotSet("has_sufficient_funds", has_sufficient_funds)]

rasa/cli/project_templates/tutorial/config.yml

@@ -0,0 +1,12 @@
+recipe: default.v1
+language: en
+pipeline:
+- name: SingleStepLLMCommandGenerator
+  llm:
+    model_group: rasa_command_generation_model
+  flow_retrieval:
+    active: false
+
+policies:
+  - name: FlowPolicy
+#  - name: EnterpriseSearchPolicy

rasa/cli/project_templates/tutorial/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/tutorial/data/flows.yml

@@ -0,0 +1,8 @@
+flows:
+  transfer_money:
+    description: Help users send money to friends and family.
+    steps:
+      - collect: recipient
+      - collect: amount
+        description: the number of US dollars to send
+      - action: utter_transfer_complete

rasa/cli/project_templates/tutorial/data/patterns.yml

@@ -0,0 +1,11 @@
+flows:
+  pattern_chitchat:
+    description: Conversation repair flow for off-topic interactions that won't disrupt the main conversation. should not respond to greetings or anything else for which there is a flow defined
+    name: pattern chitchat
+    steps:
+      - action: utter_free_chitchat_response
+  pattern_search:
+    description: Flow for handling knowledge-based questions
+    name: pattern search
+    steps:
+      - action: utter_free_chitchat_response

rasa/cli/project_templates/tutorial/domain.yml

@@ -0,0 +1,35 @@
+version: "3.1"
+
+slots:
+  recipient:
+    type: text
+    mappings:
+      - type: from_llm
+  amount:
+    type: float
+    mappings:
+      - type: from_llm
+
+responses:
+  utter_ask_recipient:
+    - text: "Who would you like to send money to?"
+
+  utter_ask_amount:
+    - text: "How much money would you like to send?"
+
+  utter_transfer_complete:
+    - text: "All done. {amount} has been sent to {recipient}."
+
+  utter_free_chitchat_response:
+    - text: "placeholder"
+      metadata:
+        rephrase: True
+        rephrase_prompt: |
+          The following is a conversation with an AI assistant built with Rasa.
+          The assistant can help the user transfer money.
+          The assistant is helpful, creative, clever, and very friendly.
+          The user is making small talk, and the assistant should respond, keeping things light.
+          Context / previous conversation with the user:
+          {{history}}
+          {{current_input}}
+          Suggested AI Response:

rasa/cli/project_templates/tutorial/endpoints.yml

@@ -0,0 +1,55 @@
+# This file contains the different endpoints your bot can use.
+
+# Server where the models are pulled from.
+# https://rasa.com/docs/rasa-pro/production/model-storage#fetching-models-from-a-server
+
+#models:
+#  url: http://my-server.com/models/default_core@latest
+#  wait_time_between_pulls:  10   # [optional](default: 100)
+
+# Server which runs your custom actions.
+# https://rasa.com/docs/rasa-pro/concepts/custom-actions
+
+action_endpoint:
+  actions_module: "actions"
+
+# Tracker store which is used to store the conversations.
+# By default the conversations are stored in memory.
+# https://rasa.com/docs/rasa-pro/production/tracker-stores
+
+#tracker_store:
+#    type: redis
+#    url: <host of the redis instance, e.g. localhost>
+#    port: <port of your redis instance, usually 6379>
+#    db: <number of your database within redis, e.g. 0>
+#    password: <password used for authentication>
+#    use_ssl: <whether or not the communication is encrypted, default false>
+
+#tracker_store:
+#    type: mongod
+#    url: <url to your mongo instance, e.g. mongodb://localhost:27017>
+#    db: <name of the db within your mongo instance, e.g. rasa>
+#    username: <username used for authentication>
+#    password: <password used for authentication>
+
+# Event broker which all conversation events should be streamed to.
+# https://rasa.com/docs/rasa-pro/production/event-brokers
+
+#event_broker:
+#  url: localhost
+#  username: username
+#  password: password
+#  queue: queue
+
+# Allow rephrasing of responses using a Rasa-hosted model
+nlg:
+  type: rephrase
+  llm:
+    model_group: rasa_command_generation_model
+
+model_groups:
+  - id: rasa_command_generation_model
+    models:
+      - provider: rasa
+        model: rasa/cmd_gen_codellama_13b_calm_demo
+        api_base: "https://tutorial-llm.rasa.ai"

rasa/cli/run.py

@@ -0,0 +1,143 @@
+import argparse
+import logging
+import os
+from typing import List, Text
+
+from rasa.api import run as rasa_run
+from rasa.cli import SubParsersAction
+from rasa.cli.arguments import run as arguments
+from rasa.cli.arguments.default_arguments import SkipYamlValidation
+from rasa.cli.utils import get_validated_path
+from rasa.exceptions import ModelNotFound
+from rasa.shared.constants import (
+    DEFAULT_ACTIONS_PATH,
+    DEFAULT_CREDENTIALS_PATH,
+    DEFAULT_ENDPOINTS_PATH,
+    DEFAULT_MODELS_PATH,
+    DOCS_BASE_URL,
+)
+from rasa.shared.core.domain import Domain
+from rasa.shared.utils.cli import print_error
+
+logger = logging.getLogger(__name__)
+
+
+def add_subparser(
+    subparsers: SubParsersAction, parents: List[argparse.ArgumentParser]
+) -> None:
+    """Add all run parsers.
+
+    Args:
+        subparsers: subparser we are going to attach to
+        parents: Parent parsers, needed to ensure tree structure in argparse
+    """
+    run_parser = subparsers.add_parser(
+        "run",
+        parents=parents,
+        conflict_handler="resolve",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        help="Starts a Rasa server with your trained model.",
+    )
+    run_parser.set_defaults(func=run)
+
+    run_subparsers = run_parser.add_subparsers()
+    sdk_subparser = run_subparsers.add_parser(
+        "actions",
+        parents=parents,
+        conflict_handler="resolve",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        help="Runs the action server.",
+    )
+    sdk_subparser.set_defaults(func=run_actions)
+
+    arguments.set_run_arguments(run_parser)
+    arguments.set_run_action_arguments(sdk_subparser)
+
+
+def run_actions(args: argparse.Namespace) -> None:
+    import rasa_sdk.__main__ as sdk
+
+    args.actions = args.actions or DEFAULT_ACTIONS_PATH
+
+    sdk.main_from_args(args)
+
+
+def _validate_model_path(model_path: Text, parameter: Text, default: Text) -> Text:
+    if model_path is not None and not os.path.exists(model_path):
+        reason_str = f"'{model_path}' not found."
+        if model_path is None:
+            reason_str = f"Parameter '{parameter}' not set."
+
+        logger.debug(f"{reason_str} Using default location '{default}' instead.")
+
+        os.makedirs(default, exist_ok=True)
+        model_path = default
+
+    return model_path
+
+
+def run(args: argparse.Namespace) -> None:
+    """Entrypoint for `rasa run`.
+
+    Args:
+        args: The CLI arguments.
+    """
+    args.endpoints = get_validated_path(
+        args.endpoints, "endpoints", DEFAULT_ENDPOINTS_PATH, True
+    )
+    args.credentials = get_validated_path(
+        args.credentials, "credentials", DEFAULT_CREDENTIALS_PATH, True
+    )
+
+    if SkipYamlValidation.DOMAIN.value in args.skip_yaml_validation:
+        Domain.validate_yaml = False
+    else:
+        Domain.validate_yaml = True
+
+    if args.enable_api:
+        if not args.remote_storage:
+            args.model = _validate_model_path(args.model, "model", DEFAULT_MODELS_PATH)
+        rasa_run(**vars(args))
+        return
+
+    # if the API is not enable you cannot start without a model
+    # make sure either a model server, a remote storage, or a local model is
+    # configured
+
+    import rasa.model
+    from rasa.core.utils import AvailableEndpoints
+
+    # start server if remote storage is configured
+    if args.remote_storage is not None:
+        rasa_run(**vars(args))
+        return
+
+    # start server if model server is configured
+    endpoints = AvailableEndpoints.get_instance(args.endpoints)
+    model_server = endpoints.model if endpoints and endpoints.model else None
+    if model_server is not None:
+        rasa_run(**vars(args))
+        return
+
+    # start server if local model found
+    args.model = _validate_model_path(args.model, "model", DEFAULT_MODELS_PATH)
+    local_model_set = True
+    try:
+        rasa.model.get_local_model(args.model)
+    except ModelNotFound:
+        local_model_set = False
+
+    if local_model_set:
+        rasa_run(**vars(args))
+        return
+
+    print_error(
+        f"No model found. You have three options to provide a model:\n"
+        f"1. Configure a model server in the endpoint configuration and provide "
+        f"the configuration via '--endpoints'.\n"
+        f"2. Specify a remote storage via '--remote-storage' to load the model "
+        f"from.\n"
+        f"3. Train a model before running the server using `rasa train` and "
+        f"use '--model' to provide the model path.\n"
+        f"For more information check {DOCS_BASE_URL}/model-storage."
+    )