SDK regeneration

Author: fern-api[bot]

.fern/metadata.json

@@ -3,6 +3,7 @@
   "generatorName": "fernapi/fern-python-sdk",
   "generatorVersion": "4.37.0",
   "generatorConfig": {
+    "package_name": "agora_agent",
     "client": {
       "class_name": "Agora",
       "filename": "client.py"

README.md

@@ -1,14 +1,35 @@
-# Agora Conversational AI Python SDK
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FAgoraIO-Conversational-AI%2Fagora-agent-python-sdk)
-[![pypi](https://img.shields.io/pypi/v/agora-agent-sdk)](https://pypi.python.org/pypi/agora-agent-sdk)
-
-The Agora Conversational AI SDK provides convenient access to the Agora Conversational AI APIs, enabling you to build voice-powered AI agents with support for both **cascading flows** (ASR → LLM → TTS) and **multimodal flows** (MLLM) for real-time audio processing.
+# Agoraio Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FAgoraIO-Conversational-AI%2Fagent-server-sdk-python)
+[![pypi](https://img.shields.io/pypi/v/agora-agent-server-sdk)](https://pypi.python.org/pypi/agora-agent-server-sdk)
+
+The Agora Conversational AI SDK provides convenient access to the Agora Conversational AI APIs, 
+enabling you to build voice-powered AI agents with support for both cascading flows (ASR -> LLM -> TTS) 
+and multimodal flows (MLLM) for real-time audio processing.
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Documentation](#documentation)
+- [Reference](#reference)
+- [Mllm Flow Multimodal](#mllm-flow-multimodal)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
 
 ## Installation
 
 ```sh
-pip install agora-agent-sdk
+pip install agora-agent-server-sdk
 ```
 
 ## Quick Start
@@ -122,20 +143,323 @@ session = agent.create_session(
 
 ## Documentation
 
-| Topic              | Link                                                                             |
-| ------------------ | -------------------------------------------------------------------------------- |
-| **API docs**       | [docs.agora.io](https://docs.agora.io/en/conversational-ai/overview)             |
-| **Installation**   | [docs/getting-started/installation.md](docs/getting-started/installation.md)     |
-| **Authentication** | [docs/getting-started/authentication.md](docs/getting-started/authentication.md) |
-| **Quick Start**    | [docs/getting-started/quick-start.md](docs/getting-started/quick-start.md)       |
-| **Cascading flow** | [docs/guides/cascading-flow.md](docs/guides/cascading-flow.md)                   |
-| **MLLM flow**      | [docs/guides/mllm-flow.md](docs/guides/mllm-flow.md)                             |
-| **Low-level API**  | [docs/guides/low-level-api.md](docs/guides/low-level-api.md)                     |
-| **Error handling** | [docs/guides/error-handling.md](docs/guides/error-handling.md)                   |
-| **Pagination**     | [docs/guides/pagination.md](docs/guides/pagination.md)                           |
-| **Advanced**       | [docs/guides/advanced.md](docs/guides/advanced.md)                               |
-| **API reference**  | [reference.md](reference.md)                                                     |
+API reference documentation is available [here](https://docs.agora.io/en/conversational-ai/overview).
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/AgoraIO-Conversational-AI/agent-server-sdk-python/blob/HEAD/./reference.md).
+
+## 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 agora-agent-server-sdk import Agora
+from agora-agent-server-sdk.agents import (
+    StartAgentsRequestProperties,
+    StartAgentsRequestPropertiesAdvancedFeatures,
+    StartAgentsRequestPropertiesMllm,
+    StartAgentsRequestPropertiesMllmVendor,
+    StartAgentsRequestPropertiesTts,
+    StartAgentsRequestPropertiesTtsVendor,
+    StartAgentsRequestPropertiesLlm,
+    StartAgentsRequestPropertiesTurnDetection,
+    StartAgentsRequestPropertiesTurnDetectionType,
+)
+
+client = Agora(
+    customer_id="YOUR_CUSTOMER_ID",
+    customer_secret="YOUR_CUSTOMER_SECRET",
+)
+
+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:
+
+```python
+from agora_agent import Agora, MicrosoftTtsParams, Tts_Microsoft
+from agora_agent.agents import (
+    StartAgentsRequestProperties,
+    StartAgentsRequestPropertiesAsr,
+    StartAgentsRequestPropertiesLlm,
+)
+
+client = Agora(
+    authorization="YOUR_AUTHORIZATION",
+    username="YOUR_USERNAME",
+    password="YOUR_PASSWORD",
+)
+client.agents.start(
+    appid="appid",
+    name="unique_name",
+    properties=StartAgentsRequestProperties(
+        channel="channel_name",
+        token="token",
+        agent_rtc_uid="1001",
+        remote_rtc_uids=["1002"],
+        idle_timeout=120,
+        asr=StartAgentsRequestPropertiesAsr(
+            language="en-US",
+        ),
+        tts=Tts_Microsoft(
+            params=MicrosoftTtsParams(
+                key="key",
+                region="region",
+                voice_name="voice_name",
+            ),
+        ),
+        llm=StartAgentsRequestPropertiesLlm(
+            url="https://api.openai.com/v1/chat/completions",
+            api_key="<your_llm_key>",
+            system_messages=[
+                {"role": "system", "content": "You are a helpful chatbot."}
+            ],
+            params={"model": "gpt-4o-mini"},
+            max_history=32,
+            greeting_message="Hello, how can I assist you today?",
+            failure_message="Please hold on a second.",
+        ),
+    ),
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from agora_agent import AsyncAgora, MicrosoftTtsParams, Tts_Microsoft
+from agora_agent.agents import (
+    StartAgentsRequestProperties,
+    StartAgentsRequestPropertiesAsr,
+    StartAgentsRequestPropertiesLlm,
+)
+
+client = AsyncAgora(
+    authorization="YOUR_AUTHORIZATION",
+    username="YOUR_USERNAME",
+    password="YOUR_PASSWORD",
+)
+
+
+async def main() -> None:
+    await client.agents.start(
+        appid="appid",
+        name="unique_name",
+        properties=StartAgentsRequestProperties(
+            channel="channel_name",
+            token="token",
+            agent_rtc_uid="1001",
+            remote_rtc_uids=["1002"],
+            idle_timeout=120,
+            asr=StartAgentsRequestPropertiesAsr(
+                language="en-US",
+            ),
+            tts=Tts_Microsoft(
+                params=MicrosoftTtsParams(
+                    key="key",
+                    region="region",
+                    voice_name="voice_name",
+                ),
+            ),
+            llm=StartAgentsRequestPropertiesLlm(
+                url="https://api.openai.com/v1/chat/completions",
+                api_key="<your_llm_key>",
+                system_messages=[
+                    {"role": "system", "content": "You are a helpful chatbot."}
+                ],
+                params={"model": "gpt-4o-mini"},
+                max_history=32,
+                greeting_message="Hello, how can I assist you today?",
+                failure_message="Please hold on a second.",
+            ),
+        ),
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from agora_agent.core.api_error import ApiError
+
+try:
+    client.agents.start(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from agora_agent import Agora
+
+client = Agora(
+    authorization="YOUR_AUTHORIZATION",
+    username="YOUR_USERNAME",
+    password="YOUR_PASSWORD",
+)
+response = client.agents.list(
+    appid="appid",
+)
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.agents.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from agora_agent import Agora
+
+client = Agora(
+    ...,
+)
+response = client.agents.with_raw_response.start(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+pager = client.agents.list(...)
+print(pager.response)  # access the typed response for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.agents.start(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from agora_agent import Agora
+
+client = Agora(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.agents.start(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from agora_agent import Agora
+
+client = Agora(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
 
 ## Contributing
 
-This library is generated programmatically. Contributions to the README and docs are welcome. For code changes, open an issue first to discuss.
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!