user-simulator 0.1.11__tar.gz → 0.2.1__tar.gz

{user_simulator-0.1.11 → user_simulator-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: user-simulator
-Version: 0.1.11
+Version: 0.2.1
 Summary: LLM-based user simulator for chatbot testing.
 Author: Alejandro Del Pozzo Escalera, Juan de Lara Jaramillo, Esther Guerra Sánchez
 License: MIT License
@@ -30,6 +30,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: allpairspy>=2.5.1
 Requires-Dist: beautifulsoup4>=4.13.4
+Requires-Dist: build>=1.3.0
+Requires-Dist: chatbot-connectors>=0.2.2
 Requires-Dist: colorama>=0.4.6
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: inflect>=7.0.0
@@ -44,6 +46,7 @@ Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: requests>=2.32.4
 Requires-Dist: scikit-learn>=1.7.0
 Requires-Dist: selenium>=4.33.0
+Requires-Dist: twine>=6.1.0
 Requires-Dist: webdriver-manager>=4.0.2
 Dynamic: license-file
 

{user_simulator-0.1.11 → user_simulator-0.2.1}/pyproject.toml

@@ -1,54 +1,57 @@
-[project]
-name = "user-simulator"
-version = "0.1.11"
-description = "LLM-based user simulator for chatbot testing."
-readme = "README.md"
-requires-python = ">=3.12"
-license = {file = "LICENSE.txt"}
-
-authors = [
-    {name = "Alejandro Del Pozzo Escalera"},
-    {name = "Juan de Lara Jaramillo"},
-    {name = "Esther Guerra Sánchez"}
-]
-
-dependencies = [
-    "allpairspy>=2.5.1",
-    "beautifulsoup4>=4.13.4",
-    "colorama>=0.4.6",
-    "httpx>=0.28.1",
-    "inflect>=7.0.0",
-    "langchain>=0.3.25",
-    "langchain-openai>=0.3.23",
-    "openai>=1.0.0",
-    "pandas>=2.3.0",
-    "pillow>=11.2.1",
-    "pydantic>=2.0.0",
-    "pymupdf>=1.26.1",
-    "pyyaml>=6.0.2",
-    "requests>=2.32.4",
-    "scikit-learn>=1.7.0",
-    "selenium>=4.33.0",
-    "webdriver-manager>=4.0.2",
-]
-
-[project.urls]
-Homepage = "https://github.com/satori-chatbots/user-simulator"
-
-[project.scripts]
-sensei-init-project = "user_sim.cli.init_project:main"
-sensei-chat = "user_sim.cli.sensei_chat:main"
-sensei-check = "user_sim.cli.sensei_check:main"
-sensei-validation-check = "user_sim.cli.validation_check:main"
-sensei-gen-user-profile = "user_sim.cli.gen_user_profile:main"
-
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools]
-package-dir = {"" = "src"}
-
-[tool.setuptools.packages.find]
-where = ["src"]
-include = ["user_sim*", "technologies*", "metamorphic*"]
+[project]
+name = "user-simulator"
+version = "0.2.1"
+description = "LLM-based user simulator for chatbot testing."
+readme = "README.md"
+requires-python = ">=3.12"
+license = {file = "LICENSE.txt"}
+
+authors = [
+    {name = "Alejandro Del Pozzo Escalera"},
+    {name = "Juan de Lara Jaramillo"},
+    {name = "Esther Guerra Sánchez"}
+]
+
+dependencies = [
+    "allpairspy>=2.5.1",
+    "beautifulsoup4>=4.13.4",
+    "build>=1.3.0",
+    "chatbot-connectors>=0.2.2",
+    "colorama>=0.4.6",
+    "httpx>=0.28.1",
+    "inflect>=7.0.0",
+    "langchain>=0.3.25",
+    "langchain-openai>=0.3.23",
+    "openai>=1.0.0",
+    "pandas>=2.3.0",
+    "pillow>=11.2.1",
+    "pydantic>=2.0.0",
+    "pymupdf>=1.26.1",
+    "pyyaml>=6.0.2",
+    "requests>=2.32.4",
+    "scikit-learn>=1.7.0",
+    "selenium>=4.33.0",
+    "twine>=6.1.0",
+    "webdriver-manager>=4.0.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/satori-chatbots/user-simulator"
+
+[project.scripts]
+sensei-init-project = "user_sim.cli.init_project:main"
+sensei-chat = "user_sim.cli.sensei_chat:main"
+sensei-check = "user_sim.cli.sensei_check:main"
+sensei-validation-check = "user_sim.cli.validation_check:main"
+sensei-gen-user-profile = "user_sim.cli.gen_user_profile:main"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["user_sim*", "technologies*", "metamorphic*"]

user_simulator-0.2.1/src/user_sim/cli/cli.py

@@ -0,0 +1,113 @@
+import argparse
+from argparse import Namespace
+from chatbot_connectors import parse_connector_params
+
+def parse_chat_arguments() -> 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"
+        "--run-from-yaml",
+        type=str,
+        default=None,
+        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",
+    )
+
+    parser.add_argument(
+        "-ic",
+        "--ignore-cache",
+        type=int,
+        default=0,
+        help=f"Cache is ignored during the testing process.",
+    )
+
+    parser.add_argument(
+        "-t",
+        "--technology",
+        type=str,
+        default=default_technology,
+        help=f"Chatbot technology to use (default: {default_technology})",
+    )
+
+    parser.add_argument(
+        "-cp",
+        "--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.',
+    )
+
+    parser.add_argument(
+        "-pp",
+        "--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",
+        type=str,
+        default=None,
+        help="Name of the user profile YAML or the folder containing user profiles to use in the testing process."
+    )
+
+    #todo: extract
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=str,
+        default=default_output_dir,
+        help=f"Output directory for results and profiles (default: {default_output_dir})",
+    )
+
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="Increase output verbosity",
+    )
+
+    parser.add_argument(
+        "-cc",
+        "--clean-cache",
+        action="store_true",
+        help=f"Cache is cleaned after the testing process",
+    )
+
+    parser.add_argument(
+        "-uc",
+        "--update-cache",
+        action="store_true",
+        help=f"Cache is updated with new content if previous cache was saved",
+    )
+
+    #todo: implement
+    parser.add_argument(
+        "--list-connector-params",
+        type=str,
+        metavar="TECHNOLOGY",
+        help="List the available parameters for a specific chatbot technology and exit",
+    )
+
+    #todo: implement
+    parser.add_argument(
+        "--list-connectors",
+        action="store_true",
+        help="List all available chatbot connector technologies and exit",
+    )
+
+    return parser.parse_args()

