rasa-pro 3.12.22__py3-none-any.whl → 3.13.0__py3-none-any.whl

rasa/dialogue_understanding/generator/command_parser_validator.py

@@ -0,0 +1,63 @@
+from typing import List
+
+import structlog
+
+from rasa.dialogue_understanding.commands import (
+    Command,
+)
+
+structlogger = structlog.get_logger()
+
+
+class CommandParserValidatorSingleton:
+    """Singleton class to validate the command parser.
+
+    This class is used to validate the command parser. It keeps track of the number of
+    consecutive turns where no commands are parsed by the command parser. If the
+    number of consecutive turns exceeds a certain threshold, a warning is logged.
+    The prompt can use a DSL syntax that can be incompatible with the command syntax
+    used by the command parser. This class helps to detect such incompatibilities.
+    """
+
+    MAX_CONSECUTIVE_TURNS_NO_COMMAND_PREDICTED = 5
+    _NO_COMMAND_PREDICTED_TURN_COUNTER = 0
+    _command_parser_validated = False
+
+    @classmethod
+    def get_no_command_predicted_turn_counter(cls) -> int:
+        return cls._NO_COMMAND_PREDICTED_TURN_COUNTER
+
+    @classmethod
+    def should_validate_command_parser(cls) -> bool:
+        return not cls._command_parser_validated
+
+    @classmethod
+    def reset_command_parser_validation(cls) -> None:
+        cls._NO_COMMAND_PREDICTED_TURN_COUNTER = 0
+        cls._command_parser_validated = False
+
+    @classmethod
+    def validate_if_commands_are_parsed_from_llm_response(
+        cls, commands: List[Command], llm_response: str
+    ) -> None:
+        if llm_response and not commands:
+            cls._NO_COMMAND_PREDICTED_TURN_COUNTER += 1
+        else:
+            # Reset the counter if commands are generated, and mark
+            # the command parser as validated.
+            cls._NO_COMMAND_PREDICTED_TURN_COUNTER = 0
+            cls._command_parser_validated = True
+            return
+
+        if (
+            cls._NO_COMMAND_PREDICTED_TURN_COUNTER
+            >= cls.MAX_CONSECUTIVE_TURNS_NO_COMMAND_PREDICTED
+        ):
+            structlogger.warning(
+                "llm_command_generator.predict_commands.command_parser_not_working",
+                event_info=(
+                    f"No commands were generated by the command parser for the last "
+                    f"{cls._NO_COMMAND_PREDICTED_TURN_COUNTER} times. Check if you "
+                    "are running incompatible prompt and LLM command generator."
+                ),
+            )

rasa/dialogue_understanding/generator/llm_based_command_generator.py

