rasa-pro 3.13.0rc4__py3-none-any.whl → 3.13.1a3__py3-none-any.whl

rasa/builder/training_service.py

@@ -0,0 +1,123 @@
+"""Functions for training and loading Rasa models."""
+
+import tempfile
+
+import structlog
+
+from rasa.builder import config
+from rasa.builder.exceptions import AgentLoadError, TrainingError
+from rasa.core import agent
+from rasa.core.utils import AvailableEndpoints, read_endpoints_from_path
+from rasa.model_training import train
+from rasa.shared.importers.importer import TrainingDataImporter
+from rasa.shared.utils.yaml import dump_obj_as_yaml_to_string
+
+structlogger = structlog.get_logger()
+
+
+async def train_and_load_agent(importer: TrainingDataImporter) -> agent.Agent:
+    """Train a model and load an agent.
+
+    Args:
+        importer: Training data importer with domain, flows, and config
+
+    Returns:
+        Loaded and ready agent
+
+    Raises:
+        TrainingError: If training fails
+        AgentLoadError: If agent loading fails
+    """
+    try:
+        # Setup endpoints for training validation
+        await _setup_endpoints()
+
+        # Train the model
+        training_result = await _train_model(importer)
+
+        # Load the agent
+        agent_instance = await _load_agent(training_result.model)
+
+        # Verify agent is ready
+        if not agent_instance.is_ready():
+            raise AgentLoadError("Agent failed to load properly - model is not ready")
+
+        structlogger.info("training.agent_ready", model_path=training_result.model)
+
+        return agent_instance
+
+    except (TrainingError, AgentLoadError):
+        raise
+    except Exception as e:
+        raise TrainingError(f"Unexpected error during training: {e}")
+
+
+async def _setup_endpoints():
+    """Setup endpoints configuration for training."""
+    try:
+        with tempfile.NamedTemporaryFile(
+            mode="w", suffix=".yml", delete=False
+        ) as temp_file:
+            endpoints_yaml = dump_obj_as_yaml_to_string(config.get_default_endpoints())
+            temp_file.write(endpoints_yaml)
+            temp_file.flush()
+
+            # Reset and load endpoints
+            AvailableEndpoints.reset_instance()
+            read_endpoints_from_path(temp_file.name)
+
+            structlogger.debug("training.endpoints_setup", temp_file=temp_file.name)
+
+    except Exception as e:
+        raise TrainingError(f"Failed to setup endpoints: {e}")
+
+
+async def _train_model(importer: TrainingDataImporter):
+    """Train the Rasa model."""
+    try:
+        structlogger.info("training.started")
+
+        training_result = await train(
+            domain="",
+            config="",
+            training_files=None,
+            file_importer=importer,
+        )
+
+        if not training_result or not training_result.model:
+            raise TrainingError("Training completed but no model was produced")
+
+        structlogger.info("training.completed", model_path=training_result.model)
+
+        return training_result
+
+    except Exception as e:
+        raise TrainingError(f"Model training failed: {e}")
+
+
+async def _load_agent(model_path: str) -> agent.Agent:
+    """Load the trained agent."""
+    try:
+        structlogger.info("training.loading_agent", model_path=model_path)
+
+        available_endpoints = AvailableEndpoints.get_instance()
+        if available_endpoints is None:
+            raise AgentLoadError("No endpoints available for agent loading")
+
+        agent_instance = await agent.load_agent(
+            model_path=model_path,
+            remote_storage=None,
+            endpoints=available_endpoints,
+        )
+
+        if agent_instance is None:
+            raise AgentLoadError("Agent loading returned None")
+
+        structlogger.info("training.agent_loaded", model_path=model_path)
+
+        return agent_instance
+
+    except AgentLoadError:
+        raise
+    except Exception as e:
+        raise AgentLoadError(f"Failed to load agent: {e}")

rasa/builder/validation_service.py

