rasa-pro 3.12.18__py3-none-any.whl → 3.13.0a1.dev1__py3-none-any.whl

rasa/builder/scrape_rasa_docs.py

@@ -0,0 +1,97 @@
+import json
+import os
+from pathlib import Path
+from urllib.parse import urljoin, urlparse
+
+import requests
+from bs4 import BeautifulSoup
+
+BASE_URL = "https://rasa.com"
+DOCS_ROOT = "https://rasa.com/docs"
+OUTPUT_DIR = "rasa_docs_md"
+MAX_PAGES = 100  # Optional limit for safety
+
+visited = set()
+to_visit = [DOCS_ROOT]
+
+os.makedirs(OUTPUT_DIR, exist_ok=True)
+
+
+def is_valid_doc_url(url):
+    return url.startswith(DOCS_ROOT) and not any(
+        [url.endswith(".pdf"), "#" in url, "mailto:" in url]
+    )
+
+
+def slugify_url(url):
+    path = urlparse(url).path.strip("/").replace("/", "_")
+    return path if path else "index"
+
+
+def clean_text(html):
+    soup = BeautifulSoup(html, "html.parser")
+
+    # Remove navs, footers, and code tabs (customize if needed)
+    for tag in soup(["nav", "footer", "script", "style", "form", "button"]):
+        tag.decompose()
+
+    main = soup.find("main") or soup.body
+    if not main:
+        return ""
+
+    # Replace <code> with backticks
+    for code in main.find_all("code"):
+        code.string = f"`{code.get_text(strip=True)}`"
+
+    text = main.get_text(separator="\n", strip=True)
+    return text
+
+
+def save_as_markdown(text) -> str:
+    slug = slugify_url(url)
+    file_name = f"{slug}.md"
+    md_path = Path(OUTPUT_DIR) / file_name
+    with open(md_path, "w", encoding="utf-8") as f:
+        f.write(text)
+
+    print(f"✅ Saved: {md_path}")
+    return file_name
+
+
+pages_scraped = 0
+markdown_to_url = {}
+
+while to_visit and pages_scraped < MAX_PAGES:
+    url = to_visit.pop(0)
+    if url in visited:
+        continue
+
+    try:
+        print(f"Scraping: {url}")
+        response = requests.get(url)
+        response.raise_for_status()
+
+        html = response.text
+        text = clean_text(html)
+        if len(text) < 200:  # skip very short pages
+            print("⏭️ Skipped (too short)")
+            continue
+
+        file_name = save_as_markdown(text)
+        markdown_to_url[file_name] = url
+        pages_scraped += 1
+
+        soup = BeautifulSoup(html, "html.parser")
+        for link_tag in soup.find_all("a", href=True):
+            link = urljoin(url, link_tag["href"])
+            if is_valid_doc_url(link) and link not in visited:
+                to_visit.append(link)
+
+        visited.add(url)
+
+    except Exception as e:
+        print(f"⚠️ Failed to scrape {url}: {e}")
+
+
+with open("markdown_to_url.json", "w") as f:
+    json.dump(markdown_to_url, f, indent=2)

rasa/builder/skill_to_bot_prompt.jinja

