rasa-pro 3.12.0.dev13__py3-none-any.whl → 3.12.0rc1__py3-none-any.whl

rasa/dialogue_understanding/generator/__init__.py

@@ -9,6 +9,7 @@ from rasa.dialogue_understanding.generator.multi_step.multi_step_llm_command_gen
     MultiStepLLMCommandGenerator,
 )
 from rasa.dialogue_understanding.generator.single_step.single_step_llm_command_generator import (  # noqa: E501
+    CompactLLMCommandGenerator,
     SingleStepLLMCommandGenerator,
 )
 
@@ -18,4 +19,5 @@ __all__ = [
     "LLMCommandGenerator",
     "MultiStepLLMCommandGenerator",
     "SingleStepLLMCommandGenerator",
+    "CompactLLMCommandGenerator",
 ]

rasa/dialogue_understanding/generator/command_parser.py

@@ -16,6 +16,7 @@ from rasa.dialogue_understanding.commands import (
     SkipQuestionCommand,
     StartFlowCommand,
 )
+from rasa.dialogue_understanding.commands.prompt_command import PromptCommand
 from rasa.dialogue_understanding.commands.utils import start_flow_by_name
 from rasa.shared.core.flows import FlowsList
 
@@ -41,8 +42,8 @@ def _get_compiled_pattern(pattern_str: str) -> re.Pattern:
 
 
 def _create_default_commands(
-    default_commands_to_remove: Union[List[Type[Command]], List[str]],
-) -> List[Type[Command]]:
+    default_commands_to_remove: Union[List[Type[PromptCommand]], List[str]],
+) -> List[Type[PromptCommand]]:
     """Return an updated list of default commands after removing the provided commands.
 
     Args:
@@ -64,11 +65,11 @@ def _create_default_commands(
 
 
 def _get_additional_parsing_logic(
-    command_clz: Type[Command],
-) -> Optional[Callable[[Command, FlowsList], Optional[Command]]]:
+    command_clz: Type[PromptCommand],
+) -> Optional[Callable[[PromptCommand, FlowsList], Optional[PromptCommand]]]:
     """Get additional parsing logic for a command."""
     command_to_parsing_fn_mapper: Dict[
-        Type[Command], Callable[..., Optional[Command]]
+        Type[PromptCommand], Callable[..., Optional[PromptCommand]]
     ] = {
         ClarifyCommand: _parse_clarify_command,
         SetSlotCommand: _parse_set_slot_command,
@@ -81,8 +82,10 @@ def parse_commands(
     actions: Optional[str],
     flows: FlowsList,
     is_handle_flows_prompt: bool = False,
-    additional_commands: Optional[List[Type[Command]]] = None,
-    default_commands_to_remove: Optional[Union[List[Type[Command]], List[str]]] = None,
+    additional_commands: Optional[List[Type[PromptCommand]]] = None,
+    default_commands_to_remove: Optional[
+        Union[List[Type[PromptCommand]], List[str]]
+    ] = None,
     **kwargs: Any,
 ) -> List[Command]:
     """Parse a list of action commands."""
@@ -116,7 +119,7 @@ def parse_commands(
 
 
 def _parse_standard_commands(
-    standard_commands: List[Type[Command]],
+    standard_commands: List[Type[PromptCommand]],
     action: str,
     flows: FlowsList,
     **kwargs: Any,
@@ -135,7 +138,7 @@ def _parse_standard_commands(
 
 
 def _parse_custom_commands(
-    custom_commands: List[Type[Command]],
+    custom_commands: List[Type[PromptCommand]],
     action: str,
     flows: FlowsList,
     **kwargs: Any,
@@ -152,7 +155,7 @@ def _parse_custom_commands(
 
 def _parse_set_slot_command(
     parsed_command: Optional[SetSlotCommand], flows: FlowsList, **kwargs: Any
-) -> Optional[Command]:
+) -> Optional[PromptCommand]:
     """Additional parsing logic for the SetSlotCommand."""
     if not parsed_command:
         return None
@@ -164,7 +167,7 @@ def _parse_set_slot_command(
 
 def _parse_clarify_command(
     parsed_command: Optional[ClarifyCommand], flows: FlowsList, **kwargs: Any
-) -> Optional[Command]:
+) -> Optional[PromptCommand]:
     """Additional parsing logic for the ClarifyCommand."""
     if not parsed_command:
         return None
@@ -194,7 +197,7 @@ def _parse_clarify_command(
 
 def _parse_start_flow_command(
     parsed_command: Optional[StartFlowCommand], flows: FlowsList, **kwargs: Any
-) -> Optional[Command]:
+) -> Optional[PromptCommand]:
     """Additional parsing logic for the StartFlowCommand."""
     if not parsed_command:
         return None

rasa/dialogue_understanding/generator/constants.py

@@ -25,3 +25,6 @@ FLOW_RETRIEVAL_ACTIVE_KEY = "active"
 FLOW_RETRIEVAL_EMBEDDINGS_CONFIG_KEY = "embeddings"
 
 FLOW_RETRIEVAL_FLOW_THRESHOLD = 20
+
+COMMAND_PROMPT_FILE_NAME = "command_prompt.jinja2"
+LLM_BASED_COMMAND_GENERATOR_CONFIG_FILE = "config.json"

rasa/dialogue_understanding/generator/llm_based_command_generator.py

@@ -27,9 +27,7 @@ from rasa.engine.graph import ExecutionContext, GraphComponent
 from rasa.engine.recipes.default_recipe import DefaultV1Recipe
 from rasa.engine.storage.resource import Resource
 from rasa.engine.storage.storage import ModelStorage
-from rasa.shared.core.constants import (
-    SetSlotExtractor,
-)
+from rasa.shared.core.constants import SetSlotExtractor
 from rasa.shared.core.domain import Domain
 from rasa.shared.core.flows import Flow, FlowsList, FlowStep
 from rasa.shared.core.flows.steps.collect import CollectInformationFlowStep
@@ -313,11 +311,20 @@ class LLMBasedCommandGenerator(
         return filtered_flows
 
     @measure_llm_latency
-    async def invoke_llm(self, prompt: Text) -> Optional[LLMResponse]:
+    async def invoke_llm(
+        self, prompt: Union[List[dict], List[str], str]
+    ) -> Optional[LLMResponse]:
         """Use LLM to generate a response.
 
         Args:
