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

rasa/shared/utils/pykwalify_extensions.py

@@ -0,0 +1,27 @@
+"""This module regroups custom validation functions, and it is
+loaded as an extension of the pykwalify library:
+
+https://pykwalify.readthedocs.io/en/latest/extensions.html#extensions
+"""
+
+from typing import Any, List, Dict, Text, Union
+
+from pykwalify.errors import SchemaError
+
+
+def require_response_keys(
+    responses: List[Dict[Text, Any]], _: Dict, __: Text
+) -> Union[SchemaError, bool]:
+    """Validates that response dicts have either the "text" key or the "custom" key."""
+    for response in responses:
+        if not isinstance(response, dict):
+            # this is handled by other validation rules
+            continue
+
+        if response.get("text") is None and not response.get("custom"):
+            return SchemaError(
+                "Missing 'text' or 'custom' key in response or "
+                "null 'text' value in response."
+            )
+
+    return True

rasa/shared/utils/schemas/config.yml

@@ -0,0 +1,2 @@
+allowempty: True
+type: map

rasa/shared/utils/schemas/domain.yml

@@ -0,0 +1,145 @@
+allowempty: True
+mapping:
+  version:
+    type: "str"
+    required: False
+    allowempty: False
+  intents:
+    type: "seq"
+    sequence:
+    - type: "map"
+      mapping:
+        use_entities:
+          type: "any"
+        ignore_entities:
+          type: "any"
+      allowempty: True
+    - type: "str"
+  entities:
+    type: "seq"
+    matching: "any"
+    sequence:
+      - type: "map"
+        mapping:
+          roles:
+            type: "seq"
+            sequence:
+              - type: "str"
+          groups:
+            type: "seq"
+            sequence:
+            - type: "str"
+        allowempty: True
+      - type: "str"
+  actions:
+    type: seq
+    matching: "any"
+    seq:
+      - type: str
+      - type: map
+        mapping:
+          regex;([A-Za-z]+):
+            type: map
+            mapping:
+              send_domain:
+                type: "bool"
+  responses:
+    # see shared/nlu/training_data/schemas/responses.yml
+    include: responses
+
+  slots:
+    type: "map"
+    allowempty: True
+    mapping:
+      regex;([A-Za-z]+):
+        type: "map"
+        allowempty: True
+        mapping:
+          influence_conversation:
+            type: "bool"
+            required: False
+          type:
+            type: "any"
+            required: True
+          values:
+            type: "seq"
+            sequence:
+              - type: "any"
+            required: False
+          min_value:
+            type: "number"
+            required: False
+          max_value:
+            type: "number"
+            required: False
+          initial_value:
+            type: "any"
+            required: False
+          mappings:
+           type: "seq"
+           required: False
+           allowempty: False
+           sequence:
+              - type: "map"
+                allowempty: True
+                mapping:
+                  type:
+                    type: "str"
+                  intent:
+                    type: "any"
+                  not_intent:
+                    type: "any"
+                  entity:
+                    type: "str"
+                  role:
+                    type: "str"
+                  group:
+                    type: "str"
+                  value:
+                    type: "any"
+                  action:
+                    type: "str"
+                  conditions:
+                    type: "seq"
+                    sequence:
+                      - type: "map"
+                        mapping:
+                          active_loop:
+                            type: "str"
+                            nullable: True
+                          requested_slot:
+                            type: "str"
+                          active_flow:
+                            type: "str"
+                            nullable: True
+  forms:
+    type: "map"
+    required: False
+    mapping:
+      regex;([A-Za-z]+):
+        type: "map"
+        mapping:
+          required_slots:
+            type: "seq"
+            sequence:
+              - type: str
+            required: False
+            allowempty: True
+          ignored_intents:
+            type: any
+  config:
+    type: "map"
+    allowempty: True
+    mapping:
+      store_entities_as_slots:
+        type: "bool"
+  session_config:
+    type: "map"
+    allowempty: True
+    mapping:
+      session_expiration_time:
+        type: "number"
+        range:
+          min: 0
+      carry_over_slots_to_new_session:
+        type: "bool"

rasa/shared/utils/schemas/events.py

