spinf-client 0.3.0__tar.gz

spinf_client-0.3.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+# Lint and the test suite on every push and pull request. Two tests compare this repository with its neighbours: the vendored
+# evaluator against spinf-serve's pipeline.py, and the pack evaluator against the spinf/moderation pack files of spinf-prompts;
+# both checkouts are optional (the tests skip without them). SPINF_SERVE_REPO / SPINF_PROMPTS_REPO (repository variables) and
+# SPINF_SERVE_TOKEN / SPINF_PROMPTS_TOKEN (secrets) point a fork or a mirror at its own copies; unset, the public ones are used.
+name: ci
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/checkout@v7
+        id: serve
+        continue-on-error: true
+        with:
+          repository: ${{ vars.SPINF_SERVE_REPO || 'spinfinc/spinf-serve' }}
+          token: ${{ secrets.SPINF_SERVE_TOKEN || github.token }}
+          path: .spinf-serve
+      - uses: actions/checkout@v7
+        id: prompts
+        continue-on-error: true
+        with:
+          repository: ${{ vars.SPINF_PROMPTS_REPO || 'spinfinc/spinf-prompts' }}
+          token: ${{ secrets.SPINF_PROMPTS_TOKEN || github.token }}
+          path: .spinf-prompts
+      - uses: astral-sh/setup-uv@v10.2.0
+      - run: uv sync --frozen
+      - run: uv run ruff check . && uv run ruff format --check src tests
+      - run: uv run pytest
+        env:
+          SPINF_SERVE_DIR: ${{ steps.serve.outcome == 'success' && format('{0}/.spinf-serve', github.workspace) || '' }}
+          SPINF_PROMPTS_DIR: ${{ steps.prompts.outcome == 'success' && format('{0}/.spinf-prompts', github.workspace) || '' }}

spinf_client-0.3.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.egg-info/
+dist/
+.pytest_cache/
+.ruff_cache/
+tests/.packs/

spinf_client-0.3.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 2026 spinf Inc.
+
+   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.

