Module livekit.plugins.anam.types

Classes

class DirectorNotes (expressivity: float | None = None,
presetStyle: str | None = None,
customStylePrompt: str | None = None)

Expand source code

@dataclass
class DirectorNotes:
    """Per-session director-notes overrides forwarded to Anam.

    For a full list of available style presets, see https://anam.ai/docs/personas/director-notes

    Mirrors the ``directorNotes`` field of the Anam persona config. Every field
    is optional; unset (``None``) fields are omitted from the request so Anam
    falls back to the avatar model / cue defaults.

    Attributes:
        expressivity: Normalized expressivity in [0, 1] controlling how strongly the
            avatar responds to ``presetStyle``/``customStylePrompt`` and any inline
            cues: 1 responds more strongly, 0 less strongly. ``None`` falls back to
            the default value of 0.5. Out-of-range values are rejected by Anam with
            an HTTP 400.
        presetStyle: A built-in expressive style (e.g. ``"happy"``, ``"warm"``,
            ``"playful"``). Mutually exclusive with ``customStylePrompt`` — Anam
            rejects the pair with an HTTP 400.
        customStylePrompt: A free-form expressive style prompt. Mutually exclusive
            with ``presetStyle``.
    """

    expressivity: float | None = None
    presetStyle: str | None = None
    customStylePrompt: str | None = None

Per-session director-notes overrides forwarded to Anam.

For a full list of available style presets, see https://anam.ai/docs/personas/director-notes

Mirrors the directorNotes field of the Anam persona config. Every field is optional; unset (None) fields are omitted from the request so Anam falls back to the avatar model / cue defaults.

Attributes

expressivity

Normalized expressivity in [0, 1] controlling how strongly the avatar responds to presetStyle/customStylePrompt and any inline cues: 1 responds more strongly, 0 less strongly. None falls back to the default value of 0.5. Out-of-range values are rejected by Anam with an HTTP 400.

presetStyle

A built-in expressive style (e.g. "happy", "warm", "playful"). Mutually exclusive with customStylePrompt — Anam rejects the pair with an HTTP 400.

customStylePrompt

A free-form expressive style prompt. Mutually exclusive with presetStyle.

Instance variables

var customStylePrompt : str | None

var expressivity : float | None

var presetStyle : str | None

class PersonaConfig (name: str,
avatarId: str,
avatarModel: str | None = None,
directorNotes: DirectorNotes | None = None)

Expand source code

@dataclass
class PersonaConfig:
    """Configuration for Anam avatar persona.

    See https://anam.ai/docs/integrations/livekit/configuration for the persona
    config reference.
    """

    name: str
    avatarId: str
    avatarModel: str | None = None
    directorNotes: DirectorNotes | None = None

Configuration for Anam avatar persona.

See https://anam.ai/docs/integrations/livekit/configuration for the persona config reference.

Instance variables

var avatarId : str

var avatarModel : str | None

var directorNotes : DirectorNotes | None

var name : str

class SessionOptions (video_width: int | None = None, video_height: int | None = None)

Expand source code

@dataclass
class SessionOptions:
    """Per-session output options forwarded to Anam's session-token API.

    Mirrors the ``sessionOptions`` field of the Anam session-token request.

    Attributes:
        video_width: Output video frame width in pixels. Provide together with
            ``video_height`` (both or neither). Omit to use the avatar model's
            default output size. Supported pairs are model-dependent and are
            validated by Anam; an unsupported pair is rejected with an HTTP 400
            rather than silently downgraded.
        video_height: Output video frame height in pixels. See ``video_width``.
    """

    video_width: int | None = None
    video_height: int | None = None

Per-session output options forwarded to Anam's session-token API.

Mirrors the sessionOptions field of the Anam session-token request.

Attributes

video_width

Output video frame width in pixels. Provide together with video_height (both or neither). Omit to use the avatar model's default output size. Supported pairs are model-dependent and are validated by Anam; an unsupported pair is rejected with an HTTP 400 rather than silently downgraded.

video_height

Output video frame height in pixels. See video_width.

Instance variables

var video_height : int | None

var video_width : int | None