rasa-pro 3.9.18__py3-none-any.whl → 3.10.16__py3-none-any.whl

rasa/core/actions/e2e_stub_custom_action_executor.py

@@ -0,0 +1,68 @@
+import typing
+from typing import (
+    Any,
+    Dict,
+    Text,
+)
+
+import structlog
+
+from rasa.core.actions.custom_action_executor import (
+    CustomActionExecutor,
+)
+from rasa.shared.core.domain import Domain
+from rasa.shared.core.trackers import DialogueStateTracker
+from rasa.shared.exceptions import RasaException
+from rasa.utils.endpoints import EndpointConfig
+
+if typing.TYPE_CHECKING:
+    from rasa.e2e_test.stub_custom_action import StubCustomAction
+
+structlogger = structlog.get_logger(__name__)
+
+
+class E2EStubCustomActionExecutor(CustomActionExecutor):
+    def __init__(
+        self,
+        action_name: str,
+        action_endpoint: EndpointConfig,
+    ):
+        """Initializes the e2e stub custom action executor.
+
+        Args:
+            action_name: Name of the custom action.
+            action_endpoint: The endpoint to execute custom actions.
+        """
+        self.action_name = action_name
+        self.action_endpoint = action_endpoint
+        self.stub_custom_action = self.get_stub_custom_action()
+
+    def get_stub_custom_action(self) -> "StubCustomAction":
+        from rasa.e2e_test.stub_custom_action import get_stub_custom_action
+
+        stub_custom_action = get_stub_custom_action(
+            self.action_endpoint, self.action_name
+        )
+
+        if stub_custom_action:
+            return stub_custom_action
+
+        # TODO Update message below with reference to the docs
+        raise RasaException(
+            f"You are using custom action stubs, however action `{self.action_name}` "
+            f"has not been stubbed. Note that you cannot stub some custom actions "
+            f"while running an action server instance, you must stub all custom "
+            f"actions called by the tests in the provided test path."
+        )
+
+    async def run(
+        self,
+        tracker: "DialogueStateTracker",
+        domain: "Domain",
+        include_domain: bool = False,
+    ) -> Dict[Text, Any]:
+        structlogger.debug(
+            "action.e2e_stub_custom_action_executor.run",
+            action_name=self.action_name,
+        )
+        return self.stub_custom_action.as_dict()

rasa/core/actions/grpc_custom_action_executor.py

@@ -97,7 +97,7 @@ class GRPCCustomActionExecutor(CustomActionExecutor):
         Args:
             tracker: Tracker for the current conversation.
             domain: Domain of the assistant.
-            include_domain: If True, the domain information is included in the request.
+            include_domain: If True, the domain is included in the request.
 
         Returns:
             Response from the action server.
@@ -184,7 +184,7 @@ class GRPCCustomActionExecutor(CustomActionExecutor):
         Args:
             tracker: Tracker for the current conversation.
             domain: Domain of the assistant.
-            include_domain: If True, the domain information is included in the request.
+            include_domain: If True, the domain is included in the request.
 
         Returns:
             gRPC payload for the action server.

rasa/core/actions/http_custom_action_executor.py

@@ -1,6 +1,6 @@
 import json
 import logging
-from typing import TYPE_CHECKING, Any, Dict
+from typing import Any, Dict, Optional, TYPE_CHECKING
 
 import aiohttp
 
@@ -14,14 +14,16 @@ from rasa.core.constants import (
     DEFAULT_COMPRESS_ACTION_SERVER_REQUEST,
     DEFAULT_REQUEST_TIMEOUT,
 )
+from rasa.shared.core.domain import Domain
+from rasa.shared.core.trackers import DialogueStateTracker
 from rasa.shared.exceptions import RasaException
 from rasa.utils.common import get_bool_env_variable
-from rasa.utils.endpoints import ClientResponseError, EndpointConfig
 
 if TYPE_CHECKING:
     from rasa.shared.core.domain import Domain
     from rasa.shared.core.trackers import DialogueStateTracker
 
