rasa-pro 3.12.0.dev1__py3-none-any.whl

rasa/shared/constants.py

@@ -0,0 +1,311 @@
+from __future__ import annotations
+
+from typing import List, Text
+
+from rasa.shared.engine.caching import get_local_cache_location
+
+DOCS_BASE_URL = "https://rasa.com/docs/rasa-pro"
+DOCS_URL_CONCEPTS = DOCS_BASE_URL + "/concepts"
+DOCS_URL_NLU_BASED = DOCS_BASE_URL + "/nlu-based-assistants"
+
+# Docs URLs for CALM assistants
+DOCS_URL_SLOTS = DOCS_URL_CONCEPTS + "/domain#slots"
+DOCS_URL_RESPONSES = DOCS_URL_CONCEPTS + "/responses"
+DOCS_URL_POLICIES = DOCS_URL_CONCEPTS + "/policies/policy-overview"
+DOCS_URL_ACTIONS = DOCS_URL_CONCEPTS + "/actions"
+DOCS_URL_DEFAULT_ACTIONS = DOCS_URL_CONCEPTS + "/default-actions"
+DOCS_URL_COMPONENTS = DOCS_URL_CONCEPTS + "/components/overview"
+DOCS_URL_GRAPH_COMPONENTS = DOCS_URL_CONCEPTS + "/components/custom-graph-components"
+DOCS_URL_GRAPH_RECIPE = DOCS_URL_CONCEPTS + "/components/graph-recipe"
+DOCS_URL_CATEGORICAL_SLOTS = DOCS_URL_CONCEPTS + "/domain#categorical-slot"
+DOCS_URL_DOMAIN = DOCS_URL_CONCEPTS + "/domain"
+
+# Docs URLs for NLU-based assistants
+DOCS_URL_TRAINING_DATA = DOCS_URL_NLU_BASED + "/training-data-format"
+DOCS_URL_TRAINING_DATA_NLU = DOCS_URL_TRAINING_DATA + "#nlu-training-data"
+DOCS_URL_DOMAINS = DOCS_URL_NLU_BASED + "/domain"
+DOCS_URL_NLU_BASED_SLOTS = DOCS_URL_DOMAINS + "#slots"
+DOCS_URL_INTENTS = DOCS_URL_DOMAINS + "#intents"
+DOCS_URL_ENTITIES = DOCS_URL_DOMAINS + "#entities"
+DOCS_URL_STORIES = DOCS_URL_NLU_BASED + "/stories"
+DOCS_URL_RULES = DOCS_URL_NLU_BASED + "/rules"
+DOCS_URL_FORMS = DOCS_URL_NLU_BASED + "/forms"
+DOCS_URL_PIPELINE = DOCS_URL_NLU_BASED + "/model-configuration"
+DOCS_URL_NLU_BASED_POLICIES = DOCS_URL_NLU_BASED + "/policies"
+
+# Other docs URLs
+DOCS_URL_MARKERS = DOCS_BASE_URL + "/operating/analytics/realtime-markers"
+DOCS_URL_CONNECTORS = DOCS_BASE_URL + "/connectors/messaging-and-voice-channels"
+DOCS_URL_CONNECTORS_SLACK = DOCS_BASE_URL + "/connectors/slack"
+DOCS_URL_EVENT_BROKERS = DOCS_BASE_URL + "/production/event-brokers"
+DOCS_URL_PIKA_EVENT_BROKER = DOCS_URL_EVENT_BROKERS + "#pika-event-broker"
+DOCS_URL_TRACKER_STORES = DOCS_BASE_URL + "/production/tracker-stores"
+DOCS_URL_MIGRATION_GUIDE = DOCS_BASE_URL + "/migration-guide"
+DOCS_URL_TELEMETRY = DOCS_BASE_URL + "/telemetry/telemetry"
+
+INTENT_MESSAGE_PREFIX = "/"
+
+PACKAGE_NAME = "rasa"
+NEXT_MAJOR_VERSION_FOR_DEPRECATIONS = "4.0.0"
+
+MODEL_CONFIG_SCHEMA_FILE = "shared/utils/schemas/model_config.yml"
+CONFIG_SCHEMA_FILE = "shared/utils/schemas/config.yml"
+RESPONSES_SCHEMA_FILE = "shared/nlu/training_data/schemas/responses.yml"
+SCHEMA_EXTENSIONS_FILE = "shared/utils/pykwalify_extensions.py"
+ASSERTIONS_SCHEMA_FILE = "e2e_test/assertions_schema.yml"
+ASSERTIONS_SCHEMA_EXTENSIONS_FILE = "e2e_test/pykwalify_extensions.py"
+LATEST_TRAINING_DATA_FORMAT_VERSION = "3.1"
+
+DOMAIN_SCHEMA_FILE = "shared/utils/schemas/domain.yml"
+
+DEFAULT_SESSION_EXPIRATION_TIME_IN_MINUTES = 60
+DEFAULT_CARRY_OVER_SLOTS_TO_NEW_SESSION = True
+
+DEFAULT_NLU_FALLBACK_INTENT_NAME = "nlu_fallback"
+
+DEFAULT_E2E_TESTS_PATH = "."
+TEST_STORIES_FILE_PREFIX = "test_"
+
+LOG_LEVEL_NAME_TO_LEVEL = {
+    "CRITICAL": 50,
+    "ERROR": 40,
+    "WARNING": 30,
+    "INFO": 20,
+    "DEBUG": 10,
+    "NOTSET": 0,
+}
+
+DEFAULT_LOG_LEVEL = "INFO"
+ENV_LOG_LEVEL = "LOG_LEVEL"
+DEFAULT_LOG_LEVEL_LLM = "DEBUG"
+ENV_LOG_LEVEL_LLM = "LOG_LEVEL_LLM"
+ENV_LOG_LEVEL_LLM_MODULE_NAMES = {
+    "LLMCommandGenerator": "LOG_LEVEL_LLM_COMMAND_GENERATOR",
+    "SingleStepLLMCommandGenerator": "LOG_LEVEL_LLM_COMMAND_GENERATOR",
+    "MultiStepLLMCommandGenerator": "LOG_LEVEL_LLM_COMMAND_GENERATOR",
+    "EnterpriseSearchPolicy": "LOG_LEVEL_LLM_ENTERPRISE_SEARCH",
+    "IntentlessPolicy": "LOG_LEVEL_LLM_INTENTLESS_POLICY",
+    "ContextualResponseRephraser": "LOG_LEVEL_LLM_REPHRASER",
+    "NLUCommandAdapter": "LOG_LEVEL_NLU_COMMAND_ADAPTER",
+    "LLMBasedRouter": "LOG_LEVEL_LLM_BASED_ROUTER",
+}
+TCP_PROTOCOL = "TCP"
+
+DEFAULT_SENDER_ID = "default"
+UTTER_PREFIX = "utter_"
+UTTER_ASK_PREFIX = "utter_ask_"
+ACTION_ASK_PREFIX = "action_ask_"
+FLOW_PREFIX = "flow_"
+
+ASSISTANT_ID_KEY = "assistant_id"
+ASSISTANT_ID_DEFAULT_VALUE = "placeholder_default"
+
+CONFIG_MANDATORY_COMMON_KEYS = [ASSISTANT_ID_KEY]
+CONFIG_NAME_KEY = "name"
+CONFIG_POLICIES_KEY = "policies"
+CONFIG_PIPELINE_KEY = "pipeline"
+CONFIG_LANGUAGE_KEY = "language"
+CONFIG_RECIPE_KEY = "recipe"
+CONFIG_LLM_KEY = "llm"
+CONFIG_MODEL_NAME_KEY = "model_name"
+CONFIG_TRAIN_SCHEMA = "train_schema"
+CONFIG_PREDICT_SCHEMA = "predict_schema"
+CONFIG_AUTOCONFIGURABLE_KEYS_CORE = [CONFIG_POLICIES_KEY]
+CONFIG_AUTOCONFIGURABLE_KEYS_NLU = [CONFIG_PIPELINE_KEY]
+CONFIG_AUTOCONFIGURABLE_KEYS = (
+    CONFIG_AUTOCONFIGURABLE_KEYS_CORE + CONFIG_AUTOCONFIGURABLE_KEYS_NLU
+)
+CONFIG_KEYS_CORE = [CONFIG_POLICIES_KEY] + CONFIG_MANDATORY_COMMON_KEYS
+CONFIG_KEYS_NLU = [
+    CONFIG_LANGUAGE_KEY,
+    CONFIG_PIPELINE_KEY,
+] + CONFIG_MANDATORY_COMMON_KEYS
+CONFIG_KEYS = CONFIG_KEYS_CORE + CONFIG_KEYS_NLU
+CONFIG_MANDATORY_KEYS_CORE: List[Text] = [] + CONFIG_MANDATORY_COMMON_KEYS
+CONFIG_MANDATORY_KEYS_NLU = [CONFIG_LANGUAGE_KEY] + CONFIG_MANDATORY_COMMON_KEYS
+CONFIG_MANDATORY_KEYS = CONFIG_MANDATORY_KEYS_CORE + CONFIG_MANDATORY_KEYS_NLU
+
+# Keys related to Forms (in the Domain)
+REQUIRED_SLOTS_KEY = "required_slots"
+IGNORED_INTENTS = "ignored_intents"
+
+# Constants for default Rasa Pro project layout
+DEFAULT_ENDPOINTS_PATH = "endpoints.yml"
+DEFAULT_CREDENTIALS_PATH = "credentials.yml"
+DEFAULT_CONFIG_PATH = "config.yml"
+DEFAULT_DOMAIN_PATHS = ["domain.yml", "domain"]
+DEFAULT_DOMAIN_PATH = DEFAULT_DOMAIN_PATHS[0]
+DEFAULT_ACTIONS_PATH = "actions"
+DEFAULT_MODELS_PATH = "models"
+DEFAULT_CONVERTED_DATA_PATH = "converted_data"
+DEFAULT_DATA_PATH = "data"
+DEFAULT_RESULTS_PATH = "results"
+DEFAULT_NLU_RESULTS_PATH = "nlu_comparison_results"
+DEFAULT_CORE_SUBDIRECTORY_NAME = "core"
+DEFAULT_NLU_SUBDIRECTORY_NAME = "nlu"
+DEFAULT_CONVERSATION_TEST_PATH = "tests"
+DEFAULT_MARKERS_PATH = "markers"
+DEFAULT_MARKERS_CONFIG_PATH = "markers/config"
+DEFAULT_MARKERS_OUTPUT_PATH = "markers/output"
+DEFAULT_MARKERS_STATS_PATH = "markers/stats"
+
+DIAGNOSTIC_DATA = "diagnostic_data"
+
+RESPONSE_CONDITION = "condition"
+CHANNEL = "channel"
+
+API_KEY = "api_key"
+
+AZURE_API_KEY_ENV_VAR = "AZURE_API_KEY"
+AZURE_AD_TOKEN_ENV_VAR = "AZURE_AD_TOKEN"
+AZURE_API_BASE_ENV_VAR = "AZURE_API_BASE"
+AZURE_API_VERSION_ENV_VAR = "AZURE_API_VERSION"
+AZURE_API_TYPE_ENV_VAR = "AZURE_API_TYPE"
+AZURE_AD_SCOPES_ENV_VAR = "AZURE_AD_SCOPES"
+AZURE_SPEECH_API_KEY_ENV_VAR = "AZURE_SPEECH_API_KEY"
+
+DEEPGRAM_API_KEY_ENV_VAR = "DEEPGRAM_API_KEY"
+CARTESIA_API_KEY_ENV_VAR = "CARTESIA_API_KEY"
+
+OPENAI_API_KEY_ENV_VAR = "OPENAI_API_KEY"
+OPENAI_API_TYPE_ENV_VAR = "OPENAI_API_TYPE"
+OPENAI_API_VERSION_ENV_VAR = "OPENAI_API_VERSION"
+OPENAI_API_BASE_ENV_VAR = "OPENAI_API_BASE"
+
+OPENAI_API_BASE_CONFIG_KEY = "openai_api_base"
+OPENAI_API_TYPE_CONFIG_KEY = "openai_api_type"
+OPENAI_API_VERSION_CONFIG_KEY = "openai_api_version"
+
+AWS_BEDROCK_PROVIDER = "bedrock"
+AWS_SAGEMAKER_PROVIDER = "sagemaker"
+
+API_BASE_CONFIG_KEY = "api_base"
+API_TYPE_CONFIG_KEY = "api_type"
+API_VERSION_CONFIG_KEY = "api_version"
+LANGCHAIN_TYPE_CONFIG_KEY = "_type"
+RASA_TYPE_CONFIG_KEY = "type"
+PROVIDER_CONFIG_KEY = "provider"
+
+REQUEST_TIMEOUT_CONFIG_KEY = "request_timeout"  # deprecated
+TIMEOUT_CONFIG_KEY = "timeout"
+
+DEPLOYMENT_NAME_CONFIG_KEY = "deployment_name"
+DEPLOYMENT_CONFIG_KEY = "deployment"
+EMBEDDINGS_CONFIG_KEY = "embeddings"
+ENGINE_CONFIG_KEY = "engine"
+LLM_CONFIG_KEY = "llm"
+MODEL_CONFIG_KEY = "model"
+MODEL_NAME_CONFIG_KEY = "model_name"
+PROMPT_CONFIG_KEY = "prompt"
+PROMPT_TEMPLATE_CONFIG_KEY = "prompt_template"
+STREAM_CONFIG_KEY = "stream"
+N_REPHRASES_CONFIG_KEY = "n"
+USE_CHAT_COMPLETIONS_ENDPOINT_CONFIG_KEY = "use_chat_completions_endpoint"
+
+ROUTER_CONFIG_KEY = "router"
+ROUTING_STRATEGY_CONFIG_KEY = "routing_strategy"
+REDIS_HOST_CONFIG_KEY = "redis_host"
+ROUTING_STRATEGIES_REQUIRING_REDIS_CACHE = [
+    "cost-based-routing",
+    "usage-based-routing",
+]
+ROUTING_STRATEGIES_NOT_REQUIRING_CACHE = [
+    "latency-based-routing",
+    "least-busy",
+    "simple-shuffle",
+]
+VALID_ROUTING_STRATEGIES = (
+    ROUTING_STRATEGIES_REQUIRING_REDIS_CACHE + ROUTING_STRATEGIES_NOT_REQUIRING_CACHE
+)
+
+MODELS_CONFIG_KEY = "models"
+MODEL_GROUPS_CONFIG_KEY = "model_groups"
+MODEL_GROUP_CONFIG_KEY = "model_group"
+MODEL_GROUP_ID_CONFIG_KEY = "id"
+
+EXTRA_PARAMETERS_KEY = "extra_parameters"
+MODEL_GROUP_ID_KEY = "model_group_id"
+MODEL_LIST_KEY = "model_list"
+LITELLM_PARAMS_KEY = "litellm_params"
+
+LLM_API_HEALTH_CHECK_ENV_VAR = "LLM_API_HEALTH_CHECK"
+LLM_API_HEALTH_CHECK_DEFAULT_VALUE = "false"
+
+AWS_REGION_NAME_CONFIG_KEY = "aws_region_name"
+AWS_ACCESS_KEY_ID_CONFIG_KEY = "aws_access_key_id"
+AWS_SECRET_ACCESS_KEY_CONFIG_KEY = "aws_secret_access_key"
+AWS_SESSION_TOKEN_CONFIG_KEY = "aws_session_token"
+
+AWS_ACCESS_KEY_ID_ENV_VAR = "AWS_ACCESS_KEY_ID"
+AWS_SECRET_ACCESS_KEY_ENV_VAR = "AWS_SECRET_ACCESS_KEY"
+AWS_REGION_NAME_ENV_VAR = "AWS_REGION_NAME"
+AWS_SESSION_TOKEN_ENV_VAR = "AWS_SESSION_TOKEN"
+
+HUGGINGFACE_MULTIPROCESS_CONFIG_KEY = "multi_process"
+HUGGINGFACE_CACHE_FOLDER_CONFIG_KEY = "cache_folder"
+HUGGINGFACE_SHOW_PROGRESS_CONFIG_KEY = "show_progress"
+HUGGINGFACE_MODEL_KWARGS_CONFIG_KEY = "model_kwargs"
+HUGGINGFACE_ENCODE_KWARGS_CONFIG_KEY = "encode_kwargs"
+HUGGINGFACE_LOCAL_EMBEDDING_CACHING_FOLDER = (
+    get_local_cache_location() / "huggingface_local_embeddings"
+)
+
+REQUESTS_CA_BUNDLE_ENV_VAR = "REQUESTS_CA_BUNDLE"
+REQUESTS_SSL_CONTEXT_PURPOSE_ENV_VAR = "REQUESTS_SSL_CONTEXT_PURPOSE"
+RASA_CA_BUNDLE_ENV_VAR = "RASA_CA_BUNDLE"  # used in verify
+RASA_SSL_CERTIFICATE_ENV_VAR = "RASA_SSL_CERTIFICATE"  # used in cert (client side)
+LITELLM_SSL_VERIFY_ENV_VAR = "SSL_VERIFY"
+LITELLM_SSL_CERTIFICATE_ENV_VAR = "SSL_CERTIFICATE"
+
+OPENAI_PROVIDER = "openai"
+AZURE_OPENAI_PROVIDER = "azure"
+SELF_HOSTED_PROVIDER = "self-hosted"
+HUGGINGFACE_LOCAL_EMBEDDING_PROVIDER = "huggingface_local"
+RASA_PROVIDER = "rasa"
+
+SELF_HOSTED_VLLM_PREFIX = "hosted_vllm"
+SELF_HOSTED_VLLM_API_KEY_ENV_VAR = "HOSTED_VLLM_API_KEY"
+
+VALID_PROVIDERS_FOR_API_TYPE_CONFIG_KEY = [
+    OPENAI_PROVIDER,
+    AZURE_OPENAI_PROVIDER,
+]
+
+AZURE_API_TYPE = "azure"
+OPENAI_API_TYPE = "openai"
+
+RASA_DEFAULT_FLOW_PATTERN_PREFIX = "pattern_"
+CONTEXT = "context"
+
+RASA_PATTERN_INTERNAL_ERROR = "pattern_internal_error"
+RASA_PATTERN_HUMAN_HANDOFF = "pattern_human_handoff"
+
+RASA_INTERNAL_ERROR_PREFIX = "rasa_internal_error_"
+RASA_PATTERN_INTERNAL_ERROR_DEFAULT = RASA_INTERNAL_ERROR_PREFIX + "default"
+RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_TOO_LONG = (
+    RASA_INTERNAL_ERROR_PREFIX + "user_input_too_long"
+)
+RASA_PATTERN_INTERNAL_ERROR_USER_INPUT_EMPTY = (
+    RASA_INTERNAL_ERROR_PREFIX + "user_input_empty"
+)
+
+RASA_PATTERN_CANNOT_HANDLE_PREFIX = "cannot_handle_"
+RASA_PATTERN_CANNOT_HANDLE_DEFAULT = RASA_PATTERN_CANNOT_HANDLE_PREFIX + "default"
+RASA_PATTERN_CANNOT_HANDLE_CHITCHAT = RASA_PATTERN_CANNOT_HANDLE_PREFIX + "chitchat"
+RASA_PATTERN_CANNOT_HANDLE_NOT_SUPPORTED = (
+    RASA_PATTERN_CANNOT_HANDLE_PREFIX + "not_supported"
+)
+RASA_PATTERN_CANNOT_HANDLE_INVALID_INTENT = (
+    RASA_PATTERN_CANNOT_HANDLE_PREFIX + "invalid_intent"
+)
+
+ROUTE_TO_CALM_SLOT = "route_session_to_calm"
+
+SENSITIVE_DATA = [
+    API_KEY,
+    AWS_ACCESS_KEY_ID_CONFIG_KEY,
+    AWS_SECRET_ACCESS_KEY_CONFIG_KEY,
+    AWS_SESSION_TOKEN_CONFIG_KEY,
+]
+
+AZURE_AD_KEY = "azure_ad"