-            prompt: The prompt to send to the LLM.
+            prompt: The prompt can be,
+                - a list of preformatted messages. Each message should be a dictionary
+                    with the following keys:
+                    - content: The message content.
+                    - role: The role of the message (e.g. user or system).
+                - a list of messages. Each message is a string and will be formatted
+                    as a user message.
+                - a single message as a string which will be formatted as user message.
 
         Returns:
             An LLMResponse object.

rasa/dialogue_understanding/generator/llm_command_generator.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, Optional, Text
+from typing import Any, Dict, List, Optional, Text, Union
 
 import structlog
 from deprecated import deprecated  # type: ignore[import]
@@ -25,7 +25,7 @@ structlogger = structlog.get_logger()
 @deprecated(
     reason=(
         "The LLMCommandGenerator is deprecated and will be removed in Rasa 4.0.0. "
-        "Please use use SingleStepLLMCommandGenerator instead."
+        "Please use SingleStepLLMCommandGenerator instead."
     )
 )
 class LLMCommandGenerator(SingleStepLLMCommandGenerator):
@@ -54,7 +54,9 @@ class LLMCommandGenerator(SingleStepLLMCommandGenerator):
             **kwargs,
         )
 
-    async def invoke_llm(self, prompt: Text) -> Optional[LLMResponse]:
+    async def invoke_llm(
+        self, prompt: Union[List[dict], List[str], str]
+    ) -> Optional[LLMResponse]:
         try:
             return await super().invoke_llm(prompt)
         except ProviderClientAPIException:

rasa/dialogue_understanding/generator/multi_step/multi_step_llm_command_generator.py

@@ -2,6 +2,7 @@ import importlib.resources
 from typing import Any, Dict, List, Optional, Text, Tuple, Union
 
 import structlog
+from deprecated import deprecated  # type: ignore[import]
 from jinja2 import Template
 
 import rasa.shared.utils.io
@@ -51,7 +52,7 @@ from rasa.shared.exceptions import ProviderClientAPIException
 from rasa.shared.nlu.constants import TEXT
 from rasa.shared.nlu.training_data.message import Message
 from rasa.shared.providers.llm.llm_response import LLMResponse