@@ -0,0 +1,214 @@
+ENTITIES_SCHEMA = {
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "start": {"type": "integer"},
+            "end": {"type": "integer"},
+            "entity": {"type": "string"},
+            "confidence": {"type": "number"},
+            "extractor": {"type": ["string", "null"]},
+            "value": {},
+            "role": {"type": ["string", "null"]},
+            "group": {"type": ["string", "null"]},
+        },
+        "required": ["entity", "value"],
+    },
+}
+
+INTENT = {
+    "type": "object",
+    "properties": {"name": {"type": "string"}, "confidence": {"type": "number"}},
+}
+
+RESPONSE_SCHEMA = {
+    "type": "object",
+    "properties": {
+        "responses": {
+            "type": "array",
+            "items": {"type": "object", "properties": {"text": {"type": "string"}}},
+        },
+        "response_templates": {
+            "type": "array",
+            "items": {"type": "object", "properties": {"text": {"type": "string"}}},
+        },
+        "confidence": {"type": "number"},
+        "intent_response_key": {"type": "string"},
+        "utter_action": {"type": "string"},
+        "template_name": {"type": "string"},
+    },
+}
+
+RANKING_SCHEMA = {
+    "type": "array",
+    "items": {
+        "type": "object",
+        "properties": {
+            "id": {"type": "number"},
+            "confidence": {"type": "number"},
+            "intent_response_key": {"type": "string"},
+        },
+    },
+}
+
+USER_UTTERED = {
+    "properties": {
+        "event": {"const": "user"},
+        "text": {"type": ["string", "null"]},
+        "input_channel": {"type": ["string", "null"]},
+        "message_id": {"type": ["string", "null"]},
+        "parse_data": {
+            "type": "object",
+            "properties": {
+                "text": {"type": ["string", "null"]},
+                "intent_ranking": {"type": "array", "items": INTENT},
+                "intent": INTENT,
+                "entities": ENTITIES_SCHEMA,
+                "response_selector": {
+                    "type": "object",
+                    "oneOf": [
+                        {"properties": {"all_retrieval_intents": {"type": "array"}}},
+                        {
+                            "patternProperties": {
+                                "[\\w/]": {
+                                    "type": "object",
+                                    "properties": {
+                                        "response": RESPONSE_SCHEMA,
+                                        "ranking": RANKING_SCHEMA,
+                                    },
+                                }
+                            }
+                        },
+                    ],
+                },
+            },
+        },
+    }
+}
+
+ACTION_EXECUTED = {
+    "properties": {
+        "event": {"const": "action"},
+        "policy": {"type": ["string", "null"]},
+        "confidence": {"type": ["number", "null"]},
+        "name": {"type": ["string", "null"]},
+        "hide_rule_turn": {"type": "boolean"},
+        "action_text": {"type": ["string", "null"]},
+    }
+}
+
+SLOT_SET = {
+    "properties": {"event": {"const": "slot"}, "name": {"type": "string"}, "value": {}},
+    "required": ["name", "value"],
+}
+
+ENTITIES_ADDED = {
+    "properties": {"event": {"const": "entities"}, "entities": ENTITIES_SCHEMA},
+    "required": ["entities"],
+}
+
+USER_UTTERED_FEATURIZATION = {"properties": {"event": {"const": "user_featurization"}}}
+REMINDER_CANCELLED = {"properties": {"event": {"const": "cancel_reminder"}}}
+REMINDER_SCHEDULED = {"properties": {"event": {"const": "reminder"}}}
+ACTION_EXECUTION_REJECTED = {
+    "properties": {"event": {"const": "action_execution_rejected"}}
+}
+FORM_VALIDATION = {"properties": {"event": {"const": "form_validation"}}}
+LOOP_INTERRUPTED = {"properties": {"event": {"const": "loop_interrupted"}}}
+FORM = {"properties": {"event": {"const": "form"}}}
+ACTIVE_LOOP = {"properties": {"event": {"const": "active_loop"}}}
+ALL_SLOTS_RESET = {"properties": {"event": {"const": "reset_slots"}}}
+CONVERSATION_RESUMED = {"properties": {"event": {"const": "resume"}}}
+CONVERSATION_PAUSED = {"properties": {"event": {"const": "pause"}}}
+FOLLOWUP_ACTION = {"properties": {"event": {"const": "followup"}}}
+STORY_EXPORTED = {"properties": {"event": {"const": "export"}}}
+RESTARTED = {"properties": {"event": {"const": "restart"}}}
+ACTION_REVERTED = {"properties": {"event": {"const": "undo"}}}
+USER_UTTERANCE_REVERTED = {"properties": {"event": {"const": "rewind"}}}
+BOT_UTTERED = {"properties": {"event": {"const": "bot"}}}
+SESSION_STARTED = {"properties": {"event": {"const": "session_started"}}}
+SESSION_ENDED = {"properties": {"event": {"const": "session_ended"}}}
+AGENT_UTTERED = {"properties": {"event": {"const": "agent"}}}
+FLOW_STARTED = {
+    "properties": {"event": {"const": "flow_started"}, "flow_id": {"type": "string"}}
+}
+FLOW_INTERRUPTED = {
+    "properties": {
+        "event": {"const": "flow_interrupted"},
+        "flow_id": {"type": "string"},
+        "step_id": {"type": "string"},
+    }
+}
+FLOW_RESUMED = {
+    "properties": {
+        "event": {"const": "flow_resumed"},
+        "flow_id": {"type": "string"},
+        "step_id": {"type": "string"},
+    }
+}
+FLOW_COMPLETED = {
+    "properties": {
+        "event": {"const": "flow_completed"},
+        "flow_id": {"type": "string"},
+        "step_id": {"type": "string"},
+    }
+}
+FLOW_CANCELLED = {
+    "properties": {
+        "event": {"const": "flow_cancelled"},
+        "flow_id": {"type": "string"},
+        "step_id": {"type": "string"},
+    }
+}
+DIALOGUE_STACK_UPDATED = {
+    "properties": {"event": {"const": "stack"}, "update": {"type": "array"}}
+}
+ROUTING_SESSION_ENDED = {"properties": {"event": {"const": "routing_session_ended"}}}
+
+
+ROUTING_SESSION_ENDED = {"properties": {"event": {"const": "routing_session_ended"}}}
+
+EVENT_SCHEMA = {
+    "type": "object",
+    "properties": {
+        "event": {"type": "string"},
+        "timestamp": {"type": ["number", "null"]},
+        "metadata": {"type": ["object", "null"]},
+    },
+    "required": ["event"],
+    "oneOf": [
+        USER_UTTERED,
+        ACTION_EXECUTED,
+        SLOT_SET,
+        ENTITIES_ADDED,
+        USER_UTTERED_FEATURIZATION,
+        REMINDER_CANCELLED,
+        REMINDER_SCHEDULED,
+        ACTION_EXECUTION_REJECTED,
+        FORM_VALIDATION,
+        LOOP_INTERRUPTED,
+        FORM,
+        ACTIVE_LOOP,
+        ALL_SLOTS_RESET,
+        CONVERSATION_RESUMED,
+        CONVERSATION_PAUSED,
+        FOLLOWUP_ACTION,
+        STORY_EXPORTED,
+        RESTARTED,
+        ACTION_REVERTED,
+        USER_UTTERANCE_REVERTED,
+        BOT_UTTERED,
+        SESSION_STARTED,
+        AGENT_UTTERED,
+        FLOW_STARTED,
+        FLOW_INTERRUPTED,
+        FLOW_RESUMED,
+        FLOW_COMPLETED,
+        FLOW_CANCELLED,
+        DIALOGUE_STACK_UPDATED,
+        ROUTING_SESSION_ENDED,
+        SESSION_ENDED,
+    ],
+}
+
+EVENTS_SCHEMA = {"type": "array", "items": EVENT_SCHEMA}