rasa/shared/core/command_payload_reader.py

@@ -0,0 +1,109 @@
+import copy
+import re
+from typing import List, Optional
+
+import structlog
+
+from rasa.dialogue_understanding.commands.set_slot_command import SetSlotExtractor
+from rasa.shared.core.domain import Domain
+from rasa.shared.nlu.constants import COMMANDS, SET_SLOT_COMMAND, TEXT
+from rasa.shared.nlu.training_data.message import Message
+
+structlogger = structlog.get_logger()
+
+SET_SLOTS_PATTERN = r"(?P<slot_name>[^(),=]+)=(?P<slot_value>[^(),]+)"
+MAX_NUMBER_OF_SLOTS = 10
+
+
+class CommandPayloadReader:
+    @staticmethod
+    def unpack_regex_message(
+        message: Message,
+        domain: Optional[Domain] = None,
+        entity_extractor_name: Optional[
+            str
+        ] = SetSlotExtractor.COMMAND_PAYLOAD_READER.value,
+    ) -> Message:
+        """Extracts commands from user text and adds them to the message."""
+        user_text = message.get(TEXT).strip()
+
+        # prevent ReDos attacks by placing a limit on the number of slots
+        if CommandPayloadReader.is_above_slot_limit(user_text):
+            return message
+
+        matches = CommandPayloadReader.find_matches(user_text)
+        if not matches:
+            structlogger.warning(
+                "message.parsing.failed", user_text=copy.deepcopy(user_text)
+            )
+            return message
+
+        return CommandPayloadReader.extract_commands_from_pattern_matches(
+            message, matches, domain, entity_extractor_name
+        )
+
+    @staticmethod
+    def find_matches(user_text: str) -> List[re.Match]:
+        return re.findall(SET_SLOTS_PATTERN, user_text)
+
+    @staticmethod
+    def extract_commands_from_pattern_matches(
+        message: Message,
+        matches: List[re.Match],
+        domain: Optional[Domain] = None,
+        entity_extractor_name: Optional[
+            str
+        ] = SetSlotExtractor.COMMAND_PAYLOAD_READER.value,
+    ) -> Message:
+        """Extract attributes from the matches and validate them via the domain."""
+        commands = []
+
+        for match in matches:
+            slot_name = match[0].strip()
+            slot_value = match[1].strip()
+
+            domain_slot_names = [slot.name for slot in domain.slots] if domain else []
+
+            if domain and slot_name not in domain_slot_names:
+                structlogger.warning(
+                    "slot.not.found",
+                    slot_name=slot_name,
+                )
+                return message
+
+            slot_value = (
+                slot_value
+                if slot_value.lower() not in {"none", "null", "undefined"}
+                else None
+            )
+
+            # Create new SetSlot commands from the extracted attributes.
+            commands.append(
+                {
+                    "command": SET_SLOT_COMMAND,
+                    "name": slot_name,
+                    "value": slot_value,
+                    "extractor": entity_extractor_name,
+                }
+            )
+
+            structlogger.debug(
+                "slot.set.command.added",
+                slot_name=slot_name,
+            )
+
+        # set the command(s) on the Message object
+        message.set(COMMANDS, commands, add_to_output=True)
+        return message
+
+    @staticmethod
+    def is_above_slot_limit(user_text: str) -> bool:
+        """Prevent ReDoS attacks by limiting the number of slots."""
+        if user_text.count("=") > MAX_NUMBER_OF_SLOTS:
+            structlogger.warning(
+                "too.many.slots",
+                user_text=copy.deepcopy(user_text),
+                slot_limit=10,
+            )
+            return True
+        return False