{user_simulator-0.1.11 → user_simulator-0.2.1}/src/user_sim/cli/sensei_chat.py

@@ -1,11 +1,13 @@
 import timeit
 import yaml
 import pandas as pd
+from argparse import Namespace
 from collections import Counter
+from cli import parse_chat_arguments
 from argparse import ArgumentParser
 from colorama import Fore, Style
-from technologies.chatbot_connectors import (Chatbot, ChatbotRasa, ChatbotTaskyto, ChatbotMillionBot,
-                                             ChatbotServiceform)
+# from technologies.chatbot_connectors import (Chatbot, ChatbotRasa, ChatbotTaskyto, ChatbotMillionBot,
+#                                              ChatbotServiceform)
 from user_sim.core.data_extraction import DataExtraction
 from user_sim.core.role_structure import *
 from user_sim.core.user_simulator import UserSimulator
@@ -13,6 +15,8 @@ from user_sim.utils.show_logs import *
 from user_sim.utils.utilities import *
 from user_sim.utils.token_cost_calculator import create_cost_dataset
 from user_sim.utils.register_management import clean_temp_files
+from chatbot_connectors.cli import ChatbotFactory, parse_connector_params
+
 
 # check_keys(["OPENAI_API_KEY"])
 current_script_dir = os.path.dirname(os.path.abspath(__file__))
