finest-ai 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- finest_ai-0.1.0/.gitignore +37 -0
- finest_ai-0.1.0/LICENSE +202 -0
- finest_ai-0.1.0/PKG-INFO +255 -0
- finest_ai-0.1.0/README.md +230 -0
- finest_ai-0.1.0/pyproject.toml +49 -0
- finest_ai-0.1.0/src/finest_ai/__init__.py +416 -0
- finest_ai-0.1.0/src/finest_ai/_guard.py +54 -0
- finest_ai-0.1.0/src/finest_ai/_log.py +101 -0
- finest_ai-0.1.0/src/finest_ai/_transport.py +119 -0
- finest_ai-0.1.0/src/finest_ai/_version.py +14 -0
- finest_ai-0.1.0/src/finest_ai/_wrap.py +812 -0
- finest_ai-0.1.0/src/finest_ai/canonical.py +272 -0
- finest_ai-0.1.0/src/finest_ai/config.py +373 -0
- finest_ai-0.1.0/src/finest_ai/constraints.py +43 -0
- finest_ai-0.1.0/src/finest_ai/ed25519.py +148 -0
- finest_ai-0.1.0/src/finest_ai/ids.py +54 -0
- finest_ai-0.1.0/src/finest_ai/journal.py +745 -0
- finest_ai-0.1.0/src/finest_ai/ownership.py +312 -0
- finest_ai-0.1.0/src/finest_ai/policy.py +176 -0
- finest_ai-0.1.0/src/finest_ai/pseudonym.py +22 -0
- finest_ai-0.1.0/src/finest_ai/py.typed +0 -0
- finest_ai-0.1.0/src/finest_ai/shapes.py +206 -0
- finest_ai-0.1.0/tests/conftest.py +212 -0
- finest_ai-0.1.0/tests/test_bootstrap.py +210 -0
- finest_ai-0.1.0/tests/test_canonical.py +195 -0
- finest_ai-0.1.0/tests/test_disable.py +88 -0
- finest_ai-0.1.0/tests/test_golden_vectors.py +195 -0
- finest_ai-0.1.0/tests/test_journal.py +601 -0
- finest_ai-0.1.0/tests/test_lifecycle.py +69 -0
- finest_ai-0.1.0/tests/test_never_raises.py +219 -0
- finest_ai-0.1.0/tests/test_ownership.py +152 -0
- finest_ai-0.1.0/tests/test_transport.py +114 -0
- finest_ai-0.1.0/tests/test_wrap.py +613 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# deps / builds
|
|
2
|
+
node_modules/
|
|
3
|
+
.pnpm-store/
|
|
4
|
+
dist/
|
|
5
|
+
build/
|
|
6
|
+
.next/
|
|
7
|
+
.turbo/
|
|
8
|
+
out/
|
|
9
|
+
coverage/
|
|
10
|
+
*.tsbuildinfo
|
|
11
|
+
__pycache__/
|
|
12
|
+
*.pyc
|
|
13
|
+
.venv/
|
|
14
|
+
.pytest_cache/
|
|
15
|
+
|
|
16
|
+
# secrets — never commit
|
|
17
|
+
.env
|
|
18
|
+
.env.*
|
|
19
|
+
!.env.example
|
|
20
|
+
*.pem
|
|
21
|
+
*.key
|
|
22
|
+
|
|
23
|
+
# runtime artifacts (keep summaries, drop bulk)
|
|
24
|
+
artifacts/**
|
|
25
|
+
!artifacts/gate-zero/
|
|
26
|
+
artifacts/gate-zero/**
|
|
27
|
+
!artifacts/gate-zero/*.md
|
|
28
|
+
!artifacts/gate-zero/*.json
|
|
29
|
+
!artifacts/gate-zero/*.png
|
|
30
|
+
|
|
31
|
+
# local state
|
|
32
|
+
.DS_Store
|
|
33
|
+
*.log
|
|
34
|
+
.finest-cache/
|
|
35
|
+
playwright-report/
|
|
36
|
+
test-results/
|
|
37
|
+
stripe-mock/
|
finest_ai-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Finest (finest.so)
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
finest_ai-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,255 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: finest-ai
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Finest observer SDK — see every job your code asks an AI model to do, without changing what it does.
|
|
5
|
+
Project-URL: Homepage, https://finest.so
|
|
6
|
+
Author-email: Finest <engineering@finest.so>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Keywords: anthropic,cost,finops,llm,observability,openai
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Requires-Dist: httpx>=0.27
|
|
22
|
+
Provides-Extra: dev
|
|
23
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# finest — the Python observer SDK
|
|
27
|
+
|
|
28
|
+
See every job your code asks an AI model to do. Change nothing about how it does it.
|
|
29
|
+
|
|
30
|
+
```python
|
|
31
|
+
import finest_ai
|
|
32
|
+
from openai import OpenAI
|
|
33
|
+
|
|
34
|
+
finest.init(
|
|
35
|
+
api_key="fnst_...",
|
|
36
|
+
environment="production",
|
|
37
|
+
spool_dir="/var/lib/my-app/finest-spool",
|
|
38
|
+
)
|
|
39
|
+
client = finest.wrap(OpenAI())
|
|
40
|
+
|
|
41
|
+
client.chat.completions.create(
|
|
42
|
+
model="...",
|
|
43
|
+
messages=[...],
|
|
44
|
+
finest={"route": "classify_support_ticket"}, # stripped before the request is sent
|
|
45
|
+
)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Two calls. Your requests still go from your process straight to your provider, on
|
|
49
|
+
your key. The in-process observer inspects the call to derive metadata; normal
|
|
50
|
+
request and response payloads do not transit or persist in Finest's control plane.
|
|
51
|
+
|
|
52
|
+
The Finest key authenticates a startup bootstrap against
|
|
53
|
+
`https://api.finest.so`: workspace identity, policy verification keys,
|
|
54
|
+
revocation epoch, and hard constraints become visible in `diagnostics()`. This
|
|
55
|
+
Python release remains deliberately observer-only even when bootstrap publishes
|
|
56
|
+
routing endpoints; it never presents bootstrap readiness as routing support.
|
|
57
|
+
|
|
58
|
+
For a local observer that must make no Finest network calls:
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
finest.init(offline=True)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## What it does
|
|
65
|
+
|
|
66
|
+
It records **metadata** about each model call — which job, which configuration,
|
|
67
|
+
how many tokens, how long, what the provider said it actually served — and hands
|
|
68
|
+
that to the control plane. That is what lets the console say *"your app asks AI to
|
|
69
|
+
do four jobs, and job 1 costs $84/month"* before anything is changed.
|
|
70
|
+
|
|
71
|
+
Content is not captured. Prompts and completions never leave your process.
|
|
72
|
+
|
|
73
|
+
## What it does not do
|
|
74
|
+
|
|
75
|
+
**It does not route.** Nothing this SDK observes can be sent to a different
|
|
76
|
+
model: there is no policy evaluation and no adapter in this tier. Routing is a
|
|
77
|
+
separate capability gated on a signed policy, and when it arrives in Python it
|
|
78
|
+
will arrive behind `finest.policy`, which already verifies exactly the same
|
|
79
|
+
signatures the TypeScript SDK does — see [Cross-language parity](#cross-language-parity).
|
|
80
|
+
|
|
81
|
+
## The three promises
|
|
82
|
+
|
|
83
|
+
**It never raises into your call.** Every stage around the provider call —
|
|
84
|
+
detection, annotation, hashing, journalling — runs inside a guard that logs once
|
|
85
|
+
and continues. `tests/test_never_raises.py` injects a failure at each stage in
|
|
86
|
+
turn and asserts your result comes back untouched. The provider call itself is
|
|
87
|
+
never wrapped: if OpenAI raises, you get that exception with its own traceback.
|
|
88
|
+
|
|
89
|
+
**Its healthy path does not block your call.** Recording is a bounded-queue put;
|
|
90
|
+
spooling and upload happen on a daemon thread, batched, with an `atexit` flush.
|
|
91
|
+
If that queue is already full, Finest fsyncs a local gap marker before returning
|
|
92
|
+
so overload cannot become a silent hole in savings evidence.
|
|
93
|
+
|
|
94
|
+
**`FINEST_DISABLE=1` removes it entirely.** `wrap()` returns *the object you
|
|
95
|
+
passed in* — the same object, asserted by identity in the test suite. Not a
|
|
96
|
+
disabled proxy: no proxy at all.
|
|
97
|
+
|
|
98
|
+
## Install
|
|
99
|
+
|
|
100
|
+
Python ≥ 3.10. One runtime dependency, `httpx`, imported lazily inside the
|
|
101
|
+
journal upload — a process without it still wraps, annotates and spools to disk;
|
|
102
|
+
only the upload stops, and that shows up as a gap marker rather than an error.
|
|
103
|
+
|
|
104
|
+
The package is not published, and the PyPI name `finest` belongs to the
|
|
105
|
+
unrelated FineST spatial-transcriptomics project. Do not run
|
|
106
|
+
`pip install finest`. Build and install the explicit wheel from this repository:
|
|
107
|
+
|
|
108
|
+
```sh
|
|
109
|
+
python -m pip install hatchling build
|
|
110
|
+
python -m build packages/sdk-python
|
|
111
|
+
pip install ./packages/sdk-python/dist/*.whl
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Route annotations
|
|
115
|
+
|
|
116
|
+
A route name describes the **job**, not the model:
|
|
117
|
+
|
|
118
|
+
```python
|
|
119
|
+
finest={"route": "extract_invoice_fields", "sticky_key": conversation_id}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Good: `classify_support_ticket`, `summarise_call_transcript`, `extract_invoice_fields`.
|
|
123
|
+
Bad: `gpt_call`, `claude_route_2`. The model behind a route is expected to
|
|
124
|
+
change — that is the entire point — so a model name in a route name is a name
|
|
125
|
+
that will be wrong next month.
|
|
126
|
+
|
|
127
|
+
`sticky_key` is what keeps a conversation, document or user on one side of a
|
|
128
|
+
canary. Sticky assignment is never by request id.
|
|
129
|
+
|
|
130
|
+
The raw value never enters the journal. Hosted bootstrap supplies a stable
|
|
131
|
+
workspace HMAC key; offline installs may set `FINEST_STICKY_HMAC_KEY` or pass
|
|
132
|
+
`sticky_hmac_key=` (minimum 32 bytes). The SDK writes only a purpose-separated
|
|
133
|
+
`stk_v1_journal_…` digest. Without a valid key it writes `null`, never the raw
|
|
134
|
+
identifier.
|
|
135
|
+
|
|
136
|
+
Calls with **no** annotation are still observed: they are grouped by template
|
|
137
|
+
hash under an `unannotated:` key and marked observer-only. An unannotated call is
|
|
138
|
+
never routed, by construction.
|
|
139
|
+
|
|
140
|
+
## What lands in the journal
|
|
141
|
+
|
|
142
|
+
The wire format is `ingestJournalRequestSchema` from `@finest-ai/schemas` — the same
|
|
143
|
+
contract the TypeScript SDK writes:
|
|
144
|
+
|
|
145
|
+
```json
|
|
146
|
+
{
|
|
147
|
+
"sdkVersion": "finest-python/0.1.0",
|
|
148
|
+
"attempts": [{ "attemptId": "01J...", "routeId": "rt_01J...", "usage": {...}, "...": "..." }],
|
|
149
|
+
"gapMarkers": [{ "fromTs": 0, "toTs": 0, "reason": "sink_unreachable", "estimatedLost": 3 }]
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Fields an in-process observer genuinely cannot determine — the serving region,
|
|
154
|
+
the pinned model version when the provider does not report one — are the literal
|
|
155
|
+
string `"unreported"`. A plausible-looking guess in a field the ledger reconciles
|
|
156
|
+
against would be worse than an absence.
|
|
157
|
+
|
|
158
|
+
### Gap markers
|
|
159
|
+
|
|
160
|
+
Anything the journal loses becomes a gap marker: an uploaded record saying
|
|
161
|
+
*"attempts existed here and we do not have them"*. Reasons are `spool_overflow`,
|
|
162
|
+
`process_exit`, `sink_unreachable`, `disk_full`, `unknown`.
|
|
163
|
+
|
|
164
|
+
A gap freezes savings evidence for its interval. That is deliberate: a period
|
|
165
|
+
we cannot account for cannot support a trustworthy savings claim. Usage-based
|
|
166
|
+
fee statement authority is not implemented in this release.
|
|
167
|
+
|
|
168
|
+
Two consequences of the ingest contract, both deliberate:
|
|
169
|
+
|
|
170
|
+
- **A gap marker can travel alone.** A gap-only batch is uploaded immediately;
|
|
171
|
+
it does not wait for a later provider call to make a known evidence hole
|
|
172
|
+
visible. Stable gap IDs make retries idempotent.
|
|
173
|
+
- **A spooled-but-unsent attempt is not a gap.** It is delayed, and the next
|
|
174
|
+
process delivers it. Claiming a gap there would tell you your telemetry has a
|
|
175
|
+
hole when it does not.
|
|
176
|
+
|
|
177
|
+
### Durability
|
|
178
|
+
|
|
179
|
+
Attempts are appended to an NDJSON spool and `fsync`-ed before the network is
|
|
180
|
+
attempted, so a `kill -9` between spool and upload loses nothing — the next
|
|
181
|
+
process picks the spool up. Attempt ids are ULIDs and ingest dedupes on them, so
|
|
182
|
+
an interrupted drain re-sends rather than duplicates. A torn trailing line is
|
|
183
|
+
dropped and reported as a `process_exit` gap, never parsed as truth.
|
|
184
|
+
|
|
185
|
+
Production requires an explicit persistent `spool_dir` (or
|
|
186
|
+
`FINEST_SPOOL_DIR`). Without one, wrapping is pass-through and diagnostics
|
|
187
|
+
reports `production_requires_explicit_spool_dir`; the SDK never substitutes a
|
|
188
|
+
shared `/tmp` spool. Every simultaneously running process or replica needs a
|
|
189
|
+
different persistent spool directory. A private owner record prevents live
|
|
190
|
+
processes from sharing mutable journal and route state; dead same-host owners
|
|
191
|
+
are reclaimed, while live, foreign-host, and malformed ownership fails closed.
|
|
192
|
+
|
|
193
|
+
## Cross-language parity
|
|
194
|
+
|
|
195
|
+
`finest.canonical` implements RFC 8785 (JCS) canonical JSON and `finest.ed25519`
|
|
196
|
+
implements RFC 8032 verification, both in the standard library alone.
|
|
197
|
+
|
|
198
|
+
`tests/test_golden_vectors.py` loads `packages/policy/golden/policy-vectors.json`
|
|
199
|
+
— generated by the **TypeScript** signer — and asserts that Python:
|
|
200
|
+
|
|
201
|
+
1. produces **byte-identical** canonical text for every vector;
|
|
202
|
+
2. reproduces every committed `canonicalSha256`;
|
|
203
|
+
3. verifies every `valid` and `boundary` vector;
|
|
204
|
+
4. rejects every `tampered` vector with the named rejection.
|
|
205
|
+
|
|
206
|
+
That is the proof two languages agree about *what was signed*, rather than merely
|
|
207
|
+
looking similar. The vectors deliberately exercise UTF-16 key ordering (which is
|
|
208
|
+
not code-point ordering once astral characters appear), minimal string escaping,
|
|
209
|
+
the integer range where a JS double and a Python `int` stop agreeing, and the one
|
|
210
|
+
key where `null` is legal.
|
|
211
|
+
|
|
212
|
+
Ed25519 is implemented here rather than taken as a dependency because `finest`'s
|
|
213
|
+
dependency set is a trust surface, and the alternative would pull a compiled
|
|
214
|
+
crypto library in to verify a 32-byte key a few times a minute. It **verifies
|
|
215
|
+
only** — there is no signing function and there must never be one, because a
|
|
216
|
+
data-plane SDK that could mint a policy would defeat the signature entirely.
|
|
217
|
+
|
|
218
|
+
## Diagnostics
|
|
219
|
+
|
|
220
|
+
```python
|
|
221
|
+
finest.diagnostics()
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
Returns a support-safe snapshot: counts, reasons, route names, whether an API key is
|
|
225
|
+
configured. It reports that a key *exists*, never its value. Nothing in this SDK
|
|
226
|
+
prints, hashes or transmits key material.
|
|
227
|
+
|
|
228
|
+
## Known limits of this version
|
|
229
|
+
|
|
230
|
+
- **Streaming evidence is terminal.** A `create(..., stream=True)` iterator is
|
|
231
|
+
wrapped and journalled only when it finishes, fails, or is closed. Usage and
|
|
232
|
+
served-model facts are accumulated when the provider emits them; omitted
|
|
233
|
+
terminal usage remains an honest zero for reconciliation. A stream created
|
|
234
|
+
but never consumed has no terminal attempt in this release.
|
|
235
|
+
- **Observer tier only.** Every attempt is `arm: "passthrough"` with
|
|
236
|
+
`policyId: null`. This SDK cannot emit a `challenger` arm.
|
|
237
|
+
- **Sync and async clients are supported; `.stream()` context managers are not
|
|
238
|
+
intercepted** — they pass through untouched.
|
|
239
|
+
|
|
240
|
+
## Tests
|
|
241
|
+
|
|
242
|
+
```sh
|
|
243
|
+
python3 -m venv packages/sdk-python/.venv
|
|
244
|
+
packages/sdk-python/.venv/bin/pip install pytest httpx
|
|
245
|
+
packages/sdk-python/.venv/bin/python -m pytest packages/sdk-python -q
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
The suite imports no provider package. Client shapes are detected by their call
|
|
249
|
+
paths, never by `import openai`, so the SDK works for a customer who has only one
|
|
250
|
+
provider installed — or a vendored fork of either.
|
|
251
|
+
|
|
252
|
+
## Licence
|
|
253
|
+
|
|
254
|
+
Apache-2.0. The data-plane SDK is open source on purpose: you should be able to
|
|
255
|
+
read every line that touches your traffic.
|