livekit-agents 1.0.0.dev2__tar.gz → 1.0.0.dev4__tar.gz

livekit_agents-1.0.0.dev4/.gitignore

@@ -0,0 +1,168 @@
+**/.vscode
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+node_modules
+
+credentials.json
+pyrightconfig.json

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/PKG-INFO

@@ -1,53 +1,43 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: livekit-agents
-Version: 1.0.0.dev2
+Version: 1.0.0.dev4
 Summary: LiveKit Python Agents
-Home-page: https://github.com/livekit/agents
-License: Apache-2.0
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
 Project-URL: Source, https://github.com/livekit/agents
-Keywords: webrtc,realtime,audio,video,livekit,agents,AI
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: AI,agents,audio,livekit,realtime,video,webrtc
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.9.0
-Description-Content-Type: text/markdown
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Requires-Dist: aiohttp~=3.10
 Requires-Dist: click~=8.1
+Requires-Dist: docstring-parser>=0.16
+Requires-Dist: eval-type-backport
+Requires-Dist: livekit-api>=0.8.2
+Requires-Dist: livekit-protocol>=0.8.2
 Requires-Dist: livekit>=0.21.1
-Requires-Dist: livekit-api~=0.8.2
-Requires-Dist: livekit-protocol~=0.8.2
 Requires-Dist: protobuf>=3
-Requires-Dist: pyjwt>=2.0.0
-Requires-Dist: types-protobuf<5,>=4
-Requires-Dist: watchfiles~=0.22
-Requires-Dist: psutil~=5.9
-Requires-Dist: aiohttp~=3.10
-Requires-Dist: typing-extensions~=4.12
+Requires-Dist: psutil>=7.0
+Requires-Dist: pyjwt>=2.0
 Requires-Dist: sounddevice>=0.5
-Requires-Dist: colorama; sys_platform == "win32"
+Requires-Dist: types-protobuf<5,>=4
+Requires-Dist: typing-extensions>=4.12
+Requires-Dist: watchfiles>=1.0
 Provides-Extra: codecs
-Requires-Dist: av>=12.0.0; extra == "codecs"
-Requires-Dist: numpy>=1.26.0; extra == "codecs"
+Requires-Dist: av>=12.0.0; extra == 'codecs'
+Requires-Dist: numpy>=1.26.0; extra == 'codecs'
 Provides-Extra: images
-Requires-Dist: pillow>=10.3.0; extra == "images"
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Requires-Dist: pillow>=10.3.0; extra == 'images'
+Description-Content-Type: text/markdown
 
 # LiveKit Agents
 

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/__init__.py

