Skip to content

refactor: rename uri to ws_url in AssemblyAISTT configuration #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
plutoless merged 1 commit into from
Aug 10, 2026
+8 −8
Merged

refactor: rename uri to ws_url in AssemblyAISTT configuration #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/vendors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ For `nova-2` and `nova-3`, omit `api_key` to use Agora-managed credentials. For
|---|---|---|---|---|
| `api_key` | `str` | Yes | — | AssemblyAI API key |
| `language` | `str` | Yes | — | Language code |
| `uri` | `str` | No | `None` | AssemblyAI streaming WebSocket URL |
| `ws_url` | `str` | No | `None` | AssemblyAI streaming WebSocket URL |
| `additional_params` | `Dict[str, Any]` | No | `None` | Additional parameters |

### `AresSTT`
Expand Down
6 changes: 3 additions & 3 deletions src/agora_agent/agentkit/vendors/stt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,16 +195,16 @@ class AssemblyAISTT(BaseSTT):

api_key: str = Field(..., description="AssemblyAI API key")
language: str = Field(..., description="Language code")
uri: Optional[str] = Field(default=None, description="AssemblyAI streaming WebSocket URL")
ws_url: Optional[str] = Field(default=None, description="AssemblyAI streaming WebSocket URL")
additional_params: Optional[Dict[str, Any]] = Field(default=None)

def to_config(self) -> Dict[str, Any]:
params: Dict[str, Any] = dict(self.additional_params or {})
params["api_key"] = self.api_key
if self.language is not None:
params["language"] = self.language
if self.uri is not None:
params["uri"] = self.uri
if self.ws_url is not None:
params["ws_url"] = self.ws_url

config: Dict[str, Any] = {
"vendor": "assemblyai",
Expand Down
8 changes: 4 additions & 4 deletions tests/custom/test_stt_language.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,12 +163,12 @@ def test_stt_vendor_params_match_documented_shapes() -> None:
"language_code": "en-US",
}

assemblyai_config = AssemblyAISTT(api_key="assembly-key", language="en-US", uri="wss://example.test/ws").to_config()
assemblyai_config = AssemblyAISTT(api_key="assembly-key", language="en-US", ws_url="wss://example.test/ws").to_config()
assert "language" not in assemblyai_config
assert assemblyai_config["params"] == {
"api_key": "assembly-key",
"language": "en-US",
"uri": "wss://example.test/ws",
"ws_url": "wss://example.test/ws",
}

assert MicrosoftSTT(key="ms-key", region="eastus", language="en-US").to_config()["params"] == {
Expand All @@ -193,7 +193,7 @@ def test_assemblyai_params_stay_nested_and_asr_language_comes_from_turn_detectio
Agent(test_client(), turn_detection=TurnDetectionConfig(language="fr-FR"))
.with_llm(OpenAI(api_key="llm-key", model="gpt-4o-mini", base_url="https://api.openai.com/v1/chat/completions"))
.with_tts(ElevenLabsTTS(key="tts-key", voice_id="voice", model_id="eleven_flash_v2_5", base_url="wss://api.elevenlabs.io/v1"))
.with_stt(AssemblyAISTT(api_key="assembly-key", language="en-US", uri="wss://example.test/ws"))
.with_stt(AssemblyAISTT(api_key="assembly-key", language="en-US", ws_url="wss://example.test/ws"))
)

assert props["asr"] == {
Expand All @@ -202,7 +202,7 @@ def test_assemblyai_params_stay_nested_and_asr_language_comes_from_turn_detectio
"params": {
"api_key": "assembly-key",
"language": "en-US",
"uri": "wss://example.test/ws",
"ws_url": "wss://example.test/ws",
},
}
assert props["turn_detection"] == {"language": "fr-FR"}
Loading