rasa/shared/utils/schemas/model_config.yml

@@ -0,0 +1,36 @@
+allowempty: True
+mapping:
+  version:
+    type: "str"
+    required: False
+    allowempty: False
+  language:
+    type: "str"
+    required: False
+  assistant_id:
+    type: "str"
+    required: False
+  pipeline:
+    type: "seq"
+    required: False
+    sequence:
+      - type: "map"
+        # Only validate required items but do not validate each potential config param
+        # for the the components
+        allowempty: True
+        mapping:
+          name:
+            type: str
+            required: True
+  policies:
+    type: "seq"
+    required: False
+    sequence:
+      - type: "map"
+        # Only validate required items but do not validate each potential config param
+        # for the the policies
+        allowempty: True
+        mapping:
+          name:
+            type: str
+            required: True

rasa/shared/utils/schemas/stories.yml

@@ -0,0 +1,173 @@
+allowempty: True
+mapping:
+  version:
+    type: "str"
+    required: False
+    allowempty: False
+  stories:
+    type: "seq"
+    matching: "any"
+    sequence:
+    - type: "map"
+      mapping:
+        story:
+          type: "str"
+          allowempty: False
+        metadata:
+          type: "any"
+          required: False
+        steps:
+          type: "seq"
+          matching: "any"
+          sequence:
+          - type: "map"
+            mapping: &intent_and_entities
+              intent:
+                type: "str"
+                allowempty: False
+              user:
+                type: "str"
+                allowempty: False
+              commands:
+                type: "seq"
+                matching: "any"
+                sequence:
+                - type: "map"
+                  mapping:
+                    regex;(.*):
+                      type: "any"
+              entities:
+                type: "seq"
+                matching: "any"
+                sequence:
+                - type: "map"
+                  mapping:
+                    regex;(.*):
+                      type: "any"
+                    role:
+                      type: "str"
+                    group:
+                      type: "str"
+                - type: "str"
+          - type: "map"
+            mapping: &active_loop
+              active_loop:
+                type: "str"
+                allowempty: False
+          - type: "map"
+            mapping: &action
+              action:
+                type: "str"
+                allowempty: False
+          - type: "map"
+            mapping:
+              bot:
+                type: "str"
+                allowempty: False
+          - type: "map"
+            mapping:
+              stack:
+                type: "seq"
+                allowempty: False
+                sequence:
+                - type: "map"
+                  mapping:
+                    op:
+                      type: "str"
+                      allowempty: False
+                    path:
+                      type: "str"
+                      allowempty: False
+                    value:
+                      type: "any"
+          - type: "map"
+            mapping: &slot_was_set_seq
+              slot_was_set: &slot_was_set_seq_value
+                type: "seq"
+                matching: "any"
+                sequence:
+                - type: "map"
+                  mapping:
+                    regex;(.*):
+                      type: "text"
+                - type: "map"
+                  mapping:
+                    regex;(.*):
+                      type: "bool"
+                - type: "map"
+                  mapping:
+                    regex;(.*):
+                      type: "seq"
+                      matching: "any"
+                      sequence:
+                      - type: "map"
+                        mapping:
+                          regex;(.*):
+                            type: "text"
+                      - type: "map"
+                        mapping:
+                          regex;(.*):
+                            type: "bool"
+                      - type: "text"
+                - type: "str"
+                - type: "map"
+                  allowempty: True
+          - type: "map"
+            matching-rule: 'any'
+            mapping:
+              checkpoint:
+                type: "str"
+                allowempty: False
+              slot_was_set: *slot_was_set_seq_value
+          - type: "map"
+            mapping: &or_statement
+              or:
+                type: "seq"
+                matching: "any"
+                sequence:
+                - type: "map"
+                  mapping: *intent_and_entities
+                - type: "map"
+                  mapping: *slot_was_set_seq
+  rules:
+    type: "seq"
+    matching: "any"
+    sequence:
+    - type: "map"
+      mapping:
+        rule:
+          type: "str"
+          allowempty: False
+        metadata:
+          type: "any"
+          required: False
+        steps:
+          type: "seq"
+          matching: "any"
+          sequence:
+          - type: "map"
+            mapping: *intent_and_entities
+          - type: "map"
+            mapping: *action
+          - type: "map"
+            mapping: *active_loop
+          - type: "map"
+            mapping: *slot_was_set_seq
+          - type: "map"
+            mapping: *or_statement
+        condition:
+          type: "seq"
+          matching: "any"
+          sequence:
+          - type: "map"
+            mapping: *active_loop
+          - type: "map"
+            mapping: *slot_was_set_seq
+        conversation_start:
+          type: "bool"
+          allowempty: False
+        wait_for_user_input:
+          type: "bool"
+          allowempty: False
+  regex;(.*):
+    type: "any"