@@ -85,35 +89,51 @@ def configure_project(project_path):
     default_types = load_yaml_files_from_folder(default_types_path, existing_keys=custom_types.keys())
     config.types_dict = {**default_types, **custom_types}
 
-def configure_connector(*args):
-
-    connec = args[0]
-    with open(connec, 'r', encoding='utf-8') as f:
-        con_yaml = yaml.safe_load(f)
-
-
-    if len(args)<2 or not con_yaml["parameters"]:
-        logger.warning("No parameters added for connector configuration. They may not have been set as input arguments "
-                    "or declared as dynamic parameters in the connector file.")
-        return con_yaml
-
-    parameters = args[1]
-    if isinstance(parameters, str):
-        parameters = json.loads(parameters)
+# def configure_connector(*args):
+#     connec = args[0]
+#     with open(connec, 'r', encoding='utf-8') as f:
+#         con_yaml = yaml.safe_load(f)
+#
+#
+#     if len(args)<2 or not con_yaml["parameters"]:
+#         logger.warning("No parameters added for connector configuration. They may not have been set as input arguments "
+#                     "or declared as dynamic parameters in the connector file.")
+#         return con_yaml
+#
+#     parameters = args[1]
+#     if isinstance(parameters, str):
+#         parameters = json.loads(parameters)
+#
+#     param_key_list = list(parameters.keys())
+#     if Counter(con_yaml["parameters"]) != Counter(param_key_list):
+#         raise UnmachedList("Parameters in yaml don't match parameters input in execution")
+#
+#     def replace_values(obj_dict, src_dict):
+#         for key in obj_dict:
+#             if isinstance(obj_dict[key], dict):
+#                 replace_values(obj_dict[key], src_dict)
+#             elif key in src_dict:
+#                 obj_dict[key] = src_dict[key]
+#
+#     replace_values(con_yaml, parameters)
+#     return con_yaml
+
+def _setup_configuration() -> Namespace:
+    """Parse command line arguments, validate config, and create output dir.
+
+    Returns:
+        The parsed and validated command line arguments
+
+    Raises:
+        TracerError: If the specified technology is invalid
+    """
+    args = parse_chat_arguments()
+
+    logger = create_logger(args.verbose, 'Info Logger')
+    logger.info('Logs enabled!')
 
-    param_key_list = list(parameters.keys())
-    if Counter(con_yaml["parameters"]) != Counter(param_key_list):
-        raise UnmachedList("Parameters in yaml don't match parameters input in execution")
 
-    def replace_values(obj_dict, src_dict):
-        for key in obj_dict:
-            if isinstance(obj_dict[key], dict):
-                replace_values(obj_dict[key], src_dict)
-            elif key in src_dict:
-                obj_dict[key] = src_dict[key]
 
-    replace_values(con_yaml, parameters)
-    return con_yaml
 
 
 def get_conversation_metadata(user_profile, the_user, serial=None):
@@ -233,17 +253,18 @@ def parse_profiles(user_path):
         raise Exception(f'Invalid path for user profile operation: {user_path}')
 
 
-def build_chatbot(technology, connector) -> Chatbot:
-    chatbot_builder = {
-        'rasa': ChatbotRasa,
-        'taskyto': ChatbotTaskyto,
-        'serviceform': ChatbotServiceform,
-        'millionbot': ChatbotMillionBot
-    }
-    chatbot_class = chatbot_builder.get(technology, Chatbot)
-    return chatbot_class(connector)
-
-
+def build_chatbot(technology, connector):
+    # chatbot_builder = {
+    #     'rasa': RasaChatbot,
+    #     'taskyto': ChatbotTaskyto,
+    #     # 'serviceform': ChatbotServiceform(connector),
+    #     'millionbot': MillionBot,
+    #     'custom': CustomChatbot
+    # }
+    # chatbot_class = chatbot_builder.get(technology, CustomChatbot)
+    parsed_connector = parse_connector_params(connector)
+    chatbot = ChatbotFactory.create_chatbot(chatbot_type=technology, **parsed_connector)
+    return chatbot
 
 def generate_conversation(technology, connector, user,
                           personality, extract, project_folder):
