pinecall-protocol 0.1.0__py3-none-any.whl

pinecall_protocol/__init__.py

@@ -0,0 +1,41 @@
+"""Generated from schema/ by `python generate`. Never edited by hand."""
+
+from pinecall_protocol._base import ProtocolError, WireModel
+from pinecall_protocol.codec import (
+    command_of,
+    decode_entries,
+    decode_entry,
+    encode,
+    event_of,
+)
+from pinecall_protocol.envelope import Command, Entry
+from pinecall_protocol.registry import (
+    COMMANDS,
+    EPHEMERAL_EVENTS,
+    EVENTS,
+    PRODUCES,
+    TERMINAL_EVENT,
+    CommandType,
+    EventType,
+)
+from pinecall_protocol.state import State
+
+__all__ = [
+    "COMMANDS",
+    "EPHEMERAL_EVENTS",
+    "EVENTS",
+    "PRODUCES",
+    "TERMINAL_EVENT",
+    "Command",
+    "CommandType",
+    "Entry",
+    "EventType",
+    "ProtocolError",
+    "State",
+    "WireModel",
+    "command_of",
+    "decode_entries",
+    "decode_entry",
+    "encode",
+    "event_of",
+]

pinecall_protocol/_base.py

@@ -0,0 +1,13 @@
+"""The base every wire model shares: unknown keys are refused; a field builds by name or alias."""
+
+from pydantic import BaseModel, ConfigDict
+
+
+class WireModel(BaseModel):
+    """A shape on the wire. extra=forbid is the schema's additionalProperties: false."""
+
+    model_config = ConfigDict(extra="forbid", validate_by_name=True, validate_by_alias=True)
+
+
+class ProtocolError(ValueError):
+    """A message did not match the protocol: unknown type, bad shape, a seq out of order."""

pinecall_protocol/_version.py

@@ -0,0 +1,4 @@
+"""The one place the version lives; hatch reads it from here at build time."""
+
+# 0.0.0 means "unreleased". The number is the maintainer's call and is never bumped from code.
+__version__ = "0.1.0"

pinecall_protocol/codec.py

@@ -0,0 +1,52 @@
+"""JSON in, models out, and back. The only file that touches a key name: aliases, by_alias."""
+
+from typing import Any
+
+from pydantic import TypeAdapter, ValidationError
+
+from pinecall_protocol._base import ProtocolError, WireModel
+from pinecall_protocol.envelope import Command, Entry
+from pinecall_protocol.registry import COMMANDS, EVENTS
+
+_LOG: TypeAdapter[list[Entry]] = TypeAdapter(list[Entry])
+
+
+def decode_entry(raw: dict[str, Any]) -> Entry:
+    """One log line from decoded JSON. A bad shape is a ProtocolError."""
+    return _validate(Entry, raw, "entry")
+
+
+def decode_entries(text: str) -> list[Entry]:
+    """A whole log from a JSON array text, in the order it came."""
+    try:
+        return _LOG.validate_json(text)
+    except ValidationError as error:
+        raise ProtocolError(f"log: {error}") from error
+
+
+def event_of(entry: Entry) -> WireModel:
+    """The entry's data as the model its type names. Unknown type or bad shape: ProtocolError."""
+    model = EVENTS.get(entry.type)
+    if model is None:
+        raise ProtocolError(f"unknown event type: {entry.type}")
+    return _validate(model, entry.data, entry.type)
+
+
+def command_of(command: Command) -> WireModel:
+    """The command's data as the model its type names. Unknown type or bad shape: ProtocolError."""
+    model = COMMANDS.get(command.type)
+    if model is None:
+        raise ProtocolError(f"unknown command type: {command.type}")
+    return _validate(model, command.data, command.type)
+
+
+def encode(model: WireModel) -> dict[str, Any]:
+    """A model as it goes on the wire: wire key names, absent fields absent, JSON-ready values."""
+    return model.model_dump(mode="json", by_alias=True, exclude_unset=True)
+
+
+def _validate[T: WireModel](model: type[T], raw: dict[str, Any], what: str) -> T:
+    try:
+        return model.model_validate(raw)
+    except ValidationError as error:
+        raise ProtocolError(f"{what}: {error}") from error

pinecall_protocol/commands.py

