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

rasa/markers/marker.py

@@ -0,0 +1,269 @@
+import logging
+from typing import List, Optional, Text
+
+from rasa.shared.core.domain import Domain
+from rasa.shared.core.events import ActionExecuted, Event, SlotSet, UserUttered
+
+from rasa.markers.marker_base import (
+    ConditionMarker,
+    Marker,
+    MarkerRegistry,
+    OperatorMarker,
+)
+
+logger = logging.getLogger(__name__)
+
+
+@MarkerRegistry.configurable_marker
+class AndMarker(OperatorMarker):
+    """Checks that all sub-markers apply."""
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "and"
+
+    @staticmethod
+    def negated_tag() -> Text:
+        """Returns the tag to be used in a config file for the negated version."""
+        return "at_least_one_not"
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        return all(marker.history[-1] for marker in self.sub_markers)
+
+
+@MarkerRegistry.configurable_marker
+class OrMarker(OperatorMarker):
+    """Checks that at least one sub-marker applies."""
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "or"
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        return any(marker.history[-1] for marker in self.sub_markers)
+
+
+@MarkerRegistry.configurable_marker
+class NotMarker(OperatorMarker):
+    """Checks that at least one sub-marker applies."""
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "not"
+
+    @staticmethod
+    def expected_number_of_sub_markers() -> Optional[int]:
+        """Returns the expected number of sub-markers (if there is any)."""
+        return 1
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        return not self.sub_markers[0].history[-1]
+
+
+@MarkerRegistry.configurable_marker
+class SequenceMarker(OperatorMarker):
+    """Checks that all sub-markers apply consecutively in the specified order.
+
+    The sequence marker application follows two rules:
+    (1) Given a sequence of sub-markers `m_0, m_1,...,m_n`, the sequence marker applies
+        at the `i`-th event if all sub-markers successively applied to some previous
+        events and the last sub-marker applies at the current `i`-th events.
+    (2) If the sequence marker applies at the `i`-th event, then for it's next
+        application the events up to the `i`-th event will be ignored.
+
+    """
+
+    def __init__(
+        self, markers: List[Marker], negated: bool = False, name: Optional[Text] = None
+    ) -> None:
+        """Instantiate a new sequence marker.
+
+        Args:
+            markers: the sub-markers listed in the expected order
+            negated: whether this marker should be negated (i.e. a negated marker
+                applies if and only if the non-negated marker does not apply)
+            name: a custom name that can be used to replace the default string
+                conversion of this marker
+        """
+        super().__init__(markers=markers, negated=negated, name=name)
+        self._progress: int = 0
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "seq"
+
+    def _to_str_with(self, tag: Text) -> Text:
+        sub_markers_str = " -> ".join(str(marker) for marker in self.sub_markers)
+        return f"{tag}({sub_markers_str})"
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        # Remember that all the sub-markers have been updated before this tracker.
+        # Hence, whether the sub-markers apply to the current `event` is stored in the
+        # last item of their history. Hence, to check if we made some progress in
+        # identifying a sequence, we can simply check:
+        if self.sub_markers[self._progress].history[-1]:
+            self._progress += 1
+        # If we were able to apply every sub-marker once, we reset our progress:
+        if self._progress == len(self.sub_markers):
+            self._progress = 0
+            return True
+        return False
+
+
+@MarkerRegistry.configurable_marker
+class OccurrenceMarker(OperatorMarker):
+    """Checks that all sub-markers applied at least once in history.
+
+    It doesn't matter if the sub markers stop applying later in history. If they
+    applied at least once they will always evaluate to `True`.
+    """
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "at_least_once"
+
+    @staticmethod
+    def negated_tag() -> Optional[Text]:
+        """Returns the tag to be used in a config file for the negated version."""
+        return "never"
+
+    @staticmethod
+    def expected_number_of_sub_markers() -> Optional[int]:
+        """Returns the expected number of sub-markers (if there is any)."""
+        return 1
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        occurred_before = False
+
+        if self.history:
+            occurred_before = self.history[-1]
+            if self.negated:
+                occurred_before = not occurred_before
+
+        return occurred_before or self.sub_markers[0].history[-1]
+
+    def relevant_events(self) -> List[int]:
+        """Only return index of first match (see parent class for full docstring)."""
+        try:
+            return [self.history.index(True)]
+        except ValueError:
+            return []
+
+
+@MarkerRegistry.configurable_marker
+class ActionExecutedMarker(ConditionMarker):
+    """Checks whether an action is executed at the current step."""
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "action"
+
+    @staticmethod
+    def negated_tag() -> Optional[Text]:
+        """Returns the tag to be used in a config file for the negated version."""
+        return "not_action"
+
+    def validate_against_domain(self, domain: Domain) -> bool:
+        """Checks that this marker (and its children) refer to entries in the domain.
+
+        Args:
+            domain: The domain to check against
+        """
+        valid = self.text in domain.action_names_or_texts
+
+        if not valid:
+            logger.error(
+                f"Referenced action '{self.text}' does not exist in the domain"
+            )
+
+        return valid
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        return isinstance(event, ActionExecuted) and event.action_name == self.text
+
+
+@MarkerRegistry.configurable_marker
+class IntentDetectedMarker(ConditionMarker):
+    """Checks whether an intent is expressed at the current step.
+
+    More precisely it applies at an event if this event is a `UserUttered` event
+    where either (1) the retrieval intent or (2) just the intent coincides with
+    the specified text.
+    """
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "intent"
+
+    @staticmethod
+    def negated_tag() -> Optional[Text]:
+        """Returns the tag to be used in a config file for the negated version."""
+        return "not_intent"
+
+    def validate_against_domain(self, domain: Domain) -> bool:
+        """Checks that this marker (and its children) refer to entries in the domain.
+
+        Args:
+            domain: The domain to check against
+        """
+        valid = self.text in domain.intent_properties
+
+        if not valid:
+            logger.error(
+                f"Referenced intent '{self.text}' does not exist in the domain"
+            )
+
+        return valid
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        return isinstance(event, UserUttered) and self.text in [
+            event.intent_name,
+            event.full_retrieval_intent_name,
+        ]
+
+
+@MarkerRegistry.configurable_marker
+class SlotSetMarker(ConditionMarker):
+    """Checks whether a slot is set at the current step.
+
+    The actual `SlotSet` event might have happened at an earlier step.
+    """
+
+    @staticmethod
+    def positive_tag() -> Text:
+        """Returns the tag to be used in a config file."""
+        return "slot_was_set"
+
+    @staticmethod
+    def negated_tag() -> Optional[Text]:
+        """Returns the tag to be used in a config file for the negated version."""
+        return "slot_was_not_set"
+
+    def validate_against_domain(self, domain: Domain) -> bool:
+        """Checks that this marker (and its children) refer to entries in the domain.
+
+        Args:
+            domain: The domain to check against.
+        """
+        valid = any(self.text == slot.name for slot in domain.slots)
+
+        if not valid:
+            logger.error(f"Referenced slot '{self.text}' does not exist in the domain")
+
+        return valid
+
+    def _non_negated_version_applies_at(self, event: Event) -> bool:
+        if isinstance(event, SlotSet) and event.key == self.text:
+            # slot is set if and only if it's value is not `None`
+            return event.value is not None
+        if self.history:
+            was_set = self.history[-1] if not self.negated else not self.history[-1]
+            return was_set
+        return False