voqalize-agent-sdk 0.0.1__tar.gz

voqalize_agent_sdk-0.0.1/.gitignore

@@ -0,0 +1,35 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+.uv/
+uv.lock.*
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+
+# JS / TS
+node_modules/
+.pnpm-store/
+*.tsbuildinfo
+.astro/
+# sdk/react is a pnpm workspace member — the root lockfile is authoritative. This
+# transient lockfile is only written when demos/build.mjs builds it standalone
+# (--ignore-workspace) and must not be committed.
+sdk/react/pnpm-lock.yaml
+
+# Generated protobuf stubs (regenerated via `make proto`)
+proto/gen/
+
+# Env / secrets
+.env
+.env.*
+!.env.example
+
+# OS / editor
+.DS_Store
+*.swp
+.idea/
+.vscode/

voqalize_agent_sdk-0.0.1/CHANGELOG.md

@@ -0,0 +1,225 @@
+# Changelog
+
+All notable changes to `voqalize-agent-sdk`. This project is pre-1.0 and still
+alpha: the package API can break on a minor version, the **wire** does not.
+
+**The numbering restarts at `0.0.1`.** Everything below it — `0.1.0` through the
+work that would have been `0.4.0` — was never published: the one host that used
+the SDK installed it from a path in a sibling checkout. `0.0.1` is the first
+version anyone can `pip install`, and starting the public series at the bottom
+says plainly that nothing here is promised yet. Those older entries stay,
+because the API they describe is the API `0.0.1` ships.
+
+## 0.0.1
+
+First release published to PyPI: `pip install voqalize-agent-sdk`.
+
+**No wire change.** Every change below is package-API or packaging only; the
+frames a brain emits are byte-identical to what the previous release emitted.
+
+### Added
+
+- **Session-scoped logging — your brain's logs join the rest of the call.** Every
+  session now runs inside a context that tags each log line with `session_id`,
+  and with `tenant_id`/`agent_id` when the connection's verified token carries
+  them. A bare `from loguru import logger` anywhere in your brain — including in
+  tasks it spawns — picks that up with nothing threaded through your signatures.
+
+  The SDK **only adds fields**; it never touches your logging setup. If you
+  already configure loguru, add `{extra}` to your format. If you don't, call
+  `voqalize.sdk.configure_logging()` from your entrypoint — `json_logs=True`
+  writes one JSON object per line with the identity fields at top level, which is
+  the shape a log shipper indexes on.
+
+  `session_context(...)` is exported too, for tagging work you do outside a
+  session (a warm-up, a background reconciler).
+
+- **`voqalize.sdk.Action` — typed UI commands.** Declare a command as a pydantic
+  model that carries its own wire name and pass an instance where you used to pass
+  `(name, args)`:
+
+  ```python
+  class AddToCart(Action):          # wire name: "add_to_cart"
+      sku: str
+      qty: int = 1
+
+  interaction.action(AddToCart(sku="oat-milk", qty=2))
+  ```
+
+  The name is `snake_case`d from the class name unless pinned
+  (`class AddToCart(Action, name="add_to_cart")`). Serialization is
+  `model_dump(by_alias=True, mode="json")`: aliases apply (a `from_` field goes out
+  as `from`), `date`/`Enum`/`Decimal`/`UUID` become JSON scalars, nested models and
+  lists compose, unknown kwargs are rejected, and **every declared field is emitted
+  including `None`** — no `exclude_none`, so the wire shape is a function of the
+  class and the browser can declare one total TypeScript interface. A field that
+  would serialize to `type`, `action` or `action_id` raises at class definition.
+  Accepted by `session.action`, `interaction.action` and `voice().action`, with
+  `callback=` unchanged. **The `(name, args)` dict form is unchanged and remains
+  first-class** — convert one command at a time. `pydantic` is now a core
+  dependency (it was already a transitive one for ADK users).
+- **Tools may return pydantic models.** The ADK adapter's new `after_tool_callback`
+  dumps a returned model — and models nested in a returned dict/list — with the
+  same `by_alias`/JSON-mode rules before the result reaches the model, so the field
+  names a tool declares are the field names the model reads, instead of ADK's
+  `str()` of a `BaseModel`. A non-dict dump is wrapped as `{"result": ...}`,
+  matching ADK's own handling; a result containing no model passes through
+  untouched. This is the mirror of the 0.3.0 tool-*argument* coercion.
+- **`useUiCommand`** in `@voqalize/client-react` is the browser half — see
+  [the React client docs](https://voqalize.com/docs/client/react/).
+
+### Changed
+
+- **`protobuf>=5.29.3,<7`** (was `>=6.30,<7`) — **the SDK no longer drags a host
+  application onto protobuf 6.** The old floor came from the committed wire stubs,
+  which were generated with protoc v32 and therefore assert a 6.32 runtime at
+  import. A protobuf runtime accepts gencode from its own major or an older one,
+  so the stubs are now generated with protoc **v29.3**: they run unchanged on
+  protobuf 5.29+ *and* on 6.x, and an application already resolved on 5.29 keeps
+  its resolution when it adds this SDK. The `.proto` contract is untouched and the
+  wire bytes are identical — this is a gencode-target change, not a wire change.
+  We test against both majors.
+
+  The generator pin lives in `proto/buf.gen.yaml` and now tracks the **oldest**
+  runtime we support, not the newest; raise it only together with the floor here.
+- **The `adk` extra now requires `google-adk>=2.3,<3`** (was `>=1.33,<2`). The old
+  ceiling held installs on the 1.x line, and 1.x caps two things a host
+  application is likely to be ahead of: `starlette<1` (lifted in ADK 2.2) and
+  `opentelemetry-*<=1.41.1` (lifted in ADK 2.3). Installing `[adk]` next to a
+  modern FastAPI or OTel stack therefore walked those backwards, and dragged in
+  the 1.x-only `google-cloud-aiplatform` subtree with them. 2.3 is the first
+  release that pins neither. The adapter itself is unchanged — the ADK surfaces
+  it uses (`Runner`, `InvocationContext`, callbacks, `types`) are identical
+  across the two lines, and the drift canaries pass on 2.3.0 and 2.6.2 alike.
+
+## 0.3.0
+
+The ADK adapter grows the seams a real screen-driving agent needed. **No wire
+change** — `proto/voqalize/frames/frames.proto` is untouched, so this is a pure
+package-API release and any 0.2.0 runtime pairing keeps working.
+
+### Added
+
+- **`AdkBrain.grounding() -> str | None`** — override it to append live context to
+  the **fully assembled** system instruction on *every* model call (the root
+  agent's and every sub-agent's). Appending after ADK assembles is what makes it
+  compose instead of clobber: a plain-string `instruction` keeps ADK's `{state}`
+  templating, a client's own `InstructionProvider` still runs, and one
+  registration covers the whole agent tree. `None` appends nothing, turn by turn.
+  This replaces reaching for an `InstructionProvider` just to re-read state.
+- **The `state_sync` browser-snapshot convention.** `on_client_message` now
+  handles the `state_sync` message type by default and parks the payload on
+  **`self.browser_state`**. It **takes no floor** — a screen change never makes
+  the agent talk — and it **replaces** rather than merges (the browser sends a
+  complete picture; merging would resurrect rows the user just deleted). Pair it
+  with `grounding()`. A subclass that overrides `on_client_message` keeps the
+  default by calling `super()`. Convention, not protocol: the wire still carries
+  an opaque client message.
+- **Tool arguments arrive as the models you annotated.** A parameter typed `Leg`
+  or `list[Leg]` (also `Model | None`, `Sequence`/`tuple`/`set` of a model) is
+  constructed from the model's raw JSON before the tool runs; every other
+  annotation is passed through untouched. `Field(alias=...)` validates **both
+  ways** — from the wire's `from` *and* from the schema's `from_` — so a wire key
+  that is a Python keyword needs no rename in the body. An argument the model
+  shaped wrong comes back to it as a **tool error result** it can retry, not an
+  exception that kills the turn. (`voqalize._framework.coerce`, wired at
+  `before_tool_callback`.)
+- **The sync-tool guard.** A non-`async` tool is rejected when the agent is
+  built, with a `ValueError` naming it — ADK dispatches a sync tool on a thread
+  pool, where `voice()` is unset and `voice().action(...)` would raise mid-call,
+  after the model already spoke. **`allow_sync_tools=True`** opts out for tools
+  that never call `voice()`.
+- **`AdkBrain.agent`** — the ADK `LlmAgent` this brain drives, for inspection in
+  tests.
+
+### Changed
+
+- **The ADK agent is built lazily**, on first need (session start, or the `agent`
+  property) and exactly once — never in `__init__`. A subclass can therefore
+  assign its per-session state *after* `super().__init__(...)` and still have the
+  factory, the instruction and the tools see it. The "build your state before
+  `super().__init__`" ordering trap is gone.
+- **`ScriptedLlm`** records `captured_system_instructions` (each call's assembled
+  system instruction, in call order) alongside `captured_contents`.
+- **`call(name, /, ...)` / `reply_and_call(text, name, /, ...)`** take the
+  helper's own parameters **positional-only**, so every keyword is unambiguously
+  a tool argument — a tool taking `name=` or `text=` no longer collides — plus an
+  explicit `args={...}` form for an argument literally named `args`. Mixing the
+  two forms raises `TypeError`.
+
+## 0.2.0
+
+Breaking changes to the package API. The wire protocol is fully backward
+compatible — every change to `proto/voqalize/frames/frames.proto` in this release
+is an addition, so a 0.1.0 brain keeps working against the current runtime and a
+0.2.0 brain keeps working against an older one (it just never sees the new
+frames).
+
+### Breaking (package API)
+
+- **`on_app_event(session, event)` → `on_client_message(session, message)`.**
+  `event.name` → `message.type`, `event.data` → `message.data`. The `AppEvent`
+  type is gone; `ClientMessage` replaces it and adds `.id` (the browser-supplied
+  message id) and `.interaction_id` (minted by Voice for this message).
+  Replying is now explicit: touch `message.interaction` to take the floor and
+  respond on the pre-minted id, or read the data and return to ingest it
+  silently. Messages from an older runtime arrive unstamped
+  (`interaction_id == 0`) and degrade to an agent-initiated turn.
+- **`inference()` → `say()`.** `session.inference()` → `session.say()` and
+  `interaction.inference()` → `interaction.say()`. The bracket is otherwise
+  unchanged (`async with … as speech: await speech.speak(text)`), still 1:1 with
+  one model call.
+
+### Added
+
+- **`on_user_idle(interaction)`** — the user went silent past the idle timeout
+  and the brain holds the floor to re-engage. `interaction.idle` is an
+  `IdleInfo(level, idle_ms)`; `level` escalates while the silence persists and
+  resets on user speech. Default is a no-op, so the silence just rides.
+- **`session.configure_idle(timeout_ms=…)`** — set the silence window mid-call;
+  `0` disables idle detection entirely.
+- **`InteractionSource`** (`USER` / `IDLE` / `CLIENT_MESSAGE`), readable as
+  `interaction.source`.
+- **`voqalize.google_adk`** — hand the SDK a native Google ADK agent
+  (`AdkBrain` / `adk_brain(...)`) and let it drive the run loop, including the
+  heard-truth corrector that reconciles what the user actually heard back into
+  ADK's session history. Optional extra: `pip install voqalize-agent-sdk[adk]`.
+- **`voqalize.conformance`** — a wire-level driver plus a scenario catalog and
+  MUST checks that any brain can be run against
+  (`python -m voqalize.conformance`), so protocol compatibility is testable
+  without the voice runtime.
+- **`voqalize._framework`** — the internal framework-brain machinery the ADK
+  adapter is built on (heard-truth readers, greeting resolution, the no-dead-air
+  turn runner). Private; not part of the public API.
+
+### Wire (all additive)
+
+- `VqlUserIdle` (`Envelope` body 12) — `interaction_id`, `level`, `idle_ms`.
+- `IdleUpdateSettings` (`Envelope` body 38) — JSON idle policy.
+- `RTVIClientMessage.interaction_id` (field 4) — the Voice-minted stamp; `0` or
+  absent means an older, unstamped sender.
+
+### Migration
+
+```diff
+-async with session.inference() as inf:
+-    await inf.speak("Hi!")
++async with session.say() as speech:
++    await speech.speak("Hi!")
+
+-async def on_app_event(self, session, event) -> None:
+-    if event.name == "state_sync":
+-        self.screen = event.data
++async def on_client_message(self, session, message) -> None:
++    if message.type == "state_sync":
++        self.screen = message.data          # silent: no floor taken
++    elif message.type == "photo_upload":
++        async with message.interaction.say() as speech:
++            await speech.speak("Let me look at that.")
+```
+
+## 0.1.0
+
+Initial release: the pipecat-free `Brain` surface, the inbound (direct) server
+and the Cortex agent, the `Vql*` wire vocabulary, and the framework-owned
+heard-text conversation record.

voqalize_agent_sdk-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Voqalize
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.