@@ -412,13 +433,12 @@ def main():
     parser.add_argument('--technology', required=False,
                         choices=['rasa', 'taskyto', 'ada-uam', 'millionbot', 'genion', 'lola', 'serviceform', 'kuki', 'julie', 'rivas_catalina', 'saic_malaga'],
                         help='Technology the chatbot is implemented in')
-    # parser.add_argument('--chatbot', required=False, help='URL where the chatbot is deployed')
-    parser.add_argument('--connector', required=False, help='path to the connector configuration file')
-    parser.add_argument('--connector_parameters', required=False, help='dynamic parameters for the selected chatbot connector')
+    # parser.add_argument('--connector', required=False, help='path to the connector configuration file')
+    parser.add_argument('--connector-params', required=False, help='dynamic parameters for the selected chatbot connector')
     parser.add_argument('--project_path', required=False, help='Project folder PATH where all testing data is stored')
     parser.add_argument('--user_profile', required=False, help='User profile file or user profile folder to test the chatbot')
     parser.add_argument('--personality', required=False, help='Personality file')
-    parser.add_argument("--extract", default=False, help='Path to store conversation user-chatbot')
+    parser.add_argument('--extract', default=False, help='Path to store conversation user-chatbot')
     parser.add_argument('--verbose', action='store_true', help='Shows debug prints')
     parser.add_argument('--clean_cache', action='store_true', help='Deletes temporary files.')
     parser.add_argument('--ignore_cache', action='store_true', help='Ignores cache for temporary files')
@@ -449,7 +469,7 @@ def main():
         parser_args = ArgsNamespace(**yaml_args)
 
     else:
-        required_args = ['technology', 'user_profile', 'connector']
+        required_args = ['technology', 'user_profile', 'connector_params']
         missing_args = [arg for arg in required_args if getattr(parser_args, arg) is None]
 
         if missing_args:
@@ -459,8 +479,7 @@ def main():
     config.root_path = os.path.abspath(os.path.join(current_script_dir, "../../.."))
     profile_path = os.path.join(config.profiles_path, parser_args.user_profile)
 
-    logger = create_logger(parser_args.verbose, 'Info Logger')
-    logger.info('Logs enabled!')
+
 
     # check_keys(["OPENAI_API_KEY"])
     config.test_cases_folder = parser_args.extract
@@ -468,14 +487,18 @@ def main():
     config.update_cache = parser_args.update_cache
     config.clean_cache = parser_args.clean_cache
 
-    if parser_args.connector_parameters:
-        connector = configure_connector(parser_args.connector, parser_args.connector_parameters)
-    else:
-        connector = configure_connector(parser_args.connector)
+    # if parser_args.connector_parameters:
+    #     connector = configure_connector(parser_args.connector, parser_args.connector_parameters)
+    # else:
+    #     connector = configure_connector(parser_args.connector)
 
-    generate_conversation(parser_args.technology, connector, profile_path,
-                          parser_args.personality, parser_args.extract, parser_args.project_path)
+    connector = parser_args.connector_params
 
+    try:
+        generate_conversation(parser_args.technology, connector, profile_path,
+                          parser_args.personality, parser_args.extract, parser_args.project_path)
+    except Exception as e:
+        logger.error(f"An error occurred while generating the conversation: {e}")
 
 if __name__ == '__main__':
     main()

{user_simulator-0.1.11 → user_simulator-0.2.1}/src/user_sim/utils/utilities.py

@@ -9,6 +9,7 @@ import importlib.util
 import logging
 import platform
 
