Release 0.0.14

Author: fern-api[bot]

.fern/metadata.json

@@ -1,5 +1,5 @@
 {
-  "cliVersion": "1.9.2",
+  "cliVersion": "3.35.2",
   "generatorName": "fernapi/fern-python-sdk",
   "generatorVersion": "4.37.0",
   "generatorConfig": {

README.md

@@ -14,6 +14,7 @@ and multimodal flows (MLLM) for real-time audio processing.
 - [Installation](#installation)
 - [Reference](#reference)
 - [Mllm Flow Multimodal](#mllm-flow-multimodal)
+- [Mllm Flow Multimodal](#mllm-flow-multimodal)
 - [Usage](#usage)
 - [Async Client](#async-client)
 - [Exception Handling](#exception-handling)
@@ -104,6 +105,71 @@ client.agents.start(
 ```
 
 
+## MLLM Flow (Multimodal)
+
+For real-time audio processing using OpenAI's Realtime API or Google Gemini Live, use the MLLM (Multimodal Large Language Model) flow instead of the cascading ASR -> LLM -> TTS flow. See the [MLLM Overview](https://docs.agora.io/en/conversational-ai/models/mllm/overview) for more details.
+
+```python
+from agoraio-sdk import Agora
+from agoraio-sdk.agents import (
+    StartAgentsRequestProperties,
+    StartAgentsRequestPropertiesAdvancedFeatures,
+    StartAgentsRequestPropertiesMllm,
+    StartAgentsRequestPropertiesMllmVendor,
+    StartAgentsRequestPropertiesTts,
+    StartAgentsRequestPropertiesTtsVendor,
+    StartAgentsRequestPropertiesLlm,
+    StartAgentsRequestPropertiesTurnDetection,
+    StartAgentsRequestPropertiesTurnDetectionType,
+)
+
+client = Agora(
+    username="YOUR_APP_ID",
+    password="YOUR_APP_CERTIFICATE",
+)
+
+client.agents.start(
+    appid="your_app_id",
+    name="mllm_agent",
+    properties=StartAgentsRequestProperties(
+        channel="channel_name",
+        token="your_token",
+        agent_rtc_uid="1001",
+        remote_rtc_uids=["1002"],
+        idle_timeout=120,
+        advanced_features=StartAgentsRequestPropertiesAdvancedFeatures(
+            enable_mllm=True,
+        ),
+        mllm=StartAgentsRequestPropertiesMllm(
+            url="wss://api.openai.com/v1/realtime",
+            api_key="<your_openai_api_key>",
+            vendor=StartAgentsRequestPropertiesMllmVendor.OPENAI,
+            params={
+                "model": "gpt-4o-realtime-preview",
+                "voice": "alloy",
+            },
+            input_modalities=["audio"],
+            output_modalities=["text", "audio"],
+            greeting_message="Hello! I'm ready to chat in real-time.",
+        ),
+        turn_detection=StartAgentsRequestPropertiesTurnDetection(
+            type=StartAgentsRequestPropertiesTurnDetectionType.SERVER_VAD,
+            threshold=0.5,
+            silence_duration_ms=500,
+        ),
+        # TTS and LLM are still required but not used when MLLM is enabled
+        tts=StartAgentsRequestPropertiesTts(
+            vendor=StartAgentsRequestPropertiesTtsVendor.MICROSOFT,
+            params={},
+        ),
+        llm=StartAgentsRequestPropertiesLlm(
+            url="https://api.openai.com/v1/chat/completions",
+        ),
+    ),
+)
+```
+
+
 ## Usage
 
 Instantiate and use the client with the following:

pyproject.toml

@@ -3,7 +3,7 @@ name = "agoraio-sdk"
 
 [tool.poetry]
 name = "agoraio-sdk"
-version = "0.1.1"
+version = "0.0.14"
 description = ""
 readme = "README.md"
 authors = []

src/agoraio/agents/types/get_history_agents_response.py

@@ -6,6 +6,7 @@
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 from ...core.unchecked_base_model import UncheckedBaseModel
 from .get_history_agents_response_contents_item import GetHistoryAgentsResponseContentsItem
+from .get_history_agents_response_status import GetHistoryAgentsResponseStatus
 
 
 class GetHistoryAgentsResponse(UncheckedBaseModel):
@@ -19,7 +20,7 @@ class GetHistoryAgentsResponse(UncheckedBaseModel):
     Agent creation timestamp.
     """
 
-    status: typing.Optional[typing.Literal["RUNNING"]] = pydantic.Field(default=None)
+    status: typing.Optional[GetHistoryAgentsResponseStatus] = pydantic.Field(default=None)
     """
     Agent status. Only supports querying the running agent.
     """

src/agoraio/agents/types/get_history_agents_response_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetHistoryAgentsResponseStatus = typing.Union[typing.Literal["RUNNING"], typing.Any]

src/agoraio/agents/types/start_agents_request_properties_mllm.py

@@ -5,6 +5,7 @@
 import pydantic
 from ...core.pydantic_utilities import IS_PYDANTIC_V2
 from ...core.unchecked_base_model import UncheckedBaseModel
+from .start_agents_request_properties_mllm_style import StartAgentsRequestPropertiesMllmStyle
 from .start_agents_request_properties_mllm_vendor import StartAgentsRequestPropertiesMllmVendor
 
 
@@ -58,7 +59,7 @@ class StartAgentsRequestPropertiesMllm(UncheckedBaseModel):
     - `vertexai`: Use this for Google Gemini Live
     """
 
-    style: typing.Optional[typing.Literal["openai"]] = pydantic.Field(default=None)
+    style: typing.Optional[StartAgentsRequestPropertiesMllmStyle] = pydantic.Field(default=None)
     """
     The request style for MLLM completion:
     - `openai`: For OpenAI Realtime API format

src/agoraio/agents/types/start_agents_request_properties_mllm_style.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+StartAgentsRequestPropertiesMllmStyle = typing.Union[typing.Literal["openai"], typing.Any]

src/agoraio/core/client_wrapper.py

@@ -24,10 +24,9 @@ def __init__(
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "agoraio-sdk/0.1.1",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "agoraio-sdk",
-            "X-Fern-SDK-Version": "0.1.1",
+            "X-Fern-SDK-Version": "0.0.14",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = httpx.BasicAuth(self._get_username(), self._get_password())._auth_header