@@ -227,19 +227,18 @@ class LLMBasedCommandGenerator(
     def compile_template(self, template: str) -> Template:
         """
         Compile the prompt template and register custom filters.
+
         Compiling the template is an expensive operation,
         so we cache the result.
         """
         # Create an environment
         # Autoescaping disabled explicitly for LLM prompt templates rendered from
-
         # strings (safe, not HTML)
         env = Environment(
             autoescape=select_autoescape(
                 disabled_extensions=["jinja2"], default_for_string=False, default=True
             )
         )
-
         # Register filters
         env.filters[TO_JSON_ESCAPED_STRING_JINJA_FILTER] = to_json_escaped_string
 

rasa/dialogue_understanding/generator/multi_step/multi_step_llm_command_generator.py

@@ -125,8 +125,9 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         raise_deprecation_warning(
             message=(
                 "Support for `MultiStepLLMCommandGenerator` will be removed in Rasa "
-                "`4.0.0`. Please modify your assistant's configuration to use other "
-                "LLM command generators like the `SingleStepLLMCommandGenerator`."
+                "`4.0.0`. Please modify your assistant's configuration to use the "
+                "`CompactLLMCommandGenerator` or `SearchReadyLLMCommandGenerator` "
+                "instead."
             )
         )
 

rasa/dialogue_understanding/generator/nlu_command_adapter.py

@@ -190,9 +190,9 @@ class NLUCommandAdapter(GraphComponent, CommandGenerator):
         if len(commands) > 1:
             structlogger.warning(
                 "nlu_command_adapter.predict_commands",
-                messag=f"Two many flows found that are triggered by the "
+                message=f"Too many flows found that are triggered by the "
                 f"intent '{message.get(INTENT)['name']}'. Take the first one.",
-                commands=commands,
+                commands=[command.__class__.__name__ for command in commands],
             )
             commands = [commands[0]]
 

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_template.jinja2

@@ -41,9 +41,7 @@ Based on this information generate a list of actions you want to take. Your job
 * Responding to knowledge-oriented user messages, described by "SearchAndReply()"
 * Responding to a casual, non-task-oriented user message, described by "ChitChat()".
 * Handing off to a human, in case the user seems frustrated or explicitly asks to speak to one, described by "HumanHandoff()".
-{% if is_repeat_command_enabled %}
 * Repeat the last bot messages, described by "RepeatLastBotMessages()". This is useful when the user asks to repeat the last bot messages.
-{% endif %}
 
 ===
 Write out the actions you want to take, one per line, in the order they should take place.

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v2_claude_3_5_sonnet_20240620_template.jinja2

@@ -11,6 +11,7 @@ Your task is to analyze the current conversation context and generate a list of
 * `provide info`: Responding to the user's questions by supplying relevant information, such as answering FAQs or explaining services.
 * `offtopic reply`: Responding to casual or social user messages that are unrelated to any flows, engaging in friendly conversation and addressing off-topic remarks.
 * `hand over`: Handing over to a human, in case the user seems frustrated or explicitly asks to speak to one.
+* `repeat message`: Repeating the last bot message.
 
 --
 

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v2_gpt_4o_2024_11_20_template.jinja2

@@ -19,6 +19,7 @@ Use the following structured data:
 * `provide info`: Responding to the user's questions by supplying relevant information, such as answering FAQs or explaining services.
 * `offtopic reply`: Responding to casual or social user messages that are unrelated to any flows, engaging in friendly conversation and addressing off-topic remarks.
 * `hand over`: Handing over to a human, in case the user seems frustrated or explicitly asks to speak to one.
+* `repeat message`: Repeating the last bot message.
 
 ---
 

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v3_claude_3_5_sonnet_20240620_template.jinja2

@@ -0,0 +1,79 @@
+## Task Description
+Your task is to analyze the current conversation context and generate a list of actions to start new business processes that we call flows, to extract slots, or respond to off-topic and knowledge requests.
+
+---
+
+## Available Actions:
+* `start flow flow_name`: Start a flow. For example, `start flow transfer_money` or `start flow list_contacts`.
+* `set slot slot_name slot_value`: Set a slot for the active flow. For example, `set slot transfer_money_recipient Freddy`. Can be used to correct and change previously set values.
+* `disambiguate flows flow_name1 flow_name2 ... flow_name_n`: When a message could refer to multiple flows, list the possible flows as options to clarify. Example: `disambiguate flows list_contacts add_contact remove_contact`.
+* `search and reply`: Provide a response from the knowledge base to address the user's inquiry when no flows fit, including domain knowledge, FAQs, and all off-topic or social messages.
+* `cancel flow`: Cancel the current flow if the user requests it.
+* `repeat message`: Repeat the last bot message.
+
+---
+
+## General Instructions
+### Start Flow
+* Only start a flow if the user's message is clear and fully addressed by that flow's description and purpose.
+* Pay close attention to exact wording and scope in the flow description — do not assume or “stretch” the intended use of a flow.
+### Set Slot
+* Do not fill slots with abstract values or placeholders.
+* For categorical slots, try to match the user message with allowed slot values. Use "other" if you cannot match it.
+* Set the boolean slots based on the user's response. Map positive responses to `True`, and negative to `False`.
+* Extract text slot values exactly as provided by the user. Avoid assumptions, format changes, or partial extractions.
+### Disambiguate Flows
+* Use `disambiguate flows` when the user's message matches multiple flows and you cannot decide which flow is most appropriate.
+* If the user message is short and not precise enough to start a flow or `search and reply`, disambiguate.
+* If a single flow is a strong/plausible fit, prefer starting that flow directly.
+* If a user's message unambiguously and distinctly matches multiple flows, start all relevant flows at once (rather than disambiguating).
+### Search and Reply
+* Only start `search and reply` if the user intent is clear.
+* Flow Priority: If you are unsure between starting a flow or `search and reply`, always prioritize starting a flow.
+### Cancel Flow
+* Do not cancel any flow unless the user explicitly requests it.
+* Multiple flows can be started without cancelling the previous, if the user wants to pursue multiple processes.
+### General Tips
+* Only use information provided by the user.
+* Strictly adhere to the provided action format.
+* Focus on the last message and take it one step at a time.
+* Use the previous conversation steps only to aid understanding.
+
+---
+
+## Decision Rule Table
+| Condition                                             | Action             |
+|-------------------------------------------------------|--------------------|
+| Flow perfectly matches user's message                 | start flow         |
+| Multiple flows are equally strong, relevant matches   | disambiguate flows |
+| User's message is unclear or imprecise                | disambiguate flows |
+| No flow fits at all, but knowledge base may help      | search and reply   |
+
+---
+
+## Available Flows and Slots
+Use the following structured data:
+```json
+{"flows":[{% for flow in available_flows %}{"name":"{{ flow.name }}","description":{{ flow.description | to_json_escaped_string }}{% if flow.slots %},"slots":[{% for slot in flow.slots %}{"name":"{{ slot.name }}"{% if slot.description %},"description":{{ slot.description | to_json_escaped_string }}{% endif %}{% if slot.allowed_values %},"allowed_values":{{ slot.allowed_values }}{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]}
+```
+
+---
+
+## Current State
+{% if current_flow != None %}Use the following structured data:
+```json
+{"active_flow":"{{ current_flow }}","current_step":{"requested_slot":"{{ current_slot }}","requested_slot_description":{{ current_slot_description | to_json_escaped_string }}},"slots":[{% for slot in flow_slots %}{"name":"{{ slot.name }}","value":"{{ slot.value }}","type":"{{ slot.type }}"{% if slot.description %},"description":{{ slot.description | to_json_escaped_string }}{% endif %}{% if slot.allowed_values %},"allowed_values":"{{ slot.allowed_values }}"{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]}
+```{% else %}
+You are currently not inside any flow.{% endif %}
+
+---
+
+## Conversation History
+{{ current_conversation }}
+
+---
+
+## Task
+Create an action list with one action per line in response to the user's last message: """{{ user_message }}""".
+
+Your action list:

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v3_gpt_4o_2024_11_20_template.jinja2

@@ -0,0 +1,79 @@
+## Task Description
+Your task is to analyze the current conversation context and generate a list of actions to start new business processes that we call flows, to extract slots, or respond to off-topic and knowledge requests.
+
+---
+
+## Available Flows and Slots
+Use the following structured data:
+```json
+{"flows":[{% for flow in available_flows %}{"name":"{{ flow.name }}","description":{{ flow.description | to_json_escaped_string }}{% if flow.slots %},"slots":[{% for slot in flow.slots %}{"name":"{{ slot.name }}"{% if slot.description %},"description":{{ slot.description | to_json_escaped_string }}{% endif %}{% if slot.allowed_values %},"allowed_values":{{ slot.allowed_values }}{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]}
+```
+
+---
+
+## Available Actions:
+* `start flow flow_name`: Start a flow. For example, `start flow transfer_money` or `start flow list_contacts`.
+* `set slot slot_name slot_value`: Set a slot for the active flow. For example, `set slot transfer_money_recipient Freddy`. Can be used to correct and change previously set values.
+* `disambiguate flows flow_name1 flow_name2 ... flow_name_n`: When a message could refer to multiple flows, list the possible flows as options to clarify. Example: `disambiguate flows list_contacts add_contact remove_contact`.
+* `search and reply`: Provide a response from the knowledge base to address the user’s inquiry when no flows fit, including domain knowledge, FAQs, and all off-topic or social messages.
+* `cancel flow`: Cancel the current flow if the user requests it.
+* `repeat message`: Repeat the last bot message.
+
+---
+
+## General Instructions
+### Start Flow
+* Only start a flow if the user's message is clear and fully addressed by that flow's description and purpose.
+* Pay close attention to exact wording and scope in the flow description — do not assume or “stretch” the intended use of a flow.
+### Set Slot
+* Do not fill slots with abstract values or placeholders.
+* For categorical slots try to match the user message with allowed slot values. Use "other" if you cannot match it.
+* Set the boolean slots based on the user response. Map positive responses to `True`, and negative to `False`.
+* Extract text slot values exactly as provided by the user. Avoid assumptions, format changes, or partial extractions.
+### Disambiguate Flows
+* Use `disambiguate flows` when the user's message matches multiple flows and you cannot decide which flow is most appropriate.
+* If the user message is short and not precise enough to start a flow or `search and reply`, disambiguate.
+* If a single flow is a strong/plausible fit, prefer starting that flow directly.
+* If a user's message unambiguously and distinctly matches multiple flows, start all relevant flows at once (rather than disambiguating).
+### Search and Reply
+* Only start `search and reply` if the user intent is clear.
+* Flow Priority: If you are unsure between starting a flow or `search and reply`, always prioritize starting a flow.
+### Cancel Flow
+* Do not cancel any flow unless the user explicitly requests it.
+* Multiple flows can be started without cancelling the previous, if the user wants to pursue multiple processes.
+### General Tips
+* Only use information provided by the user.
+* Strictly adhere to the provided action format.
+* Focus on the last message and take it one step at a time.
+* Use the previous conversation steps only to aid understanding.
+
+---
+
+## Decision Rule Table
+| Condition                                             | Action             |
+|-------------------------------------------------------|--------------------|
+| Flow perfectly matches user's message                 | start flow         |
+| Multiple flows are equally strong, relevant matches   | disambiguate flows |
+| User's message is unclear or imprecise                | disambiguate flows |
+| No flow fits at all, but knowledge base may help      | search and reply   |
+
+---
+
+## Current State
+{% if current_flow != None %}Use the following structured data:
+```json
+{"active_flow":"{{ current_flow }}","current_step":{"requested_slot":"{{ current_slot }}","requested_slot_description":{{ current_slot_description | to_json_escaped_string }}},"slots":[{% for slot in flow_slots %}{"name":"{{ slot.name }}","value":"{{ slot.value }}","type":"{{ slot.type }}"{% if slot.description %},"description":{{ slot.description | to_json_escaped_string }}{% endif %}{% if slot.allowed_values %},"allowed_values":"{{ slot.allowed_values }}"{% endif %}}{% if not loop.last %},{% endif %}{% endfor %}]}
+```{% else %}
+You are currently not inside any flow.{% endif %}
+
+---
+
+## Conversation History
+{{ current_conversation }}
+
+---
+
+## Task
+Create an action list with one action per line in response to the user's last message: """{{ user_message }}""".
+
+Your action list: