feat: update default values for advanced parameters to None in TTS configuration

Author: twangodev

src/fishaudio/types/tts.py

@@ -75,11 +75,11 @@ class TTSConfig(BaseModel):
         top_p: Nucleus sampling parameter for token selection. Range: 0.0-1.0. Default: 0.7
         temperature: Randomness in generation. Range: 0.0-1.0. Default: 0.7.
             Higher = more varied, lower = more consistent
-        max_new_tokens: Maximum number of tokens to generate. Default: 1024
-        repetition_penalty: Penalty for repeated tokens. Default: 1.2
-        min_chunk_length: Minimum chunk length for generation. Default: 50
-        condition_on_previous_chunks: Whether to condition generation on previous chunks. Default: True
-        early_stop_threshold: Threshold for early stopping. Default: 1.0
+        max_new_tokens: Maximum number of tokens to generate. Default: None (server decides)
+        repetition_penalty: Penalty for repeated tokens. Default: None (server decides)
+        min_chunk_length: Minimum chunk length for generation. Default: None (server decides)
+        condition_on_previous_chunks: Whether to condition generation on previous chunks. Default: None (server decides)
+        early_stop_threshold: Threshold for early stopping. Default: None (server decides)
     """
 
     # Audio output settings
@@ -103,11 +103,11 @@ class TTSConfig(BaseModel):
     temperature: Annotated[float, Field(ge=0.0, le=1.0)] = 0.7
 
     # Advanced generation parameters
-    max_new_tokens: int = 1024
-    repetition_penalty: float = 1.2
-    min_chunk_length: int = 50
-    condition_on_previous_chunks: bool = True
-    early_stop_threshold: float = 1.0
+    max_new_tokens: Optional[int] = None
+    repetition_penalty: Optional[float] = None
+    min_chunk_length: Optional[int] = None
+    condition_on_previous_chunks: Optional[bool] = None
+    early_stop_threshold: Optional[float] = None
 
 
 class TTSRequest(BaseModel):
@@ -131,11 +131,11 @@ class TTSRequest(BaseModel):
         prosody: Speech speed and volume settings. Default: None
         top_p: Nucleus sampling for token selection. Range: 0.0-1.0. Default: 0.7
         temperature: Randomness in generation. Range: 0.0-1.0. Default: 0.7
-        max_new_tokens: Maximum number of tokens to generate. Default: 1024
-        repetition_penalty: Penalty for repeated tokens. Default: 1.2
-        min_chunk_length: Minimum chunk length for generation. Default: 50
-        condition_on_previous_chunks: Whether to condition generation on previous chunks. Default: True
-        early_stop_threshold: Threshold for early stopping. Default: 1.0
+        max_new_tokens: Maximum number of tokens to generate. Default: None (server decides)
+        repetition_penalty: Penalty for repeated tokens. Default: None (server decides)
+        min_chunk_length: Minimum chunk length for generation. Default: None (server decides)
+        condition_on_previous_chunks: Whether to condition generation on previous chunks. Default: None (server decides)
+        early_stop_threshold: Threshold for early stopping. Default: None (server decides)
     """
 
     text: str
@@ -151,11 +151,11 @@ class TTSRequest(BaseModel):
     prosody: Optional[Prosody] = None
     top_p: Annotated[float, Field(ge=0.0, le=1.0)] = 0.7
     temperature: Annotated[float, Field(ge=0.0, le=1.0)] = 0.7
-    max_new_tokens: int = 1024
-    repetition_penalty: float = 1.2
-    min_chunk_length: int = 50
-    condition_on_previous_chunks: bool = True
-    early_stop_threshold: float = 1.0
+    max_new_tokens: Optional[int] = None
+    repetition_penalty: Optional[float] = None
+    min_chunk_length: Optional[int] = None
+    condition_on_previous_chunks: Optional[bool] = None
+    early_stop_threshold: Optional[float] = None
 
 
 # WebSocket event types for streaming TTS

tests/unit/test_tts.py

@@ -266,6 +266,11 @@ def test_convert_omit_parameters_not_sent(self, tts_client, mock_client_wrapper)
         assert "reference_id" not in payload
         assert "sample_rate" not in payload
         assert "prosody" not in payload
