rasa-pro 3.14.1__py3-none-any.whl → 3.15.0a1__py3-none-any.whl

rasa/builder/telemetry/copilot_langfuse_telemetry.py

@@ -0,0 +1,384 @@
+from functools import wraps
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    AsyncGenerator,
+    Callable,
+    Dict,
+    List,
+    Optional,
+)
+
+if TYPE_CHECKING:
+    from rasa.builder.copilot.copilot import Copilot
+    from rasa.builder.copilot.models import CopilotContext
+    from rasa.builder.document_retrieval.inkeep_document_retrieval import (
+        InKeepDocumentRetrieval,
+    )
+
+import langfuse
+import structlog
+
+from rasa.builder.copilot.copilot_response_handler import CopilotResponseHandler
+from rasa.builder.copilot.models import (
+    CopilotRequest,
+    EventContent,
+    UsageStatistics,
+    UserChatMessage,
+)
+from rasa.builder.document_retrieval.models import Document
+from rasa.builder.models import BotFiles
+from rasa.builder.shared.tracker_context import TrackerContext
+
+structlogger = structlog.get_logger()
+
+
+class CopilotLangfuseTelemetry:
+    @staticmethod
+    def trace_copilot_tracker_context(
+        tracker_context: Optional[TrackerContext],
+        max_conversation_turns: int,
+        session_id: str,
+    ) -> None:
+        """Trace the copilot tracker context.
+
+        Args:
+            tracker_context: The tracker context.
+            max_conversation_turns: The maximum number of conversation turns to be
+                fetched from the tracker.
+            session_id: The session ID used to fetch the right tracker.
+        """
+        langfuse_client = langfuse.get_client()
+        # Use `update_current_span` to update the current span of the trace.
+        langfuse_client.update_current_span(
+            output={
+                "tracker_context": (
+                    tracker_context.model_dump() if tracker_context else None
+                ),
+            },
+            metadata={
+                "max_conversation_turns": max_conversation_turns,
+                "session_id": session_id,
+            },
+        )
+
+    @staticmethod
+    def trace_copilot_relevant_assistant_files(
+        relevant_assistant_files: BotFiles,
+    ) -> None:
+        """Trace the copilot relevant assistant files.
+
+        Args:
+            relevant_assistant_files: The relevant assistant files.
+        """
+        langfuse_client = langfuse.get_client()
+        # Use `update_current_span` to update the current span of the trace.
+        langfuse_client.update_current_span(
+            output={
+                "relevant_assistant_files": relevant_assistant_files,
+            },
+        )
+
+    @staticmethod
+    def setup_copilot_endpoint_call_trace_attributes(
+        hello_rasa_project_id: str,
+        chat_id: str,
+        user_id: str,
+        request: CopilotRequest,
+        handler: CopilotResponseHandler,
+        relevant_documents: list[Document],
+        copilot_context: "CopilotContext",
+    ) -> None:
+        """Set up the current langfuse trace with project and user context.
+
+        Args:
+            hello_rasa_project_id: The Hello Rasa project ID.
+            chat_id: The chat/conversation ID.
+            user_id: The user ID.
+            request: The parsed CopilotRequest object.
+            handler: The response handler containing generated responses.
+            relevant_documents: The relevant documents used to generate the response.
+        """
+        langfuse_client = langfuse.get_client()
+        user_message = CopilotLangfuseTelemetry._extract_last_user_message_content(
+            request
+        )
+        tracker_event_attachments = (
+            CopilotLangfuseTelemetry._extract_tracker_event_attachments(request)
+        )
+        response_category = CopilotLangfuseTelemetry._extract_response_category(handler)
+        reference_section_entries = CopilotLangfuseTelemetry._extract_references(
+            handler, relevant_documents
+        )
+
+        # Create a session ID as a composite ID from project id, user id and chat id
+        session_id = CopilotLangfuseTelemetry._create_session_id(
+            hello_rasa_project_id, user_id, chat_id
+        )
+        # Use `update_current_trace` to update the top level trace.
+        langfuse_client.update_current_trace(
+            user_id=user_id,
+            session_id=session_id,
+            input={
+                "message": user_message,
+                "tracker_event_attachments": tracker_event_attachments,
+            },
+            output={
+                "answer": CopilotLangfuseTelemetry._full_text(handler),
+                "response_category": response_category,
+                "references": reference_section_entries,
+            },
+            metadata={
+                "ids": {
+                    "user_id": user_id,
+                    "project_id": hello_rasa_project_id,
+                    "chat_history_id": chat_id,
+                },
+                "copilot_additional_context": {
+                    "relevant_documents": [
+                        doc.model_dump() for doc in relevant_documents
+                    ],
+                    "relevant_assistant_files": copilot_context.assistant_files,
+                    "assistant_tracker_context": (
+                        copilot_context.tracker_context.model_dump()
+                        if copilot_context.tracker_context
+                        else None
+                    ),
+                    "assistant_logs": copilot_context.assistant_logs,
+                    "copilot_chat_history": [
+                        message.model_dump()
+                        for message in copilot_context.copilot_chat_history
+                    ],
+                },
+            },
+            tags=[response_category] if response_category else [],
+        )
+
+    @staticmethod
+    def trace_copilot_streaming_generation(
+        func: Callable[..., AsyncGenerator[str, None]],
+    ) -> Callable[..., AsyncGenerator[str, None]]:
+        """Custom decorator for tracing async streaming of the Copilot's LLM generation.
+
+        This decorator handles Langfuse tracing for async streaming of the Copilot's LLM
+        generation by manually managing the generation span and updating it with usage
+        statistics after the stream completes.
+        """
+
+        @wraps(func)
+        async def wrapper(
+            self: "Copilot", messages: List[Dict[str, Any]]
+        ) -> AsyncGenerator[str, None]:
+            langfuse_client = langfuse.get_client()
+
+            with langfuse_client.start_as_current_generation(
+                name=f"{self.__class__.__name__}.{func.__name__}",
+                input={"messages": messages},
+            ) as generation:
+                output = []
+                # Call the original streaming function and start capturing the output
+                async for chunk in func(self, messages):
+                    output.append(chunk)
+                    yield chunk
+
+                # Update the span's model parameters and output after streaming is
+                # complete
+                generation.update(
+                    model_parameters=self.llm_config, output="".join(output)
+                )
+
+                # Update the span's usage statistics after streaming is complete
+                if self.usage_statistics:
+                    CopilotLangfuseTelemetry._update_generation_span_with_usage_statistics(
+                        generation, self.usage_statistics
+                    )
+
+        return wrapper
+
+    @staticmethod
+    def trace_document_retrieval_generation(
+        func: Callable[..., Any],
+    ) -> Callable[..., Any]:
+        """Custom decorator for tracing document retrieval generation with Langfuse.
+
+        This decorator handles Langfuse tracing for document retrieval API calls
+        by manually managing the generation span and updating it with usage statistics.
+        """
+
+        @wraps(func)
+        async def wrapper(
+            self: "InKeepDocumentRetrieval",
+            query: str,
+            temperature: float,
+            timeout: float,
+        ) -> Any:
+            langfuse_client = langfuse.get_client()
+
+            with langfuse_client.start_as_current_generation(
+                name=f"{self.__class__.__name__}.{func.__name__}",
+                input={
+                    "query": query,
+                    "temperature": temperature,
+                    "timeout": timeout,
+                },
+            ) as generation:
+                # Call the original function
+                response = await func(self, query, temperature, timeout)
+
+                # Update the span with response content
+                generation.update(
+                    output=response,
+                    model_parameters={
+                        "temperature": str(temperature),
+                        "timeout": str(timeout),
+                    },
+                )
+
+                # Update usage statistics if available
+                usage_statistics = UsageStatistics.from_chat_completion_response(
+                    response
+                )
+                if usage_statistics:
+                    CopilotLangfuseTelemetry._update_generation_span_with_usage_statistics(
+                        generation, usage_statistics
+                    )
+
+                return response
+
+        return wrapper
+
+    @staticmethod
+    def _extract_last_user_message_content(request: CopilotRequest) -> Optional[str]:
+        """Extract the last user message from the CopilotRequest object.
+
+        Args:
+            request: The CopilotRequest object.
+        """
+        if not isinstance(request.last_message, UserChatMessage):
+            return None
+        return request.last_message.get_flattened_text_content()
+
+    @staticmethod
+    def _extract_tracker_event_attachments(
+        request: CopilotRequest,
+    ) -> list[Dict[str, Any]]:
+        """Extract tracker event attachments from the last user message.
+
+        Args:
+            request: The CopilotRequest object.
+
+        Returns:
+            The event content block sent with the last user message in the
+            dictionary format.
+        """
+        last_message = request.last_message
+        if not isinstance(last_message, UserChatMessage):
+            return []
+        return [
+            attachment.model_dump()
+            for attachment in last_message.get_content_blocks_by_type(EventContent)
+        ]
+
+    @staticmethod
+    def _extract_response_category(handler: CopilotResponseHandler) -> Optional[str]:
+        """Extract the response category from the response handler.
+
+        Args:
+            handler: The response handler containing generated response.
+
+        Returns:
+            The response category of the first generated response, or None if no
+            responses.
+        """
+        if not handler.generated_responses:
+            return None
+        # The handler contains multiple chunks of one response. We use the first chunk's
+        # response category.
+        return handler.generated_responses[0].response_category.value
+
+    @staticmethod
+    def _full_text(handler: CopilotResponseHandler) -> str:
+        """Extract full text from the response handler.
+
+        Args:
+            handler: The response handler containing generated responses.
+
+        Returns:
+            The concatenated content of all generated responses.
+        """
+        return "".join(
+            response.content
+            for response in handler.generated_responses
+            if getattr(response, "content", None)
+        )
+
+    @staticmethod
+    def _extract_references(
+        handler: CopilotResponseHandler,
+        relevant_documents: list[Document],
+    ) -> List[Dict[str, Any]]:
+        """Extract reference entries from the response handler.
+
+        Args:
+            handler: The response handler containing generated responses.
+            relevant_documents: The relevant documents used to generate the response.
+
+        Returns:
+            A list of reference entries in dictionary format.
+        """
+        if not relevant_documents:
+            return []
+
+        reference_entries: list[Dict[str, Any]] = []
+        reference_section = handler.extract_references(relevant_documents)
+        for reference_entry in reference_section.references:
+            reference_entries.append(
+                reference_entry.model_dump(
+                    exclude={"response_category", "response_completeness"}
+                )
+            )
+
+        return reference_entries
+
+    @staticmethod
+    def _update_generation_span_with_usage_statistics(
+        generation_span: langfuse.LangfuseGeneration,
+        usage_statistics: UsageStatistics,
+    ) -> None:
+        """Update the generation span with the usage statistics.
+
+        Args:
+            generation_span: The generation span.
+            usage_statistics: The usage statistics of the generation.
+        """
+        generation_span.update(
+            usage_details={
+                "input_non_cached_usage": (
+                    usage_statistics.non_cached_prompt_tokens or 0
+                ),
+                "input_cached_usage": usage_statistics.cached_prompt_tokens or 0,
+                "output_usage": usage_statistics.completion_tokens or 0,
+                "total": usage_statistics.total_tokens or 0,
+            },
+            cost_details={
+                "input_non_cached_cost": usage_statistics.non_cached_cost or 0,
+                "input_cached_cost": usage_statistics.cached_cost or 0,
+                "output_cost": usage_statistics.output_cost or 0,
+                "total": usage_statistics.total_cost or 0,
+            },
+            model=usage_statistics.model,
+        )
+
+    @staticmethod
+    def _create_session_id(
+        hello_rasa_project_id: str,
+        user_id: str,
+        chat_id: str,
+    ) -> str:
+        """Create a session ID as a composite from project id, user id and chat id."""
+        pattern = "PID-{project_id}-UID-{user_id}-CID-{chat_id}"
+        return pattern.format(
+            project_id=hello_rasa_project_id,
+            user_id=user_id,
+            chat_id=chat_id,
+        )