@@ -0,0 +1,79 @@
+"""Functions for validating Rasa projects."""
+
+import sys
+from contextlib import contextmanager
+from typing import Optional
+
+import structlog
+from structlog.testing import capture_logs
+
+from rasa.builder import config
+from rasa.builder.exceptions import ValidationError
+from rasa.cli.utils import validate_files
+from rasa.shared.importers.importer import TrainingDataImporter
+
+structlogger = structlog.get_logger()
+
+
+@contextmanager
+def _mock_sys_exit():
+    """Context manager to prevent sys.exit from being called during validation."""
+    was_sys_exit_called = {"value": False}
+
+    def sys_exit_mock(code: int = 0):
+        was_sys_exit_called["value"] = True
+
+    original_exit = sys.exit
+    sys.exit = sys_exit_mock
+
+    try:
+        yield was_sys_exit_called
+    finally:
+        sys.exit = original_exit
+
+
+async def validate_project(importer: TrainingDataImporter) -> Optional[str]:
+    """Validate a Rasa project.
+
+    Args:
+        importer: Training data importer with domain, flows, and config
+
+    Returns:
+        None if validation passes, error message if validation fails.
+
+    Raises:
+        ValidationError: If validation fails
+    """
+    try:
+        with _mock_sys_exit() as exit_tracker:
+            with capture_logs() as cap_logs:
+                validate_files(
+                    fail_on_warnings=config.VALIDATION_FAIL_ON_WARNINGS,
+                    max_history=config.VALIDATION_MAX_HISTORY,
+                    importer=importer,
+                )
+
+            if exit_tracker["value"]:
+                error_logs = [
+                    log for log in cap_logs if log.get("log_level") != "debug"
+                ]
+                structlogger.error(
+                    "validation.failed.sys_exit",
+                    error_logs=error_logs,
+                )
+                raise ValidationError(
+                    "Validation failed with sys.exit", validation_logs=error_logs
+                )
+
+            structlogger.info("validation.success")
+            return None
+
+    except ValidationError:
+        raise
+    except Exception as e:
+        error_msg = f"Validation failed with exception: {e}"
+        structlogger.error(
+            "validation.failed.exception",
+            error=str(e),
+        )
+        raise ValidationError(error_msg)

rasa/cli/project_templates/finance/config.yml

@@ -0,0 +1,17 @@
+# The config recipe.
+recipe: default.v1
+
+# The assistant project unique identifier
+# This default value must be replaced with a unique assistant name within your deployment
+assistant_id: placeholder_default
+
+language: en
+pipeline:
+- name: CompactLLMCommandGenerator
+  llm:
+    model_group: openai-gpt-4o
+
+# Configuration for Rasa Core.
+policies:
+- name: FlowPolicy
+- name: IntentlessPolicy

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

@@ -0,0 +1,5 @@
+flows:
+  transfer_money:
+    description: Transfer money between accounts.
+    steps:
+      - action: utter_transfer_money

rasa/cli/project_templates/finance/data/patterns/pattern_session_start.yml

@@ -0,0 +1,7 @@
+flows:
+  pattern_session_start:
+    description: Custom session start to greet the user.
+    nlu_trigger:
+      - intent: session_start
+    steps:
+      - action: utter_greet

rasa/cli/project_templates/finance/domain.yml

@@ -0,0 +1,7 @@
+version: "3.1"
+
+responses:
+  utter_greet:
+    - text: "Hello! Welcome to your finance assistant. How can I help you today?"
+  utter_transfer_money:
+    - text: "I'm sorry, I can't transfer money between accounts."

rasa/cli/project_templates/finance/endpoints.yml

@@ -0,0 +1,58 @@
+# 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
+
+# The lines below activate contextual rephrasing, using the default OpenAI language model.
+# Ensure the OPENAI_API_KEY is set to prevent any missing API key errors.
+# For more details, refer to the documentation:
+# https://rasa.com/docs/rasa-pro/concepts/contextual-response-rephraser
+# To enable the rephraser, remove the comment symbols in the lines below.
+#nlg:
+#   type: rephrase
+
+model_groups:
+  - id: openai-gpt-4o
+    models:
+      - provider: openai
+        model: gpt-4o-2024-11-20
+        request_timeout: 7
+        max_tokens: 256

rasa/cli/project_templates/plain/config.yml

@@ -0,0 +1,17 @@
+# The config recipe.
+recipe: default.v1
+
+# The assistant project unique identifier
+# This default value must be replaced with a unique assistant name within your deployment
+assistant_id: placeholder_default
+
+language: en
+pipeline:
+- name: CompactLLMCommandGenerator
+  llm:
+    model_group: openai-gpt-4o
+
+# Configuration for Rasa Core.
+policies:
+- name: FlowPolicy
+- name: IntentlessPolicy

rasa/cli/project_templates/plain/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/plain/data/patterns/pattern_session_start.yml

@@ -0,0 +1,7 @@
+flows:
+  pattern_session_start:
+    description: Custom session start to greet the user.
+    nlu_trigger:
+      - intent: session_start
+    steps:
+      - action: utter_greet

rasa/cli/project_templates/plain/domain.yml

@@ -0,0 +1,5 @@
+version: "3.1"
+
+responses:
+  utter_greet:
+    - text: "Hello! Welcome to your finance assistant. How can I help you today?"

rasa/cli/project_templates/plain/endpoints.yml

