nvoken 0.9.1__tar.gz

nvoken-0.9.1/.gitignore

@@ -0,0 +1,43 @@
+.DS_Store
+.env
+.env.*
+!.env.example
+
+# Go
+/nvoken
+bin/
+dist/
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.test
+*.out
+coverage.*
+*.coverprofile
+profile.cov
+go.work
+go.work.sum
+
+# JavaScript / TypeScript
+node_modules/
+sdk/typescript/dist/
+examples/*/dist/
+
+# Python
+.pytest_cache/
+.ruff_cache/
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+sdk/python/build/
+sdk/python/dist/
+
+# Rust
+sdk/rust/target/
+
+# Editors
+.idea/
+.vscode/

nvoken-0.9.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 [yyyy] [name of copyright owner]
+
+   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.

nvoken-0.9.1/PKG-INFO

@@ -0,0 +1,296 @@
+Metadata-Version: 2.4
+Name: nvoken
+Version: 0.9.1
+Summary: Python SDK for the nvoken durable agent runtime
+Project-URL: Homepage, https://github.com/deepnoodle-ai/nvoken/tree/main/sdk/python
+Project-URL: Repository, https://github.com/deepnoodle-ai/nvoken
+Project-URL: Changelog, https://github.com/deepnoodle-ai/nvoken/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/deepnoodle-ai/nvoken/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,durable-execution,llm,nvoken
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: python-dateutil<3,>=2.8
+Requires-Dist: typing-extensions>=4.7
+Provides-Extra: test
+Requires-Dist: pytest-asyncio==1.4.0; extra == 'test'
+Requires-Dist: pytest==9.1.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+# nvoken Python SDK
+
+An Invocation is one durable agent turn. The host supplies `agent_key`,
+optional `tenant_key`, `session_key`, and `idempotency_key`; instructions,
+model, and tools travel inline with the turn.
+
+The package has three deliberate levels:
+
+- `Agent` is the ordinary workflow facade: `text`, `run`, `invoke`, `stream`,
+  and locally serialized bound Sessions.
+- `Client` and `InvocationHandle` expose durable operations, transcript drains,
+  provider-key lifecycle, iterators, configurable waits, and resumable streams.
+- `nvoken_generated` is the complete generated Runtime transport and raw
+  escape hatch.
+
+```bash
+python -m pip install nvoken
+NVOKEN_BASE_URL=http://localhost:8080 NVOKEN_API_KEY=... \
+  python examples/quickstart.py
+```
+
+The async facade provides durable handles, replay-safe retries, typed errors,
+cursor iterators, resumable SSE, composed result reads (`result`,
+`list_messages`, `output_text`), and callback verification. Session-scoped
+messages use `Client.list_session_messages`.
+
+Resolve the identity-only Agent anchor without admitting work:
+
+```python
+agents = await client.list_agent_identities(agent_key="support")
+identity = await client.get_agent_identity(agents.items[0].id)
+```
+
+The identity contains only its nvoken ID, host-owned key, and creation time.
+Instructions, models, tools, and provider keys remain per Invocation.
+
+Opt into the fixed guarded public-web reader with `fetch_tool()`:
+
+```python
+from nvoken import AgentOptions, Model, fetch_tool
+
+options = AgentOptions(
+    agent_key="research",
+    model=Model(provider="anthropic", id="claude-sonnet-5"),
+    tools=(fetch_tool(),),
+)
+```
+
+The Runtime accepts only `{"name":"nvoken_fetch","mode":"builtin"}`. It owns
+public-address checks, up to five guarded redirects, one transient retry,
+HTML-to-Markdown conversion, and the ten-second and 64 KiB limits. Run
+`python examples/fetch.py` to summarize `NVOKEN_FETCH_URL`.
+
+Use an Agent for the common path:
+
+```python
+agent = client.agent(AgentOptions(
+    agent_key="support",
+    instructions="Help with billing questions.",
+    model=Model(provider="anthropic", id="claude-sonnet-5"),
+))
+
+print(await agent.text("Why was I charged twice?"))
+continued = agent.session(session_key="customer-123")
+print(await continued.text("What should I do next?"))
+```
+
+A bound Session serializes admission only within that local binding. The
+Runtime remains authoritative across processes and rejects a second
+nonterminal turn. Agent operations dispatch configured host-tool handlers.
+If a waiting call has no handler, the Agent cancels before raising
+`MissingToolHandlerError` by default; set
+`InvocationOptions(leave_waiting_on_missing_handler=True)` only when another
+worker deliberately owns it. `NoOutputTextError.result_kind` distinguishes
+structured, tool-only, and empty completions.
+
+For an intentional replace/regenerate action, use a new idempotency key and
+the typed option:
+
+```python
+handle = await agent.invoke(
+    "Try that answer again.",
+    options=InvocationOptions(
+        idempotency_key="customer-123:regenerate-2",
+        if_active="supersede",
+        session_key="customer-123",
+    ),
+)
+```
+
+Omission or `"reject"` preserves the default conflict response. Low-level
+callers set the same policy on `InvokeRequest.if_active`.
+
+`if_active="interrupt"` is the keep-the-work variant: the active Invocation
+stops at its next execution seam and settles `completed` with `stop_reason`
+`"interrupted"`, so the replacement turn builds on what it already produced.
+`await handle.interrupt()` asks for the same graceful stop without admitting a
+replacement, and `Invocation.stop_reason` names why any turn ended.
+
+A turn can also stop without ending: `"incomplete"` means the Runtime enforced
+a budget at a seam, with `stop_reason` naming which one. It is terminal — the
+wait helpers stop there — and its work is kept, so treat it as an unfinished
+answer rather than an error. `SessionMessage.phase` says which assistant
+message was the reply: `"final_answer"` on the one that settled a completed
+turn, `"commentary"` on everything else, so an incomplete turn has none.
+
+`InvocationOptions(timeout=...)` is one overall local deadline. Cancelling the
+calling task still raises native `asyncio.CancelledError`; it does not imply a
+durable Runtime cancellation. Call `handle.cancel()` when that is intended.
+
+Recovery reads accept a status union, and a known Invocation can stream only
+durable frames:
+
+```python
+page = await client.list_invocations(
+    status=["queued", "running", "waiting"],
+)
+async for event in handle.events(deltas=False):
+    ...
+```
+
+Equivalent status sets share cursor identity regardless of input order.
+Session get/list models expose typed nullable `usage`, computed from durable
+Invocation usage as a convenience estimate rather than a billing ledger.
+
+Set `Outcome(description=..., rubric=...)` on the request or Agent to request a
+single finish-time self-review. The selected model does not see the criteria
+during its initial work; nvoken supplies them once as a Dive system reminder
+when the turn would otherwise finish, then continues the same turn within its
+ordinary limits. No independent grade or result field is produced.
+
+Install restart-stable compaction on a new or existing Session:
+
+```python
+from nvoken import ContextCompaction, SessionOptions
+
+request = InvokeRequest(
+    agent_key="support",
+    session_key="support:123",
+    session_options=SessionOptions(
+        compaction=ContextCompaction(trigger_tokens="auto"),
+    ),
+    input="hello",
+    model=Model(provider="anthropic", id="claude-sonnet-5"),
+)
+```
+
+Use an integer trigger and optional same-provider `model` for explicit policy.
+A Session without a policy accepts late opt-in; once installed, the policy is
+immutable. Supplied options on an existing Session must equal stored values or
+admission returns `session_options_conflict`.
+
+Summary usage appears in Session usage rather than Invocation usage. Read
+applied and fell-through diagnostics with
+`client.list_session_compactions(session_id)`.
+
+`InvocationOptions.metadata` correlates a turn with your own records from the
+Agent binding. It is part of the admitted input, so it is immutable and material
+to idempotency: a replay carrying different metadata conflicts rather than
+updating it. That is why it is per-call rather than an `AgentOptions` default.
+
+Pass a stored or one-turn provider key directly through
+`InvokeRequest`:
+
+```python
+request = InvokeRequest(
+    agent_key="support",
+    input="hello",
+    model=Model(provider="openai", id="gpt-test"),
+    provider_keys=(
+        ProviderKeySelection(
+            provider="openai",
+            source="caller_ephemeral",
+            api_key=provider_key,
+        ),
+    ),
+)
+```
+
+Stored sources are `app_byok`, `tenant_byok`, and `platform` and do not
+accept an `api_key`. `Client.stream_session(session_id, reducer, consume)`
+follows the Session until its task is cancelled; a terminal turn does not end
+the Session stream. For catch-up reads, use `get_transcript_page` when
+checkpointing each page or `drain_transcript` to consume one fixed cut.
+
+Discover models through the same async facade:
+
+```python
+catalog = await client.list_models(provider="openai")
+selected = await client.get_model(
+    Model(provider="openai", id=catalog.items[0].id)
+)
+print(selected.cataloged, selected.pricing.status)
+```
+
+The list is curated discovery metadata, not proof of provider-account access.
+Exact inspection also accepts uncataloged IDs.
+
+Set an explicit portable temperature on the request or Agent:
+
+```python
+from nvoken import InvokeRequest, Model, Sampling
+
+request = InvokeRequest(
+    agent_key="support",
+    input="hello",
+    model=Model(provider="anthropic", id="claude-haiku-4-5"),
+    sampling=Sampling(temperature=0),
+)
+```
+
+Omit `sampling` to preserve the provider default. Check
+`selected.controls.sampling.temperature` first; missing controls are unknown,
+and unsupported or unknown selections fail before durable admission. The
+portable range is `[0,1]`. `top_p` and stop sequences are intentionally absent;
+`limits.max_output_tokens` is the output guardrail.
+
+Reasoning is typed and fail closed:
+
+```python
+from nvoken import InvokeRequest, Model, Reasoning
+
+request = InvokeRequest(
+    agent_key="support",
+    input="hello",
+    model=Model(provider="anthropic", id="claude-opus-4-8"),
+    reasoning=Reasoning(effort="high"),
+)
+```
+
+Check `selected.controls.reasoning` first. `budget_tokens` requires a larger
+explicit `limits.max_output_tokens`. Omission preserves provider defaults;
+unsupported values and combinations are rejected without aliasing. OpenAI
+reasoning remains unavailable until its complete continuation representation
+is durable.
+
+## Structured-output schema preflight
+
+`Client.invoke` and Agent operations call
+`preflight_output_schema(schema)` before transport when
+`InvokeRequest.output_schema` is present. Rejection is an `NvokenError` with
+code `schema_preflight_failed`; its safe `details` contain the portable issue
+`code`, RFC 6901 `path`, and optional `keyword`. A successful local check means
+eligible for admission. Generated APIs reached through `client.raw()` still
+rely on the authoritative Runtime check.
+
+## Remote MCP tools
+
+Use the handwritten declaration for discovery and Invocation admission:
+
+```python
+server = MCPServer(
+    name="support",
+    url="https://mcp.example.com/rpc",
+    allowed_tools=("lookup_order",),
+    headers={"Authorization": f"Bearer {mcp_token}"},
+    timeouts=MCPTimeouts(discovery_seconds=10, call_seconds=30),
+)
+
+catalog = await client.list_mcp_tools(server)
+request = InvokeRequest(
+    agent_key="support",
+    input="hello",
+    model=Model(provider="anthropic", id="claude-sonnet-5"),
+    mcp_servers=(server,),
+)
+```
+
+Headers are hidden from dataclass representation and are one-Invocation secret
+material. They never appear in durable specs or public recovery surfaces.