rasa/builder/{copilot/telemetry.py → telemetry/copilot_segment_telemetry.py}

@@ -1,14 +1,25 @@
 import datetime as dt
 import os
 import uuid
-from typing import Any, Iterable, Optional, Sequence
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Iterable,
+    Optional,
+    Sequence,
+)
+
+if TYPE_CHECKING:
+    pass
 
 import structlog
 
 from rasa import telemetry
 from rasa.builder.copilot.constants import COPILOT_SEGMENT_WRITE_KEY_ENV_VAR
 from rasa.builder.copilot.copilot_response_handler import CopilotResponseHandler
-from rasa.builder.copilot.models import EventContent
+from rasa.builder.copilot.models import (
+    EventContent,
+)
 from rasa.builder.document_retrieval.models import Document
 from rasa.telemetry import (
     SEGMENT_TRACK_ENDPOINT,
@@ -56,7 +67,7 @@ def _track(event: str, user_id: str, properties: dict) -> None:
         structlogger.warning("builder.telemetry.track_failed", error=str(e))
 
 
-class CopilotTelemetry:
+class CopilotSegmentTelemetry:
     def __init__(
         self,
         *,
@@ -96,6 +107,7 @@ class CopilotTelemetry:
         latency_ms: int,
         model: str,
         input_tokens: Optional[int] = None,
+        cached_prompt_tokens: Optional[int] = None,
         output_tokens: Optional[int] = None,
         total_tokens: Optional[int] = None,
         system_message: Optional[dict[str, Any]] = None,
@@ -112,6 +124,7 @@ class CopilotTelemetry:
             latency_ms: End-to-end Copilot latency to produce this response.
             model: The model used to generate the response.
             input_tokens: Number of input tokens used (optional).
+            cached_prompt_tokens: Number of cached prompt tokens.
             output_tokens: Number of output tokens generated (optional).
             total_tokens: Total number of tokens used (input + output) (optional).
             system_message: The system message used (optional).
@@ -135,6 +148,7 @@ class CopilotTelemetry:
             "latency_ms": latency_ms,
             "model": model,
             "input_tokens": input_tokens,
+            "cached_prompt_tokens": cached_prompt_tokens,
             "output_tokens": output_tokens,
             "total_tokens": total_tokens,
             "chat_history": chat_history,
@@ -193,6 +207,7 @@ class CopilotTelemetry:
         latency_ms: int,
         model: str,
         prompt_tokens: int,
+        cached_prompt_tokens: int,
         completion_tokens: int,
         total_tokens: int,
         system_message: dict[str, Any],
@@ -208,11 +223,13 @@ class CopilotTelemetry:
             latency_ms: End-to-end Copilot latency to produce this response.
             model: The model used to generate the response.
             prompt_tokens: Number of input tokens used.
+            cached_prompt_tokens: Number of cached prompt tokens.
             completion_tokens: Number of output tokens generated.
             total_tokens: Total number of tokens used (input + output).
             system_message: The system message used.
             chat_history: The chat history messages used.
             last_user_message: The last user message used.
+            tracker_event_attachments: List of tracker event attachments.
         """
         structlogger.debug("builder.telemetry.log_copilot_from_handler")
         text = self._full_text(handler)
@@ -223,6 +240,7 @@ class CopilotTelemetry:
             latency_ms=latency_ms,
             model=model,
             input_tokens=prompt_tokens,
+            cached_prompt_tokens=cached_prompt_tokens,
             output_tokens=completion_tokens,
             total_tokens=total_tokens,
             system_message=system_message,

rasa/constants.py

@@ -33,6 +33,7 @@ ENV_MCP_LOGGING_ENABLED = "MCP_LOGGING_ENABLED"
 ENV_LOG_LEVEL_MATPLOTLIB = "LOG_LEVEL_MATPLOTLIB"
 ENV_LOG_LEVEL_RABBITMQ = "LOG_LEVEL_RABBITMQ"
 ENV_LOG_LEVEL_KAFKA = "LOG_LEVEL_KAFKA"
+ENV_LOG_LEVEL_PYMONGO = "LOG_LEVEL_PYMONGO"
 
 DEFAULT_SANIC_WORKERS = 1
 ENV_SANIC_WORKERS = "SANIC_WORKERS"

rasa/core/policies/flows/flow_executor.py

@@ -357,6 +357,10 @@ def reset_scoped_slots(
     flow_persistable_slots = current_flow.persisted_slots
 
     for step in current_flow.steps_with_calls_resolved:
+        # take persisted slots from called flows into consideration
+        # before resetting slots
+        if isinstance(step, CallFlowStep) and step.called_flow_reference:
+            flow_persistable_slots.extend(step.called_flow_reference.persisted_slots)
         if isinstance(step, CollectInformationFlowStep):
             # reset all slots scoped to the flow
             slot_name = step.collect
@@ -368,7 +372,22 @@ def reset_scoped_slots(
     # slots set by the set slots step should be reset after the flow ends
     # unless they are also used in a collect step where `reset_after_flow_ends`
     # is set to `False` or set in the `persisted_slots` list.
-    resettable_set_slots = [
+    resettable_set_slots = _get_resettable_set_slots(
+        current_flow, not_resettable_slot_names, flow_persistable_slots
+    )
+    for name in resettable_set_slots:
+        _reset_slot(name, tracker)
+
+    return events
+
+
+def _get_resettable_set_slots(
+    current_flow: Flow,
+    not_resettable_slot_names: set[Text],
+    flow_persistable_slots: List[Text],
+) -> List[Text]:
+    """Get list of slot names from SetSlotsFlowStep that should be reset."""
+    return [
         slot["key"]
         for step in current_flow.steps_with_calls_resolved
         if isinstance(step, SetSlotsFlowStep)
@@ -377,11 +396,6 @@ def reset_scoped_slots(
         and slot["key"] not in flow_persistable_slots
     ]
 
-    for name in resettable_set_slots:
-        _reset_slot(name, tracker)
-
-    return events
-
 
 async def advance_flows(
     tracker: DialogueStateTracker,

rasa/core/run.py

@@ -328,10 +328,21 @@ def serve_application(
 
     logger.info(f"Starting Rasa server on {protocol}://{interface}:{port}")
 
-    app.register_listener(
-        partial(load_agent_on_start, model_path, endpoints, remote_storage, sub_agents),
-        "before_server_start",
-    )
+    async def load_agent_and_check_failure(app: Sanic, loop: AbstractEventLoop) -> None:
+        """Load agent and exit if it fails in non-debug mode."""
+        try:
+            await load_agent_on_start(
+                model_path, endpoints, remote_storage, sub_agents, app, loop
+            )
+        except Exception as e:
+            is_debug = logger.isEnabledFor(logging.DEBUG)
+            if is_debug:
+                raise e  # show traceback in debug
+            # non-debug: log and exit without starting server
+            logger.error(f"Failed to load agent: {e}")
+            os._exit(1)  # Any other exit method would show a traceback.
+
+    app.register_listener(load_agent_and_check_failure, "before_server_start")
 
     app.register_listener(
         licensing.validate_limited_server_license, "after_server_start"

rasa/e2e_test/e2e_config.py

@@ -72,9 +72,10 @@ class LLMJudgeConfig(BaseModel):
 
         llm_config = resolve_model_client_config(llm_config)
         llm_config, llm_extra_parameters = cls.extract_attributes(llm_config)
-        llm_config = combine_custom_and_default_config(
-            llm_config, cls.get_default_llm_config()
-        )
+        if not llm_config:
+            llm_config = combine_custom_and_default_config(
+                llm_config, cls.get_default_llm_config()
+            )
         embeddings_config = resolve_model_client_config(embeddings)
         embeddings_config, embeddings_extra_parameters = cls.extract_attributes(
             embeddings_config

rasa/engine/recipes/default_components.py

@@ -27,22 +27,32 @@ from rasa.shared.utils.common import conditional_import
 
 # components dependent on tensorflow
 TEDPolicy, TED_POLICY_AVAILABLE = conditional_import(
-    "rasa.core.policies.ted_policy", "TEDPolicy"
+    "rasa.core.policies.ted_policy", "TEDPolicy", check_installation_setup=True
 )
 UnexpecTEDIntentPolicy, UNEXPECTED_INTENT_POLICY_AVAILABLE = conditional_import(
-    "rasa.core.policies.unexpected_intent_policy", "UnexpecTEDIntentPolicy"
+    "rasa.core.policies.unexpected_intent_policy",
+    "UnexpecTEDIntentPolicy",
+    check_installation_setup=True,
 )
 DIETClassifier, DIET_CLASSIFIER_AVAILABLE = conditional_import(
-    "rasa.nlu.classifiers.diet_classifier", "DIETClassifier"
+    "rasa.nlu.classifiers.diet_classifier",
+    "DIETClassifier",
+    check_installation_setup=True,
 )
 ConveRTFeaturizer, CONVERT_FEATURIZER_AVAILABLE = conditional_import(
-    "rasa.nlu.featurizers.dense_featurizer.convert_featurizer", "ConveRTFeaturizer"
+    "rasa.nlu.featurizers.dense_featurizer.convert_featurizer",
+    "ConveRTFeaturizer",
+    check_installation_setup=True,
 )
 LanguageModelFeaturizer, LANGUAGE_MODEL_FEATURIZER_AVAILABLE = conditional_import(
-    "rasa.nlu.featurizers.dense_featurizer.lm_featurizer", "LanguageModelFeaturizer"
+    "rasa.nlu.featurizers.dense_featurizer.lm_featurizer",
+    "LanguageModelFeaturizer",
+    check_installation_setup=True,
 )
 ResponseSelector, RESPONSE_SELECTOR_AVAILABLE = conditional_import(
-    "rasa.nlu.selectors.response_selector", "ResponseSelector"
+    "rasa.nlu.selectors.response_selector",
+    "ResponseSelector",
+    check_installation_setup=True,
 )
 
 # components dependent on skops

rasa/graph_components/validators/default_recipe_validator.py

@@ -40,16 +40,22 @@ from rasa.shared.utils.common import conditional_import
 
 # Conditional imports for TensorFlow-dependent components
 TEDPolicy, TED_POLICY_AVAILABLE = conditional_import(
-    "rasa.core.policies.ted_policy", "TEDPolicy"
+    "rasa.core.policies.ted_policy", "TEDPolicy", check_installation_setup=True
 )
 UnexpecTEDIntentPolicy, UNEXPECTED_INTENT_POLICY_AVAILABLE = conditional_import(
-    "rasa.core.policies.unexpected_intent_policy", "UnexpecTEDIntentPolicy"
+    "rasa.core.policies.unexpected_intent_policy",
+    "UnexpecTEDIntentPolicy",
+    check_installation_setup=True,
 )
 DIETClassifier, DIET_CLASSIFIER_AVAILABLE = conditional_import(
-    "rasa.nlu.classifiers.diet_classifier", "DIETClassifier"
+    "rasa.nlu.classifiers.diet_classifier",
+    "DIETClassifier",
+    check_installation_setup=True,
 )
 ResponseSelector, RESPONSE_SELECTOR_AVAILABLE = conditional_import(
-    "rasa.nlu.selectors.response_selector", "ResponseSelector"
+    "rasa.nlu.selectors.response_selector",
+    "ResponseSelector",
+    check_installation_setup=True,
 )
 
 # Conditional imports for nlu components requiring other dependencies than tensorflow

rasa/nlu/classifiers/diet_classifier.py

@@ -9,9 +9,11 @@ from typing import Any, Dict, List, Optional, Text, Tuple, Type, TypeVar, Union
 import numpy as np
 import scipy.sparse
 
+from rasa.utils.installation_utils import check_for_installation_issues
 from rasa.utils.tensorflow import TENSORFLOW_AVAILABLE
 
 if TENSORFLOW_AVAILABLE:
+    check_for_installation_issues()
     import tensorflow as tf
 else:
     tf = None