rasa-pro 3.8.16__py3-none-any.whl

rasa/shared/constants.py

@@ -0,0 +1,181 @@
+from __future__ import annotations
+
+from typing import List, Text
+
+
+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 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"
+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",
+    "EnterpriseSearchPolicy": "LOG_LEVEL_LLM_ENTERPRISE_SEARCH",
+    "IntentlessPolicy": "LOG_LEVEL_LLM_INTENTLESS_POLICY",
+    "ContextualResponseRephraser": "LOG_LEVEL_LLM_REPHRASER",
+}
+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_AUTOCONFIGURABLE_KEYS_CORE = ["policies"]
+CONFIG_AUTOCONFIGURABLE_KEYS_NLU = ["pipeline"]
+CONFIG_AUTOCONFIGURABLE_KEYS = (
+    CONFIG_AUTOCONFIGURABLE_KEYS_CORE + CONFIG_AUTOCONFIGURABLE_KEYS_NLU
+)
+CONFIG_KEYS_CORE = ["policies"] + CONFIG_MANDATORY_COMMON_KEYS
+CONFIG_KEYS_NLU = ["language", "pipeline"] + 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 = ["language"] + 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 Open Source 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"
+
+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_TYPE_CONFIG_KEY = "openai_api_type"
+OPENAI_API_TYPE_NO_PREFIX_CONFIG_KEY = "api_type"
+
+OPENAI_API_VERSION_CONFIG_KEY = "openai_api_version"
+OPENAI_API_VERSION_NO_PREFIX_CONFIG_KEY = "api_version"
+
+OPENAI_API_BASE_CONFIG_KEY = "openai_api_base"
+OPENAI_API_BASE_NO_PREFIX_CONFIG_KEY = "api_base"
+
+OPENAI_DEPLOYMENT_NAME_CONFIG_KEY = "deployment_name"
+OPENAI_DEPLOYMENT_CONFIG_KEY = "deployment"
+OPENAI_ENGINE_CONFIG_KEY = "engine"
+
+RASA_TYPE_CONFIG_KEY = "type"
+LANGCHAIN_TYPE_CONFIG_KEY = "_type"
+
+REQUESTS_CA_BUNDLE_ENV_VAR = "REQUESTS_CA_BUNDLE"
+REQUESTS_SSL_CONTEXT_PURPOSE_ENV_VAR = "REQUESTS_SSL_CONTEXT_PURPOSE"
+
+
+RASA_DEFAULT_FLOW_PATTERN_PREFIX = "pattern_"
+CONTEXT = "context"
+
+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_INVALID_INTENT = (
+    RASA_PATTERN_CANNOT_HANDLE_PREFIX + "invalid_intent"
+)
+
+ROUTE_TO_CALM_SLOT = "route_session_to_calm"

rasa/shared/core/constants.py

@@ -0,0 +1,168 @@
+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"
+SESSION_START_METADATA_SLOT = "session_started_metadata"
+
+DEFAULT_INTENTS = [
+    USER_INTENT_RESTART,
+    USER_INTENT_BACK,
+    USER_INTENT_OUT_OF_SCOPE,
+    USER_INTENT_SESSION_START,
+    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"
+
+
+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_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"
+
+# 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 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"
+    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 iff the mapping type is predefined.
+
+        That is, to evaluate the mapping no custom action execution is needed.
+        """
+        return self != SlotMappingType.CUSTOM
+
+
+# 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", [])),
+        )