+        assert "max_new_tokens" not in payload
+        assert "repetition_penalty" not in payload
+        assert "min_chunk_length" not in payload
+        assert "condition_on_previous_chunks" not in payload
+        assert "early_stop_threshold" not in payload
 
         # references is an empty list by default, so it IS included
         assert payload["references"] == []
@@ -445,24 +450,24 @@ def test_convert_with_new_advanced_parameters(
         assert payload["condition_on_previous_chunks"] is False
         assert payload["early_stop_threshold"] == 0.8
 
-    def test_convert_new_parameters_have_defaults(
+    def test_convert_advanced_parameters_not_sent_by_default(
         self, tts_client, mock_client_wrapper
     ):
-        """Test TTS default values for new advanced parameters."""
+        """Test that advanced parameters are not sent when not explicitly set."""
         mock_response = Mock()
         mock_response.iter_bytes.return_value = iter([b"audio"])
         mock_client_wrapper.request.return_value = mock_response
 
         tts_client.convert(text="Hello")
 
-        # Verify default values for new parameters in payload
+        # Verify advanced parameters are NOT in payload by default
         call_args = mock_client_wrapper.request.call_args
         payload = ormsgpack.unpackb(call_args[1]["content"])
-        assert payload["max_new_tokens"] == 1024
-        assert payload["repetition_penalty"] == 1.2
-        assert payload["min_chunk_length"] == 50
-        assert payload["condition_on_previous_chunks"] is True
-        assert payload["early_stop_threshold"] == 1.0
+        assert "max_new_tokens" not in payload
+        assert "repetition_penalty" not in payload
+        assert "min_chunk_length" not in payload
+        assert "condition_on_previous_chunks" not in payload
+        assert "early_stop_threshold" not in payload
 
 
 class TestAsyncTTSClient:
@@ -676,13 +681,18 @@ async def async_iter_bytes():
 
         await async_tts_client.convert(text="Hello")
 
-        # Verify OMIT params not in payload
+        # Verify None params not in payload
         call_args = async_mock_client_wrapper.request.call_args
         payload = ormsgpack.unpackb(call_args[1]["content"])
 
         assert "reference_id" not in payload
         assert "sample_rate" not in payload
         assert "prosody" not in payload
+        assert "max_new_tokens" not in payload
+        assert "repetition_penalty" not in payload
+        assert "min_chunk_length" not in payload
+        assert "condition_on_previous_chunks" not in payload
+        assert "early_stop_threshold" not in payload
 
     @pytest.mark.asyncio
     async def test_convert_empty_response(

tests/unit/test_types.py

@@ -111,12 +111,12 @@ def test_tts_config_defaults(self):
         assert config.latency == "balanced"
         assert config.top_p == 0.7
         assert config.temperature == 0.7
-        # New parameter defaults
-        assert config.max_new_tokens == 1024
-        assert config.repetition_penalty == 1.2
-        assert config.min_chunk_length == 50
-        assert config.condition_on_previous_chunks is True
-        assert config.early_stop_threshold == 1.0
+        # Advanced parameters default to None (server decides)
+        assert config.max_new_tokens is None
+        assert config.repetition_penalty is None
+        assert config.min_chunk_length is None
+        assert config.condition_on_previous_chunks is None
+        assert config.early_stop_threshold is None
 
     def test_tts_config_custom_new_parameters(self):
         """Test TTSConfig with custom values for new parameters."""
@@ -141,12 +141,12 @@ def test_tts_request_defaults(self):
         assert request.format == "mp3"
         assert request.chunk_length == 200
         assert request.latency == "balanced"
-        # New parameter defaults
-        assert request.max_new_tokens == 1024
-        assert request.repetition_penalty == 1.2
-        assert request.min_chunk_length == 50
-        assert request.condition_on_previous_chunks is True
-        assert request.early_stop_threshold == 1.0
+        # Advanced parameters default to None (server decides)
+        assert request.max_new_tokens is None
+        assert request.repetition_penalty is None
+        assert request.min_chunk_length is None
+        assert request.condition_on_previous_chunks is None
+        assert request.early_stop_threshold is None
 
     def test_tts_request_custom_new_parameters(self):
         """Test TTSRequest with custom values for new parameters."""