@@ -0,0 +1,158 @@
+# Rasa CALM Flow and Domain YAML Generator
+
+You are an expert in creating Rasa CALM flows and domain JSON configurations. Your task is to generate these JSON files based on a user's description of a conversational skill. The user may not be familiar with Rasa, so it's crucial to interpret their requirements accurately and create a well-structured, functional Rasa configuration.
+
+## Input
+You will receive a description of a conversational skill. This description will be inserted where you see [USER_SKILL_DESCRIPTION] in this prompt.
+
+## Output
+Generate a JSON configurations that includes:
+1. A Rasa CALM flow JSON
+2. A corresponding Rasa domain JSON
+
+Ensure that both parts of the JSONs are complete, well-structured, and compatible with each other.
+
+## Example
+Here's an example of a skill description and the corresponding JSON outputs and custom action code
+
+Skill Description: "Create a skill for transferring money. It should ask for the recipient and amount, check the user has enough balance, and then confirm with the user before finalizing the transfer."
+
+CALM BOT JSON:
+```json
+{
+  "flows": {
+    "transfer_money": {
+      "description": "This flow lets users send money to friends and family.",
+      "steps": [
+        {
+          "collect": "recipient"
+        },
+        {
+          "collect": "amount",
+          "description": "the number of US dollars to send"
+        },
+        {
+          "action": "action_check_sufficient_funds",
+          "next": [
+            {
+              "if": "not slots.has_sufficient_funds",
+              "then": [
+                {
+                  "action": "utter_insufficient_funds",
+                  "next": "END"
+                }
+              ]
+            },
+            {
+              "else": "final_confirmation"
+            }
+          ]
+        },
+        {
+          "collect": "final_confirmation",
+          "id": "final_confirmation",
+          "next": [
+            {
+              "if": "not slots.final_confirmation",
+              "then": [
+                {
+                  "action": "utter_transfer_cancelled",
+                  "next": "END"
+                }
+              ]
+            },
+            {
+              "else": "transfer_successful"
+            }
+          ]
+        },
+        {
+          "action": "utter_transfer_complete",
+          "id": "transfer_successful"
+        }
+      ]
+    }
+  },
+  "domain": {
+    "actions": [
+      "action_check_sufficient_funds"
+    ],
+    "slots": {
+      "recipient": {
+        "type": "Text",
+        "mappings": [
+          {
+            "type": "from_llm"
+          }
+        ]
+      },
+      "has_sufficient_funds": {
+        "type": "bool",
+        "mappings": [
+          {
+            "type": "custom"
+          }
+        ]
+      }
+    },
+    "responses": {
+      "utter_ask_recipient": [
+        {
+          "text": "Who would you like to send money to?"
+        }
+      ],
+      "utter_ask_final_confirmation": [
+        {
+          "text": "Please confirm: you want to transfer {amount} to {recipient}?"
+        }
+      ],
+      "utter_transfer_cancelled": [
+        {
+          "text": "Your transfer has been cancelled."
+        }
+      ],
+      "utter_insufficient_funds": [
+        {
+          "text": "You do not have enough funds to make this transaction."
+        }
+      ]
+    }
+  }
+}
+```
+
+## Guidelines for CALM Flow JSON:
+- Start a `flow` with the name of the flow as the key in `flows`
+- Include a `description` for the skill
+- Use `steps` to outline the conversation flow
+- Implement `collect` steps for gathering information
+- `collect` steps should reference an existing slot
+- For a collect step referencing a slot `A`, there should be a corresponding `utter_ask_A` 
+  utterance that is used in the collect step to ask for the information to be stored in `A`
+- Use `action` steps for custom actions
+- Implement conditional logic with `if`, `then`, and `else` where appropriate
+- Use `next` to define the flow between steps. If the flow should end after a step, add next: END. 
+- The content after `then` or `else` can be: the id of another step defined in the flow, a list of steps, or an END
+- End the flow with an appropriate action or message
+
+## Guidelines for Domain JSON:
+- Include all necessary `actions`
+- Define all required `slots` with appropriate types. Type should be one of 'float', 'bool', 'text', or 'categorical'
+- Slots filled by a 'collect' step should have mapping 'from_llm' and slots set by custom actions should have a 'custom' mapping
+- Provide `responses` for all bot turns
+
+## Guidelines for Custom Actions
+- Ensure all actions mentioned in the flow are properly defined in the domains list of actions.
+
+## Important Notes:
+- Ensure that the flow logic is coherent and follows a natural conversation pattern
+- All custom actions in the flow should be listed in the domain's `actions` section
+- All slots collected in the flow should be defined in the domain's `slots` section
+- Provide appropriate `utter_` responses for each user interaction
+- Use realistic and appropriate names for actions, slots, and responses
+- Consider error handling and alternative conversation paths
+- Aim for a balance between simplicity and functionality
+
+Now, please generate Rasa CALM flow and domain JSON configuration for the following skill description:
+
+${skillDescription}

rasa/cli/dialogue_understanding_test.py

@@ -16,9 +16,9 @@ from rasa.cli.arguments.default_arguments import (
     add_remote_storage_param,
 )
 from rasa.core.agent import Agent
+from rasa.core.available_endpoints import AvailableEndpoints
 from rasa.core.exceptions import AgentNotReady
 from rasa.core.processor import MessageProcessor
-from rasa.core.utils import AvailableEndpoints
 from rasa.dialogue_understanding.commands import Command
 from rasa.dialogue_understanding.generator import LLMBasedCommandGenerator
 from rasa.dialogue_understanding.generator.command_parser import DEFAULT_COMMANDS

rasa/cli/e2e_test.py

@@ -18,8 +18,8 @@ from rasa.cli.arguments.default_arguments import (
     add_model_param,
     add_remote_storage_param,
 )
+from rasa.core.available_endpoints import AvailableEndpoints
 from rasa.core.exceptions import AgentNotReady
-from rasa.core.utils import AvailableEndpoints
 from rasa.e2e_test.aggregate_test_stats_calculator import (
     AggregateTestStatsCalculator,
 )

rasa/cli/evaluate.py

