meshagent-livekit 0.16.0__tar.gz

meshagent_livekit-0.16.0/CHANGELOG.md

@@ -0,0 +1,66 @@
+## [0.16.0]
+- Add optional `namespace` support across database client operations (list/inspect/create/drop/index/etc.) to target namespaced tables
+- Update dependencies `livekit-api` to `~1.1` (from `>=1.0`) and `livekit-agents`/`livekit-plugins-openai`/`livekit-plugins-silero`/`livekit-plugins-turn-detector` to `~1.3` (from `~1.2`)
+
+## [0.15.0]
+- Added new UI schema widgets for `tabs`/`tab` (including initial tab selection and active background styling) plus a `visible` boolean widget property for conditional rendering.
+- Updated Python LiveKit integration dependencies to include `livekit==1.0.20`.
+
+## [0.14.0]
+- Breaking change: toolkit extension hooks were simplified to a synchronous `get_toolkit_builders()` API and tool selection now uses per-toolkit configuration objects (not just tool names)
+- `LLMTaskRunner` now supports per-client and per-room rules, plus dynamically injected required toolkits at call time
+- `TaskRunner.ask` now supports optional binary attachments; `LLMTaskRunner` can unpack tar attachments and pass images/files into the LLM conversation context
+- `AgentsClient.ask` now returns `TextResponse` when the agent responds with plain text (instead of always treating answers as JSON)
+- Added a CLI `task-runner` command to run/join LLM task runners with configurable rules, schemas, toolkits, and optional remote LLM delegation
+
+## [0.13.0]
+- Added `initial_json` and explicit schema support when opening MeshDocuments, enabling schema-first document initialization
+- Added binary attachment support when invoking agent tools so tool calls can include raw payload data
+- Breaking change: toolkit construction is now async and receives the active room client, enabling toolkits that introspect room state during build
+- Added database schema inspection and JSON Schema mappings for data types to support tool input validation and generation
+- Introduced database toolkits (list/inspect/search/insert/update/delete) and integrated optional per-table enablement into the chatbot/mailbot/helpers CLI flows
+
+## [0.12.0]
+- Reduce worker-queue logging verbosity to avoid logging full message payloads
+
+## [0.11.0]
+- Stability
+
+## [0.10.1]
+- Stability
+
+## [0.10.0]
+- Stability
+
+## [0.9.3]
+- Stability
+
+## [0.9.2]
+- Stability
+
+## [0.9.1]
+- Stability
+
+## [0.9.0]
+- Stability
+
+## [0.8.4]
+- Stability
+
+## [0.8.3]
+- Stability
+
+## [0.8.2]
+- Stability
+
+## [0.8.1]
+- Stability
+
+## [0.8.0]
+- Stability
+
+## [0.7.2]
+- Stability
+
+## [0.7.1]
+- Stability

meshagent_livekit-0.16.0/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

meshagent_livekit-0.16.0/MANIFEST.in

@@ -0,0 +1 @@
+include CHANGELOG.md