+from rasa.utils.endpoints import ClientResponseError, EndpointConfig
 
 logger = logging.getLogger(__name__)
 
@@ -48,7 +50,7 @@ class HTTPCustomActionExecutor(CustomActionExecutor):
     async def run(
         self,
         tracker: "DialogueStateTracker",
-        domain: "Domain",
+        domain: Optional["Domain"] = None,
         include_domain: bool = False,
     ) -> Dict[str, Any]:
         """Execute the custom action using an HTTP POST request.
@@ -56,8 +58,7 @@ class HTTPCustomActionExecutor(CustomActionExecutor):
         Args:
             tracker: The current state of the dialogue.
             domain: The domain object containing domain-specific information.
-            include_domain: If `True`, the domain information
-                            is included in the request.
+            include_domain: If True, the domain is included in the request.
 
         Returns:
             A dictionary containing the response from the custom action endpoint.

rasa/core/agent.py

@@ -1,38 +1,42 @@
 from __future__ import annotations
-from asyncio import AbstractEventLoop, CancelledError
+
 import functools
 import logging
 import os
+import uuid
+from asyncio import AbstractEventLoop, CancelledError
 from pathlib import Path
 from typing import Any, Callable, Dict, List, Optional, Text, Union
-import uuid
 
 import aiohttp
 from aiohttp import ClientError
 
+import rasa.shared.utils.io
 from rasa.core import jobs
 from rasa.core.channels.channel import OutputChannel, UserMessage
 from rasa.core.constants import DEFAULT_REQUEST_TIMEOUT
-from rasa.core.http_interpreter import RasaNLUHttpInterpreter
-from rasa.shared.core.domain import Domain
 from rasa.core.exceptions import AgentNotReady
-from rasa.shared.constants import DEFAULT_SENDER_ID
+from rasa.core.http_interpreter import RasaNLUHttpInterpreter
 from rasa.core.lock_store import InMemoryLockStore, LockStore
 from rasa.core.nlg import NaturalLanguageGenerator, TemplatedNaturalLanguageGenerator
 from rasa.core.policies.policy import PolicyPrediction
 from rasa.core.processor import MessageProcessor
-from rasa.core.tracker_store import FailSafeTrackerStore, InMemoryTrackerStore
-from rasa.shared.core.trackers import DialogueStateTracker, EventVerbosity
+from rasa.core.tracker_store import (
+    FailSafeTrackerStore,
+    InMemoryTrackerStore,
+    TrackerStore,
+)
+from rasa.core.utils import AvailableEndpoints
 from rasa.exceptions import ModelNotFound
+from rasa.nlu.persistor import StorageType
 from rasa.nlu.utils import is_url
+from rasa.shared.constants import DEFAULT_SENDER_ID
+from rasa.shared.core.domain import Domain
+from rasa.shared.core.trackers import DialogueStateTracker, EventVerbosity
 from rasa.shared.exceptions import RasaException
-import rasa.shared.utils.io
 from rasa.utils.common import TempDirectoryPath, get_temp_dir_name
 from rasa.utils.endpoints import EndpointConfig
 
-from rasa.core.tracker_store import TrackerStore
-from rasa.core.utils import AvailableEndpoints
-
 logger = logging.getLogger(__name__)
 
 
@@ -194,7 +198,7 @@ async def _schedule_model_pulling(
 async def load_agent(
     model_path: Optional[Text] = None,
     model_server: Optional[EndpointConfig] = None,
-    remote_storage: Optional[Text] = None,
+    remote_storage: Optional[StorageType] = None,
     endpoints: Optional[AvailableEndpoints] = None,
     loop: Optional[AbstractEventLoop] = None,
 ) -> Agent:
@@ -203,15 +207,15 @@ async def load_agent(
     Args:
         model_path: Path to the model if it's on disk.
         model_server: Configuration for a potential server which serves the model.
-        remote_storage: URL of remote storage for model.
+        remote_storage: Remote storage to use for loading the model.
         endpoints: Endpoint configuration.
         loop: Optional async loop to pass to broker creation.
 
     Returns:
         The instantiated `Agent` or `None`.
     """
