livekit-plugins-uplift


Namelivekit-plugins-uplift JSON
Version 0.2.8 PyPI version JSON
download
home_pageNone
SummaryAgent Framework plugin for voice synthesis with Uplift AI.
upload_time2025-07-18 08:19:27
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords audio livekit realtime tts uplift video webrtc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # LiveKit Plugins - Uplift

This plugin provides TTS integration for [Uplift AI](https://upliftai.org) into the LiveKit Agent Framework. You can also find official documentation of [Uplift API](https://docs.upliftai.org/introduction)

## Installation

```bash
pip install livekit-plugins-uplift
```

## Pre-requisites

You'll need an API key from UpliftAI. It can be set as an environment variable: `UPLIFT_AI_API_KEY`

## Urdu Script Requirements

The Uplift TTS is designed to work with Urdu script. The TTS should only receive text in Urdu script - not Roman Urdu. This can be achieved via basic prompt engineering to ensure your LLM generates output in proper Urdu script.

### Example

```python
from livekit.plugins import uplift

async def entrypoint(ctx: JobContext):
    initial_ctx = llm.ChatContext().append(
        role="system",
        text=(
            "You're an Urdu speaking livebot on a LiveKit call. "
            "No matter what, you should generate Urdu responses, in urdu script, no matter what. "
            "It should not be in Roman Urdu, it should be in Urdu script. "
        ),
    )

    await ctx.connect(auto_subscribe=AutoSubscribe.AUDIO_ONLY)

    assistant = VoicePipelineAgent(
        vad=silero.VAD.load(),
        stt=openai.STT(language="ur"),
        llm=openai.LLM(),
        tts=uplift.TTS(voice="v_30s70t3a"),
        chat_ctx=initial_ctx,
        fnc_ctx=fnc_ctx,
    )
    assistant.start(ctx.room)
    await assistant.say("ہیلو، آپ کیسے ہیں؟", allow_interruptions=True)
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "livekit-plugins-uplift",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "audio, livekit, realtime, tts, uplift, video, webrtc",
    "author": null,
    "author_email": "V12Hero <support@v12hero.com>",
    "download_url": "https://files.pythonhosted.org/packages/c7/bc/0d0460b49e27687c8a06259fd0829a402b57e13c4e395c7a1816bbe01635/livekit_plugins_uplift-0.2.8.tar.gz",
    "platform": null,
    "description": "# LiveKit Plugins - Uplift\n\nThis plugin provides TTS integration for [Uplift AI](https://upliftai.org) into the LiveKit Agent Framework. You can also find official documentation of [Uplift API](https://docs.upliftai.org/introduction)\n\n## Installation\n\n```bash\npip install livekit-plugins-uplift\n```\n\n## Pre-requisites\n\nYou'll need an API key from UpliftAI. It can be set as an environment variable: `UPLIFT_AI_API_KEY`\n\n## Urdu Script Requirements\n\nThe Uplift TTS is designed to work with Urdu script. The TTS should only receive text in Urdu script - not Roman Urdu. This can be achieved via basic prompt engineering to ensure your LLM generates output in proper Urdu script.\n\n### Example\n\n```python\nfrom livekit.plugins import uplift\n\nasync def entrypoint(ctx: JobContext):\n    initial_ctx = llm.ChatContext().append(\n        role=\"system\",\n        text=(\n            \"You're an Urdu speaking livebot on a LiveKit call. \"\n            \"No matter what, you should generate Urdu responses, in urdu script, no matter what. \"\n            \"It should not be in Roman Urdu, it should be in Urdu script. \"\n        ),\n    )\n\n    await ctx.connect(auto_subscribe=AutoSubscribe.AUDIO_ONLY)\n\n    assistant = VoicePipelineAgent(\n        vad=silero.VAD.load(),\n        stt=openai.STT(language=\"ur\"),\n        llm=openai.LLM(),\n        tts=uplift.TTS(voice=\"v_30s70t3a\"),\n        chat_ctx=initial_ctx,\n        fnc_ctx=fnc_ctx,\n    )\n    assistant.start(ctx.room)\n    await assistant.say(\"\u06c1\u06cc\u0644\u0648\u060c \u0622\u067e \u06a9\u06cc\u0633\u06d2 \u06c1\u06cc\u06ba\u061f\", allow_interruptions=True)\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Agent Framework plugin for voice synthesis with Uplift AI.",
    "version": "0.2.8",
    "project_urls": {
        "Homepage": "https://github.com/V12Hero/livekit-plugins-uplift",
        "Source": "https://github.com/V12Hero/livekit-plugins-uplift",
        "Tracker": "https://github.com/V12Hero/livekit-plugins-uplift/issues"
    },
    "split_keywords": [
        "audio",
        " livekit",
        " realtime",
        " tts",
        " uplift",
        " video",
        " webrtc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c9f221a5b203d584ce3039aea2116ced554303510f754882f58c575193169b33",
                "md5": "e1a24f84a85371ad65c824d6debc965d",
                "sha256": "d98d9e7ba2ca762a72985ae3811a345d1d0d9efa59b7996ebcae9b19aa3556cb"
            },
            "downloads": -1,
            "filename": "livekit_plugins_uplift-0.2.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e1a24f84a85371ad65c824d6debc965d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11502,
            "upload_time": "2025-07-18T08:19:26",
            "upload_time_iso_8601": "2025-07-18T08:19:26.288219Z",
            "url": "https://files.pythonhosted.org/packages/c9/f2/21a5b203d584ce3039aea2116ced554303510f754882f58c575193169b33/livekit_plugins_uplift-0.2.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c7bc0d0460b49e27687c8a06259fd0829a402b57e13c4e395c7a1816bbe01635",
                "md5": "d19128ef09657f8211120d81c14da40a",
                "sha256": "86aba4d8b9b004c503e13837f48785f0c2c81da06af6a218db7a7ad0949e12d3"
            },
            "downloads": -1,
            "filename": "livekit_plugins_uplift-0.2.8.tar.gz",
            "has_sig": false,
            "md5_digest": "d19128ef09657f8211120d81c14da40a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9919,
            "upload_time": "2025-07-18T08:19:27",
            "upload_time_iso_8601": "2025-07-18T08:19:27.300833Z",
            "url": "https://files.pythonhosted.org/packages/c7/bc/0d0460b49e27687c8a06259fd0829a402b57e13c4e395c7a1816bbe01635/livekit_plugins_uplift-0.2.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-18 08:19:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "V12Hero",
    "github_project": "livekit-plugins-uplift",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "livekit-plugins-uplift"
}
        
Elapsed time: 0.61146s