@@ -6,10 +6,10 @@ import rasa.cli.arguments.evaluate as arguments
 import rasa.shared.utils.cli
 from rasa import telemetry
 from rasa.cli import SubParsersAction
+from rasa.core.available_endpoints import AvailableEndpoints
 from rasa.core.evaluation.marker_base import Marker, OperatorMarker
 from rasa.core.evaluation.marker_tracker_loader import MarkerTrackerLoader
-from rasa.core.tracker_store import TrackerStore
-from rasa.core.utils import AvailableEndpoints
+from rasa.core.tracker_stores.tracker_store import TrackerStore
 from rasa.shared.core.domain import Domain
 
 STATS_OVERALL_SUFFIX = "-overall.csv"

rasa/cli/export.py

@@ -16,10 +16,10 @@ from rasa.shared.constants import DOCS_URL_EVENT_BROKERS, DOCS_URL_TRACKER_STORE
 from rasa.shared.exceptions import RasaException
 
 if typing.TYPE_CHECKING:
+    from rasa.core.available_endpoints import AvailableEndpoints
     from rasa.core.brokers.broker import EventBroker
     from rasa.core.exporter import Exporter
-    from rasa.core.tracker_store import TrackerStore
-    from rasa.core.utils import AvailableEndpoints
+    from rasa.core.tracker_stores.tracker_store import TrackerStore
 
 logger = logging.getLogger(__name__)
 
@@ -67,7 +67,7 @@ def _get_tracker_store(endpoints: "AvailableEndpoints") -> "TrackerStore":
             f"Exiting. "
         )
 
-    from rasa.core.tracker_store import TrackerStore
+    from rasa.core.tracker_stores.tracker_store import TrackerStore
 
     return TrackerStore.create(endpoints.tracker_store)
 

rasa/cli/llm_fine_tuning.py

@@ -20,8 +20,8 @@ from rasa.cli.e2e_test import (
     read_test_cases,
     validate_model_path,
 )
+from rasa.core.available_endpoints import AvailableEndpoints
 from rasa.core.exceptions import AgentNotReady
-from rasa.core.utils import AvailableEndpoints
 from rasa.dialogue_understanding.generator.llm_based_command_generator import (
     LLMBasedCommandGenerator,
 )

rasa/cli/project_templates/default/config.yml

@@ -1,44 +1,17 @@
 # The config recipe.
-# https://rasa.com/docs/rasa-pro/nlu-based-assistants/model-configuration/
 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
 
-# Configuration for Rasa NLU.
-# https://rasa.com/docs/rasa-pro/nlu-based-assistants/components/
 language: en
-
 pipeline:
-# # No configuration for the NLU pipeline was provided. The following default pipeline was used to train your model.
-# # If you'd like to customize it, uncomment and adjust the pipeline.
-# # See https://rasa.com/docs/rasa-pro/nlu-based-assistants/tuning-your-model for more information.
-#   - name: WhitespaceTokenizer
-#   - name: RegexFeaturizer
-#   - name: LexicalSyntacticFeaturizer
-#   - name: CountVectorsFeaturizer
-#   - name: CountVectorsFeaturizer
-#     analyzer: char_wb
-#     min_ngram: 1
-#     max_ngram: 4
-#   - name: DIETClassifier
-#     epochs: 100
-#   - name: EntitySynonymMapper
-#   - name: ResponseSelector
-#     epochs: 100
-#   - name: FallbackClassifier
-#     threshold: 0.3
-#     ambiguity_threshold: 0.1
+- name: CompactLLMCommandGenerator
+  llm:
+    model_group: openai-gpt-4o
 
 # Configuration for Rasa Core.
-# https://rasa.com/docs/rasa-pro/concepts/policies/policy-overview/
 policies:
-# # No configuration for policies was provided. The following default policies were used to train your model.
-# # If you'd like to customize them, uncomment and adjust the policies.
-# # See https://rasa.com/docs/rasa-pro/concepts/policies/policy-overview/ for more information.
-#   - name: MemoizationPolicy
-#   - name: TEDPolicy
-#     max_history: 5
-#     epochs: 100
-#   - name: RulePolicy
+- name: FlowPolicy
+- name: IntentlessPolicy

rasa/cli/project_templates/{calm → default}/e2e_tests/cancelations/user_cancels_during_a_correction.yml

@@ -13,4 +13,4 @@ test_cases:
       - utter: utter_corrected_previous_input
       - utter: utter_ask_add_contact_name
       - user: I changed my mind, stop.
-      - utter: utter_flow_cancelled_rasa
+      - utter: utter_flow_cancelled_rasa