-from rasa.shared.utils.io import deep_container_fingerprint
+from rasa.shared.utils.io import deep_container_fingerprint, raise_deprecation_warning
 from rasa.shared.utils.llm import (
     allowed_values_for_slot,
     get_prompt_template,
@@ -100,6 +101,12 @@ structlogger = structlog.get_logger()
     ],
     is_trainable=True,
 )
+@deprecated(
+    reason=(
+        "The MultiStepLLMCommandGenerator is deprecated and will be removed in "
+        "Rasa `4.0.0`."
+    )
+)
 class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
     """An multi step command generator using LLM."""
 
@@ -111,6 +118,14 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
         prompt_templates: Optional[Dict[Text, Optional[Text]]] = None,
         **kwargs: Any,
     ) -> None:
+        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`."
+            )
+        )
+
         super().__init__(
             config, model_storage, resource, prompt_templates=prompt_templates, **kwargs
         )
@@ -120,7 +135,6 @@ class MultiStepLLMCommandGenerator(LLMBasedCommandGenerator):
             FILL_SLOTS_KEY: None,
         }
         self._init_prompt_templates(prompt_templates)
-
         self.trace_prompt_tokens = self.config.get("trace_prompt_tokens", False)
 
     ### Implementations of LLMBasedCommandGenerator parent

rasa/dialogue_understanding/generator/{single_step → prompt_templates}/command_prompt_template.jinja2

@@ -41,7 +41,9 @@ 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

@@ -0,0 +1,77 @@
+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 small talk and knowledge requests.
+
+## Available Actions:
+* `start flow flow_name`: Starting a flow. For example, `start flow transfer_money` or `start flow list_contacts`
+* `set slot slot_name slot_value`: Slot setting. For example, `set slot transfer_money_recipient Freddy`. Can be used to correct and change previously set values
+* `cancel flow`: Cancelling the current flow
+* `disambiguate flows flow_name1 flow_name2 ... flow_name_n`: Disambiguate which flow should be started when user input is ambiguous by listing the potential flows as options. For example, `disambiguate flows list_contacts add_contact remove_contact ...` if the user just wrote "contacts".
+* `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
+
+
+## General Tips
+* Do not fill slots with abstract values or placeholders.
+* Only use information provided by the user.
+* Use clarification in ambiguous cases.
+* Multiple flows can be started. If a user wants to digress into a second flow, you do not need to cancel the current flow.
+* Strictly adhere to the provided action format.
+* For categorical slots try to match the user message with potential slot values. Use "other" if you cannot match it
+* Focus on the last message and take it one step at a time.
+* Use the previous conversation steps only to aid understanding.
+
+
+## Available Flows:
+Use the following structured date:
+```xml
+<flows>
+    {% for flow in available_flows %}<flow>
+        <name>{{ flow.name }}</name>
+        <description>{{ flow.description }}</description>
+        <slots>{% for slot in flow.slots %}
+            <slot>
+                <name>{{ slot.name }}</name>
+                <description>{{ slot.description }}</description>
+                <allowed_values>{{ slot.allowed_values }}</allowed_values>
+            </slot>{% endfor %}
+        </slots>
+    </flow>
+    {% endfor %}
+</flows>
+```
+
+## Current State
+{% if current_flow != None %}
+Use the following structured date:
+```xml
+<current_state>
+    <active_flow>{{ current_flow }}</active_flow>
+    <current_step>
+        <requested_slot>{{ current_slot }}</requested_slot>
+        <requested_slot_description>{{ current_slot_description }}</requested_slot_description>
+    </current_step>
+    <slots>
+        {% for slot in flow_slots %}<slot>
+            <name>{{ slot.name }}</name>
+            <value>{{ slot.value }}</value>
+            <type>{{ slot.type }}</type>
+            <description>{{ slot.description }}</description>{% if slot.allowed_values %}
+            <allowed_values>{{ slot.allowed_values }}</allowed_values>{% endif %}
+        </slot>
+        {% endfor %}
+    </slots>
+</current_state>
+```
+{% 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 users last message: """{{ user_message }}""".
+
+Your action list:

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v2_default.jinja2

@@ -0,0 +1,68 @@
+## 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 small talk and knowledge requests.
+
+--
+
+## Available Actions:
+* `start flow flow_name`: Starting a flow. For example, `start flow transfer_money` or `start flow list_contacts`
+* `set slot slot_name slot_value`: Slot setting. For example, `set slot transfer_money_recipient Freddy`. Can be used to correct and change previously set values
+* `cancel flow`: Cancelling the current flow
+* `disambiguate flows flow_name1 flow_name2 ... flow_name_n`: Disambiguate which flow should be started when user input is ambiguous by listing the potential flows as options. For example, `disambiguate flows list_contacts add_contact remove_contact ...` if the user just wrote "contacts".
+* `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
+
+--
+
+## General Tips
+* Do not fill slots with abstract values or placeholders.
+* Only use information provided by the user.
+* Use clarification in ambiguous cases.
+* Multiple flows can be started. If a user wants to digress into a second flow, you do not need to cancel the current flow.
+* Strictly adhere to the provided action format.
+* For categorical slots try to match the user message with potential slot values. Use "other" if you cannot match it
+* Focus on the last message and take it one step at a time.
+* Use the previous conversation steps only to aid understanding.
+
+--
+
+## Available Flows and Slots
+{% for flow in available_flows %}
+* `{{ flow.name }}`: {{ flow.description }}
+    {% for slot in flow.slots -%}
+    * `{{ slot.name }}`{% if slot.description %} ({{ slot.description }}){% endif %}{% if slot.allowed_values %}, allowed values: `{{ slot.allowed_values }}`{% endif %}
+    {% endfor %}
+{%- endfor %}
+
+--
+
+## Current State
+{% if current_flow != None %}
+You are currently in the flow `{{ current_flow }}`.
+You have just asked the user for the slot `{{ current_slot }}`{% if current_slot_description %} ({{ current_slot_description }}){% endif %}.
+
+{% if flow_slots|length > 0 %}
+Here are the slots of the flow `{{ current_flow }}`:
+{% for slot in flow_slots -%}
+* `{{ slot.name }}`
+   - value: "{{ slot.value }}"
+   - type: {{ slot.type }}
+   - description: {{ slot.description}}
+{% if slot.allowed_values %}   - allowed values: {{ slot.allowed_values }}{% endif %}
+{% endfor %}
+{% endif %}
+{% 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 users last message: """{{ user_message }}""".
+
+Your action list:

rasa/dialogue_understanding/generator/prompt_templates/command_prompt_v2_gpt_4o_2024_11_20_template.jinja2

@@ -0,0 +1,84 @@
+## 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 small talk and knowledge requests.
+
+--
+
+## Available Actions:
+* `start flow flow_name`: Starting a flow. For example, `start flow transfer_money` or `start flow list_contacts`
+* `set slot slot_name slot_value`: Slot setting. For example, `set slot transfer_money_recipient Freddy`. Can be used to correct and change previously set values
+* `cancel flow`: Cancelling the current flow
+* `disambiguate flows flow_name1 flow_name2 ... flow_name_n`: Disambiguate which flow should be started when user input is ambiguous by listing the potential flows as options. For example, `disambiguate flows list_contacts add_contact remove_contact ...` if the user just wrote "contacts".
+* `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
+
+--
+
+## General Tips
+* Do not fill slots with abstract values or placeholders.
+* Only use information provided by the user.
+* Use clarification in ambiguous cases.
+* Multiple flows can be started. If a user wants to digress into a second flow, you do not need to cancel the current flow.
+* Strictly adhere to the provided action format.
+* For categorical slots try to match the user message with potential slot values. Use "other" if you cannot match it
+* Focus on the last message and take it one step at a time.
+* Use the previous conversation steps only to aid understanding.
+
+--
+
+## Available Flows and Slots
+Use the following structured date:
+```json
+{
+    "flows": [
+        {% for flow in available_flows %}{
+            "name": "{{ flow.name }}",
+            "description": "{{ flow.description }}"{% if flow.slots %},
+            "slots": [{% for slot in flow.slots %}
+                {
+                    "name": "{{ slot.name }}"{% if slot.description %},
+                    "description": "{{ slot.description }}"{% 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 date:
+```json
+{
+    "active_flow": "{{ current_flow }}",
+    "current_step": {
+        "requested_slot": "{{ current_slot }}",
+        "requested_slot_description": "{{ current_slot_description }}"
+    },
+    "slots": [{% for slot in flow_slots %}
+        {
+            "name": "{{ slot.name }}",
+            "value": "{{ slot.value }}",
+            "type": "{{ slot.type }}"{% if slot.description %},
+            "description": "{{ slot.description }}"{% 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 users last message: """{{ user_message }}""".
+
+Your action list: