feat:adapt to engine v2.14- #111

changelog.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/).
 
+## [Unreleased]
+
+### Added
+
+- **RTZR global STT** — Added the global-only `RtzrSTT` AgentKit vendor with typed credentials, recognition options, vendor catalog registration, and generated request serialization.
+- **Speak parameters** — Exposed the generated `SpeakConfig`/`ParametersSpeak` types through `SessionParams` so `parameters.speak.batch` can be configured with `Agent.with_parameters()`.
+
+### Changed
+
+- **Sarvam TTS v2.14 parameters** — Added `speech_sample_rate`, `enable_preprocessing`, `model`, and flattened `additional_params` support. The legacy `sample_rate` input remains supported as a deprecated alias.
+- **Generated SDK alignment** — Updated AgentKit exports, global vendor routing, request validation, avatar sample-rate handling, documentation, and feature-focused regression tests for the latest `engine-v2.14` generated API.
+
 ## [v2.10.0] — 2026-09-18
 
 ### Added

docs/concepts/vendors.md

@@ -125,6 +125,7 @@ top-level `asr.keywords`. Both vendors also accept `additional_params`, serializ
 | `AssemblyAISTT` | AssemblyAI | `api_key`, `language` |
 | `AresSTT` | Ares | — (all optional) |
 | `SarvamSTT` | Sarvam | `api_key`, `language` |
+| `RtzrSTT` | RTZR | `client_id`, `client_secret` |
 | `XaiSTT` | xAI | `api_key` |
 
 ### CN STT Vendors

docs/guides/regional-routing.md

@@ -40,7 +40,7 @@ If you omit `with_stt()`, AgentKit uses `FengmingSTT` by default for `Area.CN` c
 
 | Client area | STT classes | LLM classes | MLLM classes | TTS classes | Avatar classes |
 |---|---|---|---|---|---|
-| `Area.US`, `Area.EU`, `Area.AP` | `DeepgramSTT`, `SpeechmaticsSTT`, `MicrosoftSTT`, `OpenAISTT`, `GeminiSTT`, `GoogleSTT`, `AmazonSTT`, `AssemblyAISTT`, `AresSTT`, `SarvamSTT`, `XaiSTT` | `OpenAI`, `AzureOpenAI`, `Anthropic`, `Gemini`, `Groq`, `VertexAILLM`, `AmazonBedrock`, `Dify`, `CustomLLM` | `OpenAIRealtime`, `AzureOpenAIRealtime`, `GeminiLive`, `VertexAI`, `XaiGrok` | `ElevenLabsTTS`, `MicrosoftTTS`, `OpenAITTS`, `CartesiaTTS`, `GoogleTTS`, `AmazonTTS`, `DeepgramTTS`, `GradiumTTS`, `MistralTTS`, `TypecastTTS`, `HumeAITTS`, `RimeTTS`, `FishAudioTTS`, `MiniMaxTTS`, `MurfTTS`, `SarvamTTS`, `GenericTTS`, `XaiTTS` | `LiveAvatarAvatar`, `HeyGenAvatar`, `AkoolAvatar`, `AnamAvatar`, `GenericAvatar` |
+| `Area.US`, `Area.EU`, `Area.AP` | `DeepgramSTT`, `SpeechmaticsSTT`, `MicrosoftSTT`, `OpenAISTT`, `GeminiSTT`, `GoogleSTT`, `AmazonSTT`, `AssemblyAISTT`, `AresSTT`, `SarvamSTT`, `RtzrSTT`, `XaiSTT` | `OpenAI`, `AzureOpenAI`, `Anthropic`, `Gemini`, `Groq`, `VertexAILLM`, `AmazonBedrock`, `Dify`, `CustomLLM` | `OpenAIRealtime`, `AzureOpenAIRealtime`, `GeminiLive`, `VertexAI`, `XaiGrok` | `ElevenLabsTTS`, `MicrosoftTTS`, `OpenAITTS`, `CartesiaTTS`, `GoogleTTS`, `AmazonTTS`, `DeepgramTTS`, `GradiumTTS`, `MistralTTS`, `TypecastTTS`, `HumeAITTS`, `RimeTTS`, `FishAudioTTS`, `MiniMaxTTS`, `MurfTTS`, `SarvamTTS`, `GenericTTS`, `XaiTTS` | `LiveAvatarAvatar`, `HeyGenAvatar`, `AkoolAvatar`, `AnamAvatar`, `GenericAvatar` |
 | `Area.CN` | `FengmingSTT`, `TencentSTT`, `MicrosoftCNSTT`, `XfyunSTT`, `XfyunBigModelSTT`, `XfyunDialectSTT` | `AliyunLLM`, `BytedanceLLM`, `DeepSeekLLM`, `TencentLLM` | `QwenOmni` | `MiniMaxCNTTS`, `TencentTTS`, `BytedanceTTS`, `MicrosoftCNTTS`, `CosyVoiceTTS`, `BytedanceDuplexTTS`, `StepFunTTS`, `GenericTTS` | `SenseTimeAvatar`, `SpatiusAvatar` |
 
 Global client example:

docs/reference/agent.md

@@ -178,6 +178,7 @@ Enable or disable MCP and inline REST tool invocation by setting `advanced_featu
 ### `with_parameters(parameters: SessionParams) -> Agent`
 
 Set session parameters (silence config, farewell config, data channel, audio scenario, etc.).
+Use `SpeakConfig(batch=False)` in the `speak` field to control sentence segmentation for speak requests.
 
 ### `with_audio_scenario(audio_scenario: ParametersAudioScenario) -> Agent`
 

docs/reference/vendors.md

@@ -20,7 +20,7 @@ Construct vendors directly from `agora_agent`, then bind a client with `Agent(cl
 
 | Area | STT classes | LLM classes | MLLM classes | TTS classes | Avatar classes |
 |---|---|---|---|---|---|
-| `Area.US`, `Area.EU`, `Area.AP` | `DeepgramSTT`, `SpeechmaticsSTT`, `MicrosoftSTT`, `OpenAISTT`, `GeminiSTT`, `GoogleSTT`, `AmazonSTT`, `AssemblyAISTT`, `AresSTT`, `SarvamSTT`, `XaiSTT` | `OpenAI`, `AzureOpenAI`, `Anthropic`, `Gemini`, `Groq`, `VertexAILLM`, `AmazonBedrock`, `Dify`, `CustomLLM` | `OpenAIRealtime`, `AzureOpenAIRealtime`, `GeminiLive`, `VertexAI`, `XaiGrok` | `ElevenLabsTTS`, `MicrosoftTTS`, `OpenAITTS`, `CartesiaTTS`, `GoogleTTS`, `AmazonTTS`, `DeepgramTTS`, `GradiumTTS`, `MistralTTS`, `TypecastTTS`, `HumeAITTS`, `RimeTTS`, `FishAudioTTS`, `MiniMaxTTS`, `MurfTTS`, `SarvamTTS`, `GenericTTS`, `XaiTTS` | `LiveAvatarAvatar`, `HeyGenAvatar`, `AkoolAvatar`, `AnamAvatar`, `GenericAvatar` |
+| `Area.US`, `Area.EU`, `Area.AP` | `DeepgramSTT`, `SpeechmaticsSTT`, `MicrosoftSTT`, `OpenAISTT`, `GeminiSTT`, `GoogleSTT`, `AmazonSTT`, `AssemblyAISTT`, `AresSTT`, `SarvamSTT`, `RtzrSTT`, `XaiSTT` | `OpenAI`, `AzureOpenAI`, `Anthropic`, `Gemini`, `Groq`, `VertexAILLM`, `AmazonBedrock`, `Dify`, `CustomLLM` | `OpenAIRealtime`, `AzureOpenAIRealtime`, `GeminiLive`, `VertexAI`, `XaiGrok` | `ElevenLabsTTS`, `MicrosoftTTS`, `OpenAITTS`, `CartesiaTTS`, `GoogleTTS`, `AmazonTTS`, `DeepgramTTS`, `GradiumTTS`, `MistralTTS`, `TypecastTTS`, `HumeAITTS`, `RimeTTS`, `FishAudioTTS`, `MiniMaxTTS`, `MurfTTS`, `SarvamTTS`, `GenericTTS`, `XaiTTS` | `LiveAvatarAvatar`, `HeyGenAvatar`, `AkoolAvatar`, `AnamAvatar`, `GenericAvatar` |
 | `Area.CN` | `FengmingSTT`, `TencentSTT`, `MicrosoftCNSTT`, `XfyunSTT`, `XfyunBigModelSTT`, `XfyunDialectSTT` | `AliyunLLM`, `BytedanceLLM`, `DeepSeekLLM`, `TencentLLM` | `QwenOmni` | `MiniMaxCNTTS`, `TencentTTS`, `BytedanceTTS`, `MicrosoftCNTTS`, `CosyVoiceTTS`, `BytedanceDuplexTTS`, `StepFunTTS`, `GenericTTS` | `SenseTimeAvatar`, `SpatiusAvatar` |
 
 Global example:
@@ -446,7 +446,11 @@ AgentKit serializes `credential_mode` at the top level of the Rime TTS configura
 | `pitch` | `float` | No | `None` | Pitch adjustment |
 | `pace` | `float` | No | `None` | Speed of speech |
 | `loudness` | `float` | No | `None` | Volume level |
-| `sample_rate` | `int` | No | `None` | Audio sample rate |
+| `speech_sample_rate` | `int` | No | `None` | Output speech sample rate in Hz |
+| `enable_preprocessing` | `bool` | No | `None` | Normalize English words and numeric entities before synthesis |
+| `model` | `str` | No | `None` | Sarvam TTS model; defaults to `bulbul:v3` |
+| `sample_rate` | `int` | No | `None` | Deprecated alias for `speech_sample_rate` |
+| `additional_params` | `Dict[str, Any]` | No | `None` | Additional Sarvam TTS parameters, flattened into `params` |
 | `skip_patterns` | `List[int]` | No | `None` | Skip patterns |
 
 ### `SmallestAITTS`
@@ -636,6 +640,26 @@ stt = GeminiSTT(
 | `language` | `str` | No | `None` | Language code for speech recognition |
 | `additional_params` | `Dict[str, Any]` | No | `None` | Additional xAI STT parameters |
 
+### `RtzrSTT`
+
+Global-only RTZR speech-to-text provider (`asr.vendor: "rtzr"`).
+
+| Parameter | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `client_id` | `str` | Yes | — | RTZR client ID |
+| `client_secret` | `str` | Yes | — | RTZR client secret |
+| `api_base` | `str` | No | `None` | RTZR API base URL |
+| `model_name` | `str` | No | `None` | RTZR recognition model name |
+| `language` | `str` | No | `None` | RTZR recognition language code |
+| `sample_rate` | `int` | No | `None` | Input audio sample rate in Hz |
+| `encoding` | `str` | No | `None` | Input audio encoding |
+| `use_itn` | `bool` | No | `None` | Enable inverse text normalization |
+| `use_disfluency_filter` | `bool` | No | `None` | Filter disfluencies |
+| `use_profanity_filter` | `bool` | No | `None` | Filter profanity |
+| `use_punctuation` | `bool` | No | `None` | Add punctuation to recognized text |
+| `keywords` | `List[str]` | No | `None` | Keywords that improve recognition accuracy |
+| `additional_params` | `Dict[str, Any]` | No | `None` | Additional RTZR parameters |
+
 ### `SmallestAISTT`
 
 Global-only Smallest AI speech-to-text provider (`asr.vendor: "smallestai"`).

src/agora_agent/__init__.py

@@ -67,6 +67,9 @@
         OpenAIRealtime,
         OpenAIGPTLive,
         OpenAISTT,
+        RtzrSTT,
+        SpeakConfig,
+        ParametersSpeak,
         OpenAITTS,
         RimeTTS,
         SarvamSTT,

src/agora_agent/agentkit/__init__.py

@@ -55,6 +55,8 @@
     FarewellConfig,
     ParametersDataChannel,
     ParametersAudioScenario,
+    SpeakConfig,
+    ParametersSpeak,
     InterruptionConfig,
     InterruptionMode,
     MllmTurnDetectionConfig,
@@ -207,6 +209,7 @@
     OpenAIGPTLive,
     OpenAISampleRate,
     OpenAISTT,
+    RtzrSTT,
     OpenAITTS,
     GenericTTS,
     RimeTTS,
@@ -303,6 +306,8 @@
     "FarewellConfig",
     "ParametersDataChannel",
     "ParametersAudioScenario",
+    "SpeakConfig",
+    "ParametersSpeak",
     "InterruptionConfig",
     "InterruptionMode",
     "MllmTurnDetectionConfig",
@@ -449,6 +454,7 @@
     "MicrosoftSTT",
     "MicrosoftCNSTT",
     "OpenAISTT",
+    "RtzrSTT",
     "GeminiSTT",
     "GeminiSTTModels",
     "GoogleSTT",

src/agora_agent/agentkit/agent.py

@@ -47,6 +47,7 @@
 from ..agents.types.start_agents_request_properties_parameters_farewell_config import StartAgentsRequestPropertiesParametersFarewellConfig
 from ..agents.types.start_agents_request_properties_parameters_data_channel import StartAgentsRequestPropertiesParametersDataChannel
 from ..agents.types.start_agents_request_properties_parameters_audio_scenario import StartAgentsRequestPropertiesParametersAudioScenario
+from ..agents.types.start_agents_request_properties_parameters_speak import StartAgentsRequestPropertiesParametersSpeak
 from ..agents.types.start_agents_request_properties_interruption import StartAgentsRequestPropertiesInterruption
 from ..agents.types.start_agents_request_properties_interruption_mode import StartAgentsRequestPropertiesInterruptionMode
 from ..agents.types.start_agents_request_properties_geofence import StartAgentsRequestPropertiesGeofence
@@ -140,6 +141,8 @@
 FarewellConfig = StartAgentsRequestPropertiesParametersFarewellConfig
 ParametersDataChannel = StartAgentsRequestPropertiesParametersDataChannel
 ParametersAudioScenario = StartAgentsRequestPropertiesParametersAudioScenario
+SpeakConfig = StartAgentsRequestPropertiesParametersSpeak
+ParametersSpeak = SpeakConfig
 InterruptionConfig = StartAgentsRequestPropertiesInterruption
 InterruptionMode = StartAgentsRequestPropertiesInterruptionMode
 MllmTurnDetectionConfig = MllmTurnDetection
@@ -160,6 +163,7 @@
 
 
 class SessionParamsInput(typing_extensions.TypedDict, total=False):
+    speak: StartAgentsRequestPropertiesParametersSpeak
     silence_config: StartAgentsRequestPropertiesParametersSilenceConfig
     farewell_config: StartAgentsRequestPropertiesParametersFarewellConfig
     data_channel: StartAgentsRequestPropertiesParametersDataChannel

src/agora_agent/agentkit/agent_session.py

@@ -260,6 +260,7 @@ def _validate_avatar_config(self) -> None:
             sample_rate = (
                 tts_params.get("sample_rate")
                 or tts_params.get("sample_rate_hertz")
+                or tts_params.get("speech_sample_rate")
                 or tts_params.get("samplingRate")
             )
         if isinstance(sample_rate, int):

src/agora_agent/agentkit/regional_agent.py

@@ -34,6 +34,7 @@
     GoogleSTT,
     MicrosoftSTT,
     OpenAISTT,
+    RtzrSTT,
     SarvamSTT,
     SmallestAISTT,
     SpeechmaticsSTT,
@@ -91,6 +92,7 @@
     AssemblyAISTT,
     SpeechmaticsSTT,
     SarvamSTT,
+    RtzrSTT,
     SmallestAISTT,
     XaiSTT,
 ]

src/agora_agent/agentkit/vendors/__init__.py

@@ -58,6 +58,7 @@
     GoogleSTT,
     MicrosoftSTT,
     OpenAISTT,
+    RtzrSTT,
     SarvamSTT,
     SmallestAISTT,
     SpeechmaticsSTT,
@@ -137,6 +138,7 @@
     "MicrosoftSTT",
     "MicrosoftCNSTT",
     "OpenAISTT",
+    "RtzrSTT",
     "GeminiSTT",
     "GeminiSTTModels",
     "GoogleSTT",

src/agora_agent/agentkit/vendors/catalog.py

@@ -26,6 +26,7 @@
     GoogleSTT,
     MicrosoftSTT,
     OpenAISTT,
+    RtzrSTT,
     SarvamSTT,
     SmallestAISTT,
     SpeechmaticsSTT,
@@ -83,6 +84,7 @@ def __init__(
         "assemblyai": AssemblyAISTT,
         "speechmatics": SpeechmaticsSTT,
         "sarvam": SarvamSTT,
+        "rtzr": RtzrSTT,
         "smallestai": SmallestAISTT,
         "xai": XaiSTT,
     },

src/agora_agent/agentkit/vendors/namespaces.py

@@ -23,6 +23,7 @@
     GoogleSTT,
     MicrosoftSTT,
     OpenAISTT,
+    RtzrSTT,
     SarvamSTT,
     SmallestAISTT,
     SpeechmaticsSTT,
@@ -62,6 +63,7 @@ class GlobalSTTVendors:
     assemblyai = AssemblyAISTT
     speechmatics = SpeechmaticsSTT
     sarvam = SarvamSTT
+    rtzr = RtzrSTT
     smallestai = SmallestAISTT
     xai = XaiSTT
 

src/agora_agent/agentkit/vendors/region.py

@@ -28,6 +28,7 @@
     "assemblyai",
     "speechmatics",
     "sarvam",
+    "rtzr",
     "smallestai",
     "xai",
 )

src/agora_agent/agentkit/vendors/stt.py

@@ -115,6 +115,50 @@ def to_config(self) -> Dict[str, Any]:
         return config
 
 
+class RtzrSTTOptions(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    client_id: str = Field(..., min_length=1, description="RTZR client ID")
+    client_secret: str = Field(..., min_length=1, description="RTZR client secret")
+    api_base: Optional[str] = Field(default=None, description="RTZR API base URL")
+    model_name: Optional[str] = Field(default=None, description="RTZR recognition model name")
+    language: Optional[str] = Field(default=None, description="RTZR recognition language code")
+    sample_rate: Optional[int] = Field(default=None, gt=0, description="Input audio sample rate in Hz")
+    encoding: Optional[str] = Field(default=None, description="Input audio encoding")
+    use_itn: Optional[bool] = Field(default=None, description="Enable inverse text normalization")
+    use_disfluency_filter: Optional[bool] = Field(default=None, description="Filter disfluencies such as stuttering")
+    use_profanity_filter: Optional[bool] = Field(default=None, description="Filter profanity")
+    use_punctuation: Optional[bool] = Field(default=None, description="Add punctuation to recognized text")
+    keywords: Optional[List[str]] = Field(default=None, description="Keywords that improve recognition accuracy")
+    additional_params: Optional[Dict[str, Any]] = Field(default=None)
+
+
+class RtzrSTT(RtzrSTTOptions, BaseSTT):
+    """RTZR streaming speech-to-text provider."""
+
+    def to_config(self) -> Dict[str, Any]:
+        params: Dict[str, Any] = dict(self.additional_params or {})
+        params.update({"client_id": self.client_id, "client_secret": self.client_secret})
+
+        for name in (
+            "api_base",
+            "model_name",
+            "language",
+            "sample_rate",
+            "encoding",
+            "use_itn",
+            "use_disfluency_filter",
+            "use_profanity_filter",
+            "use_punctuation",
+            "keywords",
+        ):
+            value = getattr(self, name)
+            if value is not None:
+                params[name] = value
+
+        return {"vendor": "rtzr", "params": params}
+
+
 class MicrosoftSTTOptions(BaseModel):
     model_config = ConfigDict(extra="forbid")
 

src/agora_agent/agentkit/vendors/tts.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Any, Dict, List, Literal, Optional
 from urllib.parse import urlsplit
 
@@ -568,29 +569,65 @@ class SarvamTTSOptions(BaseModel):
     pitch: Optional[float] = Field(default=None, description="Pitch adjustment")
     pace: Optional[float] = Field(default=None, description="Speed of speech")
     loudness: Optional[float] = Field(default=None, description="Volume level")
-    sample_rate: Optional[int] = Field(default=None, description="Audio sample rate in Hz")
+    speech_sample_rate: Optional[int] = Field(default=None, gt=0, description="Output speech sample rate in Hz")
+    enable_preprocessing: Optional[bool] = Field(
+        default=None,
+        description="Normalize English words and numeric entities before synthesis",
+    )
+    model: Optional[str] = Field(default=None, description="Sarvam TTS model")
+    sample_rate: Optional[int] = Field(
+        default=None,
+        gt=0,
+        description="Deprecated alias for speech_sample_rate",
+    )
+    additional_params: Optional[Dict[str, Any]] = Field(default=None, description="Additional Sarvam TTS parameters")
     skip_patterns: Optional[List[int]] = Field(default=None)
 
+    @model_validator(mode="before")
+    @classmethod
+    def _warn_deprecated_sample_rate(cls, values: Any) -> Any:
+        if isinstance(values, dict) and "sample_rate" in values:
+            warnings.warn(
+                "SarvamTTS.sample_rate is deprecated; use speech_sample_rate instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return values
+
+    @model_validator(mode="after")
+    def _validate_sample_rate_alias(self) -> "SarvamTTSOptions":
+        legacy_sample_rate = self.__dict__.get("sample_rate")
+        if self.speech_sample_rate is not None and legacy_sample_rate is not None:
+            raise ValueError("SarvamTTS accepts only one of speech_sample_rate or sample_rate")
+        return self
+
 
 class SarvamTTS(SarvamTTSOptions, BaseTTS):
     @property
     def resolved_sample_rate(self) -> Optional[int]:
         return None
 
     def to_config(self) -> Dict[str, Any]:
-        params: Dict[str, Any] = {
+        params: Dict[str, Any] = dict(self.additional_params or {})
+        params.update({
             "api_subscription_key": self.key,
             "speaker": self.speaker,
             "target_language_code": self.target_language_code,
-        }
+        })
         if self.pitch is not None:
             params["pitch"] = self.pitch
         if self.pace is not None:
             params["pace"] = self.pace
         if self.loudness is not None:
             params["loudness"] = self.loudness
-        if self.sample_rate is not None:
-            params["sample_rate"] = self.sample_rate
+        legacy_sample_rate = self.__dict__.get("sample_rate")
+        speech_sample_rate = self.speech_sample_rate if self.speech_sample_rate is not None else legacy_sample_rate
+        if speech_sample_rate is not None:
+            params["speech_sample_rate"] = speech_sample_rate
+        if self.enable_preprocessing is not None:
+            params["enable_preprocessing"] = self.enable_preprocessing
+        if self.model is not None:
+            params["model"] = self.model
 
         result: Dict[str, Any] = {"vendor": "sarvam", "params": params}
         if self.skip_patterns is not None:

tests/custom/test_agentkit_agent.py

@@ -6,6 +6,7 @@
     LlmStyle,
     MllmConfig,
     MllmVendor,
+    SpeakConfig,
     SttConfig,
     SttVendor,
     TtsConfig,
@@ -85,6 +86,21 @@ def test_with_audio_scenario_preserves_existing_parameters():
     assert _parameter(agent.config, "audio_scenario") == "chorus"
 
 
+def test_with_parameters_serializes_speak_settings():
+    agent = Agent(test_client()).with_parameters({"speak": SpeakConfig(batch=False)})
+
+    properties = agent.to_properties(
+        channel="room",
+        agent_uid="1",
+        remote_uids=["100"],
+        token="token",
+        skip_vendor_validation=True,
+    )
+
+    assert properties.parameters.speak is not None
+    assert properties.parameters.speak.batch is False
+
+
 def test_enable_rtm_defaults_data_channel_to_rtm():
     properties = Agent(test_client(), advanced_features={"enable_rtm": True}).to_properties(
         channel="room",