@@ -0,0 +1,208 @@
+"""Generated from schema/commands/: one model per command."""
+
+from typing import Any, Literal
+
+from pydantic import Field
+
+from pinecall_protocol._base import WireModel
+from pinecall_protocol.defs import AgentConfig, Contact, Route, Supervisor, ToolSpec, TransferMode
+from pinecall_protocol.verbs import Verb
+
+
+# Declare or change what the agent is: voice, models, language, greeting, the full tool list. Only
+# the fields sent change.
+class AgentConfigure(WireModel):
+    """Declare or change what the agent is."""
+
+    config: AgentConfig
+
+
+# The gateway answers agent.registered, or error.
+class AgentRegister(WireModel):
+    """The app's first message: this socket speaks for this agent and answers these doors."""
+
+    routes: list[Route]
+    sdk: str | None = None
+    takes_unclaimed: bool = True
+
+
+# Make the model speak now, guided by an instruction it reads and the caller never hears: 'tell them
+# a slot at 10:15 just opened'. On livekit's session.generate_reply; the sibling of agent.say, which
+# speaks verbatim. The reply lands as turn.agent.
+class AgentReply(WireModel):
+    """Make the model speak now, guided by an instruction it reads and the caller never hears."""
+
+    instructions: str
+    allow_interruptions: bool | None = None
+
+
+# Make the agent say this text now, verbatim, outside the model's turn: a greeting, a read-back, a
+# system notice. The reply lands as turn.agent.
+class AgentSay(WireModel):
+    """Make the agent say this text now, verbatim, outside the model's turn."""
+
+    text: str
+    allow_interruptions: bool | None = None
+
+
+# The new call's log opens with call.dialing; call.started follows when the far end answers.
+class CallDial(WireModel):
+    """Place an outbound call as this agent."""
+
+    to: str
+    from_: str | None = Field(None, alias="from")
+    caller: Contact | None = None
+    metadata: dict[str, Any] | None = None
+
+
+class CallDtmf(WireModel):
+    """Send touch tones down the line, for an IVR on the far end."""
+
+    digits: str
+
+
+# Hand the agent a fact from the tenant's backend: a slot freed, an order shipped, a payment
+# confirmed. Lands as event.received with source app. The agent must have declared the name in its
+# events with app among the senders, or the gateway answers error and nothing touches the log.
+class CallEvent(WireModel):
+    """Hand the agent a fact from the tenant's backend."""
+
+    name: str
+    data: dict[str, Any]
+
+
+# call.ended follows with reason agent_hung_up.
+class CallHangup(WireModel):
+    """End the call from the app's side."""
+
+    reason: str | None = None
+
+
+class CallHold(WireModel):
+    """Put the caller on hold: they hear hold audio, the agent hears nothing."""
+
+
+# It gets a seq like everything else and lands as custom.
+class CallLog(WireModel):
+    """Write a line of the app's own into the call's log."""
+
+    name: str
+    data: dict[str, Any]
+
+
+class CallMute(WireModel):
+    """Mute the agent: it keeps listening and thinking, produces no audio."""
+
+
+# call.transferred says whether it worked.
+class CallTransfer(WireModel):
+    """Send the caller to another number."""
+
+    to: str
+    mode: TransferMode
+
+
+class CallUnhold(WireModel):
+    """Take the caller off hold."""
+
+
+class CallUnmute(WireModel):
+    """Unmute the agent."""
+
+
+# Why the verb did not run, in the words the console shows: the status it travels under, and the
+# sentence.
+class DevRefusal(WireModel):
+    """Why the verb did not run, in the words the console shows."""
+
+    status: int
+    detail: str
+
+
+class DevAnswer(WireModel):
+    """What came of one dev.request, named by its id."""
+
+    id: str
+    result: dict[str, Any] | None = None
+    refused: DevRefusal | None = None
+
+
+# Silence a participant for the rest of the call: their audio leaves the room, for everyone in it.
+# Lands as track.unpublished for their microphone. There is no unmute; a leg that must speak again
+# is invited again.
+class ParticipantMute(WireModel):
+    """Silence a participant for the rest of the call."""
+
+    identity: str
+
+
+# Lands as participant.left with reason participant_removed. Removing the caller ends the call.
+class ParticipantRemove(WireModel):
+    """Put a participant out of the room."""
+
+    identity: str
+
+
+class Ping(WireModel):
+    """Is the socket alive? The gateway answers pong."""
+
+
+# The name must be one of the agent's declared blocks, or one of the default four; anything else is
+# refused with the name.
+class PromptSet(WireModel):
+    """Rewrite one block of the prompt, whole, by name."""
+
+    name: str
+    text: str
+
+
+# A second SIP leg dialed to a number is the warm path: the agent stays on with the caller while the
+# other side answers. Lands as participant.joined when they arrive, or error when they do not.
+class RoomInvite(WireModel):
+    """Bring somebody else into the call's room."""
+
+    to: str
+    kind: Literal["sip", "participant"]
+
+
+# Push a payload to a browser in the room over the DataChannel: a card to render, a form to open.
+# Lands as room.sent with the size, never the payload. The widget listens on pinecall.ui; a topic of
+# the tenant's own reaches the tenant's own page code.
+class RoomSend(WireModel):
+    """Push a payload to a browser in the room over the DataChannel."""
+
+    topic: str
+    data: dict[str, Any]
+    to: str | None = None
+
+
+# Set up this one call before the first turn: the app's initial state, and any config that differs
+# from the agent's defaults for this caller.
+class SessionConfigure(WireModel):
+    """Set up this one call before the first turn."""
+
+    state: dict[str, Any] | None = None
+    config: AgentConfig | None = None
+
+
+# The platform logs state.changed and re-renders.
+class StateSet(WireModel):
+    """The app's state changed and this is all of it."""
+
+    state: dict[str, Any]
+    changed: list[str] | None = None
+
+
+class SupervisorVerb(WireModel):
+    """One supervise verb, from the human the door named."""
+
+    by: Supervisor
+    verb: Verb
+
+
+# The full list was declared in agent.configure; this is the subset whose when allows them in this
+# state.
+class ToolsSet(WireModel):
+    """The tools the model may see now."""
+
+    tools: list[ToolSpec]