+from typing import Any
 from datetime import datetime, timedelta, date
 from sklearn.feature_extraction.text import TfidfVectorizer
 from sklearn.metrics.pairwise import cosine_similarity
@@ -63,6 +64,52 @@ def init_model():
     return model, llm
 
 
+# def parse_connector_params(connector_params_str: str | None) -> dict[str, Any]:
+#     """Parse connector parameters from string input.
+#
+#     Args:
+#         connector_params_str: JSON string or key=value pairs
+#
+#     Returns:
+#         Dictionary of connector parameters
+#
+#     Raises:
+#         ValueError: If parameter parsing fails
+#     """
+#     params = {}
+#
+#     if connector_params_str:
+#         try:
+#             # Try to parse as JSON first
+#             if connector_params_str.strip().startswith("{"):
+#                 params = json.loads(connector_params_str)
+#             else:
+#                 # Parse as key=value pairs
+#                 for pair in connector_params_str.split(","):
+#                     if "=" not in pair:
+#                         continue
+#                     key, value = pair.split("=", 1)
+#                     key = key.strip()
+#                     value = value.strip()
+#
+#                     # Try to convert to appropriate types
+#                     if value.lower() in ("true", "false"):
+#                         params[key] = value.lower() == "true"
+#                     elif value.isdigit():
+#                         params[key] = int(value)
+#                     else:
+#                         try:
+#                             params[key] = float(value)
+#                         except ValueError:
+#                             params[key] = value
+#
+#         except (json.JSONDecodeError, ValueError) as e:
+#             logger.exception("Failed to parse connector parameters: %s", connector_params_str)
+#             msg = f"Invalid connector parameters format: {e}"
+#             raise ValueError(msg) from e
+#
+#     return params
+
 
 def parse_content_to_text(messages):
     return " ".join([message["content"] for message in messages if "content" in message])

{user_simulator-0.1.11 → user_simulator-0.2.1}/src/user_simulator.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: user-simulator
-Version: 0.1.11
+Version: 0.2.1
 Summary: LLM-based user simulator for chatbot testing.
 Author: Alejandro Del Pozzo Escalera, Juan de Lara Jaramillo, Esther Guerra Sánchez
 License: MIT License
@@ -30,6 +30,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: allpairspy>=2.5.1
 Requires-Dist: beautifulsoup4>=4.13.4
+Requires-Dist: build>=1.3.0
+Requires-Dist: chatbot-connectors>=0.2.2
 Requires-Dist: colorama>=0.4.6
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: inflect>=7.0.0
@@ -44,6 +46,7 @@ Requires-Dist: pyyaml>=6.0.2
 Requires-Dist: requests>=2.32.4
 Requires-Dist: scikit-learn>=1.7.0
 Requires-Dist: selenium>=4.33.0
+Requires-Dist: twine>=6.1.0
 Requires-Dist: webdriver-manager>=4.0.2
 Dynamic: license-file
 

{user_simulator-0.1.11 → user_simulator-0.2.1}/src/user_simulator.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ src/technologies/chatbots.py
 src/technologies/taskyto.py
 src/user_sim/__init__.py
 src/user_sim/cli/__init__.py
+src/user_sim/cli/cli.py
 src/user_sim/cli/gen_user_profile.py
 src/user_sim/cli/init_project.py
 src/user_sim/cli/sensei_chat.py

{user_simulator-0.1.11 → user_simulator-0.2.1}/src/user_simulator.egg-info/requires.txt

@@ -1,5 +1,7 @@
 allpairspy>=2.5.1
 beautifulsoup4>=4.13.4
+build>=1.3.0
+chatbot-connectors>=0.2.2
 colorama>=0.4.6
 httpx>=0.28.1
 inflect>=7.0.0
@@ -14,4 +16,5 @@ pyyaml>=6.0.2
 requests>=2.32.4
 scikit-learn>=1.7.0
 selenium>=4.33.0
+twine>=6.1.0
 webdriver-manager>=4.0.2