livekit-plugins-anam 1.2.2__py3-none-any.whl

livekit/plugins/anam/__init__.py

@@ -0,0 +1,37 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# 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.
+
+from .avatar import AvatarSession
+from .errors import AnamException
+from .types import PersonaConfig
+from .version import __version__
+
+__all__ = [
+    "AnamException",
+    "AvatarSession",
+    "PersonaConfig",
+    "__version__",
+]
+
+from livekit.agents import Plugin
+
+from .log import logger
+
+
+class AnamPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(AnamPlugin())

livekit/plugins/anam/api.py

@@ -0,0 +1,154 @@
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+import aiohttp
+
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    APIConnectionError,
+    APIConnectOptions,
+    APIStatusError,
+)
+
+from .errors import AnamException
+from .log import logger
+from .types import PersonaConfig
+
+DEFAULT_API_URL = "https://api.anam.ai"
+
+
+class AnamAPI:
+    """
+    An asynchronous client for interacting with the Anam API.
+
+    This class handles authentication, request signing, and retries.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        api_url: str,
+        *,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+        session: aiohttp.ClientSession | None = None,
+    ) -> None:
+        """
+        Initializes the AnamAPI client.
+
+        Args:
+            api_key: Your Anam API key. If not provided, it will be read from
+                     the ANAM_API_KEY environment variable.
+            api_url: The base URL of the Anam API.
+            conn_options: Connection options for the aiohttp session.
+            session: An optional existing aiohttp.ClientSession to use for requests.
+        """
+        self._api_key = api_key
+        self._api_url = api_url
+        self._conn_options = conn_options
+        self._session = session
+        self._own_session = session is None
+
+    async def __aenter__(self) -> AnamAPI:
+        if self._own_session:
+            self._session = aiohttp.ClientSession()
+        return self
+
+    async def __aexit__(
+        self, exc_type: type | None, exc_val: Exception | None, exc_tb: Any
+    ) -> None:
+        if self._own_session and self._session:
+            await self._session.close()
+
+    async def create_session_token(
+        self, persona_config: PersonaConfig, livekit_url: str, livekit_token: str
+    ) -> str:
+        """
+        Creates a session token to authorize starting an engine session.
+
+        Returns:
+            The created session token (a JWT string).
+        """
+        payload = {
+            "personaConfig": {
+                "type": "ephemeral",
+                "name": persona_config.name,
+                "avatarId": persona_config.avatarId,
+                "llmId": "CUSTOMER_CLIENT_V1",
+            },
+        }
+        payload["environment"] = {
+            "livekitUrl": livekit_url,
+            "livekitToken": livekit_token,
+        }
+        headers = {
+            "Authorization": f"Bearer {self._api_key}",  # Use API Key here
+            "Content-Type": "application/json",
+        }
+        response_data = await self._post("/v1/auth/session-token", payload, headers)
+
+        session_token: str | None = response_data.get("sessionToken")
+        if not session_token:
+            raise AnamException("Failed to retrieve sessionToken from API response.")
+        return session_token
+
+    async def start_engine_session(
+        self,
+        session_token: str,
+    ) -> dict[str, Any]:
+        """
+        Starts the engine session using a previously created session token.
+
+        Args:
+            session_token: The temporary token from create_session_token.
+            livekit_url: The URL of the LiveKit instance.
+            livekit_token: The access token for the LiveKit room.
+
+        Returns:
+            The session details, including sessionId and engine host info.
+        """
+        headers = {
+            "Authorization": f"Bearer {session_token}",  # Use Session Token here
+            "Content-Type": "application/json",
+        }
+        return await self._post("/v1/engine/session", {}, headers)
+
+    async def _post(
+        self, endpoint: str, payload: dict[str, Any], headers: dict[str, str]
+    ) -> dict[str, Any]:
+        """
+        Internal method to make a POST request with retry logic.
+        """
+        url = f"{self._api_url}{endpoint}"
+        session = self._session or aiohttp.ClientSession()
+        try:
+            for attempt in range(self._conn_options.max_retry):
+                try:
+                    async with session.post(
+                        url,
+                        headers=headers,
+                        json=payload,
+                        timeout=aiohttp.ClientTimeout(sock_connect=self._conn_options.timeout),
+                    ) as response:
+                        if not response.ok:
+                            text = await response.text()
+                            raise APIStatusError(
+                                f"Server returned an error for {url}: {response.status}",
+                                status_code=response.status,
+                                body=text,
+                            )
+                        return await response.json()  # type: ignore
+                except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                    logger.warning(
+                        f"API request to {url} failed on attempt {attempt + 1}",
+                        extra={"error": str(e)},
+                    )
+                    if attempt >= self._conn_options.max_retry - 1:
+                        raise APIConnectionError(f"Failed to connect to Anam API at {url}") from e
+                    await asyncio.sleep(self._conn_options.retry_interval)
+        finally:
+            if not self._session:  # if we created the session, we close it
+                await session.close()
+
+        raise APIConnectionError("Failed to call Anam API after all retries.")

livekit/plugins/anam/avatar.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+import os
+
+import aiohttp
+
+from livekit import api, rtc
+from livekit.agents import (
+    DEFAULT_API_CONNECT_OPTIONS,
+    NOT_GIVEN,
+    AgentSession,
+    APIConnectOptions,
+    NotGivenOr,
+    get_job_context,
+    utils,
+)
+from livekit.agents.voice.avatar import DataStreamAudioOutput
+from livekit.agents.voice.room_io import ATTRIBUTE_PUBLISH_ON_BEHALF
+
+from .api import DEFAULT_API_URL, AnamAPI
+from .errors import AnamException
+from .log import logger
+from .types import PersonaConfig
+
+SAMPLE_RATE = 24000
+_AVATAR_AGENT_IDENTITY = "anam-avatar-agent"
+_AVATAR_AGENT_NAME = "anam-avatar-agent"
+
+
+class AvatarSession:
+    """A Anam avatar session"""
+
+    def __init__(
+        self,
+        *,
+        persona_config: PersonaConfig,
+        api_url: NotGivenOr[str] = NOT_GIVEN,
+        api_key: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_identity: NotGivenOr[str] = NOT_GIVEN,
+        avatar_participant_name: NotGivenOr[str] = NOT_GIVEN,
+        conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
+    ) -> None:
+        self._http_session: aiohttp.ClientSession | None = None
+        self._conn_options = conn_options
+        self.session_id: str | None = None
+        self._avatar_participant_identity = avatar_participant_identity or _AVATAR_AGENT_IDENTITY
+        self._avatar_participant_name = avatar_participant_name or _AVATAR_AGENT_NAME
+        self._persona_config: PersonaConfig = persona_config
+
+        api_url_val = (
+            api_url if utils.is_given(api_url) else os.getenv("ANAM_API_URL", DEFAULT_API_URL)
+        )
+        api_key_val = api_key if utils.is_given(api_key) else os.getenv("ANAM_API_KEY")
+
+        if not api_key_val:
+            raise AnamException("ANAM_API_KEY must be set by arguments or environment variables")
+
+        self._api_url = api_url_val
+        self._api_key = api_key_val
+
+    def _ensure_http_session(self) -> aiohttp.ClientSession:
+        if self._http_session is None:
+            self._http_session = utils.http_context.http_session()
+
+        return self._http_session
+
+    async def start(
+        self,
+        agent_session: AgentSession,
+        room: rtc.Room,
+        *,
+        livekit_url: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_key: NotGivenOr[str] = NOT_GIVEN,
+        livekit_api_secret: NotGivenOr[str] = NOT_GIVEN,
+    ) -> None:
+        livekit_url = livekit_url or (os.getenv("LIVEKIT_URL") or NOT_GIVEN)
+        livekit_api_key = livekit_api_key or (os.getenv("LIVEKIT_API_KEY") or NOT_GIVEN)
+        livekit_api_secret = livekit_api_secret or (os.getenv("LIVEKIT_API_SECRET") or NOT_GIVEN)
+        if not livekit_url or not livekit_api_key or not livekit_api_secret:
+            raise AnamException(
+                "livekit_url, livekit_api_key, and livekit_api_secret must be set "
+                "by arguments or environment variables"
+            )
+
+        try:
+            job_ctx = get_job_context()
+            local_participant_identity = job_ctx.token_claims().identity
+        except RuntimeError as e:
+            if not room.isconnected():
+                raise AnamException("failed to get local participant identity") from e
+            local_participant_identity = room.local_participant.identity
+
+        livekit_token = (
+            api.AccessToken(
+                api_key=livekit_api_key,
+                api_secret=livekit_api_secret,
+            )
+            .with_kind("agent")
+            .with_identity(self._avatar_participant_identity)
+            .with_name(self._avatar_participant_name)
+            .with_grants(api.VideoGrants(room_join=True, room=room.name))
+            # allow the avatar agent to publish audio and video on behalf of your local agent
+            .with_attributes({ATTRIBUTE_PUBLISH_ON_BEHALF: local_participant_identity})
+            .to_jwt()
+        )
+        async with AnamAPI(
+            api_key=self._api_key, api_url=self._api_url, conn_options=self._conn_options
+        ) as anam_api:
+            session_token = await anam_api.create_session_token(
+                persona_config=self._persona_config,
+                livekit_url=livekit_url,
+                livekit_token=livekit_token,
+            )
+            logger.debug("Anam session token created successfully.")
+
+            logger.debug("Starting Anam engine session...")
+            session_details = await anam_api.start_engine_session(
+                session_token=session_token,
+            )
+            self.session_id = session_details.get("sessionId")
+
+        agent_session.output.audio = DataStreamAudioOutput(
+            room=room,
+            destination_identity=self._avatar_participant_identity,
+            sample_rate=SAMPLE_RATE,
+            wait_remote_track=rtc.TrackKind.KIND_VIDEO,
+        )

livekit/plugins/anam/errors.py

@@ -0,0 +1,4 @@
+class AnamException(Exception):
+    """Custom exception for Anam API errors."""
+
+    pass

livekit/plugins/anam/log.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("livekit.plugins.anam")

livekit/plugins/anam/types.py

@@ -0,0 +1,9 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class PersonaConfig:
+    """Configuration for Anam avatar persona"""
+
+    name: str
+    avatarId: str

livekit/plugins/anam/version.py

@@ -0,0 +1,15 @@
+# Copyright 2025 LiveKit, Inc.
+#
+# 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.
+
+__version__ = "1.2.2"

livekit_plugins_anam-1.2.2.dist-info/METADATA

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-anam
+Version: 1.2.2
+Summary: Agent Framework plugin for anam
+Project-URL: Documentation, https://docs.livekit.io
+Project-URL: Website, https://livekit.io/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,webrtc
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.2.2
+Description-Content-Type: text/markdown
+
+# livekit-plugins-anam
+Support for the [Anam](https://anam.ai/) virtual avatar.

livekit_plugins_anam-1.2.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+livekit/plugins/anam/__init__.py,sha256=MI_yAAR_UOQR_Ln3p27zPml02ZkNDCXC2mpn5wxhPwo,1037
+livekit/plugins/anam/api.py,sha256=zc5WSq_DfFF8Fq7DF93vqeWuCMpBVv5J3eTVwywoH2c,5439
+livekit/plugins/anam/avatar.py,sha256=H4lh90GJTg-2IbB18QsdRWUh8ha-IspMj5nSq2O_xAs,4790
+livekit/plugins/anam/errors.py,sha256=3B83wAdOufnqjKM0vNtmk0KYBUgMYPvmvxLsM2I9UHI,90
+livekit/plugins/anam/log.py,sha256=-YtMyPRFZ2Etshon45g6m44GQtxHIhZZcaF4ZpK1Iik,67
+livekit/plugins/anam/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+livekit/plugins/anam/types.py,sha256=O1wtKYZe7cxuxID5ozncp0oyd6ZA3Th6jALHbROxbfU,149
+livekit/plugins/anam/version.py,sha256=HEPfsPSBZ3rIkyBj712Ik9tN1Z2rZUKSzUk3uWa0unA,600
+livekit_plugins_anam-1.2.2.dist-info/METADATA,sha256=hHODbXB5of1tb0C6OX7hpayWEo_zPIllAesvF1MxEH8,1028
+livekit_plugins_anam-1.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+livekit_plugins_anam-1.2.2.dist-info/RECORD,,

livekit_plugins_anam-1.2.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any