rasa/cli/project_templates/{calm → default}/e2e_tests/cancelations/user_changes_mind_on_a_whim.yml

@@ -4,4 +4,4 @@ test_cases:
       - user: I want to add contact
       - utter: utter_ask_add_contact_handle
       - user: Stop
-      - utter: utter_flow_cancelled_rasa
+      - utter: utter_flow_cancelled_rasa

rasa/cli/project_templates/{calm → default}/e2e_tests/corrections/user_corrects_contact_handle.yml

@@ -17,4 +17,4 @@ test_cases:
           - add_contact_name: "Barbar"
       - utter: utter_ask_add_contact_confirmation
       - user: Yes
-      - utter: utter_contact_added
+      - utter: utter_contact_added

rasa/cli/project_templates/{calm → default}/e2e_tests/corrections/user_corrects_contact_name.yml

@@ -16,4 +16,4 @@ test_cases:
       - utter: utter_corrected_previous_input
       - utter: utter_ask_add_contact_confirmation
       - user: Yes
-      - utter: utter_contact_added
+      - utter: utter_contact_added

rasa/cli/project_templates/{calm → default}/e2e_tests/happy_paths/user_adds_contact_to_their_list.yml

@@ -12,4 +12,4 @@ test_cases:
           - add_contact_name: Bart
       - utter: utter_ask_add_contact_confirmation
       - user: Yes
-      - utter: utter_contact_added
+      - utter: utter_contact_added

rasa/cli/project_templates/{calm → default}/e2e_tests/happy_paths/user_lists_contacts.yml

@@ -2,4 +2,4 @@ test_cases:
   - test_case: user lists their contacts
     steps:
       - user: Please show me my contacts
-      - utter: utter_list_contacts
+      - utter: utter_list_contacts

rasa/cli/project_templates/{calm → default}/e2e_tests/happy_paths/user_removes_contact.yml

@@ -8,4 +8,4 @@ test_cases:
           - remove_contact_handle: "@MaryLu"
       - utter: utter_ask_remove_contact_confirmation
       - user: Yes
-      - utter: utter_remove_contact_success
+      - utter: utter_remove_contact_success

rasa/cli/project_templates/{calm → default}/e2e_tests/happy_paths/user_removes_contact_from_list.yml

@@ -9,4 +9,4 @@ test_cases:
           - remove_contact_handle: "@MaryLu"
       - utter: utter_ask_remove_contact_confirmation
       - user: yes
-      - utter: utter_remove_contact_success
+      - utter: utter_remove_contact_success

rasa/cli/project_templates/default/endpoints.yml

@@ -10,8 +10,8 @@
 # Server which runs your custom actions.
 # https://rasa.com/docs/rasa-pro/concepts/custom-actions
 
-#action_endpoint:
-#  url: "http://localhost:5055/webhook"
+action_endpoint:
+  actions_module: "actions"
 
 # Tracker store which is used to store the conversations.
 # By default the conversations are stored in memory.
@@ -40,3 +40,19 @@
 #  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/defaults.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+import tempfile
