Merge pull request #14 from speechmatics/remove-template-id-restriction

Removed choices from assistant cli argument to support arbitrary strings

Author: dumitrugutu

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.1.2] - 2025-03-28
+
+### Changed
+
+- Removed `choices` from `--assistant` cli argument to support arbitrary strings
+- Implemented case-insensitive lookup for predefined template names
+
 ## [0.1.1] - 2025-03-26
 
 ### Changed

VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

speechmatics_flow/cli.py

@@ -26,7 +26,7 @@
     PlaybackSettings,
     DebugMode,
 )
-from speechmatics_flow.templates import TemplateOptions
+from speechmatics_flow.templates import TEMPLATE_NAME_TO_ID
 
 LOGGER = logging.getLogger(__name__)
 
@@ -116,7 +116,7 @@ def get_conversation_config(
 
     # Command line arguments override values from config file
     if assistant := args.get("assistant"):
-        config["template_id"] = TemplateOptions.get(assistant)
+        config["template_id"] = TEMPLATE_NAME_TO_ID.get(assistant.lower(), assistant)
 
     return ConversationConfig(**config)
 

speechmatics_flow/cli_parser.py

@@ -5,8 +5,6 @@
 import argparse
 import logging
 
-from speechmatics_flow.templates import TemplateOptions
-
 LOGGER = logging.getLogger(__name__)
 
 
@@ -150,7 +148,6 @@ def get_arg_parser():
         "--assistant",
         default=None,
         type=str,
-        choices=[k for k in TemplateOptions.keys()],
         help="Choose your assistant.",
     )
     parser.add_argument(

speechmatics_flow/models.py

@@ -79,7 +79,7 @@ class ConnectionSettings:
 class ConversationConfig:
     """Defines configuration parameters for conversation requests."""
 
-    template_id: TemplateID = "default"
+    template_id: Union[TemplateID, str] = "default"
     """Name of a predefined template."""
 
     template_variables: Optional[Dict[str, str]] = None

speechmatics_flow/templates.py

@@ -17,4 +17,4 @@ class Template(Enum):
 ]
 
 # Map user-friendly name to full TemplateID
-TemplateOptions = {t.name: t.value for t in Template}
+TEMPLATE_NAME_TO_ID = {member.name.lower(): member.value for member in Template}

tests/test_cli.py

@@ -23,11 +23,21 @@
             {"template_id": Template.amelia.value},
             id="assistant amelia",
         ),
+        param(
+            ["--assistant=AMELIA"],
+            {"template_id": Template.amelia.value},
+            id="assistant AMELIA",
+        ),
         param(
             ["--assistant=humphrey"],
             {"template_id": Template.humphrey.value},
             id="assistant humphrey",
         ),
+        param(
+            ["--assistant=demo-assistant"],
+            {"template_id": "demo-assistant"},
+            id="assistant demo",
+        ),
         param(
             ["--config-file=tests/data/conversation_config.json"],
             {