user-simulator 0.2.5__py3-none-any.whl → 0.3.0__py3-none-any.whl

data/connectors/dialogflow.yml

@@ -0,0 +1,16 @@
+config:
+    api_url: "aaa"
+    headers:
+        Content-Type: 'application/json'
+    timeout: 10000
+    request_key: "queryInput.text.text"
+    response_key: "queryResult.fulfillmentText"
+
+payload:
+    queryInput:
+        text:
+            text:
+            languageCode: "en"
+
+parameters:
+    - api_url

data/connectors/julie.yml

@@ -0,0 +1,37 @@
+config:
+  api_url: 'https://askjulie2.nextit.com/AlmeAPI/api/Conversation/Converse'
+  headers:
+      Content-Type: 'application/json'
+  timeout: 10000
+  request_key: ["question", "displayText"]
+  response_key: "text"
+
+
+payload:
+   userId: "4b62a896-85f0-45dd-b94c-a6496f831107"
+   sessionId: "724e371e-9917-4ab2-9da4-6809199366eb"
+   question: "How are you?"
+   origin: "Typed"
+   displayText: "How are you?"
+   channel: "Web"
+   language: "en-US"
+   accessKey: "00000000-0000-0000-0000-000000000000"
+   parameters:
+       UiVersion: "1.33.17"
+       Context:
+           CurrentUrl:
+                   AbsolutePath: "https://www.amtrak.com/home.html"
+                   Protocol: "https:"
+                   Host: "www.amtrak.com"
+                   HostName: "www.amtrak.com"
+                   Port: ""
+                   Uri: "/home.html"
+                   Query: ""
+                   Fragment: ""
+                   Origin: "https://www.amtrak.com"
+                   Type: "embedded"
+                   PageName: "Amtrak Tickets, Schedules and Train Routes"
+
+parameters:
+  - userId
+  - sessionId

data/connectors/kuki.yml

@@ -0,0 +1,16 @@
+config:
+    api_url: "https://kuli.kuki.ai/cptalk"
+    headers:
+        Content-Type: 'application/x-www-form-urlencoded'  # Standard for form data
+    timeout: 10000
+    request_key: "input"
+    response_key: "responses"
+
+payload:
+    uid: ''
+    input: 'Hello'
+    sessionid: ''
+
+parameters:
+    - sessionid
+    - uid

data/connectors/millionbot_ada.yml

@@ -0,0 +1,25 @@
+config:
+  timeout: 20
+
+payload:
+  bot: "60a3be81f9a6b98f7659a6f9"
+
+parameters:
+  - bot
+
+
+#api_url: "https://api.1millionbot.com/api/public/users"
+#headers:
+#  ContentType: 'application/json'
+#  Authorization: 'API-KEY 60553d58c41f5dfa095b34b5'
+#
+#
+#payload:
+#  conversation: "670577afe0d59bbc894897b2"
+#  sender_type: "User"
+#  sender: "670577af4e61b2bc9462703f"
+#  bot: "60a3be81f9a6b98f7659a6f9"
+#  language: "es"
+#  url: "https://www.uam.es/uam/tecnologias-informacion"
+#  message:
+#    text: "Hola"

data/connectors/rasa.yml

@@ -0,0 +1,8 @@
+config:
+  api_url: "http://localhost:5005/webhooks/rest/webhook"
+  timeout: 60
+
+payload: ''
+
+parameters:
+  - api_url

data/connectors/serviceform.yml

@@ -0,0 +1,17 @@
+config:
+    api_url: "https://dash.serviceform.com/api/ai"
+    headers:
+        Content-Type: 'text/plain;charset=UTF-8'
+    timeout: 10000
+
+payload:
+    sid: "1729589460223tvzbcxe5zocgr5hs"
+    tid: "haGDRXUPY9tQOsOS44jY"
+    message: "Hello"
+    extraTraining: ""
+    assistant_id: "asst_PUNPPDAFOgHRLrlmHhDuQhCM"
+
+parameters:
+    - sid
+    - tid
+    - assistant_id

data/connectors/taskyto.yml

@@ -0,0 +1,8 @@
+config:
+  api_url: http://127.0.0.1:5000
+  timeout: 60
+
+payload: ''
+
+parameters:
+  - api_url

data/element_lists/list_of_things.yml

@@ -0,0 +1,7 @@
+pizzas:
+  - margarita
+  - pepperoni
+  - marinara
+  - carbonara
+  - bbq
+  - four cheese

user_sim/cli/cli.py

@@ -1,34 +1,61 @@
+import os
+import yaml
+import sys
 import argparse
 from argparse import Namespace
 from chatbot_connectors import parse_connector_params
 
-def parse_chat_arguments() -> Namespace:
+def load_yaml_arguments(project_path):
+    files = os.listdir(project_path)
+
+    run_file = next((f for f in files if f in ["run.yml", "run.yaml"]), None)
+
+    if not run_file:
+        raise FileNotFoundError(f"Couldn't find run.yml file.")
+
+    run_yaml_path = os.path.join(project_path, run_file)
+
+    with open(run_yaml_path, 'r', encoding='utf-8') as f:
+        yaml_args = yaml.safe_load(f) or {}
+
+        if "execution_parameters" in yaml_args:
+            parameters = yaml_args.pop("execution_parameters") or []
+            yaml_args.update({param: True for param in parameters})
+
+    normalized = {}
+    for k, v in yaml_args.items():
+        normalized[k.replace("-", "_")] = v
+
+    normalized["project_path"] = project_path
+    return normalized
+
+
+def parse_chat_arguments(argv=None) -> Namespace:
     """Parse command line arguments."""
     parser = argparse.ArgumentParser(description="User Simulator - Converses with chatbots to test capabilities")
 
