[fern-replay] Applied customizations

Patches applied (5):
  - patch-64703bda: test(agentkit): add custom tests for v1.5.0 AgentKit behavior
  - patch-7c2d9d99: feat(agentkit): align session options and token uid handling
  - patch-7465fada: fix(agentkit): resolve Python session typing issues
  - patch-fae1249a: Re-export agora-agents API from legacy PyPI compatibility package The compat distribution delegates to agora_agent via __getattr__ and documents both import paths in its README.
  - patch-44c21c14: Re-export AgentKit symbols from agora_agent package root Extend __getattr__ and __all__ so vendor classes, presets, and helpers are importable via `from agora_agent import ...`. Add tests and update class docstring examples to use the root import path.

Patches with unresolved conflicts (17):
  - patch-6e30398b: chore(agentkit): bump to v1.5.0 and expose v2.7 type aliases
  - patch-9df782b4: feat(agentkit): update MLLM and LLM vendor wrappers for v2.7
  - patch-26706d73: feat(agentkit): add GenericAvatar and session-aware avatar validation
  - patch-9f491c63: feat(agentkit): update Agent builder and session lifecycle for v2.7
  - patch-6c20f076: docs(agentkit): update v1.5.0 guides, reference, and changelog
  - patch-eaec58eb: refactor(agentkit): align deprecated vendor aliases with canonical names
  - patch-20245632: feat(agentkit): export type aliases and avatar token helpers
  - patch-972dd5bd: updated docs
  - patch-4323b470: rename python package to agora-agents
  - patch-d29165c4: make python compat package publishable
  - patch-fc9d93c3: Document agora-agents PyPI install name and migration notes
  - patch-87fc4488: Update docs to import from agora_agent package root
  - patch-923cf954: Prioritize app credentials and builder in Python docs Rewrite getting-started auth and quick-start for app credentials with the builder API. De-emphasize presets and align index, BYOK, and README with the recommended onboarding path.
  - patch-d475306b: Move package rename guidance to installation docs and protect manual paths in Fern ignore. Consolidate migration notes into the installation guide with next-step links, add a brief README pointer, and exclude README, compat, and workflow files from Fern generation.
  - patch-c9355576: Streamline Python docs and README for app-credentials-first onboarding. Remove duplicated low-level client examples from the README, de-emphasize legacy auth modes, refocus the low-level API guide on AgentKit with telephony escape hatches, and update Agora-managed model terminology.
  - patch-98ecb4d3: Add Groq, Vertex AI, Bedrock, Dify, and Custom LLM vendor helpers. Introduce named LLM vendor classes with correct request serialization, export them from the package root, and add tests covering each provider's config shape.
  - patch-a5097b8d: Document new LLM vendors and tighten onboarding docs. Add Groq, Vertex AI, Bedrock, Dify, and Custom LLM to vendor references, simplify README and index navigation, and align quick-start and terminology with Agora-managed model language.
    Run `fern-replay resolve` to apply these customizations.

Patches absorbed by generator (3):
  - patch-b7f0c36c: feat(agentkit): release v2.0.0 updates
  - patch-4d32368c: Add compat-build CI job and harden dual-package PyPI publish Build and verify the compat wheel re-exports, gate publish on compat-build, simplify version checks with poetry version, wait for primary package on PyPI, and retry compat publish on failure.
  - patch-20109390: Fix PyPI publish auth and explicitly protect release workflow in Fern ignore. Use PYPI_API_TOKEN for primary and compat Poetry publishes, matching the v1.4.1 release flow, and list release.yml explicitly in .fernignore.
    The generator now produces these customizations natively.

Author: fern-api[bot]

.fern/replay.lock

@@ -67,6 +67,8 @@
 from ..agents.types.start_agents_request_properties_filler_words_content_static_config import StartAgentsRequestPropertiesFillerWordsContentStaticConfig
 from ..agents.types.start_agents_request_properties_filler_words_content_static_config_selection_rule import StartAgentsRequestPropertiesFillerWordsContentStaticConfigSelectionRule
 from ..types.tts import Tts