rasa/shared/core/constants.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+from enum import Enum
+
+import rasa.shared.constants as constants
+
+
+DEFAULT_CATEGORICAL_SLOT_VALUE = "__other__"
+
+USER_INTENT_RESTART = "restart"
+USER_INTENT_BACK = "back"
+USER_INTENT_OUT_OF_SCOPE = "out_of_scope"
+USER_INTENT_SESSION_START = "session_start"
+USER_INTENT_SESSION_END = "session_end"
+USER_INTENT_SILENCE_TIMEOUT = "silence_timeout"
+SESSION_START_METADATA_SLOT = "session_started_metadata"
+
+DEFAULT_INTENTS = [
+    USER_INTENT_RESTART,
+    USER_INTENT_BACK,
+    USER_INTENT_OUT_OF_SCOPE,
+    USER_INTENT_SESSION_START,
+    USER_INTENT_SESSION_END,
+    USER_INTENT_SILENCE_TIMEOUT,
+    constants.DEFAULT_NLU_FALLBACK_INTENT_NAME,
+]
+
+LOOP_NAME = "name"
+
+ACTION_LISTEN_NAME = "action_listen"
+ACTION_RESTART_NAME = "action_restart"
+ACTION_SEND_TEXT_NAME = "action_send_text"
+ACTION_SESSION_START_NAME = "action_session_start"
+ACTION_DEFAULT_FALLBACK_NAME = "action_default_fallback"
+ACTION_DEACTIVATE_LOOP_NAME = "action_deactivate_loop"
+ACTION_REVERT_FALLBACK_EVENTS_NAME = "action_revert_fallback_events"
+ACTION_DEFAULT_ASK_AFFIRMATION_NAME = "action_default_ask_affirmation"
+ACTION_DEFAULT_ASK_REPHRASE_NAME = "action_default_ask_rephrase"
+ACTION_BACK_NAME = "action_back"
+ACTION_TWO_STAGE_FALLBACK_NAME = "action_two_stage_fallback"
+ACTION_UNLIKELY_INTENT_NAME = "action_unlikely_intent"
+RULE_SNIPPET_ACTION_NAME = "..."
+ACTION_EXTRACT_SLOTS = "action_extract_slots"
+ACTION_VALIDATE_SLOT_MAPPINGS = "action_validate_slot_mappings"
+ACTION_CANCEL_FLOW = "action_cancel_flow"
+ACTION_CLARIFY_FLOWS = "action_clarify_flows"
+ACTION_CORRECT_FLOW_SLOT = "action_correct_flow_slot"
+ACTION_RUN_SLOT_REJECTIONS_NAME = "action_run_slot_rejections"
+ACTION_CLEAN_STACK = "action_clean_stack"
+ACTION_TRIGGER_SEARCH = "action_trigger_search"
+ACTION_TRIGGER_CHITCHAT = "action_trigger_chitchat"
+ACTION_RESET_ROUTING = "action_reset_routing"
+ACTION_HANGUP = "action_hangup"
+ACTION_REPEAT_BOT_MESSAGES = "action_repeat_bot_messages"
+
+
+DEFAULT_ACTION_NAMES = [
+    ACTION_LISTEN_NAME,
+    ACTION_RESTART_NAME,
+    ACTION_SESSION_START_NAME,
+    ACTION_DEFAULT_FALLBACK_NAME,
+    ACTION_DEACTIVATE_LOOP_NAME,
+    ACTION_REVERT_FALLBACK_EVENTS_NAME,
+    ACTION_DEFAULT_ASK_AFFIRMATION_NAME,
+    ACTION_DEFAULT_ASK_REPHRASE_NAME,
+    ACTION_TWO_STAGE_FALLBACK_NAME,
+    ACTION_UNLIKELY_INTENT_NAME,
+    ACTION_BACK_NAME,
+    ACTION_SEND_TEXT_NAME,
+    RULE_SNIPPET_ACTION_NAME,
+    ACTION_EXTRACT_SLOTS,
+    ACTION_CANCEL_FLOW,
+    ACTION_CORRECT_FLOW_SLOT,
+    ACTION_CLARIFY_FLOWS,
+    ACTION_RUN_SLOT_REJECTIONS_NAME,
+    ACTION_CLEAN_STACK,
+    ACTION_TRIGGER_SEARCH,
+    ACTION_TRIGGER_CHITCHAT,
+    ACTION_RESET_ROUTING,
+    ACTION_HANGUP,
+    ACTION_REPEAT_BOT_MESSAGES,
+]
+
+ACTION_SHOULD_SEND_DOMAIN = "send_domain"
+
+# rules allow setting a value of slots or active_loops to None;
+# generator substitutes `None`s with this constant to notify rule policy that
+# a value should not be set during prediction to activate a rule
+SHOULD_NOT_BE_SET = "should_not_be_set"
+
+PREVIOUS_ACTION = "prev_action"
+ACTIVE_LOOP = "active_loop"
+LOOP_INTERRUPTED = "is_interrupted"
+LOOP_REJECTED = "rejected"
+TRIGGER_MESSAGE = "trigger_message"
+FOLLOWUP_ACTION = "followup_action"
+ACTIVE_FLOW = "active_flow"
+
+# start of special user message section
+EXTERNAL_MESSAGE_PREFIX = "EXTERNAL: "
+# Key to access data in the event metadata
+# It specifies if an event was caused by an external entity (e.g. a sensor).
+IS_EXTERNAL = "is_external"
+
+ACTION_NAME_SENDER_ID_CONNECTOR_STR = "__sender_id:"
+
+REQUESTED_SLOT = "requested_slot"
+FLOW_HASHES_SLOT = "flow_hashes"
+
+FLOW_SLOT_NAMES = [FLOW_HASHES_SLOT]
+
+# slots for audio timeout
+SLOT_SILENCE_TIMEOUT = "silence_timeout"
+SLOT_CONSECUTIVE_SILENCE_TIMEOUTS = "consecutive_silence_timeouts"
+SILENCE_TIMEOUT_DEFAULT_VALUE = 6.0
+SILENCE_SLOTS = [SLOT_SILENCE_TIMEOUT, SLOT_CONSECUTIVE_SILENCE_TIMEOUTS]
+# slots for knowledge base
+SLOT_LISTED_ITEMS = "knowledge_base_listed_objects"
+SLOT_LAST_OBJECT = "knowledge_base_last_object"
+SLOT_LAST_OBJECT_TYPE = "knowledge_base_last_object_type"
+DEFAULT_KNOWLEDGE_BASE_ACTION = "action_query_knowledge_base"
+
+KNOWLEDGE_BASE_SLOT_NAMES = {
+    SLOT_LISTED_ITEMS,
+    SLOT_LAST_OBJECT,
+    SLOT_LAST_OBJECT_TYPE,
+}
+
+DEFAULT_SLOT_NAMES = {
+    REQUESTED_SLOT,
+    SESSION_START_METADATA_SLOT,
+    FLOW_HASHES_SLOT,
+}
+
+
+SLOT_MAPPINGS = "mappings"
+MAPPING_CONDITIONS = "conditions"
+MAPPING_TYPE = "type"
+
+
+class SlotMappingType(Enum):
+    """Slot mapping types."""
+
+    FROM_ENTITY = "from_entity"
+    FROM_INTENT = "from_intent"
+    FROM_TRIGGER_INTENT = "from_trigger_intent"
+    FROM_TEXT = "from_text"
+    FROM_LLM = "from_llm"
+    CUSTOM = "custom"
+
+    def __str__(self) -> str:
+        """Returns the string representation that should be used in config files."""
+        return self.value
+
+    def is_predefined_type(self) -> bool:
+        """Returns True if the mapping type is NLU-predefined."""
+        return not (self == SlotMappingType.CUSTOM or self == SlotMappingType.FROM_LLM)
+
+
+# the keys for `State` (USER, PREVIOUS_ACTION, SLOTS, ACTIVE_LOOP)
+# represent the origin of a `SubState`
+USER = "user"
+SLOTS = "slots"
+
+USE_TEXT_FOR_FEATURIZATION = "use_text_for_featurization"
+ENTITY_LABEL_SEPARATOR = "#"
+
+RULE_ONLY_SLOTS = "rule_only_slots"
+RULE_ONLY_LOOPS = "rule_only_loops"
+
+# if you add more policy/classifier names, make sure to add a test as well to ensure
+# that the name and the class stay in sync
+POLICY_NAME_TWO_STAGE_FALLBACK = "TwoStageFallbackPolicy"
+POLICY_NAME_MAPPING = "MappingPolicy"
+POLICY_NAME_FALLBACK = "FallbackPolicy"
+POLICY_NAME_FORM = "FormPolicy"
+POLICY_NAME_RULE = "RulePolicy"
+
+CLASSIFIER_NAME_FALLBACK = "FallbackClassifier"
+
+POLICIES_THAT_EXTRACT_ENTITIES = {"TEDPolicy"}

