Module `livekit.agents.beta.workflows.utils`

Functions

def dtmf_event_to_code(event: DtmfEvent) ‑> int

Expand source code

def dtmf_event_to_code(event: DtmfEvent) -> int:
    if event.value.isdigit():
        return int(event.value)
    elif event.value == "*":
        return 10
    elif event.value == "#":
        return 11
    elif event.value in ["A", "B", "C", "D"]:
        # DTMF codes 10-15 are used for letters A-D
        return ord(event.value) - ord("A") + 12
    else:
        raise ValueError(f"Invalid DTMF event: {event}")

def format_dtmf(events: list[DtmfEvent]) ‑> str

Expand source code

def format_dtmf(events: list[DtmfEvent]) -> str:
    return " ".join(event.value for event in events)

Classes

class DtmfEvent (*args, **kwds)

Expand source code

class DtmfEvent(str, Enum):
    ONE = "1"
    TWO = "2"
    THREE = "3"
    FOUR = "4"
    FIVE = "5"
    SIX = "6"
    SEVEN = "7"
    EIGHT = "8"
    NINE = "9"
    ZERO = "0"
    STAR = "*"
    POUND = "#"
    A = "A"
    B = "B"
    C = "C"
    D = "D"

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

Ancestors

builtins.str
enum.Enum

Class variables

var A
var B
var C
var D
var EIGHT
var FIVE
var FOUR
var NINE
var ONE
var POUND
var SEVEN
var SIX
var STAR
var THREE
var TWO
var ZERO

class InstructionParts (persona: NotGivenOr[Instructions | str] = NOT_GIVEN, extra: Instructions | str = '')

Expand source code

@dataclass
class InstructionParts:
    """Customizable instruction sections for built-in workflow tasks.

    Each field overrides that section when set; leave as ``NOT_GIVEN`` to
    preserve the workflow's built-in default. Set to ``""`` to remove a
    section entirely.

    Args:
        persona: Agent persona/identity — who the agent is and how it behaves.
        extra: Extra instructions appended to the prompt. The simplest hook for
            adding domain context without touching defaults.
    """

    persona: NotGivenOr[Instructions | str] = NOT_GIVEN
    extra: Instructions | str = ""

Customizable instruction sections for built-in workflow tasks.

Each field overrides that section when set; leave as NOT_GIVEN to preserve the workflow's built-in default. Set to "" to remove a section entirely.

Args

persona: Agent persona/identity — who the agent is and how it behaves.
extra: Extra instructions appended to the prompt. The simplest hook for adding domain context without touching defaults.

Instance variables

var extra : livekit.agents.llm.chat_context.Instructions | str
var persona : str | livekit.agents.llm.chat_context.Instructions | livekit.agents.types.NotGiven