@@ -12,18 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from . import (
-    cli,
-    ipc,
-    llm,
-    metrics,
-    stt,
-    tokenize,
-    tts,
-    utils,
-    vad,
-    voice,
-)
+from . import cli, ipc, llm, metrics, stt, tokenize, tts, utils, vad, voice
 from ._exceptions import (
     APIConnectionError,
     APIError,
@@ -43,7 +32,7 @@ from .types import (
     NotGivenOr,
 )
 from .version import __version__
-from .voice import VoiceAgent
+from .voice import AgentSession
 from .worker import Worker, WorkerOptions, WorkerPermissions, WorkerType
 
 __all__ = [
@@ -68,7 +57,7 @@ __all__ = [
     "llm",
     "metrics",
     "voice",
-    "VoiceAgent",
+    "AgentSession",
     "cli",
     "AssignmentTimeoutError",
     "APIConnectionError",

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/cli/cli.py

@@ -153,7 +153,7 @@ def run_app(opts: WorkerOptions, *, hot_reload: NotGivenOr[bool] = NOT_GIVEN) ->
 
         args = proto.CliArgs(
             opts=opts,
-            log_level="INFO",
+            log_level="DEBUG",
             devmode=True,
             asyncio_debug=False,
             watch=False,
@@ -293,7 +293,7 @@ def run_worker(args: proto.CliArgs) -> None:
     @worker.once("worker_started")
     def _worker_started():
         if args.simulate_job and args.reload_count == 0:
-            logger.info("connecting to room %s", args.simulate_job.room)
+            # logger.info("connecting to room %s", args.simulate_job.room)
             loop.create_task(
                 worker.simulate_job(args.simulate_job.room, args.simulate_job.participant_identity)
             )

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/cli/log.py

@@ -7,7 +7,7 @@ import traceback
 from collections import OrderedDict
 from datetime import date, datetime, time, timezone
 from inspect import istraceback
-from typing import Any, Dict, Tuple
+from typing import Any
 
 from ..plugin import Plugin
 
@@ -21,6 +21,8 @@ NOISY_LOGGERS = [
     "websockets.client",
     "aiohttp.access",
     "livekit",
+    "botocore",
+    "aiobotocore",
 ]
 
 
@@ -33,7 +35,7 @@ def _silence_noisy_loggers() -> None:
 
 # skip default LogRecord attributes
 # http://docs.python.org/library/logging.html#logrecord-attributes
-_RESERVED_ATTRS: Tuple[str, ...] = (
+_RESERVED_ATTRS: tuple[str, ...] = (
     "args",
     "asctime",
     "created",
@@ -60,7 +62,7 @@ _RESERVED_ATTRS: Tuple[str, ...] = (
 )
 
 
-def _merge_record_extra(record: logging.LogRecord, target: Dict[Any, Any]):
+def _merge_record_extra(record: logging.LogRecord, target: dict[Any, Any]):
     for key, value in record.__dict__.items():
         if key not in _RESERVED_ATTRS and not (hasattr(key, "startswith") and key.startswith("_")):
             target[key] = value
@@ -75,7 +77,7 @@ def _parse_style(formatter: logging.Formatter) -> list[str]:
     elif isinstance(formatter._style, logging.PercentStyle):
         formatter_style_pattern = re.compile(r"%\((.+?)\)", re.IGNORECASE)
     else:
-        raise ValueError("Invalid format: %s" % formatter._fmt)
+        raise ValueError(f"Invalid format: {formatter._fmt}")
 
     if formatter._fmt:
         return formatter_style_pattern.findall(formatter._fmt)
@@ -108,7 +110,7 @@ class JsonFormatter(logging.Formatter):
 
     def format(self, record: logging.LogRecord) -> str:
         """Formats a log record and serializes to json"""
-        message_dict: Dict[str, Any] = {}
+        message_dict: dict[str, Any] = {}
         message_dict["level"] = record.levelname
         message_dict["name"] = record.name
 
@@ -128,7 +130,7 @@ class JsonFormatter(logging.Formatter):
         if record.stack_info and not message_dict.get("stack_info"):
             message_dict["stack_info"] = self.formatStack(record.stack_info)
 
-        log_record: Dict[str, Any] = OrderedDict()
+        log_record: dict[str, Any] = OrderedDict()
 
         for field in self._required_fields:
             log_record[field] = record.__dict__.get(field)
@@ -174,7 +176,7 @@ class ColoredFormatter(logging.Formatter):
     def formatMessage(self, record: logging.LogRecord) -> str:
         """Formats a log record with colors"""
 
-        extra: Dict[Any, Any] = {}
+        extra: dict[Any, Any] = {}
         _merge_record_extra(record, extra)
 
         args = {}

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/cli/watcher.py

@@ -8,7 +8,7 @@ import socket
 import urllib.parse
 import urllib.request
 from importlib.metadata import Distribution, PackageNotFoundError
-from typing import Any, Callable, Set
+from typing import Any, Callable
 
 import watchfiles
 
@@ -98,7 +98,7 @@ class WatchServer:
             await utils.aio.cancel_and_wait(read_ipc_task)
             await self._pch.aclose()
 
-    async def _on_reload(self, _: Set[watchfiles.main.FileChange]) -> None:
+    async def _on_reload(self, _: set[watchfiles.main.FileChange]) -> None:
         if self._worker_reloading:
             return
 

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/debug/tracing.py

@@ -145,7 +145,7 @@ def _create_tracing_app(w: Worker) -> web.Application:
         import aiofiles
 
         with importlib.resources.path("livekit.agents.debug", "index.html") as path:
-            async with aiofiles.open(path, mode="r") as f:
+            async with aiofiles.open(path) as f:
                 content = await f.read()
 
         return web.Response(text=content, content_type="text/html")
@@ -160,7 +160,7 @@ def _create_tracing_app(w: Worker) -> web.Application:
                     "room": runner.running_job.job.room.name if runner.running_job else None,
                 }
                 for runner in w._proc_pool.processes
-                if runner.started
+                if runner.started and runner.running_job
             ]
         }
 

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/inference_runner.py

@@ -2,14 +2,14 @@ from __future__ import annotations
 
 import threading
 from abc import ABC, abstractmethod
-from typing import ClassVar, Protocol, Type
+from typing import ClassVar, Protocol
 
 
 class _RunnerMeta(Protocol):
     INFERENCE_METHOD: ClassVar[str]
 
 
-_RunnersDict = dict[str, Type["_InferenceRunner"]]
+_RunnersDict = dict[str, type["_InferenceRunner"]]
 
 
 # kept private until we stabilize the API (only used for EOU today)
@@ -17,7 +17,7 @@ class _InferenceRunner(ABC, _RunnerMeta):
     registered_runners: _RunnersDict = {}
 
     @classmethod
-    def register_runner(cls, runner_class: Type["_InferenceRunner"]) -> None:
+    def register_runner(cls, runner_class: type[_InferenceRunner]) -> None:
         if threading.current_thread() != threading.main_thread():
             raise RuntimeError("InferenceRunner must be registered on the main thread")
 

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/ipc/job_proc_executor.py

@@ -3,8 +3,9 @@ from __future__ import annotations
 import asyncio
 import multiprocessing as mp
 import socket
+from collections.abc import Awaitable
 from multiprocessing.context import BaseContext
-from typing import Any, Awaitable, Callable
+from typing import Any, Callable
 
 from ..job import JobContext, JobProcess, RunningJobInfo
 from ..log import logger

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/ipc/job_proc_lazy_main.py

@@ -172,6 +172,17 @@ class _JobProc:
                         logger.warning("tracing request received without running job")
                         return
 
+                    try:
+                        tracing_tasks = []
+                        for callback in self._job_ctx._tracing_callbacks:
+                            tracing_tasks.append(
+                                asyncio.create_task(callback(), name="job_tracing_callback")
+                            )
+
+                        await asyncio.gather(*tracing_tasks)
+                    except Exception:
+                        logger.exception("error while exeuting tracing tasks")
+
                     await self._client.send(
                         TracingResponse(
                             request_id=msg.request_id,
@@ -241,10 +252,8 @@ class _JobProc:
             await asyncio.sleep(10)
             if not self._ctx_connect_called and not self._ctx_shutdown_called:
                 logger.warning(
-                    (
-                        "The room connection was not established within 10 seconds after calling job_entry. "
-                        "This may indicate that job_ctx.connect() was not called. "
-                    )
+                    "The room connection was not established within 10 seconds after calling job_entry. "
+                    "This may indicate that job_ctx.connect() was not called. "
                 )
 
         warn_unconnected_task = asyncio.create_task(_warn_not_connected_task())
@@ -261,10 +270,8 @@ class _JobProc:
                     return
 
                 logger.warning(
-                    (
-                        "The job task completed without establishing a connection or performing a proper shutdown. "
-                        "Ensure that job_ctx.connect()/job_ctx.shutdown() is called and the job is correctly finalized."
-                    )
+                    "The job task completed without establishing a connection or performing a proper shutdown. "
+                    "Ensure that job_ctx.connect()/job_ctx.shutdown() is called and the job is correctly finalized."
                 )
 
         job_entry_task.add_done_callback(log_exception)

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/ipc/job_thread_executor.py

@@ -4,8 +4,9 @@ import asyncio
 import contextlib
 import socket
 import threading
+from collections.abc import Awaitable
 from dataclasses import dataclass
-from typing import Any, Awaitable, Callable
+from typing import Any, Callable
 
 from .. import utils
 from ..job import JobContext, JobProcess, RunningJobInfo

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/ipc/proc_client.py

@@ -5,19 +5,14 @@ import contextlib
 import logging
 import socket
 import sys
-from typing import Callable, Coroutine
+from collections.abc import Coroutine
+from typing import Callable
 
 from ..log import logger
 from ..utils import aio, log_exceptions, time_ms
 from .channel import Message, arecv_message, asend_message, recv_message, send_message
 from .log_queue import LogQueueHandler
-from .proto import (
-    IPC_MESSAGES,
-    InitializeRequest,
-    InitializeResponse,
-    PingRequest,
-    PongResponse,
-)
+from .proto import IPC_MESSAGES, InitializeRequest, InitializeResponse, PingRequest, PongResponse
 
 
 class _ProcClient:
@@ -25,7 +20,7 @@ class _ProcClient:
         self,
         mp_cch: socket.socket,
         log_cch: socket.socket | None,
-        initialize_fnc: Callable[[InitializeRequest, "_ProcClient"], None],
+        initialize_fnc: Callable[[InitializeRequest, _ProcClient], None],
         main_task_fnc: Callable[[aio.ChanReceiver[Message]], Coroutine[None, None, None]],
     ) -> None:
         self._mp_cch = mp_cch

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/ipc/proc_pool.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
 import asyncio
+from collections.abc import Awaitable
 from multiprocessing.context import BaseContext
-from typing import Any, Awaitable, Callable, Literal
+from typing import Any, Callable, Literal
 
 from .. import utils
 from ..job import JobContext, JobExecutorType, JobProcess, RunningJobInfo

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/job.py

@@ -18,9 +18,10 @@ import asyncio
 import contextvars
 import functools
 import multiprocessing as mp
+from collections.abc import Coroutine
 from dataclasses import dataclass
 from enum import Enum, unique
-from typing import Any, Callable, Coroutine, Tuple, Union
+from typing import Any, Callable
 
 from livekit import api, rtc
 from livekit.protocol import agent, models
@@ -94,14 +95,15 @@ class JobContext:
         self._room = room
         self._on_connect = on_connect
         self._on_shutdown = on_shutdown
-        self._shutdown_callbacks: list[Callable[[str], Coroutine[None, None, None]],] = []
+        self._shutdown_callbacks: list[Callable[[str], Coroutine[None, None, None]]] = []
+        self._tracing_callbacks: list[Callable[[], Coroutine[None, None, None]]] = []
         self._participant_entrypoints: list[
-            Tuple[
+            tuple[
                 Callable[[JobContext, rtc.RemoteParticipant], Coroutine[None, None, None]],
                 list[rtc.ParticipantKind.ValueType] | rtc.ParticipantKind.ValueType,
             ]
         ] = []
-        self._participant_tasks = dict[Tuple[str, Callable], asyncio.Task[None]]()
+        self._participant_tasks = dict[tuple[str, Callable], asyncio.Task[None]]()
         self._room.on("participant_connected", self._participant_available)
         self._inf_executor = inference_executor
 
@@ -141,12 +143,19 @@ class JobContext:
     def agent(self) -> rtc.LocalParticipant:
         return self._room.local_participant
 
+    def add_tracing_callback(
+        self,
+        callback: Callable[[], Coroutine[None, None, None]],
+    ) -> None:
+        """
+        Add a callback to be called when the job is about to receive a new tracing request.
+        """
+        self._tracing_callbacks.append(callback)
+
     def add_shutdown_callback(
         self,
-        callback: Union[
-            Callable[[], Coroutine[None, None, None]],
-            Callable[[str], Coroutine[None, None, None]],
-        ],
+        callback: Callable[[], Coroutine[None, None, None]]
+        | Callable[[str], Coroutine[None, None, None]],
     ) -> None:
         """
         Add a callback to be called when the job is shutting down.

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/llm/__init__.py

@@ -11,15 +11,6 @@ from .chat_context import (
     ImageContent,
 )
 from .fallback_adapter import AvailabilityChangedEvent, FallbackAdapter
-from .function_context import (
-    AIError,
-    AIFunction,
-    FunctionContext,
-    StopResponse,
-    ai_function,
-    find_ai_functions,
-    is_ai_function,
-)
 from .llm import (
     LLM,
     ChatChunk,
@@ -27,7 +18,6 @@ from .llm import (
     CompletionUsage,
     FunctionToolCall,
     LLMStream,
-    ToolChoice,
 )
 from .realtime import (
     ErrorEvent,
@@ -35,13 +25,22 @@ from .realtime import (
     InputSpeechStartedEvent,
     InputSpeechStoppedEvent,
     InputTranscriptionCompleted,
-    InputTranscriptionFailed,
     MessageGeneration,
     RealtimeCapabilities,
     RealtimeError,
     RealtimeModel,
     RealtimeSession,
 )
+from .tool_context import (
+    FunctionTool,
+    StopResponse,
+    ToolContext,
+    ToolError,
+    find_function_tools,
+    function_tool,
+    is_function_tool,
+    ToolChoice,
+)
 
 __all__ = [
     "LLM",
@@ -62,12 +61,12 @@ __all__ = [
     "FallbackAdapter",
     "AvailabilityChangedEvent",
     "ToolChoice",
-    "is_ai_function",
-    "ai_function",
-    "find_ai_functions",
-    "AIFunction",
-    "FunctionContext",
-    "AIError",
+    "is_function_tool",
+    "function_tool",
+    "find_function_tools",
+    "FunctionTool",
+    "ToolContext",
+    "ToolError",
     "StopResponse",
     "utils",
     "remote_chat_context",

{livekit_agents-1.0.0.dev2 → livekit_agents-1.0.0.dev4}/livekit/agents/llm/_strict.py

@@ -52,7 +52,7 @@ def _ensure_strict_json_schema(
     # { 'type': 'object', 'properties': { 'a':  {...} } }
     properties = json_schema.get("properties")
     if is_dict(properties):
-        json_schema["required"] = [prop for prop in properties.keys()]
+        json_schema["required"] = list(properties.keys())
         json_schema["properties"] = {
             key: _ensure_strict_json_schema(prop_schema, path=(*path, "properties", key), root=root)
             for key, prop_schema in properties.items()