rasa/shared/core/conversation.py

@@ -0,0 +1,46 @@
+from typing import Dict, List, Text, Any, TYPE_CHECKING
+
+import rasa.shared.core.events
+
+
+if TYPE_CHECKING:
+    from rasa.shared.core.events import Event
+
+
+class Dialogue:
+    """A dialogue comprises a list of Turn objects."""
+
+    def __init__(self, name: Text, events: List["Event"]) -> None:
+        """This function initialises the dialogue with the dialogue name and the event
+        list.
+        """
+        self.name = name
+        self.events = events
+
+    def __str__(self) -> Text:
+        """This function returns the dialogue and turns."""
+        return "Dialogue with name '{}' and turns:\n{}".format(
+            self.name, "\n\n".join([f"\t{t}" for t in self.events])
+        )
+
+    def as_dict(self) -> Dict:
+        """This function returns the dialogue as a dictionary to assist in
+        serialization.
+        """
+        return {"events": [event.as_dict() for event in self.events], "name": self.name}
+
+    @classmethod
+    def from_parameters(cls, parameters: Dict[Text, Any]) -> "Dialogue":
+        """Create `Dialogue` from parameters.
+
+        Args:
+            parameters: Serialised dialogue, should contain keys 'name' and 'events'.
+
+        Returns:
+            Deserialised `Dialogue`.
+
+        """
+        return cls(
+            parameters.get("name"),
+            rasa.shared.core.events.deserialise_events(parameters.get("events", [])),
+        )