Adds support for configuring volume filtering

CHANGELOG.md

@@ -5,6 +5,12 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.14.4] - 2024-03-04
+
+## Added
+
+- Support for volume_threshold audio filtering in transcription config
+
 ## [1.14.3] - 2024-02-29
 
 ## Fixed

VERSION

@@ -1 +1 @@
-1.14.3
+1.14.4

speechmatics/cli.py

@@ -230,6 +230,11 @@ def get_transcription_config(
     ]:
         config[option] = True if args.get(option) else config.get(option)
 
+    if args.get("volume_threshold") is not None:
+        config["audio_filtering_config"] = {
+            "volume_threshold": args.get("volume_threshold")
+        }
+
     if args.get("ctrl"):
         LOGGER.warning(f"Using internal dev control command: {args['ctrl']}")
         config["ctrl"] = json.loads(args["ctrl"])

speechmatics/cli_parser.py

@@ -165,6 +165,13 @@ def get_arg_parser():
         default=None,
         help="Language (ISO 639-1 code, e.g. en, fr, de).",
     )
+    config_parser.add_argument(
+        "--volume-threshold",
+        dest="volume_threshold",
+        type=float,
+        default=None,
+        help=("Filter out quiet audio which falls below this threshold (0.0-100.0)"),
+    )
     config_parser.add_argument(
         "--operating-point",
         choices=["standard", "enhanced"],

speechmatics/models.py

@@ -128,6 +128,9 @@ def asdict(self) -> Dict[Any, Any]:
     enable_entities: bool = None
     """Indicates if inverse text normalization entity output is enabled."""
 
+    audio_filtering_config: dict = None
+    """Configuration for limiting the transcription of quiet audio."""
+
 
 @dataclass
 class RTSpeakerDiarizationConfig:

tests/test_cli.py

@@ -324,6 +324,10 @@
                 "detect_chapters": True,
             },
         ),
+        (
+            ["batch", "transcribe", "--volume-threshold", "3.1"],
+            {"volume_threshold": 3.1},
+        ),
     ],
 )
 def test_cli_arg_parse_with_file(args, values):
@@ -332,6 +336,7 @@ def test_cli_arg_parse_with_file(args, values):
     actual_values = vars(cli.parse_args(args=test_args))
 
     for key, val in values.items():
+        assert key in actual_values, f"Expected {key} in {actual_values}"
         assert actual_values[key] == val, f"Expected {actual_values} to match {values}"