basal-client 0.1.0__tar.gz

basal_client-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

basal_client-0.1.0/NOTICE

@@ -0,0 +1,39 @@
+basal-rs
+Copyright 2026 basal-rs contributors
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+This project reimplements in Rust the inference protocol of basal
+(https://github.com/rkinas/basal, Copyright 2026 Remigiusz Kinas, Apache License 2.0) and ports parts of it:
+the prompt format and letter readout (basal/prompt.py), the System One request handling and answer semantics
+including multi and act (basal/server.py), facts injection (basal/facts.py -> crates/basal-core/src/facts.rs),
+evidence spans (basal/evidence.py -> crates/basal-core/src/evidence.rs) and shared-prefix packing (basal/engine.py).
+Reference requests in tools/reference include examples from basal/examples.
+
+The basal model weights (Remek/basal-1.0-*, Remek/basal-1.5-*) are not part of this repository; they are released by
+their author under the Apache License 2.0.
+
+The NOTICE file of basal (v1.5.0) follows.
+
+--------------------------------------------------------------------------------
+
+basal
+Copyright 2026 Remigiusz Kinas
+
+This product includes models fine-tuned from the following works, licensed under the Apache License, Version 2.0:
+
+  basal-1.5-4.5B  <- speakleash/Bielik-4.5B-v3.0-Instruct  (https://huggingface.co/speakleash/Bielik-4.5B-v3.0-Instruct)
+  basal-1.5-max   <- speakleash/Bielik-PL-11B-v3.0-Instruct  (https://huggingface.co/speakleash/Bielik-PL-11B-v3.0-Instruct)
+  basal-1.5-mini  <- speakleash/Bielik-1.5B-v3.0-Instruct  (https://huggingface.co/speakleash/Bielik-1.5B-v3.0-Instruct)
+  basal-1.0-4.5B  <- speakleash/Bielik-4.5B-v3.0-Instruct  (https://huggingface.co/speakleash/Bielik-4.5B-v3.0-Instruct)
+  basal-1.0-1.5B  <- speakleash/Bielik-1.5B-v3.0-Instruct  (https://huggingface.co/speakleash/Bielik-1.5B-v3.0-Instruct)
+
+The inference engine in this repository is original work licensed under the Apache License, Version 2.0.
+
+Training data attribution (basal-1.0 models):
+  English decision items in the training data were converted from the public corpus
+  avbiswas/bev-decision-150K (https://huggingface.co/datasets/avbiswas/bev-decision-150K), which aggregates questions
+  derived from many upstream sources. Its maintainers ask users to check and attribute those upstream sources; row-level
+  source identifiers are not available, so the upstream sources of these items are not documented individually.
+
+basal-1.5 models: released under the Apache License, Version 2.0.

basal_client-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.5
+Name: basal-client
+Version: 0.1.0
+Summary: Python client for the native Basal HTTP API
+Author: IT SOL
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-Expression: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: httpx>=0.28,<1
+Project-URL: Documentation, https://github.com/itsoltech/basal-rs/blob/main/docs/SDK.md
+Project-URL: Source, https://github.com/itsoltech/basal-rs/tree/main/sdk/python
+Import-Name: basal_client
+
+# basal-client (Python)
+
+HTTP SDK for the native Basal API (`POST /v1/basal`). Python 3.11+; no GPU required on the client.
+
+This package is versioned independently. Release tag: `sdk-python-vX.Y.Z`.
+[Changelog](https://github.com/itsoltech/basal-rs/blob/main/sdk/python/CHANGELOG.md).
+
+```sh
+pip install basal-client
+```
+
+Choose either a normal dictionary or a declarative class. Both use the same factories.
+A class gives each response field its exact inferred answer type:
+
+```python
+from basal_client import BasalClient, Questions, choice, noul
+
+routing = choice("Do którego działu skierować zgłoszenie?", {"returns": "Zwroty", "support": "Wsparcie techniczne"})
+
+class TicketQuestions(Questions):
+    department = routing
+    second_department = routing
+    urgent = noul("Czy sprawa jest pilna?")
+
+with BasalClient("http://127.0.0.1:8000") as client:
+    response = client.decide("Klient prosi o zwrot pieniędzy za uszkodzony telefon.", TicketQuestions)
+    print(response.answers.department.choice)         # str, ChoiceAnswer
+    print(response.answers.second_department.choice)  # independent answer
+    print(response.answers.urgent.noul)               # float, NoulAnswer
+```
+
+Pass the class itself, without `()`. No response class, field annotations, casts, type-checker
+plugin or code generator is needed. The same definition may appear under several names.
+
+For dynamic question sets, use a dictionary and read answers by their request keys:
+
+```python
+from basal_client import BasalClient, choice
+
+routing = choice("Which department?", {"returns": "Returns", "support": "Support"})
+with BasalClient() as client:
+    response = client.decide("The phone is broken.", {
+        "department": routing,
+        "second_department": routing,
+    })
+    print(response.answers["department"])
+    print(response.answer("second_department"))
+```
+
+Dictionary values are checked answer dataclasses, with the static union `AnswerResult`.
+Use `isinstance(answer, ChoiceAnswer)` to narrow that union when needed. Python cannot infer
+an individual answer type from an arbitrary string key; the class form supplies that information.
+Choice/label keys remain `str` in Python, rather than inferred literal unions.
+`answer()` now takes a request key, not a question object (a change before the initial release).
+
+Native asynchronous HTTP with connection pooling supports both forms:
+
+```python
+from basal_client import AsyncBasalClient, Questions, noul
+
+class Availability(Questions):
+    urgent = noul("Is this urgent?")
+
+async def decide():
+    async with AsyncBasalClient(timeout=120) as client:
+        response = await client.decide("The service is unavailable.", Availability)
+        return response.answers.urgent.noul
+```
+
+`models()` reads `/v1/models`. An optional `api_key` adds a bearer token
+for an authenticating reverse proxy. The server root URL may include a proxy prefix; do not append `/v1`.
+HTTPS is required except for loopback HTTP, suitable for local servers and SSH tunnels.
+URL credentials/query/fragment are rejected. `trust_env=False` is the default: environment proxies and
+certificate overrides are ignored. Set `trust_env=True` only when you intend to trust that configuration.
+`max_response_bytes` defaults to 8 MiB and limits the actual decoded stream, including HTTP errors;
+oversized responses raise `BasalResponseTooLargeError`. TLS verification remains enabled.
+The client requests `Accept-Encoding: identity` and rejects compressed responses before decoding,
+including when a proxy ignores that header. Configure proxies to return uncompressed JSON for this client.
+Malformed or excessively nested JSON raises `BasalProtocolError`.
+`timeout` is in seconds and applies to connect/read/write/pool phases, not a total wall-clock deadline.
+
+`BasalHTTPError` provides `status_code`, `body` and the raw `retry_after` header. Transport failures raise
+`BasalTransportError`; malformed successful JSON raises `BasalProtocolError`. Original exceptions are
+available through `__cause__`. There are no automatic retries or redirects. Type hints describe the native
+contract; successful responses are checked to be JSON objects, without full schema validation. Unknown
+JSON fields are preserved. Server validation errors (422) and overload (529) remain distinct.
+
+Supports `choice`, `noul`, `score`, `multi`, `act`, `facts` and `evidence`. Criterion order matters. Native
+choice/score accepts 2–10 options; multi has independent probabilities and `set_confidence`. Evidence
+offsets count Unicode characters. The SDK does not evaluate model decisions or perform selected actions.
+
+Factories `choice`, `noul`, `score`, `multi`, `act` return concrete generic question classes.
+Constructors `ChoiceQuestion(...)` etc. have the same signatures. Required response fields are
+validated before returning; evidence defaults to an empty tuple. `response.raw` retains native
+JSON and extensions. The one-argument `decide(request)` remains available for full native
+JSON dictionaries. `model=` and `facts=` work with either two-argument form.
+
+Schema fields may be inherited and overridden with the same question kind for compatibility
+with both mypy and Pyright. Changing a field's kind or removing it with `None` is not supported
+by mypy. Field order follows reversed Python MRO, like dataclasses: for `class D(M1, M2)`,
+fields from `M2` precede those from `M1`; overriding a field retains its original position.
+Names starting with `_` are reserved. Schema instances are populated by the SDK without
+calling user constructors, and their fields cannot be reassigned. Define schemas declaratively;
+do not mutate class definitions while requests are running. Dictionary question maps are also
+snapshotted before I/O. Response dictionary keys are read-only; nested native data is not deeply frozen.
+
+Typed response/answer containers do not support the copy/pickle protocols. For caching or
+passing a result between processes, serialize `response.raw` as JSON. Use `copy.deepcopy(response.raw)`
+when a detached native result is needed. Question definitions may also be stored in ordinary
+classes, `ClassVar` attributes or dataclasses; outside `Questions` they remain question definitions.
+
+[Full documentation and publication setup](https://github.com/itsoltech/basal-rs/blob/main/docs/SDK.md).
+
+Runtime uses HTTPX with seven dependencies in the audited Python 3.11 graph. Building requires only the
+hash-locked Flit Core backend; consumers of the wheel do not install the build backend.
+

basal_client-0.1.0/README.md

@@ -0,0 +1,115 @@
+# basal-client (Python)
+
+HTTP SDK for the native Basal API (`POST /v1/basal`). Python 3.11+; no GPU required on the client.
+
+This package is versioned independently. Release tag: `sdk-python-vX.Y.Z`.
+[Changelog](https://github.com/itsoltech/basal-rs/blob/main/sdk/python/CHANGELOG.md).
+
+```sh
+pip install basal-client
+```
+
+Choose either a normal dictionary or a declarative class. Both use the same factories.
+A class gives each response field its exact inferred answer type:
+
+```python
+from basal_client import BasalClient, Questions, choice, noul
+
+routing = choice("Do którego działu skierować zgłoszenie?", {"returns": "Zwroty", "support": "Wsparcie techniczne"})
+
+class TicketQuestions(Questions):
+    department = routing
+    second_department = routing
+    urgent = noul("Czy sprawa jest pilna?")
+
+with BasalClient("http://127.0.0.1:8000") as client:
+    response = client.decide("Klient prosi o zwrot pieniędzy za uszkodzony telefon.", TicketQuestions)
+    print(response.answers.department.choice)         # str, ChoiceAnswer
+    print(response.answers.second_department.choice)  # independent answer
+    print(response.answers.urgent.noul)               # float, NoulAnswer
+```
+
+Pass the class itself, without `()`. No response class, field annotations, casts, type-checker
+plugin or code generator is needed. The same definition may appear under several names.
+
+For dynamic question sets, use a dictionary and read answers by their request keys:
+
+```python
+from basal_client import BasalClient, choice
+
+routing = choice("Which department?", {"returns": "Returns", "support": "Support"})
+with BasalClient() as client:
+    response = client.decide("The phone is broken.", {
+        "department": routing,
+        "second_department": routing,
+    })
+    print(response.answers["department"])
+    print(response.answer("second_department"))
+```
+
+Dictionary values are checked answer dataclasses, with the static union `AnswerResult`.
+Use `isinstance(answer, ChoiceAnswer)` to narrow that union when needed. Python cannot infer
+an individual answer type from an arbitrary string key; the class form supplies that information.
+Choice/label keys remain `str` in Python, rather than inferred literal unions.
+`answer()` now takes a request key, not a question object (a change before the initial release).
+
+Native asynchronous HTTP with connection pooling supports both forms:
+
+```python
+from basal_client import AsyncBasalClient, Questions, noul
+
+class Availability(Questions):
+    urgent = noul("Is this urgent?")
+
+async def decide():
+    async with AsyncBasalClient(timeout=120) as client:
+        response = await client.decide("The service is unavailable.", Availability)
+        return response.answers.urgent.noul
+```
+
+`models()` reads `/v1/models`. An optional `api_key` adds a bearer token
+for an authenticating reverse proxy. The server root URL may include a proxy prefix; do not append `/v1`.
+HTTPS is required except for loopback HTTP, suitable for local servers and SSH tunnels.
+URL credentials/query/fragment are rejected. `trust_env=False` is the default: environment proxies and
+certificate overrides are ignored. Set `trust_env=True` only when you intend to trust that configuration.
+`max_response_bytes` defaults to 8 MiB and limits the actual decoded stream, including HTTP errors;
+oversized responses raise `BasalResponseTooLargeError`. TLS verification remains enabled.
+The client requests `Accept-Encoding: identity` and rejects compressed responses before decoding,
+including when a proxy ignores that header. Configure proxies to return uncompressed JSON for this client.
+Malformed or excessively nested JSON raises `BasalProtocolError`.
+`timeout` is in seconds and applies to connect/read/write/pool phases, not a total wall-clock deadline.
+
+`BasalHTTPError` provides `status_code`, `body` and the raw `retry_after` header. Transport failures raise
+`BasalTransportError`; malformed successful JSON raises `BasalProtocolError`. Original exceptions are
+available through `__cause__`. There are no automatic retries or redirects. Type hints describe the native
+contract; successful responses are checked to be JSON objects, without full schema validation. Unknown
+JSON fields are preserved. Server validation errors (422) and overload (529) remain distinct.
+
+Supports `choice`, `noul`, `score`, `multi`, `act`, `facts` and `evidence`. Criterion order matters. Native
+choice/score accepts 2–10 options; multi has independent probabilities and `set_confidence`. Evidence
+offsets count Unicode characters. The SDK does not evaluate model decisions or perform selected actions.
+
+Factories `choice`, `noul`, `score`, `multi`, `act` return concrete generic question classes.
+Constructors `ChoiceQuestion(...)` etc. have the same signatures. Required response fields are
+validated before returning; evidence defaults to an empty tuple. `response.raw` retains native
+JSON and extensions. The one-argument `decide(request)` remains available for full native
+JSON dictionaries. `model=` and `facts=` work with either two-argument form.
+
+Schema fields may be inherited and overridden with the same question kind for compatibility
+with both mypy and Pyright. Changing a field's kind or removing it with `None` is not supported
+by mypy. Field order follows reversed Python MRO, like dataclasses: for `class D(M1, M2)`,
+fields from `M2` precede those from `M1`; overriding a field retains its original position.
+Names starting with `_` are reserved. Schema instances are populated by the SDK without
+calling user constructors, and their fields cannot be reassigned. Define schemas declaratively;
+do not mutate class definitions while requests are running. Dictionary question maps are also
+snapshotted before I/O. Response dictionary keys are read-only; nested native data is not deeply frozen.
+
+Typed response/answer containers do not support the copy/pickle protocols. For caching or
+passing a result between processes, serialize `response.raw` as JSON. Use `copy.deepcopy(response.raw)`
+when a detached native result is needed. Question definitions may also be stored in ordinary
+classes, `ClassVar` attributes or dataclasses; outside `Questions` they remain question definitions.
+
+[Full documentation and publication setup](https://github.com/itsoltech/basal-rs/blob/main/docs/SDK.md).
+
+Runtime uses HTTPX with seven dependencies in the audited Python 3.11 graph. Building requires only the
+hash-locked Flit Core backend; consumers of the wheel do not install the build backend.

basal_client-0.1.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["flit_core==4.1.0"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "basal-client"
+version = "0.1.0"
+description = "Python client for the native Basal HTTP API"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{name = "IT SOL"}]
+dependencies = ["httpx>=0.28,<1"]
+classifiers = ["Programming Language :: Python :: 3", "Typing :: Typed"]
+
+[project.urls]
+Source = "https://github.com/itsoltech/basal-rs/tree/main/sdk/python"
+Documentation = "https://github.com/itsoltech/basal-rs/blob/main/docs/SDK.md"
+
+[tool.flit.module]
+name = "basal_client"

basal_client-0.1.0/src/basal_client/__init__.py

@@ -0,0 +1,30 @@
+"""Client for the native Basal API (/v1/basal)."""
+
+from .client import (
+    AsyncBasalClient, BasalClient, BasalError, BasalHTTPError,
+    BasalProtocolError, BasalTransportError, BasalResponseTooLargeError,
+)
+from .types import (
+    Answer, DecisionRequest, DecisionResponse, EvidenceSpan,
+    JsonValue, ModelMetadata, ModelsResponse, Question, Usage,
+)
+
+__all__ = [
+    "AsyncBasalClient", "BasalClient", "BasalError", "BasalHTTPError",
+    "BasalProtocolError", "BasalTransportError", "BasalResponseTooLargeError", "Answer", "DecisionRequest",
+    "DecisionResponse", "EvidenceSpan", "JsonValue",
+    "ModelMetadata", "ModelsResponse", "Question", "Usage",
+]
+
+from .questions import (
+    ChoiceAnswer, NoulAnswer, ScoreAnswer, MultiAnswer, ActAnswer,
+    ChoiceQuestion, NoulQuestion, ScoreQuestion, MultiQuestion, ActQuestion, QuestionSpec, QuestionSet, TypedDecisionResponse,
+    Questions, SchemaDecisionResponse, AnswerResult,
+    choice, noul, score, multi, act,
+)
+__all__ += [
+    "ChoiceAnswer", "NoulAnswer", "ScoreAnswer", "MultiAnswer", "ActAnswer",
+    "ChoiceQuestion", "NoulQuestion", "ScoreQuestion", "MultiQuestion", "ActQuestion", "QuestionSpec", "QuestionSet", "TypedDecisionResponse",
+    "Questions", "SchemaDecisionResponse", "AnswerResult",
+    "choice", "noul", "score", "multi", "act",
+]

basal_client-0.1.0/src/basal_client/client.py

@@ -0,0 +1,245 @@
+"""Connection-pooled synchronous and asynchronous clients for the Basal API."""
+
+import ipaddress
+import json
+import math
+from types import TracebackType
+from typing import Any, Literal, Self, cast, overload
+from urllib.parse import urlsplit
+
+import httpx
+
+from .types import DecisionRequest, DecisionResponse, ModelsResponse, JsonValue
+from .questions import (
+    Questions, QuestionSet, TSchema, TypedDecisionResponse, SchemaDecisionResponse,
+    build_questions, schema_questions,
+)
+
+
+class BasalError(Exception):
+    """Base SDK error. Transport errors retain their original exception as cause."""
+
+
+class BasalHTTPError(BasalError):
+    """Non-2xx response, retaining the body and unmodified Retry-After header."""
+
+    def __init__(self, status_code: int, body: Any, retry_after: str | None):
+        # Keep server bodies accessible explicitly; do not include state or secrets in logs.
+        super().__init__(f"Basal HTTP {status_code}")
+        self.status_code = status_code
+        self.body = body
+        self.retry_after = retry_after
+
+
+class BasalTransportError(BasalError):
+    """Connection, timeout or response-body transport failure."""
+
+
+class BasalResponseTooLargeError(BasalError):
+    """Actual streamed response exceeds the configured byte limit."""
+
+
+class BasalProtocolError(BasalError):
+    """Invalid JSON envelope or unsupported response encoding."""
+
+
+def _options(base_url: str, api_key: str | None, timeout: float) -> dict[str, Any]:
+    url = urlsplit(base_url)
+    if (
+        url.scheme not in ("http", "https")
+        or not url.hostname
+        or url.username is not None
+        or url.password is not None
+        or url.query
+        or url.fragment
+        or "?" in base_url
+        or "#" in base_url
+    ):
+        raise ValueError("base_url must be an HTTP(S) server URL without credentials, query or fragment")
+    try:
+        loopback = ipaddress.ip_address(url.hostname).is_loopback
+    except ValueError:
+        loopback = url.hostname.lower() == "localhost"
+    if url.scheme != "https" and not loopback:
+        raise ValueError("base_url requires HTTPS or loopback HTTP (e.g. an SSH tunnel)")
+    if not math.isfinite(timeout) or timeout <= 0:
+        raise ValueError("timeout must be finite and positive (seconds)")
+    headers = {"Accept": "application/json", "Accept-Encoding": "identity", "User-Agent": "basal-client-python"}
+    if api_key is not None:
+        if not api_key or "\r" in api_key or "\n" in api_key:
+            raise ValueError("api_key must be a nonempty, single-line token")
+        headers["Authorization"] = f"Bearer {api_key}"
+    return dict(base_url=base_url.rstrip("/") + "/", headers=headers, timeout=timeout,
+                follow_redirects=False)
+
+
+def _decode(response: httpx.Response, raw: bytes) -> dict[str, Any]:
+    try:
+        body = json.loads(raw)
+    except (ValueError, UnicodeError, RecursionError) as error:
+        if response.is_success:
+            raise BasalProtocolError("Basal returned invalid JSON") from error
+        body = raw.decode("utf-8", errors="replace")
+    if not response.is_success:
+        raise BasalHTTPError(response.status_code, body, response.headers.get("Retry-After"))
+    if not isinstance(body, dict):
+        raise BasalProtocolError("Basal returned a JSON value other than an object")
+    return body
+
+
+def _validate_limit(limit: int) -> int:
+    if isinstance(limit, bool) or not isinstance(limit, int) or limit <= 0:
+        raise ValueError("max_response_bytes must be a positive integer")
+    return limit
+
+
+def _check_encoding(response: httpx.Response) -> None:
+    # Reject before HTTPX invokes a decompressor, including when a proxy ignores Accept-Encoding.
+    if response.headers.get("Content-Encoding", "").strip().lower() not in ("", "identity"):
+        raise BasalProtocolError("Basal requires an uncompressed response")
+
+
+def _decision_request(state: DecisionRequest | JsonValue, questions: QuestionSet | None,
+                      model: str | None, facts: Literal["off", "auto"] | None) -> DecisionRequest:
+    if questions is None:
+        if model is not None or facts is not None:
+            raise ValueError("pass model/facts in a raw request, or supply typed questions")
+        if not isinstance(state, dict):
+            raise TypeError("a raw request must be a dictionary")
+        return cast(DecisionRequest, state)
+    if state is None:
+        raise ValueError("state must not be null")
+    request: DecisionRequest = {"state": cast(JsonValue, state), "questions": build_questions(questions)}
+    if model is not None:
+        if not isinstance(model, str) or not model.strip():
+            raise ValueError("model must be a nonempty string")
+        request["model"] = model
+    if facts is not None:
+        if facts not in ("off", "auto"):
+            raise ValueError("facts must be off or auto")
+        request["facts"] = facts
+    return request
+
+
+def _prepare_questions(questions: QuestionSet | type[Questions] | None) -> tuple[type[Questions] | None, QuestionSet | None]:
+    if isinstance(questions, type):
+        return questions, schema_questions(questions)
+    return None, None if questions is None else dict(questions)
+
+
+class BasalClient:
+    """Sync client. Reuse one instance; close it or use a with block.
+
+    base_url is the server root (optionally a proxy prefix), without /v1.
+    timeout applies to each HTTPX network phase, not the whole request.
+    No automatic retries: the caller decides whether to repeat inference.
+    """
+
+    def __init__(self, base_url: str = "http://127.0.0.1:8000", *,
+                 api_key: str | None = None, timeout: float = 120.0,
+                 max_response_bytes: int = 8 * 1024 * 1024, trust_env: bool = False):
+        self._max_response_bytes = _validate_limit(max_response_bytes)
+        self._http = httpx.Client(**_options(base_url, api_key, timeout), trust_env=trust_env)
+
+    def _request(self, method: str, path: str, body: DecisionRequest | None = None) -> dict[str, Any]:
+        try:
+            with self._http.stream(method, path, json=body) as response:
+                _check_encoding(response)
+                raw = bytearray()
+                for chunk in response.iter_bytes():
+                    if len(chunk) > self._max_response_bytes - len(raw):
+                        raise BasalResponseTooLargeError("Basal response exceeds the configured byte limit")
+                    raw.extend(chunk)
+                return _decode(response, bytes(raw))
+        except httpx.RequestError as error:
+            raise BasalTransportError("Basal HTTP transport failed") from error
+
+    @overload
+    def decide(self, state: DecisionRequest) -> DecisionResponse: ...
+
+    @overload
+    def decide(self, state: JsonValue, questions: QuestionSet, *, model: str | None = None,
+               facts: Literal["off", "auto"] | None = None) -> TypedDecisionResponse: ...
+
+    @overload
+    def decide(self, state: JsonValue, questions: type[TSchema], *, model: str | None = None,
+               facts: Literal["off", "auto"] | None = None) -> SchemaDecisionResponse[TSchema]: ...
+
+    def decide(self, state: DecisionRequest | JsonValue, questions: QuestionSet | type[Questions] | None = None, *,
+               model: str | None = None, facts: Literal["off", "auto"] | None = None) -> DecisionResponse | TypedDecisionResponse | SchemaDecisionResponse[Questions]:
+        """POST a raw request, or decide(state, a question dictionary or Questions class)."""
+        schema, fields = _prepare_questions(questions)
+        response = cast(DecisionResponse, self._request("POST", "v1/basal", _decision_request(state, fields, model, facts)))
+        if fields is None:
+            return response
+        return SchemaDecisionResponse(response, schema, fields) if schema is not None else TypedDecisionResponse(response, fields)
+
+    def models(self) -> ModelsResponse:
+        """GET /v1/models."""
+        return cast(ModelsResponse, self._request("GET", "v1/models"))
+
+    def close(self) -> None:
+        self._http.close()
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(self, exc_type: type[BaseException] | None, exc: BaseException | None,
+                 traceback: TracebackType | None) -> None:
+        self.close()
+
+
+class AsyncBasalClient:
+    """Native async HTTPX client; use async with or await aclose()."""
+
+    def __init__(self, base_url: str = "http://127.0.0.1:8000", *,
+                 api_key: str | None = None, timeout: float = 120.0,
+                 max_response_bytes: int = 8 * 1024 * 1024, trust_env: bool = False):
+        self._max_response_bytes = _validate_limit(max_response_bytes)
+        self._http = httpx.AsyncClient(**_options(base_url, api_key, timeout), trust_env=trust_env)
+
+    async def _request(self, method: str, path: str, body: DecisionRequest | None = None) -> dict[str, Any]:
+        try:
+            async with self._http.stream(method, path, json=body) as response:
+                _check_encoding(response)
+                raw = bytearray()
+                async for chunk in response.aiter_bytes():
+                    if len(chunk) > self._max_response_bytes - len(raw):
+                        raise BasalResponseTooLargeError("Basal response exceeds the configured byte limit")
+                    raw.extend(chunk)
+                return _decode(response, bytes(raw))
+        except httpx.RequestError as error:
+            raise BasalTransportError("Basal HTTP transport failed") from error
+
+    @overload
+    async def decide(self, state: DecisionRequest) -> DecisionResponse: ...
+
+    @overload
+    async def decide(self, state: JsonValue, questions: QuestionSet, *, model: str | None = None,
+                     facts: Literal["off", "auto"] | None = None) -> TypedDecisionResponse: ...
+
+    @overload
+    async def decide(self, state: JsonValue, questions: type[TSchema], *, model: str | None = None,
+                     facts: Literal["off", "auto"] | None = None) -> SchemaDecisionResponse[TSchema]: ...
+
+    async def decide(self, state: DecisionRequest | JsonValue, questions: QuestionSet | type[Questions] | None = None, *,
+                     model: str | None = None, facts: Literal["off", "auto"] | None = None) -> DecisionResponse | TypedDecisionResponse | SchemaDecisionResponse[Questions]:
+        """POST a raw request, a question dictionary, or a declarative Questions class."""
+        schema, fields = _prepare_questions(questions)
+        response = cast(DecisionResponse, await self._request("POST", "v1/basal", _decision_request(state, fields, model, facts)))
+        if fields is None:
+            return response
+        return SchemaDecisionResponse(response, schema, fields) if schema is not None else TypedDecisionResponse(response, fields)
+
+    async def models(self) -> ModelsResponse:
+        return cast(ModelsResponse, await self._request("GET", "v1/models"))
+
+    async def aclose(self) -> None:
+        await self._http.aclose()
+
+    async def __aenter__(self) -> Self:
+        return self
+
+    async def __aexit__(self, exc_type: type[BaseException] | None, exc: BaseException | None,
+                        traceback: TracebackType | None) -> None:
+        await self.aclose()

basal_client-0.1.0/src/basal_client/questions.py

@@ -0,0 +1,348 @@
+"""Typed, validated question factories. Wire dictionaries remain available separately."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping, Sequence
+from copy import deepcopy
+from dataclasses import dataclass
+import math
+from types import MappingProxyType
+from typing import Any, Generic, Literal, Self, TypeVar, cast, overload
+
+from .types import DecisionResponse, EvidenceSpan, JsonValue, Question as WireQuestion, Usage
+
+OptionKeys = Literal["show", "hide"]
+
+
+@dataclass(frozen=True, slots=True)
+class ChoiceAnswer:
+    choice: str
+    confidence: float
+    probabilities: dict[str, float]
+    evidence: tuple[EvidenceSpan, ...] = ()
+
+
+@dataclass(frozen=True, slots=True)
+class NoulAnswer:
+    noul: float
+    confidence: float
+    probabilities: dict[str, float]
+    evidence: tuple[EvidenceSpan, ...] = ()
+
+
+@dataclass(frozen=True, slots=True)
+class ScoreAnswer:
+    score: float
+    confidence: float
+    legend: dict[str, str]
+    probabilities: dict[str, float]
+    evidence: tuple[EvidenceSpan, ...] = ()
+
+
+@dataclass(frozen=True, slots=True)
+class MultiAnswer:
+    selected: tuple[str, ...]
+    threshold: float
+    set_confidence: float
+    probabilities: dict[str, float]
+
+
+@dataclass(frozen=True, slots=True)
+class ActAnswer:
+    action: str
+    answer: str
+    expected_costs: dict[str, float]
+    confidence: float
+    calibration: Literal["validated", "unvalidated"]
+    probabilities: dict[str, float]
+    evidence: tuple[EvidenceSpan, ...] = ()
+    refused: str | None = None
+    max_error: str | None = None
+
+
+TAnswer = TypeVar("TAnswer")
+AnswerResult = ChoiceAnswer | NoulAnswer | ScoreAnswer | MultiAnswer | ActAnswer
+TSchema = TypeVar("TSchema", bound="Questions")
+TSchema_co = TypeVar("TSchema_co", bound="Questions", covariant=True)
+
+
+def _text(value: str, name: str) -> str:
+    if not isinstance(value, str) or not value.strip():
+        raise ValueError(f"{name} must be a nonempty string")
+    return value
+
+
+def _criteria(values: Mapping[str, str], minimum: int, maximum: int | None) -> dict[str, JsonValue]:
+    if not isinstance(values, Mapping) or len(values) < minimum or (maximum is not None and len(values) > maximum):
+        raise ValueError("invalid number of criteria")
+    return {_text(key, "criterion key"): _text(value, "criterion description") for key, value in values.items()}
+
+
+def _number(value: float, name: str, probability: bool = False) -> float:
+    if isinstance(value, bool) or not isinstance(value, (int, float)) or not math.isfinite(value):
+        raise ValueError(f"{name} must be finite")
+    if probability and not 0 <= value <= 1:
+        raise ValueError(f"{name} must be between 0 and 1")
+    return value
+
+
+class QuestionSpec(Generic[TAnswer]):
+    """Typed question. to_dict() returns a copy; read() checks its answer's required fields."""
+
+    def __init__(self, kind: str, instructions: str, fields: dict[str, JsonValue]):
+        self._payload: dict[str, JsonValue] = {"type": kind, "instructions": _text(instructions, "instructions"), **fields}
+
+    def to_dict(self) -> WireQuestion:
+        return cast(WireQuestion, deepcopy(self._payload))
+
+    @overload
+    def __get__(self, instance: None, owner: type[Any] | None = None) -> Self: ...
+
+    @overload
+    def __get__(self, instance: Questions, owner: type[Any] | None = None) -> TAnswer: ...
+
+    @overload
+    def __get__(self, instance: object, owner: type[Any] | None = None) -> Self: ...
+
+    def __get__(self, instance: object, owner: type[Any] | None = None) -> Self | TAnswer:
+        # Non-data descriptor: validated answers stored under individual instance
+        # keys shadow the definition. Reusing one definition never merges keys.
+        # Outside a Questions schema, definitions remain ordinary values, also
+        # when stored in namespace classes, instance fields or dataclasses.
+        if not isinstance(instance, Questions):
+            return self
+        raise AttributeError("Question answers are populated by client.decide")
+
+    def read(self, response: DecisionResponse, question_id: str) -> TAnswer:
+        from .client import BasalProtocolError
+        answer = response.get("answers", {}).get(question_id)
+        if not isinstance(answer, dict) or answer.get("type") != self._payload["type"]:
+            raise BasalProtocolError("Basal returned a missing or mismatched answer")
+        data = cast(dict[str, Any], answer)
+        try:
+            probabilities = data["probabilities"]
+            if not isinstance(probabilities, dict) or any(not isinstance(k, str) for k in probabilities):
+                raise ValueError("invalid probabilities")
+            for value in probabilities.values():
+                _number(value, "probability", True)
+            spans = data.get("evidence", [])
+            if not isinstance(spans, list):
+                raise ValueError("invalid evidence")
+            for span in spans:
+                if not isinstance(span, dict) or not isinstance(span.get("text"), str):
+                    raise ValueError("invalid span")
+                for field in ("start", "end"):
+                    if isinstance(span.get(field), bool) or not isinstance(span.get(field), int) or span[field] < 0:
+                        raise ValueError("invalid offset")
+                _number(span["probability"], "span probability", True)
+            evidence = tuple(cast(list[EvidenceSpan], spans))
+            kind = data["type"]
+            result: ChoiceAnswer | NoulAnswer | ScoreAnswer | MultiAnswer | ActAnswer
+            if kind == "choice":
+                selected = _text(data["choice"], "choice")
+                if selected not in cast(dict[str, JsonValue], self._payload["criteria"]):
+                    raise ValueError("unknown choice")
+                result = ChoiceAnswer(selected, _number(data["confidence"], "confidence", True), probabilities, evidence)
+            elif kind == "noul":
+                result = NoulAnswer(_number(data["noul"], "noul", True), _number(data["confidence"], "confidence", True), probabilities, evidence)
+            elif kind == "score":
+                legend = data["legend"]
+                if not isinstance(legend, dict) or any(not isinstance(k, str) or not isinstance(v, str) for k, v in legend.items()):
+                    raise ValueError("invalid legend")
+                result = ScoreAnswer(_number(data["score"], "score"), _number(data["confidence"], "confidence", True), legend, probabilities, evidence)
+            elif kind == "multi":
+                labels = data["selected"]
+                if not isinstance(labels, list) or any(not isinstance(k, str) or k not in cast(dict[str, JsonValue], self._payload["criteria"]) for k in labels):
+                    raise ValueError("invalid selected labels")
+                result = MultiAnswer(tuple(labels), _number(data["threshold"], "threshold", True), _number(data["set_confidence"], "set_confidence", True), probabilities)
+            else:
+                action = _text(data["action"], "action")
+                if action not in cast(dict[str, JsonValue], self._payload["costs"]) or data["calibration"] not in ("validated", "unvalidated"):
+                    raise ValueError("invalid action or calibration")
+                costs = data["expected_costs"]
+                if not isinstance(costs, dict) or any(not isinstance(k, str) for k in costs):
+                    raise ValueError("invalid expected costs")
+                for value in costs.values():
+                    _number(value, "expected cost")
+                refused, max_error = data.get("refused"), data.get("max_error")
+                if any(value is not None and not isinstance(value, str) for value in (refused, max_error)):
+                    raise ValueError("invalid act metadata")
+                result = ActAnswer(action, _text(data["answer"], "answer"), costs, _number(data["confidence"], "confidence", True), data["calibration"], probabilities, evidence, refused, max_error)
+            return cast(TAnswer, result)
+        except (KeyError, TypeError, ValueError, OverflowError) as error:
+            raise BasalProtocolError("Basal returned an invalid typed answer") from error
+
+
+def _display(evidence: bool, option_keys: OptionKeys) -> dict[str, JsonValue]:
+    if not isinstance(evidence, bool) or option_keys not in ("show", "hide"):
+        raise ValueError("invalid evidence or option_keys")
+    fields: dict[str, JsonValue] = {}
+    if evidence:
+        fields["evidence"] = True
+    if option_keys != "show":
+        fields["option_keys"] = option_keys
+    return fields
+
+
+class ChoiceQuestion(QuestionSpec[ChoiceAnswer]):
+    def __init__(self, instructions: str, criteria: Mapping[str, str], *, evidence: bool = False,
+                 option_keys: OptionKeys = "show"):
+        super().__init__("choice", instructions, {"criteria": _criteria(criteria, 2, 10), **_display(evidence, option_keys)})
+
+
+class NoulQuestion(QuestionSpec[NoulAnswer]):
+    def __init__(self, instructions: str, *, evidence: bool = False):
+        super().__init__("noul", instructions, _display(evidence, "show"))
+
+
+class ScoreQuestion(QuestionSpec[ScoreAnswer]):
+    def __init__(self, instructions: str, levels: Sequence[str], *, evidence: bool = False):
+        if isinstance(levels, str) or not 2 <= len(levels) <= 10:
+            raise ValueError("score requires 2–10 ordered levels")
+        super().__init__("score", instructions, {"criteria": [_text(value, "level") for value in levels], **_display(evidence, "show")})
+
+
+class MultiQuestion(QuestionSpec[MultiAnswer]):
+    def __init__(self, instructions: str, criteria: Mapping[str, str], *, threshold: float = 0.5,
+                 min: int | None = None, max: int | None = None):
+        fields: dict[str, JsonValue] = {"criteria": _criteria(criteria, 1, None)}
+        _number(threshold, "threshold", True)
+        if threshold != 0.5:
+            fields["threshold"] = threshold
+        for name, value in (("min", min), ("max", max)):
+            if value is not None:
+                if isinstance(value, bool) or not isinstance(value, int) or not 0 <= value <= len(criteria):
+                    raise ValueError(f"{name} must be an integer within the number of labels")
+                fields[name] = value
+        if min is not None and max is not None and min > max:
+            raise ValueError("min must not exceed max")
+        super().__init__("multi", instructions, fields)
+
+
+class ActQuestion(QuestionSpec[ActAnswer]):
+    def __init__(self, instructions: str, costs: Mapping[str, Mapping[str, float]], *,
+                 criteria: Mapping[str, str] | None = None, evidence: bool = False,
+                 defer_action: str | None = None, max_error: float | None = None):
+        outcomes = set(criteria) if criteria is not None else {"true", "false"}
+        fields: dict[str, JsonValue] = _display(evidence, "show")
+        if criteria is not None:
+            fields["criteria"] = _criteria(criteria, 2, 10)
+        if not costs:
+            raise ValueError("act requires a nonempty cost matrix")
+        matrix: dict[str, JsonValue] = {}
+        for action, row in costs.items():
+            if not isinstance(row, Mapping) or set(row) != outcomes:
+                raise ValueError("each cost row must cover every outcome exactly")
+            matrix[_text(action, "action")] = {key: _number(value, "cost") for key, value in row.items()}
+        fields["costs"] = matrix
+        if defer_action is not None:
+            if defer_action not in costs:
+                raise ValueError("defer_action must identify a cost row")
+            fields["defer_action"] = defer_action
+        if max_error is not None:
+            fields["max_error"] = _number(max_error, "max_error", True)
+        super().__init__("act", instructions, fields)
+
+
+# Factories and constructors share exactly the same typed signatures.
+choice = ChoiceQuestion
+noul = NoulQuestion
+score = ScoreQuestion
+multi = MultiQuestion
+act = ActQuestion
+QuestionSet = Mapping[str, QuestionSpec[Any]]
+
+
+class Questions:
+    """Declare questions as class fields; pass the class itself to client.decide.
+
+    The returned response.answers is an instance with inferred answer fields.
+    Definitions may be reused or inherited. Constructors are not called when
+    populating responses; use this class as a declarative schema.
+    """
+
+    def __new__(cls) -> Self:
+        raise TypeError("Pass the Questions class to client.decide instead of constructing it")
+
+    def __setattr__(self, name: str, value: object) -> None:
+        raise AttributeError("Question answers are read-only")
+
+    def __delattr__(self, name: str) -> None:
+        raise AttributeError("Question answers are read-only")
+
+
+def schema_questions(schema: type[Questions]) -> dict[str, QuestionSpec[Any]]:
+    """Snapshot effective definitions in declaration order, respecting Python MRO."""
+    if not issubclass(schema, Questions):
+        raise TypeError("expected a Questions subclass")
+    members: dict[str, Any] = {}
+    for base in reversed(schema.__mro__):
+        members.update(vars(base))
+    fields: dict[str, QuestionSpec[Any]] = {}
+    for name, value in members.items():
+        if isinstance(value, QuestionSpec):
+            if name.startswith("_"):
+                raise ValueError("Schema question names must not start with an underscore")
+            fields[name] = value
+    return fields
+
+
+def build_questions(questions: QuestionSet) -> dict[str, WireQuestion]:
+    if not questions:
+        raise ValueError("questions must not be empty")
+    result: dict[str, WireQuestion] = {}
+    for key, question in questions.items():
+        _text(key, "question ID")
+        if not isinstance(question, (ChoiceQuestion, NoulQuestion, ScoreQuestion, MultiQuestion, ActQuestion)):
+            raise TypeError("questions must contain typed question specs")
+        result[key] = question.to_dict()
+    return result
+
+
+class _DecisionResponseBase:
+    def __init__(self, raw: DecisionResponse):
+        from .client import BasalProtocolError
+        if not isinstance(raw.get("model"), str) or not raw.get("model") or not isinstance(raw.get("usage"), dict) or not isinstance(raw.get("answers"), dict):
+            raise BasalProtocolError("Invalid decision envelope")
+        for name in ("input_tokens", "output_tokens"):
+            value = raw["usage"].get(name)
+            if isinstance(value, bool) or not isinstance(value, int) or value < 0:
+                raise BasalProtocolError("Invalid usage field")
+        self.model: str = raw["model"]
+        self.usage: Usage = raw["usage"]
+        self.raw = raw
+
+
+class TypedDecisionResponse(_DecisionResponseBase):
+    """Checked answers from a dictionary request, indexed by their request keys.
+
+    Values have a union of answer types. Use a Questions class when each named
+    field should have an exact inferred type, or isinstance to narrow this union.
+    """
+
+    def __init__(self, raw: DecisionResponse, questions: QuestionSet):
+        super().__init__(raw)
+        self.answers: Mapping[str, AnswerResult] = MappingProxyType({
+            name: question.read(raw, name) for name, question in questions.items()
+        })
+
+    def answer(self, key: str) -> AnswerResult:
+        """Retrieve by request key; an unknown key raises KeyError."""
+        return self.answers[key]
+
+
+class SchemaDecisionResponse(_DecisionResponseBase, Generic[TSchema_co]):
+    """Checked response with the named answer fields inferred from its schema."""
+
+    def __init__(self, raw: DecisionResponse, schema: type[TSchema_co], questions: QuestionSet):
+        super().__init__(raw)
+        parsed = {name: question.read(raw, name) for name, question in questions.items()}
+        # Populate only after all answers pass validation, bypassing user
+        # constructors. Instance attributes shadow non-data question descriptors.
+        self._answers = object.__new__(schema)
+        vars(self._answers).update(parsed)
+
+    @property
+    def answers(self) -> TSchema_co:
+        """Read-only schema instance with each field's inferred answer type."""
+        return self._answers

basal_client-0.1.0/src/basal_client/types.py

@@ -0,0 +1,84 @@
+"""Wire types for POST /v1/basal. Question and criteria order is significant."""
+
+from typing import Literal, NotRequired, TypedDict
+
+# Python 3.11 syntax keeps these aliases usable on the minimum supported version.
+JsonValue = str | int | float | bool | None | list["JsonValue"] | dict[str, "JsonValue"]
+
+
+class Question(TypedDict, total=False):
+    """Native question fields; validation and calibration belong to the server."""
+
+    type: Literal["choice", "noul", "score", "multi", "act"]
+    instructions: JsonValue
+    criteria: dict[str, JsonValue] | list[JsonValue]
+    levels: dict[str, JsonValue] | list[JsonValue]
+    option_keys: Literal["show", "hide"]
+    evidence: bool
+    threshold: float
+    min: int
+    max: int
+    base: Literal["noul", "choice", "score"]
+    costs: dict[str, float] | dict[str, dict[str, float]]
+    defer_action: str
+    max_error: float
+
+
+class DecisionRequest(TypedDict):
+    state: JsonValue
+    questions: dict[str, Question]
+    model: NotRequired[str]
+    facts: NotRequired[Literal["off", "auto"]]
+
+
+class EvidenceSpan(TypedDict):
+    text: str
+    start: int
+    end: int
+    probability: float
+
+
+class Answer(TypedDict):
+    type: Literal["choice", "noul", "score", "multi", "act"]
+    probabilities: dict[str, float]
+    confidence: NotRequired[float]
+    choice: NotRequired[str]
+    noul: NotRequired[float]
+    score: NotRequired[float]
+    legend: NotRequired[dict[str, str]]
+    selected: NotRequired[list[str]]
+    threshold: NotRequired[float]
+    set_confidence: NotRequired[float]
+    action: NotRequired[str]
+    answer: NotRequired[str]
+    expected_costs: NotRequired[dict[str, float]]
+    calibration: NotRequired[Literal["validated", "unvalidated"]]
+    refused: NotRequired[str]
+    max_error: NotRequired[str]
+    evidence: NotRequired[list[EvidenceSpan]]
+
+
+class Usage(TypedDict):
+    input_tokens: int
+    output_tokens: int
+    questions: NotRequired[int]
+    branches: NotRequired[int]
+    latency_ms: NotRequired[float]
+
+
+class DecisionResponse(TypedDict):
+    model: str
+    answers: dict[str, Answer]
+    usage: Usage
+
+
+class ModelMetadata(TypedDict):
+    name: str
+    description: NotRequired[str]
+    release_date: NotRequired[str]
+    mode: NotRequired[str]
+    early_exit: NotRequired[list[JsonValue]]
+
+
+class ModelsResponse(TypedDict):
+    models: list[ModelMetadata]