+from typing import Any, Dict, List, Optional, Text
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from rasa.dialogue_understanding.patterns.domain_for_patterns import (
+    ContextField,
+    generate_domain_for_default_patterns,
+)
+from rasa.shared.core.domain import Domain
+from rasa.shared.importers.importer import FlowSyncImporter, TrainingDataImporter
+from rasa.shared.utils.llm import SystemPrompts, get_system_default_prompts
+from rasa.shared.utils.yaml import read_yaml, write_yaml
+
+
+class Response(BaseModel):
+    text: str = Field(..., description="The human-readable response string.")
+    metadata: Optional[Dict[str, Any]] = Field(
+        None, description="Optional metadata used by Rasa at runtime."
+    )
+
+
+class Slot(BaseModel):
+    name: Text = Field(..., description="Name of the slot.")
+    type: Text = Field(..., description="Type of the slot.")
+    mappings: Optional[List[Dict[str, Any]]] = Field(
+        None, description="Mappings for the slot."
+    )
+    model_config = ConfigDict(extra="allow")
+
+
+class PatternFlow(BaseModel):
+    description: str = Field(..., description="Description of the flow.")
+    name: Text = Field(..., description="Name of the flow.")
+    steps: List[Any] = Field(..., description="List of steps in the flow.")
+    nlu_trigger: Optional[Any] = Field(None, description="NLU trigger for the flow.")
+    persisted_slots: Optional[List[Text]] = Field(None, description="Slots to persist.")
+
+
+class PatternDefaults(BaseModel):
+    """Content of `default_flows_for_patterns.yml` after it is loaded from disk."""
+
+    responses: Dict[Text, List[Response]] = Field(
+        default_factory=dict,
+        description="Response templates available out-of-the-box.",
+    )
+    slots: Dict[Text, Slot] = Field(
+        default_factory=dict, description="Slot definitions used by the default flows."
+    )
+    flows: Dict[Text, PatternFlow] = Field(
+        default_factory=dict, description="Default flows (conversation patterns)."
+    )
+
+
+class RasaDefaults(PatternDefaults):
+    """Full set of defaults that Rasa injects when a project is created."""
+
+    prompts: SystemPrompts = Field(..., description="Built-in system prompts.")
+    actions: List[Text] = Field(..., description="Default actions shipped by Rasa.")
+    intents: List[Text] = Field(..., description="Default intents shipped by Rasa.")
+    contexts: Dict[Text, ContextField] = Field(
+        ..., description="Context fields that can appear on the conversation stack."
+    )
+
+    class Config:
+        extra = "forbid"
+        validate_assignment = True
+
+
+def _get_domain_from_importer(config: Dict[Text, Any]) -> Domain:
+    """Get the domain from the TrainingDataImporter.
+
+    Args:
+        config: The config.yml file data.
+
+    Returns:
+        A Domain object .
+    """
+    with tempfile.NamedTemporaryFile("w+", suffix=".yml") as tmp:
+        write_yaml(config, tmp.name)
+        importer = TrainingDataImporter.load_from_config(
+            domain_path=FlowSyncImporter.default_pattern_path(),
+            config_path=tmp.name,
+        )
+        return importer.get_domain()
+
+
+def get_pattern_defaults(config: Dict[Text, Any]) -> PatternDefaults:
+    """Get the default flows, responses and slots for patterns.
+
+    Args:
+        config: The config.yml file data.
+
+    Returns:
+        A PatternDefaults object containing the defaults.
+    """
+    domain = _get_domain_from_importer(config)
+    domain_dict = domain.as_dict()
+
+    # Make sure all the slots are exported, including the builtin slots
+    domain_dict["slots"] = {slot.name: slot.to_dict() for slot in domain.slots}
+
+    return PatternDefaults(**domain_dict)
+
+
+def get_rasa_defaults(config_yaml: Text, endpoints_yaml: Text) -> RasaDefaults:
+    """Get the default values for a Rasa project.
+
+    Args:
+        config_yaml: The content of the config.yml file.
+        endpoints_yaml: The content of the endpoints.yml file.
+
+    Returns:
+        A RasaDefaults object containing the default values for the project.
+    """
+    config = read_yaml(config_yaml)
+    endpoints = read_yaml(endpoints_yaml)
+
+    prompts = get_system_default_prompts(config, endpoints)
+    pattern_domain = generate_domain_for_default_patterns()
+    pattern_defaults = get_pattern_defaults(config)
+
+    return RasaDefaults(
+        prompts=prompts,
+        actions=pattern_domain.actions,
+        intents=pattern_domain.intents,
+        contexts=pattern_domain.contexts,
+        responses=pattern_defaults.responses,
+        slots=pattern_defaults.slots,
+        flows=pattern_defaults.flows,
+    )

rasa/cli/run.py

@@ -109,7 +109,7 @@ def run(args: argparse.Namespace) -> None:
     # configured
 
     import rasa.model
-    from rasa.core.utils import AvailableEndpoints
+    from rasa.core.available_endpoints import AvailableEndpoints
 
     # start server if remote storage is configured
     if args.remote_storage is not None:

rasa/cli/scaffold.py

@@ -20,18 +20,17 @@ from rasa.shared.utils.cli import print_error_and_exit, print_success
 
 
 class ProjectTemplateName(Enum):
-    """Enum of the different project templates."""
+    """Enum of CALM project templates."""
 
     DEFAULT = "default"
     TUTORIAL = "tutorial"
-    CALM = "calm"
 
     def __str__(self) -> str:
         return self.value
 
 
 template_domain_path = defaultdict(lambda: DEFAULT_DOMAIN_PATH)
-template_domain_path[ProjectTemplateName.CALM] = "domain"
+template_domain_path[ProjectTemplateName.DEFAULT] = "domain"
 
 
 def add_subparser(

rasa/cli/studio/download.py

@@ -8,7 +8,7 @@ from rasa.cli.arguments.default_arguments import (
 )
 from rasa.cli.arguments.train import add_data_param, add_domain_param
 from rasa.shared.constants import DEFAULT_CONFIG_PATH, DEFAULT_ENDPOINTS_PATH
-from rasa.studio.download import handle_download
+from rasa.studio.download.download import handle_download
 
 
 def add_subparser(