-    from rasa.core.tracker_store import TrackerStore
     from rasa.core.brokers.broker import EventBroker
+    from rasa.core.tracker_store import TrackerStore
 
     tracker_store = None
     lock_store = None
@@ -299,7 +303,7 @@ class Agent:
         action_endpoint: Optional[EndpointConfig] = None,
         fingerprint: Optional[Text] = None,
         model_server: Optional[EndpointConfig] = None,
-        remote_storage: Optional[Text] = None,
+        remote_storage: Optional[StorageType] = None,
         http_interpreter: Optional[RasaNLUHttpInterpreter] = None,
         endpoints: Optional[AvailableEndpoints] = None,
     ):
@@ -329,11 +333,11 @@ class Agent:
         action_endpoint: Optional[EndpointConfig] = None,
         fingerprint: Optional[Text] = None,
         model_server: Optional[EndpointConfig] = None,
-        remote_storage: Optional[Text] = None,
+        remote_storage: Optional[StorageType] = None,
         http_interpreter: Optional[RasaNLUHttpInterpreter] = None,
         endpoints: Optional[AvailableEndpoints] = None,
     ) -> Agent:
-        """Constructs a new agent and loads the processer and model."""
+        """Constructs a new agent and loads the processor and model."""
         agent = Agent(
             domain=domain,
             generator=generator,

rasa/core/channels/__init__.py

@@ -22,6 +22,7 @@ from rasa.core.channels.slack import SlackInput
 from rasa.core.channels.telegram import TelegramInput
 from rasa.core.channels.twilio import TwilioInput
 from rasa.core.channels.twilio_voice import TwilioVoiceInput
+from rasa.core.channels.voice_aware.jambonz import JambonzVoiceAwareInput
 from rasa.core.channels.webexteams import WebexTeamsInput
 from rasa.core.channels.hangouts import HangoutsInput
 from rasa.core.channels.audiocodes import AudiocodesInput
@@ -47,6 +48,7 @@ input_channel_classes: List[Type[InputChannel]] = [
     AudiocodesInput,
     DevelopmentInspectInput,
     CVGInput,
+    JambonzVoiceAwareInput,
 ]
 
 # Mapping from an input channel name to its class to allow name based lookup.

rasa/core/channels/audiocodes.py

@@ -9,6 +9,7 @@ import structlog
 from jsonschema import ValidationError, validate
 from rasa.core import jobs
 from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+from rasa.core.channels.voice_aware.utils import validate_voice_license_scope
 from rasa.shared.constants import INTENT_MESSAGE_PREFIX
 from rasa.shared.exceptions import RasaException
 from sanic import Blueprint, response
@@ -16,11 +17,6 @@ from sanic.exceptions import NotFound, SanicException, ServerError
 from sanic.request import Request
 from sanic.response import HTTPResponse
 
-from rasa.utils.licensing import (
-    PRODUCT_AREA,
-    VOICE_SCOPE,
-    validate_license_from_env,
-)
 
 logger = logging.getLogger(__name__)
 structlogger = structlog.get_logger()
@@ -30,17 +26,6 @@ KEEP_ALIVE_SECONDS = 120
 KEEP_ALIVE_EXPIRATION_FACTOR = 1.5
 
 
-def validate_voice_license_scope() -> None:
-    """Validate that the correct license scope is present."""
-    logger.info(
-        f"Validating current Rasa Pro license scope which must include "
-        f"the '{VOICE_SCOPE}' scope to use the voice channel."
-    )
-
-    voice_product_scope = PRODUCT_AREA + " " + VOICE_SCOPE
-    validate_license_from_env(product_area=voice_product_scope)
-
-
 class Unauthorized(SanicException):
     """**Status**: 401 Not Authorized."""
 

rasa/core/channels/voice_aware/jambonz.py

@@ -0,0 +1,103 @@
+from typing import Any, Awaitable, Callable, Dict, Optional, Text
+
+import structlog
+from rasa.core.channels.channel import InputChannel, OutputChannel, UserMessage
+from rasa.core.channels.voice_aware.jambonz_protocol import (
+    send_ws_text_message,
+    websocket_message_handler,
+)
+from rasa.core.channels.voice_aware.utils import validate_voice_license_scope
+from rasa.shared.exceptions import RasaException
+from sanic import Blueprint, response, Websocket  # type: ignore[attr-defined]
+from sanic.request import Request
+from sanic.response import HTTPResponse
+
+from rasa.shared.utils.common import mark_as_experimental_feature
+
+
+structlogger = structlog.get_logger()
+
+CHANNEL_NAME = "jambonz"
+
+
+class JambonzVoiceAwareInput(InputChannel):
+    """Connector for the Jambonz platform."""
+
+    @classmethod
+    def name(cls) -> Text:
+        return CHANNEL_NAME
+
+    @classmethod
+    def from_credentials(cls, credentials: Optional[Dict[Text, Any]]) -> InputChannel:
+        return cls()
+
+    def __init__(self) -> None:
+        """Initializes the JambonzVoiceAwareInput channel."""
+        mark_as_experimental_feature("Jambonz Channel")
+        validate_voice_license_scope()
+
+    def blueprint(
+        self, on_new_message: Callable[[UserMessage], Awaitable[Any]]
+    ) -> Blueprint:
+        jambonz_webhook = Blueprint("jambonz_webhook", __name__)
+
+        @jambonz_webhook.route("/", methods=["GET"])
+        async def health(request: Request) -> HTTPResponse:
+            """Server health route."""
+            return response.json({"status": "ok"})
+
+        @jambonz_webhook.websocket("/websocket", subprotocols=["ws.jambonz.org"])  # type: ignore
+        async def websocket(request: Request, ws: Websocket) -> None:
+            """Triggered on new websocket connection."""
+            async for message in ws:
+                await websocket_message_handler(message, on_new_message, ws)
+
+        return jambonz_webhook
+
+
+class JambonzWebsocketOutput(OutputChannel):
+    @classmethod
+    def name(cls) -> Text:
+        return CHANNEL_NAME
+
+    def __init__(self, ws: Any, conversation_id: Text) -> None:
+        self.ws = ws
+        self.conversation_id = conversation_id
+
+    async def add_message(self, message: Dict) -> None:
+        """Add metadata and add message.
+
+        Message is added to the list of
+        activities to be sent to the Jambonz Websocket server.
+        """
+        text_message = message.get("text", "")
+        structlogger.debug(
+            "jambonz.add.message",
+            class_name=self.__class__.__name__,
+            message=text_message,
+        )
+
+        # send message to jambonz
+        await send_ws_text_message(self.ws, message.get("text"))
+
+    async def send_text_message(
+        self, recipient_id: Text, text: Text, **kwargs: Any
+    ) -> None:
+        """Send a text message."""
+        await self.add_message({"type": "message", "text": text})
+
+    async def send_image_url(
+        self, recipient_id: Text, image: Text, **kwargs: Any
+    ) -> None:
+        raise RasaException("Images are not supported by this channel")
+
+    async def send_attachment(
+        self, recipient_id: Text, attachment: Text, **kwargs: Any
+    ) -> None:
+        raise RasaException("Attachments are not supported by this channel")
+
+    async def send_custom_json(
+        self, recipient_id: Text, json_message: Dict[Text, Any], **kwargs: Any
+    ) -> None:
+        """Send an activity."""
+        await self.add_message(json_message)