spinf_client-0.3.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.5
+Name: spinf-client
+Version: 0.3.0
+Summary: Python client for the spinf scoring API, hosted or self-hosted with spinf-serve: scored queries, extraction slots, images and video frames, prompt packs and content moderation
+Project-URL: Homepage, https://spinf.com
+Project-URL: Repository, https://github.com/spinfinc/spinf-client
+Project-URL: Server, https://github.com/spinfinc/spinf-serve
+Project-URL: Packs, https://github.com/spinfinc/spinf-prompts
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Provides-Extra: media
+Requires-Dist: pillow>=10; extra == 'media'
+Description-Content-Type: text/markdown
+
+# spinf-client
+
+Python client for the spinf scoring API: scored queries (`{?}` + options), extraction slots (`{*}` text, `{n}` number,
+`{$}` amount), images and video frames, prompt packs and content moderation. One runtime dependency (httpx). The same
+client talks to the hosted API at `api.spinf.com` and to a [spinf-serve](https://github.com/spinfinc/spinf-serve) of your own:
+the request and the response are the same, only the base URL and the key change.
+
+```bash
+pip install "spinf-client[media]"          # the media extra adds Pillow for images; video frames also need ffmpeg / ffprobe on PATH
+export SPINF_API_KEY=sk-...                # the hosted API
+```
+
+```python
+from spinf_client import SpinfClient
+
+client = SpinfClient()                                                                  # api.spinf.com, model "spinf-12b"
+client = SpinfClient(base_url="http://localhost:8000", model="spinf/gemma-4-12b-fp8")   # your own spinf-serve
+```
+
+A spinf-serve started without `--token` needs no key (`SPINF_API_URL` sets the base URL from the environment); one started
+with a token takes it as `api_key`. The hosted model names (`spinf-12b`, `spinf-31b`) are aliases of the Hub names
+(`spinf/gemma-4-12b-fp8`, `spinf/gemma-4-31b-fp8`) and both work on both. Account, pricing and billing (`client.account()`,
+`client.pricing()`, `billed_tokens()`) and the per-account features (extraction slots, video, the content limit) belong to
+the hosted API; a server of your own has every feature on and no bill.
+
+## Score and extract
+
+```python
+from spinf_client import SpinfClient, answers, query, text
+
+client = SpinfClient()  # model="spinf-12b" by default (or "spinf-31b", ...)
+out = client.score(
+    content=[text("Apple sold 3.5 million iPhones in the quarter, up from 3.1 million.")],
+    queries=[
+        query("dir", "\n\nDid iPhone sales go{?}", options=[" up", " down"]),       # scored
+        query("units", "\n\nQ: How many iPhones were sold?\nA:{n}"),                # a number
+        query("co", '\n\nThe company in this news is "{*}"', top_k=3),              # text: in quotes, name the thing
+    ],
+)
+answers(out, "units")   # {"answers": [{"text": "3.5 million", "p": 0.62, "value": 3500000.0}, ...], "mass": ..., "p_negative": 0.0}
+```
+
+Slots:
+
+| slot | the answer | ends |
+|---|---|---|
+| `{*}` | any text; write the template with an opening quote: `... is "{*}"` | at the text after the slot (the closing quote) or a newline |
+| `{n}` | a number: sign or accounting brackets, thousands separators, decimals, `thousand` / `million` / `billion`, `%` | when the next token cannot continue the number |
+| `{$}` | the same with an optional currency symbol (`$ € £ ¥`), returned as `currency` | the same |
+
+Each extraction returns the most likely answers (merged over spellings: text by case / punctuation / spaces, numbers by
+value) with their probabilities, `mass` (the probability on all answers found) and, for numbers, `p_negative` (the share
+of the top value's magnitude on its negative: brackets in accounting tables are often ambiguous). `max_tokens` 1-64
+(default 16; up to 100 generated), `top_k` 1-20 (default 5). At most **10 slots per content** (queries × combinations). Extraction slots have
+no empty floor.
+
+`generate=True` on a `{*}` slot writes free text instead of searching short answers (a one-sentence summary, a caption):
+greedy by default, or `generate={"temperature": 0.7, "top_p": 0.8, "top_k": 20, "seed": 0, "n": 1}` to sample `n` sequences
+reproducibly; `max_tokens` caps the length (up to 100). Answers come back as `{text, finish}` ("stop" at the closing quote, a newline
+or end of text; "length" at the cap) with no probability; same account feature, billed as a generated slot (2,000 tokens flat against
+500 for a searched one); no `top_k` / `calibration` with it.
+
+Writing extraction templates (what the tests showed):
+
+- `{*}`: in quotes, and name what goes there. `The company is "{*}"` reads as an adjective slot ("on track");
+  `The company in this news is "{*}"` gives "Apple". Without quotes the model also writes formatting (`<strong>Apple</strong>`).
+- `{n}` / `{$}`: no quotes and no filler; end right at the slot (`\nQ: How many ...?\nA:{n}` or `\nUnits sold: {n}`).
+- One number slot for integers and decimals: check integer-ness on `value`. Use `{$}` on financial content.
+- Take the sign from `p_negative`, not from the top answer.
+- When the answers are a known short list, a scored question (`{?}` + options) is cheaper and has an empty floor.
+
+## Calibrate a field
+
+The raw probability ranks right answers above wrong ones but is under-confident by a field-dependent amount. Fit the
+correction once per field on ~50 labelled examples:
+
+```python
+from spinf_client import calibration
+
+a, b = calibration.fit(ps, rights)   # ps: the top answer's p per example, rights: was it right
+query("amount", "\n\nQ: What was the revenue in 2019?\nA:{$}", calibration=(a, b))   # -> p_calibrated
+```
+
+Without labels, `calibration.DEFAULT_MAPS[model]` is right on average but can be off by ~0.2 on a field.
+
+## Images and video
+
+```python
+from spinf_client import image, video
+
+client.score(content=[image("photo.jpg", detail="auto"), text("\n")],
+             queries=[query("what", '\nThis is a photo of "{*}"')])
+
+# frames are sampled here with ffmpeg (the API never decodes video) and resized to the size the model reads
+part = video("ad.mp4", num_frames=20, detail="low")          # or fps=1
+client.score(content=[text("A 31-second TV commercial:\n"), part, text("\n")],
+             queries=[query("brand", '\nThe brand featured in this commercial is "{*}"')])
+```
+
+A video is read as Gemma reads video, in place in the content: each frame an image at `detail` (low = up to 70 tokens)
+after its `mm:ss` timestamp (7 text tokens). `media.video_tokens(w, h, n)` gives the content tokens (32 low frames of a
+16:9 video: 2,399). ~20 low frames were enough for the brand of a Super Bowl ad (0.95 right on the 12B, 0.975 on the
+31B). The request body is limited to 2 MB: ~80 low frames (~17 KB each as JPEG).
+
+## Content moderation
+
+The hosted `spinf/moderation` pack gives every text a calibrated 0–1 score per category (sexual, child safety,
+violence, self-harm, hate, harassment, extremism, weapons, drugs, crime, fraud, hacking, privacy, spam, profanity,
+gore, gibberish, a general score and four topics), its percentile on normal traffic, and a safe / unsafe decision.
+The API does all of it in the call; nothing is computed here unless you ask.
+
+```python
+r = client.moderate("Immigrants are vermin and should be thrown out.")
+r.unsafe, r.flagged            # True, ["hate", "general"]
+r.categories["hate"]           # Category(score=0.81, percentile=0.999, flagged=True)
+r.top(3), r.decision           # the decision as returned: mode, score, threshold, critical, ...
+
+rs = client.moderate(posts, context="forum")    # "ai" (a message to an assistant, default) or "forum" (a post)
+```
+
+Decide your way (all optional, the pack's defaults otherwise):
+
+| argument | what it does |
+|---|---|
+| `mode` | `micro_layer` (default: a small linear layer over the category scores and general reads), `max` (the highest category score against one threshold) or `per_category` (any category over its own threshold) |
+| `threshold` | the one cut of `max` (0–1) or `micro_layer` (the layer's value) |
+| `thresholds` | per category, `{"violence": 0.8, "profanity": None}`; `None` = reported, never decides. They set `flagged` in every mode. Defaults: the score 0.5% of normal traffic reaches |
+| `critical` | categories that make a text unsafe whenever flagged, whatever the mode (default `["selfharm", "child"]`; `[]` = none) |
+| `version` | pin the pack version (`client.list_packs()`) to keep scores comparable over time |
+| `queries` | your own queries, scored in the same pass on the same content (`r.queries`) |
+
+Texts are sent in batches of 64 (`batch_size`); the result list keeps their order (`ids=` names them).
+
+**Your thresholds from your data** (no retraining; standard library):
+
+```python
+from spinf_client import moderation
+
+sample = client.moderate(my_normal_traffic, context="forum")          # a few thousand typical texts
+t = moderation.rate_thresholds(sample, rate=0.002)                    # flag 0.2% of it per category
+t = moderation.fit_thresholds(labelled, labels)                       # or: best F1 on texts you labelled
+                                                                      # (labels[i] = {"hate", ...}, empty = fine)
+cut = moderation.best_threshold([r.score for r in res], is_unsafe)    # one cut for mode="max" / "micro_layer"
+client.moderate(texts, mode="per_category", thresholds=t)
+```
+
+**Re-decide without scoring again:** score with `include_queries=True` (the pack's raw query results stay on
+`r.raw`), then try other modes, thresholds or critical lists locally:
+
+```python
+pack_file = client.get_pack("spinf/moderation", r.version)   # the pack file (keep it; it changes only by version)
+r.redecide(pack_file, mode="max", threshold=0.8, thresholds={"spam": None}, critical=[])   # -> Moderation
+```
+
+The local evaluator (`packs`) is the API's own, in the standard library: a verbatim copy of spinf-serve's
+`spinf_serve/packs/pipeline.py`, kept identical by a test; it reproduces the API's scores to 1e-6.
+
+**Edit the pack:** `client.moderate(texts, pack_file=edited)` sends an edited copy's questions as ordinary queries and
+decides here. Thresholds and the critical list are yours to change; any change to the questions, reads or calibration
+breaks the micro-layer's lock (a sha256 over them), and the pack's fallback mode (`per_category`) decides, with a
+`warning` in the decision.
+
+**Other packs and your own queries in one call:** `score()` takes `packs=[pack(id, ...)]` next to `queries`; each
+result carries `packs` (`pack_result(out, id)`). `pack()` takes the same decision arguments as `moderate()`.
+
+## Pricing and usage
+
+```python
+from spinf_client import billed_tokens
+
+pricing = client.pricing()            # what this account can use: models, media rates, extraction, content limit
+m = next(x for x in pricing["models"] if x["model"] == "spinf-12b")
+billed_tokens(m, text_tokens=150, frames={"low": 20}, query_tokens=23, floor_tokens=14, slots_per_content=[1])  # 2687
+```
+
+Billed tokens = text (content text and timestamps) + images and frames at the model's rate per detail + audio per
+second + question and floor tokens + extraction (500 tokens a searched slot, 2,000 a generated one), at least 1,000 a
+call, at the model's price per million. The response's `usage.prompt_tokens_details` reports `text_tokens`, `media`
+(`images`, `video_frames`, `audio_seconds`, `billed_media_tokens`) and `extraction` (`slots`, `generated_slots`,
+`billed_tokens`);
+`usage.billed_tokens` is what is charged. `client.models()` and `client.account()` wrap `GET /v1/models` and
+`GET /v1/account`.
+
+Errors raise `SpinfError` (`status`, `code`, `message`, `param`): e.g. `403 feature_not_enabled` (extraction not
+enabled), `403 media_not_allowed` (video not enabled), `400 too_many_extractions`, `400 content_too_long` (over the
+account's content limit), `413 body_too_large`. 429 / 5xx (including `503 warming_up`) and timeouts are retried.

spinf_client-0.3.0/README.md

@@ -0,0 +1,186 @@
+# spinf-client
+
+Python client for the spinf scoring API: scored queries (`{?}` + options), extraction slots (`{*}` text, `{n}` number,
+`{$}` amount), images and video frames, prompt packs and content moderation. One runtime dependency (httpx). The same
+client talks to the hosted API at `api.spinf.com` and to a [spinf-serve](https://github.com/spinfinc/spinf-serve) of your own:
+the request and the response are the same, only the base URL and the key change.
+
+```bash
+pip install "spinf-client[media]"          # the media extra adds Pillow for images; video frames also need ffmpeg / ffprobe on PATH
+export SPINF_API_KEY=sk-...                # the hosted API
+```
+
+```python
+from spinf_client import SpinfClient
+
+client = SpinfClient()                                                                  # api.spinf.com, model "spinf-12b"
+client = SpinfClient(base_url="http://localhost:8000", model="spinf/gemma-4-12b-fp8")   # your own spinf-serve
+```
+
+A spinf-serve started without `--token` needs no key (`SPINF_API_URL` sets the base URL from the environment); one started
+with a token takes it as `api_key`. The hosted model names (`spinf-12b`, `spinf-31b`) are aliases of the Hub names
+(`spinf/gemma-4-12b-fp8`, `spinf/gemma-4-31b-fp8`) and both work on both. Account, pricing and billing (`client.account()`,
+`client.pricing()`, `billed_tokens()`) and the per-account features (extraction slots, video, the content limit) belong to
+the hosted API; a server of your own has every feature on and no bill.
+
+## Score and extract
+
+```python
+from spinf_client import SpinfClient, answers, query, text
+
+client = SpinfClient()  # model="spinf-12b" by default (or "spinf-31b", ...)
+out = client.score(
+    content=[text("Apple sold 3.5 million iPhones in the quarter, up from 3.1 million.")],
+    queries=[
+        query("dir", "\n\nDid iPhone sales go{?}", options=[" up", " down"]),       # scored
+        query("units", "\n\nQ: How many iPhones were sold?\nA:{n}"),                # a number
+        query("co", '\n\nThe company in this news is "{*}"', top_k=3),              # text: in quotes, name the thing
+    ],
+)
+answers(out, "units")   # {"answers": [{"text": "3.5 million", "p": 0.62, "value": 3500000.0}, ...], "mass": ..., "p_negative": 0.0}
+```
+
+Slots:
+
+| slot | the answer | ends |
+|---|---|---|
+| `{*}` | any text; write the template with an opening quote: `... is "{*}"` | at the text after the slot (the closing quote) or a newline |
+| `{n}` | a number: sign or accounting brackets, thousands separators, decimals, `thousand` / `million` / `billion`, `%` | when the next token cannot continue the number |
+| `{$}` | the same with an optional currency symbol (`$ € £ ¥`), returned as `currency` | the same |
+
+Each extraction returns the most likely answers (merged over spellings: text by case / punctuation / spaces, numbers by
+value) with their probabilities, `mass` (the probability on all answers found) and, for numbers, `p_negative` (the share
+of the top value's magnitude on its negative: brackets in accounting tables are often ambiguous). `max_tokens` 1-64
+(default 16; up to 100 generated), `top_k` 1-20 (default 5). At most **10 slots per content** (queries × combinations). Extraction slots have
+no empty floor.
+
+`generate=True` on a `{*}` slot writes free text instead of searching short answers (a one-sentence summary, a caption):
+greedy by default, or `generate={"temperature": 0.7, "top_p": 0.8, "top_k": 20, "seed": 0, "n": 1}` to sample `n` sequences
+reproducibly; `max_tokens` caps the length (up to 100). Answers come back as `{text, finish}` ("stop" at the closing quote, a newline
+or end of text; "length" at the cap) with no probability; same account feature, billed as a generated slot (2,000 tokens flat against
+500 for a searched one); no `top_k` / `calibration` with it.
+
+Writing extraction templates (what the tests showed):
+
+- `{*}`: in quotes, and name what goes there. `The company is "{*}"` reads as an adjective slot ("on track");
+  `The company in this news is "{*}"` gives "Apple". Without quotes the model also writes formatting (`<strong>Apple</strong>`).
+- `{n}` / `{$}`: no quotes and no filler; end right at the slot (`\nQ: How many ...?\nA:{n}` or `\nUnits sold: {n}`).
+- One number slot for integers and decimals: check integer-ness on `value`. Use `{$}` on financial content.
+- Take the sign from `p_negative`, not from the top answer.
+- When the answers are a known short list, a scored question (`{?}` + options) is cheaper and has an empty floor.
+
+## Calibrate a field
+
+The raw probability ranks right answers above wrong ones but is under-confident by a field-dependent amount. Fit the
+correction once per field on ~50 labelled examples:
+
+```python
+from spinf_client import calibration
+
+a, b = calibration.fit(ps, rights)   # ps: the top answer's p per example, rights: was it right
+query("amount", "\n\nQ: What was the revenue in 2019?\nA:{$}", calibration=(a, b))   # -> p_calibrated
+```
+
+Without labels, `calibration.DEFAULT_MAPS[model]` is right on average but can be off by ~0.2 on a field.
+
+## Images and video
+
+```python
+from spinf_client import image, video
+
+client.score(content=[image("photo.jpg", detail="auto"), text("\n")],
+             queries=[query("what", '\nThis is a photo of "{*}"')])
+
+# frames are sampled here with ffmpeg (the API never decodes video) and resized to the size the model reads
+part = video("ad.mp4", num_frames=20, detail="low")          # or fps=1
+client.score(content=[text("A 31-second TV commercial:\n"), part, text("\n")],
+             queries=[query("brand", '\nThe brand featured in this commercial is "{*}"')])
+```
+
+A video is read as Gemma reads video, in place in the content: each frame an image at `detail` (low = up to 70 tokens)
+after its `mm:ss` timestamp (7 text tokens). `media.video_tokens(w, h, n)` gives the content tokens (32 low frames of a
+16:9 video: 2,399). ~20 low frames were enough for the brand of a Super Bowl ad (0.95 right on the 12B, 0.975 on the
+31B). The request body is limited to 2 MB: ~80 low frames (~17 KB each as JPEG).
+
+## Content moderation
+
+The hosted `spinf/moderation` pack gives every text a calibrated 0–1 score per category (sexual, child safety,
+violence, self-harm, hate, harassment, extremism, weapons, drugs, crime, fraud, hacking, privacy, spam, profanity,
+gore, gibberish, a general score and four topics), its percentile on normal traffic, and a safe / unsafe decision.
+The API does all of it in the call; nothing is computed here unless you ask.
+
+```python
+r = client.moderate("Immigrants are vermin and should be thrown out.")
+r.unsafe, r.flagged            # True, ["hate", "general"]
+r.categories["hate"]           # Category(score=0.81, percentile=0.999, flagged=True)
+r.top(3), r.decision           # the decision as returned: mode, score, threshold, critical, ...
+
+rs = client.moderate(posts, context="forum")    # "ai" (a message to an assistant, default) or "forum" (a post)
+```
+
+Decide your way (all optional, the pack's defaults otherwise):
+
+| argument | what it does |
+|---|---|
+| `mode` | `micro_layer` (default: a small linear layer over the category scores and general reads), `max` (the highest category score against one threshold) or `per_category` (any category over its own threshold) |
+| `threshold` | the one cut of `max` (0–1) or `micro_layer` (the layer's value) |
+| `thresholds` | per category, `{"violence": 0.8, "profanity": None}`; `None` = reported, never decides. They set `flagged` in every mode. Defaults: the score 0.5% of normal traffic reaches |
+| `critical` | categories that make a text unsafe whenever flagged, whatever the mode (default `["selfharm", "child"]`; `[]` = none) |
+| `version` | pin the pack version (`client.list_packs()`) to keep scores comparable over time |
+| `queries` | your own queries, scored in the same pass on the same content (`r.queries`) |
+
+Texts are sent in batches of 64 (`batch_size`); the result list keeps their order (`ids=` names them).
+
+**Your thresholds from your data** (no retraining; standard library):
+
+```python
+from spinf_client import moderation
+
+sample = client.moderate(my_normal_traffic, context="forum")          # a few thousand typical texts
+t = moderation.rate_thresholds(sample, rate=0.002)                    # flag 0.2% of it per category
+t = moderation.fit_thresholds(labelled, labels)                       # or: best F1 on texts you labelled
+                                                                      # (labels[i] = {"hate", ...}, empty = fine)
+cut = moderation.best_threshold([r.score for r in res], is_unsafe)    # one cut for mode="max" / "micro_layer"
+client.moderate(texts, mode="per_category", thresholds=t)
+```
+
+**Re-decide without scoring again:** score with `include_queries=True` (the pack's raw query results stay on
+`r.raw`), then try other modes, thresholds or critical lists locally:
+
+```python
+pack_file = client.get_pack("spinf/moderation", r.version)   # the pack file (keep it; it changes only by version)
+r.redecide(pack_file, mode="max", threshold=0.8, thresholds={"spam": None}, critical=[])   # -> Moderation
+```
+
+The local evaluator (`packs`) is the API's own, in the standard library: a verbatim copy of spinf-serve's
+`spinf_serve/packs/pipeline.py`, kept identical by a test; it reproduces the API's scores to 1e-6.
+
+**Edit the pack:** `client.moderate(texts, pack_file=edited)` sends an edited copy's questions as ordinary queries and
+decides here. Thresholds and the critical list are yours to change; any change to the questions, reads or calibration
+breaks the micro-layer's lock (a sha256 over them), and the pack's fallback mode (`per_category`) decides, with a
+`warning` in the decision.
+
+**Other packs and your own queries in one call:** `score()` takes `packs=[pack(id, ...)]` next to `queries`; each
+result carries `packs` (`pack_result(out, id)`). `pack()` takes the same decision arguments as `moderate()`.
+
+## Pricing and usage
+
+```python
+from spinf_client import billed_tokens
+
+pricing = client.pricing()            # what this account can use: models, media rates, extraction, content limit
+m = next(x for x in pricing["models"] if x["model"] == "spinf-12b")
+billed_tokens(m, text_tokens=150, frames={"low": 20}, query_tokens=23, floor_tokens=14, slots_per_content=[1])  # 2687
+```
+
+Billed tokens = text (content text and timestamps) + images and frames at the model's rate per detail + audio per
+second + question and floor tokens + extraction (500 tokens a searched slot, 2,000 a generated one), at least 1,000 a
+call, at the model's price per million. The response's `usage.prompt_tokens_details` reports `text_tokens`, `media`
+(`images`, `video_frames`, `audio_seconds`, `billed_media_tokens`) and `extraction` (`slots`, `generated_slots`,
+`billed_tokens`);
+`usage.billed_tokens` is what is charged. `client.models()` and `client.account()` wrap `GET /v1/models` and
+`GET /v1/account`.
+
+Errors raise `SpinfError` (`status`, `code`, `message`, `param`): e.g. `403 feature_not_enabled` (extraction not
+enabled), `403 media_not_allowed` (video not enabled), `400 too_many_extractions`, `400 content_too_long` (over the
+account's content limit), `413 body_too_large`. 429 / 5xx (including `503 warming_up`) and timeouts are retried.