-    # default_sessions = 3
-    # default_turns = 8
-    # default_model = "gpt-4o-mini"
     default_output_dir = "output"
     default_technology = "taskyto"
 
-
     parser.add_argument(
-        "-rfy"
+        "-rfy",
         "--run-from-yaml",
+        dest="run_from_yaml",
         type=str,
         default=None,
-        help="Path to the project folder which contains run.yaml."
+        help=(
+             "Path to the project folder which contains run.yaml."
              "Runs Sensei with CLI arguments contained in the run.yaml file."
-             "Example: --run-from-yaml /path/to/project/folder",
+             "Example: --run-from-yaml /path/to/project/folder"
+        ),
     )
 
     parser.add_argument(
         "-ic",
         "--ignore-cache",
-        type=int,
-        default=0,
-        help=f"Cache is ignored during the testing process.",
+        dest="ignore_cache",
+        action="store_true",
+        help="Cache is ignored during the testing process.",
     )
 
     parser.add_argument(
@@ -42,24 +69,27 @@ def parse_chat_arguments() -> Namespace:
     parser.add_argument(
         "-cp",
         "--connector-params",
+        dest="connector_params",
         type=parse_connector_params,
-        default=None,
-        help="Connector parameters as JSON string or key=value pairs separated by commas. "
-        'Examples: \'{"base_url": "http://localhost", "port": 8080}\' or '
-        '"base_url=http://localhost,port=8080". Use --list-connector-params <technology> to see required parameters for each connector.',
+        help=(
+            'Connector parameters as JSON string or key=value pairs separated by commas. '
+            'Examples: \'{"base_url": "http://localhost", "port": 8080}\' or '
+            '"base_url=http://localhost,port=8080". '
+            "Use --list-connector-params <technology> to see required parameters for each connector."
+        ),
     )
 
     parser.add_argument(
-        "-pp",
-        "--project-path",
+        "-pp", "--project-path",
+        dest="project_path",
         type=str,
         default=None,
         help="The project path where all testing content is stored for a specific project."
     )
 
     parser.add_argument(
-        "-up",
-        "--user-profile",
+        "-up", "--user-profile",
+        dest="user_profile",
         type=str,
         default=None,
         help="Name of the user profile YAML or the folder containing user profiles to use in the testing process."
@@ -84,6 +114,7 @@ def parse_chat_arguments() -> Namespace:
     parser.add_argument(
         "-cc",
         "--clean-cache",
+        dest="clean_cache",
         action="store_true",
         help=f"Cache is cleaned after the testing process",
     )
@@ -91,6 +122,7 @@ def parse_chat_arguments() -> Namespace:
     parser.add_argument(
         "-uc",
         "--update-cache",
+        dest="update_cache",
         action="store_true",
         help=f"Cache is updated with new content if previous cache was saved",
     )
@@ -98,6 +130,7 @@ def parse_chat_arguments() -> Namespace:
     #todo: implement
     parser.add_argument(
         "--list-connector-params",
+        dest="list_connector_params",
         type=str,
         metavar="TECHNOLOGY",
         help="List the available parameters for a specific chatbot technology and exit",
@@ -106,8 +139,71 @@ def parse_chat_arguments() -> Namespace:
     #todo: implement
     parser.add_argument(
         "--list-connectors",
+        dest="list_connectors",
         action="store_true",
         help="List all available chatbot connector technologies and exit",
     )
 
-    return parser.parse_args()
+    args, unknown = parser.parse_known_args(argv) # if argv, uses argv arguments
+
+    if args.run_from_yaml:
+        # Detect if the user passed other non-default options besides the YAML
+        # Define here the "default" values that should NOT be considered as "user passed something extra"
+        defaults_guard = {
+            "technology": default_technology,
+            "output": default_output_dir,
+            "connector_params": None,
+            "project_path": None,
+            "user_profile": None,
+            "verbose": False,
+            "clean_cache": False,
+            "ignore_cache": False,
+            "update_cache": False,
+            "list_connector_params": None,
+            "list_connectors": False,
+        }
+
+
+        non_default_passed = []
+        for k, default_v in defaults_guard.items():
+            if k == "run_from_yaml":
+                continue
+            current_v = getattr(args, k, None)
+            if current_v != default_v:
+                non_default_passed.append(k)
+
+        if non_default_passed or unknown:
+            parser.error(
+                "No other arguments can be provided when using --run-from-yaml. "
+                f"Detected: {', '.join(non_default_passed + unknown)}"
+            )
+
+        yaml_args = load_yaml_arguments(args.run_from_yaml)
+
+        # Minimum default values if the YAML does not provide them
+        yaml_defaults = {
+            "technology": default_technology,
+            "connector_params": None,
+            "user_profile": None,
+            "output": default_output_dir,
+            "verbose": False,
+            "clean_cache": False,
+            "ignore_cache": False,
+            "update_cache": False,
+        }
+        for k, v in yaml_defaults.items():
+            yaml_args.setdefault(k, v)
+
+        return argparse.Namespace(**yaml_args)
+
+
+    # Normal CLI mode: validate required arguments
+    required_args = ["technology", "user_profile", "connector_params"]
+    missing = [arg for arg in required_args if getattr(args, arg) in (None, "")]
+    if missing:
+        parser.error(
+            "The following arguments are required when not using --run-from-yaml: "
+            + ", ".join(missing)
+        )
+
+    return args