meshagent_livekit-0.16.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: meshagent-livekit
+Version: 0.16.0
+Summary: Livekit support for Meshagent
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://docs.meshagent.com
+Project-URL: Website, https://www.meshagent.com
+Project-URL: Source, https://www.meshagent.com
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pytest~=8.4
+Requires-Dist: pytest-asyncio~=0.26
+Requires-Dist: strip-markdown~=1.3
+Requires-Dist: livekit==1.0.20
+Requires-Dist: livekit-api~=1.1
+Requires-Dist: livekit-agents~=1.3
+Requires-Dist: livekit-plugins-openai~=1.3
+Requires-Dist: livekit-plugins-silero~=1.3
+Requires-Dist: livekit-plugins-turn-detector~=1.3
+Requires-Dist: meshagent-api~=0.16.0
+Requires-Dist: meshagent-tools~=0.16.0
+Dynamic: license-file
+
+# [Meshagent](https://www.meshagent.com)
+
+## MeshAgent LiveKit
+The ``meshagent.livekit`` package equips agents with real-time audio and voice capabilities via the LiveKit SDK. 
+
+### VoiceBot
+The ``VoiceBot`` agent handles two-way voice conversations allowing users to interact with the agent verbally. Agents based on the ``VoiceBot`` class can be given the same tools as ``ChatBot`` based agents. This means you only need to write a tool once and the same tool can be used across both text and voice based agents. Check out the [Build a Voice Agent](https://docs.meshagent.com/agents/standard/buildanddeployvoicebot) example to learn how to create a simple Voice Agent without tools then add built-in MeshAgent tools and custom tools to the agent.
+
+---
+### Learn more about MeshAgent on our website or check out the docs for additional examples!
+
+**Website**: [www.meshagent.com](https://www.meshagent.com/)
+
+**Documentation**: [docs.meshagent.com](https://docs.meshagent.com/)
+
+---

meshagent_livekit-0.16.0/README.md

@@ -0,0 +1,16 @@
+# [Meshagent](https://www.meshagent.com)
+
+## MeshAgent LiveKit
+The ``meshagent.livekit`` package equips agents with real-time audio and voice capabilities via the LiveKit SDK. 
+
+### VoiceBot
+The ``VoiceBot`` agent handles two-way voice conversations allowing users to interact with the agent verbally. Agents based on the ``VoiceBot`` class can be given the same tools as ``ChatBot`` based agents. This means you only need to write a tool once and the same tool can be used across both text and voice based agents. Check out the [Build a Voice Agent](https://docs.meshagent.com/agents/standard/buildanddeployvoicebot) example to learn how to create a simple Voice Agent without tools then add built-in MeshAgent tools and custom tools to the agent.
+
+---
+### Learn more about MeshAgent on our website or check out the docs for additional examples!
+
+**Website**: [www.meshagent.com](https://www.meshagent.com/)
+
+**Documentation**: [docs.meshagent.com](https://docs.meshagent.com/)
+
+---

meshagent_livekit-0.16.0/meshagent/livekit/__init__.py

@@ -0,0 +1,3 @@
+from .version import __version__
+
+__all__ = [__version__]

meshagent_livekit-0.16.0/meshagent/livekit/agents/meeting_transcriber.py

@@ -0,0 +1,310 @@
+import asyncio
+import logging
+
+from typing import Optional
+
+from datetime import datetime, timezone
+from livekit import rtc
+from livekit.agents import (
+    Agent,
+    AgentSession,
+    RoomInputOptions,
+    RoomIO,
+    RoomOutputOptions,
+    StopResponse,
+    llm,
+    utils,
+)
+from livekit.agents.stt import STT
+
+from meshagent.openai.proxy import get_client
+from livekit.plugins import openai, silero
+from meshagent.api import MeshDocument, SchemaRegistration, SchemaRegistry
+from meshagent.agents import SingleRoomAgent
+from meshagent.tools import RemoteToolkit, ToolContext, Tool
+from meshagent.api.room_server_client import Requirement
+from meshagent.livekit.agents.voice import VoiceConnection
+from meshagent.agents.schemas.transcript import transcript_schema
+
+logger = logging.getLogger("meeting_transcriber")
+
+
+class StartTranscriptionTool(Tool):
+    def __init__(self, *, transcriber: "MeetingTranscriber"):
+        self.transcriber = transcriber
+        super().__init__(
+            name="start_transcription",
+            input_schema={
+                "type": "object",
+                "required": [
+                    "breakout_room",
+                    "path",
+                ],
+                "additionalProperties": False,
+                "properties": {
+                    "breakout_room": {
+                        "type": "string",
+                    },
+                    "path": {
+                        "type": "string",
+                    },
+                },
+            },
+        )
+
+    async def execute(self, context: ToolContext, *, breakout_room: str, path: str):
+        await self.transcriber.start_transcription(
+            breakout_room=breakout_room, path=path
+        )
+        return {"status": "started"}
+
+
+class StopTranscriptionTool(Tool):
+    def __init__(self, *, transcriber: "MeetingTranscriber"):
+        self.transcriber = transcriber
+        super().__init__(
+            name="stop_transcription",
+            input_schema={
+                "type": "object",
+                "required": [
+                    "breakout_room",
+                ],
+                "additionalProperties": False,
+                "properties": {
+                    "breakout_room": {
+                        "type": "string",
+                    },
+                },
+            },
+        )
+
+    async def execute(self, context: ToolContext, *, breakout_room: str):
+        await self.transcriber.stop_transcription(
+            breakout_room=breakout_room,
+        )
+        return {"status": "stopped"}
+
+
+class MeetingTranscriber(SingleRoomAgent):
+    def __init__(
+        self,
+        name: str,
+        requires: Optional[list[Requirement]] = None,
+        stt: Optional[STT] = None,
+    ):
+        super().__init__(
+            name=name,
+            requires=requires,
+        )
+        self._toolkit = RemoteToolkit(
+            name="transcription",
+            tools=[
+                StartTranscriptionTool(transcriber=self),
+                StopTranscriptionTool(transcriber=self),
+            ],
+        )
+        self.stt = stt
+        self._vad = None
+        self._transcription_tasks = dict[str, tuple[asyncio.Task, asyncio.Future]]()
+
+    async def start(self, *, room):
+        await super().start(room=room)
+        await self._toolkit.start(room=room)
+        await room.local_participant.set_attribute("supports_voice", True)
+        await room.messaging.enable()
+
+        self._vad = silero.VAD.load()
+
+    async def start_transcription(self, *, breakout_room: Optional[str], path: str):
+        stop_fut = asyncio.Future()
+
+        async def transcribe():
+            await self.room.local_participant.set_attribute(
+                f"transcribing.{breakout_room}", True
+            )
+
+            try:
+                async with VoiceConnection(
+                    room=self.room, breakout_room=breakout_room
+                ) as conn:
+                    doc = await self.room.sync.open(path=path, create=True)
+
+                    stt = self.stt
+                    if stt is None:
+                        openai_client = get_client(room=self.room)
+                        stt = openai.STT(client=openai_client)
+
+                    transcriber = MultiUserTranscriber(conn, doc, self._vad, stt)
+                    transcriber.start()
+
+                    for participant in conn.livekit_room.remote_participants.values():
+                        # handle all existing participants
+                        transcriber.on_participant_connected(participant)
+
+                    await stop_fut
+
+                    await self.room.local_participant.set_attribute(
+                        f"transcribing.{breakout_room}", False
+                    )
+
+                    await self.room.sync.close(path=path)
+
+                    await transcriber.aclose()
+            except Exception as ex:
+                logger.error(f"error during transcription {ex}", exc_info=ex)
+                pass
+
+            await self.room.local_participant.set_attribute(
+                f"transcribing.{breakout_room}", False
+            )
+
+        if breakout_room not in self._transcription_tasks:
+            self._transcription_tasks[breakout_room] = (
+                asyncio.create_task(transcribe()),
+                stop_fut,
+            )
+
+    async def stop_transcription(self, *, breakout_room: Optional[str]):
+        if breakout_room in self._transcription_tasks:
+            task, fut = self._transcription_tasks.pop(breakout_room)
+            fut.set_result(True)
+            await asyncio.gather(task)
+
+    async def stop(self):
+        await self._toolkit.stop()
+
+        tasks = []
+        for breakout_room, _ in self._transcription_tasks.items():
+            task, fut = self._transcription_tasks.pop(breakout_room)
+            fut.set_result(True)
+            tasks.append(task)
+
+        await asyncio.gather(*tasks)
+        await super().stop()
+
+
+class TranscriptRegistry(SchemaRegistry):
+    def __init__(self):
+        name = "transcript"
+        super().__init__(
+            name=f"meshagent.schema.{name}",
+            validate_webhook_secret=False,
+            schemas=[SchemaRegistration(name=name, schema=transcript_schema)],
+        )
+
+
+class Transcriber(Agent):
+    def __init__(self, *, participant, doc: MeshDocument, stt):
+        super().__init__(
+            instructions="not-needed",
+            stt=stt,
+        )
+        self.doc = doc
+        self.participant = participant
+
+    async def on_user_turn_completed(
+        self, chat_ctx: llm.ChatContext, new_message: llm.ChatMessage
+    ):
+        segments = self.doc.root
+        segments.append_child(
+            "segment",
+            {
+                "text": new_message.text_content,
+                "participant_name": self.participant.name,
+                "participant_id": self.participant.sid,
+                "time": datetime.now(timezone.utc).isoformat().replace("+00:00", "Z"),
+            },
+        )
+        raise StopResponse()
+
+
+class MultiUserTranscriber:
+    def __init__(self, ctx: VoiceConnection, doc: MeshDocument, vad, stt):
+        self.ctx = ctx
+        self.doc = doc
+        self.vad = vad
+        self.stt = stt
+        self._sessions: dict[str, AgentSession] = {}
+        self._tasks: set[asyncio.Task] = set()
+
+    def start(self):
+        self.ctx.livekit_room.on("participant_connected", self.on_participant_connected)
+        self.ctx.livekit_room.on(
+            "participant_disconnected", self.on_participant_disconnected
+        )
+
+    async def aclose(self):
+        await utils.aio.cancel_and_wait(*self._tasks)
+
+        await asyncio.gather(
+            *[self._close_session(session) for session in self._sessions.values()]
+        )
+
+        self.ctx.livekit_room.off(
+            "participant_connected", self.on_participant_connected
+        )
+        self.ctx.livekit_room.off(
+            "participant_disconnected", self.on_participant_disconnected
+        )
+
+    def on_participant_connected(self, participant: rtc.RemoteParticipant):
+        if participant.identity in self._sessions:
+            return
+
+        logger.info(f"starting session for {participant.identity}")
+        task = asyncio.create_task(self._start_session(participant))
+        self._tasks.add(task)
+
+        def on_task_done(task: asyncio.Task):
+            try:
+                self._sessions[participant.identity] = task.result()
+            finally:
+                self._tasks.discard(task)
+
+        task.add_done_callback(on_task_done)
+
+    def on_participant_disconnected(self, participant: rtc.RemoteParticipant):
+        if (session := self._sessions.pop(participant.identity)) is None:
+            return
+
+        logger.info(f"closing session for {participant.identity}")
+        task = asyncio.create_task(self._close_session(session))
+        self._tasks.add(task)
+        task.add_done_callback(lambda _: self._tasks.discard(task))
+
+    async def _start_session(self, participant: rtc.RemoteParticipant) -> AgentSession:
+        if participant.identity in self._sessions:
+            return self._sessions[participant.identity]
+
+        session = AgentSession(
+            vad=self.vad,
+        )
+        room_io = RoomIO(
+            agent_session=session,
+            room=self.ctx.livekit_room,
+            participant=participant,
+            input_options=RoomInputOptions(
+                # text input is not supported for multiple room participants
+                # if needed, register the text stream handler by yourself
+                # and route the text to different sessions based on the participant identity
+                text_enabled=False,
+                delete_room_on_close=False,
+            ),
+            output_options=RoomOutputOptions(
+                transcription_enabled=True,
+                audio_enabled=False,
+            ),
+        )
+        await room_io.start()
+        await session.start(
+            agent=Transcriber(
+                participant=participant,
+                doc=self.doc,
+                stt=self.stt,
+            )
+        )
+        return session
+
+    async def _close_session(self, sess: AgentSession) -> None:
+        await sess.drain()
+        await sess.aclose()