@@ -0,0 +1,58 @@
+# 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
+
+# The lines below activate contextual rephrasing, using the default OpenAI language model.
+# Ensure the OPENAI_API_KEY is set to prevent any missing API key errors.
+# For more details, refer to the documentation:
+# https://rasa.com/docs/rasa-pro/concepts/contextual-response-rephraser
+# To enable the rephraser, remove the comment symbols in the lines below.
+#nlg:
+#   type: rephrase
+
+model_groups:
+  - id: openai-gpt-4o
+    models:
+      - provider: openai
+        model: gpt-4o-2024-11-20
+        request_timeout: 7
+        max_tokens: 256

rasa/cli/project_templates/telecom/config.yml

@@ -0,0 +1,17 @@
+# The config recipe.
+recipe: default.v1
+
+# The assistant project unique identifier
+# This default value must be replaced with a unique assistant name within your deployment
+assistant_id: placeholder_default
+
+language: en
+pipeline:
+- name: CompactLLMCommandGenerator
+  llm:
+    model_group: openai-gpt-4o
+
+# Configuration for Rasa Core.
+policies:
+- name: FlowPolicy
+- name: IntentlessPolicy

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

@@ -0,0 +1,5 @@
+flows:
+  upgrade_contract:
+    description: Upgrade contract.
+    steps:
+      - action: utter_upgrade_contract

rasa/cli/project_templates/telecom/data/patterns/pattern_session_start.yml

@@ -0,0 +1,7 @@
+flows:
+  pattern_session_start:
+    description: Custom session start to greet the user.
+    nlu_trigger:
+      - intent: session_start
+    steps:
+      - action: utter_greet

rasa/cli/project_templates/telecom/domain.yml

@@ -0,0 +1,7 @@
+version: "3.1"
+
+responses:
+  utter_greet:
+    - text: "Hello! Welcome to your telecom assistant. How can I help you today?"
+  utter_upgrade_contract:
+    - text: "I'm sorry, I can't upgrade your contract."

rasa/cli/project_templates/telecom/endpoints.yml

@@ -0,0 +1,58 @@
+# 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
+
+# The lines below activate contextual rephrasing, using the default OpenAI language model.
+# Ensure the OPENAI_API_KEY is set to prevent any missing API key errors.
+# For more details, refer to the documentation:
+# https://rasa.com/docs/rasa-pro/concepts/contextual-response-rephraser
+# To enable the rephraser, remove the comment symbols in the lines below.
+#nlg:
+#   type: rephrase
+
+model_groups:
+  - id: openai-gpt-4o
+    models:
+      - provider: openai
+        model: gpt-4o-2024-11-20
+        request_timeout: 7
+        max_tokens: 256

rasa/cli/scaffold.py

@@ -24,10 +24,21 @@ class ProjectTemplateName(Enum):
 
     DEFAULT = "default"
     TUTORIAL = "tutorial"
+    PLAIN = "plain"
+    FINANCE = "finance"
+    TELECOM = "telecom"
 
     def __str__(self) -> str:
         return self.value
 
+    @classmethod
+    def get_all_values(cls) -> List[str]:
+        return [name.value for name in cls]
+
+    @classmethod
+    def supported_values(cls) -> str:
+        return ", ".join(cls.get_all_values())
+
 
 template_domain_path = defaultdict(lambda: DEFAULT_DOMAIN_PATH)
 template_domain_path[ProjectTemplateName.DEFAULT] = "domain"
@@ -159,9 +170,15 @@ def create_initial_project(
     path: Text, template: ProjectTemplateName = ProjectTemplateName.DEFAULT
 ) -> None:
     """Creates directory structure and templates for initial project."""
-    from distutils.dir_util import copy_tree
-
-    copy_tree(scaffold_path(template), path)
+    import distutils.dir_util as dir_util
+
+    # clear the cache of the copy_tree function, this avoids issues if
+    # a project directory existed before and we removed folders in it
+    # with shutil.rmtree. see
+    # https://stackoverflow.com/questions/9160227/dir-util-copy-tree-fails-after-shutil-rmtree
+    if hasattr(dir_util, "_path_created"):
+        dir_util._path_created.clear()
+    dir_util.copy_tree(scaffold_path(template), path)
 
 
 def scaffold_path(template: ProjectTemplateName) -> Text:

rasa/core/actions/action.py

@@ -908,10 +908,12 @@ class RemoteAction(Action):
                 draft.setdefault("buttons", [])
                 draft["buttons"].extend(buttons)
 
-            # Avoid overwriting `draft` values with empty values
             response = {k: v for k, v in response.items() if v}
-            draft.update(response)
-            bot_messages.append(create_bot_utterance(draft, tracker.current_language))
+
+            response.update(draft)
+            bot_messages.append(
+                create_bot_utterance(response, tracker.current_language)
+            )
 
         return bot_messages