# LiveKit Plugins Speechmatics
Agent Framework plugin for Speechmatics.
## Installation
```bash
pip install livekit-plugins-speechmatics
```
Usage:
```python
agent = VoicePipelineAgent(
stt=speechmatics.STT(),
turn_detector=turn_detector.EOUModel(),
min_endpointing_delay=0.5,
max_endpointing_delay=5.0,
...
)
```
Note: The plugin was built with
LiveKit's [end-of-turn detection feature](https://github.com/livekit/agents#in-house-phrase-endpointing-model) in mind,
and it doesn't implement phrase endpointing. `AddTranscript` and `AddPartialTranscript` events are emitted as soon
as they’re received from the Speechmatics STT engine. For the best user experience,
we recommend running the agent with end-of-turn detection enabled (
see [example](https://github.com/livekit-examples/voice-pipeline-agent-python/blob/main/agent.py)).
## Pre-requisites
You'll need to specify a Speechmatics API Key. It can be set as environment variable `SPEECHMATICS_API_KEY` or
`.env.local` file.
Raw data
{
"_id": null,
"home_page": "https://github.com/livekit/agents",
"name": "livekit-plugins-speechmatics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": null,
"keywords": "webrtc, realtime, audio, video, livekit",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3e/91/c69d7475f948bedea10f00654bccfcffd6ef79e42db8f70fe7fe3568cca3/livekit_plugins_speechmatics-0.0.2.tar.gz",
"platform": null,
"description": "# LiveKit Plugins Speechmatics\n\nAgent Framework plugin for Speechmatics.\n\n## Installation\n\n```bash\npip install livekit-plugins-speechmatics\n```\n\nUsage:\n\n```python\nagent = VoicePipelineAgent(\n stt=speechmatics.STT(),\n turn_detector=turn_detector.EOUModel(),\n min_endpointing_delay=0.5,\n max_endpointing_delay=5.0,\n ...\n)\n```\n\nNote: The plugin was built with\nLiveKit's [end-of-turn detection feature](https://github.com/livekit/agents#in-house-phrase-endpointing-model) in mind,\nand it doesn't implement phrase endpointing. `AddTranscript` and `AddPartialTranscript` events are emitted as soon\nas they\u2019re received from the Speechmatics STT engine. For the best user experience,\nwe recommend running the agent with end-of-turn detection enabled (\nsee [example](https://github.com/livekit-examples/voice-pipeline-agent-python/blob/main/agent.py)).\n\n## Pre-requisites\n\nYou'll need to specify a Speechmatics API Key. It can be set as environment variable `SPEECHMATICS_API_KEY` or\n`.env.local` file.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Agent Framework plugin for Speechmatics",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://docs.livekit.io",
"Homepage": "https://github.com/livekit/agents",
"Source": "https://github.com/livekit/agents",
"Website": "https://livekit.io/"
},
"split_keywords": [
"webrtc",
" realtime",
" audio",
" video",
" livekit"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "693261c831f1a8dd17d3478e48b15d4e6e9a7a5e4940e95148705cb188f58a53",
"md5": "cf137b2e0ef8fcd6afdfa5cce8c6e668",
"sha256": "b9de4699395ca63174f4b8c2872df26c7f5408f3030521de0c0e19e4436d5766"
},
"downloads": -1,
"filename": "livekit_plugins_speechmatics-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf137b2e0ef8fcd6afdfa5cce8c6e668",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 9965,
"upload_time": "2025-03-06T17:22:10",
"upload_time_iso_8601": "2025-03-06T17:22:10.605796Z",
"url": "https://files.pythonhosted.org/packages/69/32/61c831f1a8dd17d3478e48b15d4e6e9a7a5e4940e95148705cb188f58a53/livekit_plugins_speechmatics-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3e91c69d7475f948bedea10f00654bccfcffd6ef79e42db8f70fe7fe3568cca3",
"md5": "2e546f1f76dd06905fd7c4fc28aef8bb",
"sha256": "31f06c4a70aac0300df636fe5a2f40387b211e39abcca8e91117acd6dc0e94d3"
},
"downloads": -1,
"filename": "livekit_plugins_speechmatics-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "2e546f1f76dd06905fd7c4fc28aef8bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 8774,
"upload_time": "2025-03-06T17:22:35",
"upload_time_iso_8601": "2025-03-06T17:22:35.648210Z",
"url": "https://files.pythonhosted.org/packages/3e/91/c69d7475f948bedea10f00654bccfcffd6ef79e42db8f70fe7fe3568cca3/livekit_plugins_speechmatics-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-06 17:22:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "livekit",
"github_project": "agents",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "livekit-plugins-speechmatics"
}
JSON