+from ..agents.types.start_agents_request_properties_filler_words_content_static_config_selection_rule import StartAgentsRequestPropertiesFillerWordsContentStaticConfigSelectionRule
+from ..types.tts import Tts
 from ..agent_management.types.agent_think_agent_management_request_on_listening_action import (
     AgentThinkAgentManagementRequestOnListeningAction,
 )

src/agora_agent/agentkit/agent.py

@@ -24,6 +24,7 @@
     is_generic_avatar,
     is_heygen_avatar,
     is_live_avatar_avatar,
+    is_rtc_avatar,
     validate_avatar_config,
     validate_tts_sample_rate,
 )

src/agora_agent/agentkit/agent_session.py

@@ -177,6 +177,49 @@ def to_config(self) -> Dict[str, Any]:
         return {"enable": enable, "vendor": "generic", "params": params}
 
 
+class GenericAvatarOptions(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    api_key: str = Field(..., description="Generic avatar provider API key")
+    api_base_url: str = Field(..., description="Avatar provider API base URL")
+    avatar_id: str = Field(..., description="Avatar ID")
+    agora_uid: str = Field(..., description="Agora UID for the avatar video stream")
+    agora_appid: Optional[str] = Field(default=None, description="Agora App ID; filled by AgentSession when omitted")
+    agora_token: Optional[str] = Field(default=None, description="RTC token; generated by AgentSession when omitted")
+    agora_channel: Optional[str] = Field(default=None, description="Agora channel; filled by AgentSession when omitted")
+    enable: Optional[bool] = Field(default=None, description="Enable avatar (default: true)")
+    additional_params: Optional[Dict[str, Any]] = Field(default=None, description="Additional vendor-specific parameters")
+
+
+class GenericAvatar(BaseAvatar):
+    def __init__(self, **kwargs: Any):
+        self.options = GenericAvatarOptions(**kwargs)
+
+    @property
+    def required_sample_rate(self) -> int:
+        return 0
+
+    def to_config(self) -> Dict[str, Any]:
+        params: Dict[str, Any] = {
+            "api_key": self.options.api_key,
+            "api_base_url": self.options.api_base_url,
+            "avatar_id": self.options.avatar_id,
+            "agora_uid": self.options.agora_uid,
+        }
+
+        if self.options.agora_appid is not None:
+            params["agora_appid"] = self.options.agora_appid
+        if self.options.agora_token is not None:
+            params["agora_token"] = self.options.agora_token
+        if self.options.agora_channel is not None:
+            params["agora_channel"] = self.options.agora_channel
+        if self.options.additional_params is not None:
+            params = {**self.options.additional_params, **params}
+
+        enable = self.options.enable if self.options.enable is not None else True
+        return {"enable": enable, "vendor": "generic", "params": params}
+
+
 class AnamAvatarOptions(BaseModel):
     model_config = ConfigDict(extra="forbid")
 

src/agora_agent/agentkit/vendors/avatar.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel, ConfigDict, Field

src/agora_agent/agentkit/vendors/mllm.py

@@ -0,0 +1,298 @@
+from agora_agent.agentkit import (
+    Agent,
+    AvatarConfig,
+    AvatarVendor,
+    LlmConfig,
+    LlmStyle,
+    MllmConfig,
+    MllmVendor,
+    SttConfig,
+    SttVendor,
+    TtsConfig,
+)
+import pytest
+
+from agora_agent.agentkit.vendors import (
+    AkoolAvatar,
+    ElevenLabsTTS,
+    LiveAvatarAvatar,
+    OpenAI,
+    OpenAIRealtime,
+)
+
+
+def _parameter(config, key):
+    parameters = config["parameters"]
+    if isinstance(parameters, dict):
+        return parameters[key]
+    return getattr(parameters, key)
+
+
+class _CopyOnlyModel:
+    def __init__(self, **values):
+        self.values = values
+
+    def copy(self, update=None):
+        return _CopyOnlyModel(**{**self.values, **(update or {})})
+
+
+def test_generated_core_aliases_are_public():
+    assert LlmConfig is not None
+    assert LlmStyle is not None
+    assert SttConfig is not None
+    assert SttVendor is not None
+    assert TtsConfig is not None
+    assert MllmConfig is not None
+    assert MllmVendor is not None
+    assert AvatarConfig is not None
+    assert AvatarVendor is not None
+
+
+def test_model_copy_helper_supports_pydantic_v1_copy_api():
+    copied = Agent._copy_model_update(_CopyOnlyModel(enable_rtm=True), {"data_channel": "rtm"})  # noqa: SLF001
+
+    assert copied.values == {"enable_rtm": True, "data_channel": "rtm"}
+
+
+def test_with_audio_scenario_sets_session_parameter():
+    agent = Agent(name="test").with_audio_scenario("chorus")
+
+    assert _parameter(agent.config, "audio_scenario") == "chorus"
+
+
+def test_with_audio_scenario_preserves_existing_parameters():
+    agent = Agent(name="test", parameters={"enable_metrics": True}).with_audio_scenario(
+        "chorus"
+    )
+
+    assert _parameter(agent.config, "enable_metrics") is True
+    assert _parameter(agent.config, "audio_scenario") == "chorus"
+
+
+def test_enable_rtm_defaults_data_channel_to_rtm():
+    properties = Agent(name="test", advanced_features={"enable_rtm": True}).to_properties(
+        channel="room",
+        agent_uid="1",
+        remote_uids=["100"],
+        token="token",
+        skip_vendor_validation=True,
+    )
+
+    assert properties.parameters.data_channel == "rtm"
+
+
+def test_enable_rtm_preserves_explicit_data_channel():
+    properties = Agent(
+        name="test",
+        advanced_features={"enable_rtm": True},
+        parameters={"data_channel": "datastream"},
+    ).to_properties(
+        channel="room",
+        agent_uid="1",
+        remote_uids=["100"],
+        token="token",
+        skip_vendor_validation=True,
+    )
+
+    assert properties.parameters.data_channel == "datastream"
+
+
+def test_agent_level_llm_fields_override_vendor_defaults():
+    agent = (
+        Agent(name="test")
+        .with_llm(
+            OpenAI(
+                api_key="llm-key",
+                greeting_message="vendor greeting",
+                failure_message="vendor failure",
+                max_history=1,
+            )
+        )
+        .with_tts(ElevenLabsTTS(key="tts-key", model_id="model", voice_id="voice"))
+        .with_greeting("agent greeting")
+        .with_failure_message("agent failure")
+        .with_max_history(2)
+    )
+
+    properties = agent.to_properties(
+        channel="room",
+        agent_uid="1",
+        remote_uids=["100"],
+        token="token",
+    )
+
+    assert properties.llm.greeting_message == "agent greeting"
+    assert properties.llm.failure_message == "agent failure"
+    assert properties.llm.max_history == 2
+
+
+def test_avatar_sample_rate_validation_works_when_tts_added_after_avatar():
+    agent = Agent(name="test").with_avatar(
+        LiveAvatarAvatar(api_key="avatar-key", quality="medium", agora_uid="2")
+    )
+
+    with pytest.raises(ValueError, match="24000"):
+        agent.with_tts(
+            ElevenLabsTTS(key="tts-key", model_id="model", voice_id="voice", sample_rate=16000)
+        )
+
+
+def test_avatar_sample_rate_validation_uses_wrapper_sample_rate():
+    agent = (
+        Agent(name="test")
+        .with_avatar(AkoolAvatar(api_key="avatar-key"))
+        .with_tts(
+            ElevenLabsTTS(key="tts-key", model_id="model", voice_id="voice", sample_rate=16000)
+        )
+    )
+
+    assert agent.tts_sample_rate == 16000
+
+
+def test_with_mllm_removes_deprecated_advanced_features_enable_mllm():
+    properties = (
+        Agent(
+            name="test",
+            advanced_features={"enable_mllm": True, "enable_rtm": True},
+            greeting="hello from agent",
+            failure_message="try again",
+            max_history=5,
+        )
+        .with_mllm(OpenAIRealtime(api_key="openai-key"))
+        .to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            token="rtc-token",
+        )
+    )
+
+    assert properties.mllm is not None
+    assert properties.mllm.enable is True
+    assert properties.mllm.greeting_message == "hello from agent"
+    assert properties.mllm.failure_message == "try again"
+    mllm_dump = properties.mllm.model_dump(exclude_none=True)
+    assert "max_history" not in mllm_dump
+    assert properties.advanced_features is not None
+    af_dump = properties.advanced_features.model_dump(exclude_none=True)
+    assert "enable_mllm" not in af_dump
+    assert af_dump.get("enable_rtm") is True
+
+
+def test_to_properties_rejects_mllm_with_enabled_avatar():
+    agent = (
+        Agent(name="test")
+        .with_mllm(OpenAIRealtime(api_key="mllm-key"))
+        .with_avatar(
+            LiveAvatarAvatar(
+                api_key="avatar-key",
+                quality="medium",
+                agora_uid="2",
+                agora_token="avatar-token",
+            )
+        )
+    )
+
+    with pytest.raises(ValueError, match="cascading"):
+        agent.to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            token="rtc-token",
+        )
+
+
+def test_to_properties_mllm_with_avatar_fires_before_token_generation():
+    """The guard must fire before the token-generation step so callers get a
+    clear, actionable error even when app_id/app_certificate are empty.
+    """
+    agent = (
+        Agent(name="test")
+        .with_mllm(OpenAIRealtime(api_key="mllm-key"))
+        .with_avatar(
+            LiveAvatarAvatar(
+                api_key="avatar-key",
+                quality="medium",
+                agora_uid="2",
+                agora_token="avatar-token",
+            )
+        )
+    )
+
+    with pytest.raises(ValueError, match="cascading"):
+        agent.to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            app_id="",
+            app_certificate="",
+        )
+
+
+def test_to_properties_rejects_mllm_with_default_enabled_avatar():
+    """Avatar with no `enable` field should be treated as enabled."""
+    agent = Agent(name="test").with_mllm(OpenAIRealtime(api_key="mllm-key"))
+    agent._avatar = {  # noqa: SLF001
+        "vendor": "liveavatar",
+        "params": {
+            "api_key": "avatar-key",
+            "quality": "high",
+            "agora_uid": "200",
+            "agora_token": "avatar-token",
+        },
+    }
+
+    with pytest.raises(ValueError, match="cascading"):
+        agent.to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            token="rtc-token",
+        )
+
+
+def test_to_properties_allows_mllm_with_disabled_avatar_and_no_tts():
+    properties = (
+        Agent(name="test")
+        .with_mllm(OpenAIRealtime(api_key="mllm-key"))
+        .with_avatar(
+            LiveAvatarAvatar(
+                api_key="avatar-key",
+                quality="medium",
+                agora_uid="2",
+                agora_token="avatar-token",
+                enable=False,
+            )
+        )
+        .to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            token="rtc-token",
+        )
+    )
+
+    assert properties.mllm is not None and properties.mllm.enable is True
+    assert properties.tts is None
+    assert properties.llm is None
+    assert properties.asr is None
+    assert properties.avatar is not None and properties.avatar.enable is False
+
+
+def test_to_properties_mllm_without_tts_or_llm_succeeds():
+    properties = (
+        Agent(name="test")
+        .with_mllm(OpenAIRealtime(api_key="mllm-key"))
+        .to_properties(
+            channel="room",
+            agent_uid="1",
+            remote_uids=["100"],
+            token="rtc-token",
+        )
+    )
+
+    assert properties.mllm is not None and properties.mllm.enable is True
+    assert properties.tts is None
+    assert properties.llm is None
+    assert properties.asr is None
+    assert properties.avatar is None