kvsig 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.
- kvsig-0.1.0/.gitignore +10 -0
- kvsig-0.1.0/LICENSE +202 -0
- kvsig-0.1.0/NOTICE +7 -0
- kvsig-0.1.0/PKG-INFO +124 -0
- kvsig-0.1.0/README.md +93 -0
- kvsig-0.1.0/pyproject.toml +71 -0
- kvsig-0.1.0/src/kvsig/__init__.py +128 -0
- kvsig-0.1.0/src/kvsig/_text.py +33 -0
- kvsig-0.1.0/src/kvsig/cbor.py +88 -0
- kvsig-0.1.0/src/kvsig/dialects/__init__.py +10 -0
- kvsig-0.1.0/src/kvsig/dialects/anthropic_messages.py +225 -0
- kvsig-0.1.0/src/kvsig/dialects/openai_chat.py +224 -0
- kvsig-0.1.0/src/kvsig/dialects/openai_responses.py +263 -0
- kvsig-0.1.0/src/kvsig/ids.py +224 -0
- kvsig-0.1.0/src/kvsig/jsontext.py +121 -0
- kvsig-0.1.0/src/kvsig/keys.py +68 -0
- kvsig-0.1.0/src/kvsig/loose.py +217 -0
- kvsig-0.1.0/src/kvsig/model.py +188 -0
- kvsig-0.1.0/src/kvsig/py.typed +0 -0
- kvsig-0.1.0/tests/test_anthropic.py +190 -0
- kvsig-0.1.0/tests/test_canonical.py +352 -0
- kvsig-0.1.0/tests/test_cbor.py +77 -0
- kvsig-0.1.0/tests/test_cbor_xcheck.py +39 -0
- kvsig-0.1.0/tests/test_equivalence.py +214 -0
- kvsig-0.1.0/tests/test_ids.py +319 -0
- kvsig-0.1.0/tests/test_jsontext.py +99 -0
- kvsig-0.1.0/tests/test_loose.py +121 -0
- kvsig-0.1.0/tests/test_responses.py +152 -0
- kvsig-0.1.0/tests/test_system_shapes.py +123 -0
kvsig-0.1.0/.gitignore
ADDED
kvsig-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
kvsig-0.1.0/NOTICE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
kvsig
|
|
2
|
+
Copyright 2026 The PodWarden Team
|
|
3
|
+
|
|
4
|
+
The code and test vectors in this repository are licensed under the Apache
|
|
5
|
+
License, Version 2.0 (see LICENSE). The specification text (SPEC.md and docs/)
|
|
6
|
+
is licensed under the Creative Commons Attribution 4.0 International licence
|
|
7
|
+
(see LICENSE-SPEC).
|
kvsig-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: kvsig
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Keyed, content-derived ids for LLM chat conversations: the kvsig reference implementation
|
|
5
|
+
Project-URL: Homepage, https://github.com/Podwarden/kvsig
|
|
6
|
+
Project-URL: Source, https://github.com/Podwarden/kvsig
|
|
7
|
+
Project-URL: Specification, https://github.com/Podwarden/kvsig/blob/main/SPEC.md
|
|
8
|
+
Project-URL: Test vectors, https://github.com/Podwarden/kvsig/tree/main/vectors
|
|
9
|
+
Project-URL: Changelog, https://github.com/Podwarden/kvsig/blob/main/CHANGELOG.md
|
|
10
|
+
Project-URL: Issues, https://github.com/Podwarden/kvsig/issues
|
|
11
|
+
Author: The PodWarden Team
|
|
12
|
+
License-Expression: Apache-2.0
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
License-File: NOTICE
|
|
15
|
+
Keywords: anthropic,conversation-id,gateway,hmac,llm,openai,prompt-cache,routing,session-affinity
|
|
16
|
+
Classifier: Development Status :: 3 - Alpha
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
25
|
+
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
|
|
26
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
27
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
28
|
+
Classifier: Typing :: Typed
|
|
29
|
+
Requires-Python: >=3.10
|
|
30
|
+
Description-Content-Type: text/markdown
|
|
31
|
+
|
|
32
|
+
# kvsig for Python
|
|
33
|
+
|
|
34
|
+
Keyed, content-derived ids for LLM chat conversations. This is the reference
|
|
35
|
+
implementation of the [kvsig specification](https://github.com/Podwarden/kvsig/blob/main/SPEC.md)
|
|
36
|
+
(`kvsig/1`, draft 0.1): pure Python, no third-party dependencies, typed.
|
|
37
|
+
|
|
38
|
+
A gateway or router that sees a stream of stateless chat requests can use it to
|
|
39
|
+
tell which conversation each request belongs to, which prefix it shares with an
|
|
40
|
+
earlier request, and whether the system prompt or the tools changed, the same
|
|
41
|
+
way in OpenAI Chat Completions, OpenAI Responses and Anthropic Messages.
|
|
42
|
+
|
|
43
|
+
## Install
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pip install kvsig
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Python 3.10 or later.
|
|
50
|
+
|
|
51
|
+
## Quickstart
|
|
52
|
+
|
|
53
|
+
```python
|
|
54
|
+
from kvsig import Key, canonicalize, ids
|
|
55
|
+
|
|
56
|
+
key = Key.generate(epoch=1) # one per deployment; keep it secret and keep it
|
|
57
|
+
body = {
|
|
58
|
+
"model": "m",
|
|
59
|
+
"messages": [
|
|
60
|
+
{"role": "system", "content": "You answer geography questions."},
|
|
61
|
+
{"role": "user", "content": "What is the capital of France?"},
|
|
62
|
+
{"role": "assistant", "content": "Paris."},
|
|
63
|
+
{"role": "user", "content": "And Spain?"},
|
|
64
|
+
],
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
canon = canonicalize(body, "openai.chat") # None means "this request gets no ids"
|
|
68
|
+
if canon is not None:
|
|
69
|
+
i = ids(canon, key)
|
|
70
|
+
i.conv # conversation id: stable across turns, reminders, dates and tool changes
|
|
71
|
+
i.nodes[-1] # id of the whole prefix, like a git commit
|
|
72
|
+
i.sys, i.tools # the two halves of the head: which one changed?
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The same conversation sent as `"anthropic.messages"` or `"openai.responses"`
|
|
76
|
+
gives the same ids. Hostile or oversized input never raises; it gives `None`.
|
|
77
|
+
|
|
78
|
+
To check your install against the published test vectors, use the published
|
|
79
|
+
test key (epoch 0) on the vector
|
|
80
|
+
[`openai.chat/conv-base`](https://github.com/Podwarden/kvsig/blob/main/vectors/v1/openai.chat/conv-base.json):
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
import json
|
|
84
|
+
from kvsig import TEST_KEY, canonicalize, ids
|
|
85
|
+
|
|
86
|
+
v = json.load(open("vectors/v1/openai.chat/conv-base.json"))
|
|
87
|
+
i = ids(canonicalize(v["input"], v["dialect"]), TEST_KEY)
|
|
88
|
+
assert i.conv == v["expect"]["keys"]["0"]["conv"] # "00fdd9bdfb7d14a82cb5d7d4d70ac60046"
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## What 0.1 guarantees
|
|
92
|
+
|
|
93
|
+
- For the spec label `kvsig/1` and the loose profile `loose/1` (the default),
|
|
94
|
+
canonical bytes and ids are pinned by the
|
|
95
|
+
[`vectors/v1`](https://github.com/Podwarden/kvsig/tree/main/vectors) test
|
|
96
|
+
vectors. No later release changes them; a change ships under a new label or
|
|
97
|
+
profile version instead.
|
|
98
|
+
- `LOOSE_V2` (`loose/2`, decision 0005) is included but **experimental**: it is
|
|
99
|
+
not covered by the vectors yet and its ids may change until its decision is
|
|
100
|
+
accepted.
|
|
101
|
+
- The full policy is in the [specification](https://github.com/Podwarden/kvsig/blob/main/SPEC.md#versioning-and-compatibility).
|
|
102
|
+
|
|
103
|
+
## Learn more
|
|
104
|
+
|
|
105
|
+
- [Reading the ids](https://github.com/Podwarden/kvsig/blob/main/docs/reading-the-ids.md):
|
|
106
|
+
what each id identifies, and how to tell what changed between two requests.
|
|
107
|
+
- [Conformance runner](https://github.com/Podwarden/kvsig/tree/main/conformance):
|
|
108
|
+
check any implementation, in any language, against the vectors.
|
|
109
|
+
- [Changelog](https://github.com/Podwarden/kvsig/blob/main/CHANGELOG.md).
|
|
110
|
+
|
|
111
|
+
## Development
|
|
112
|
+
|
|
113
|
+
From `python/` in a checkout:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
uv run --with pytest pytest -q
|
|
117
|
+
uv run --with ruff ruff check . && uv run --with ruff ruff format --check .
|
|
118
|
+
python ../conformance/run.py -- python ../conformance/adapters/python_adapter.py
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Licence
|
|
122
|
+
|
|
123
|
+
Apache-2.0. The specification text is licensed separately under CC BY 4.0; see
|
|
124
|
+
[NOTICE](https://github.com/Podwarden/kvsig/blob/main/NOTICE).
|
kvsig-0.1.0/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# kvsig for Python
|
|
2
|
+
|
|
3
|
+
Keyed, content-derived ids for LLM chat conversations. This is the reference
|
|
4
|
+
implementation of the [kvsig specification](https://github.com/Podwarden/kvsig/blob/main/SPEC.md)
|
|
5
|
+
(`kvsig/1`, draft 0.1): pure Python, no third-party dependencies, typed.
|
|
6
|
+
|
|
7
|
+
A gateway or router that sees a stream of stateless chat requests can use it to
|
|
8
|
+
tell which conversation each request belongs to, which prefix it shares with an
|
|
9
|
+
earlier request, and whether the system prompt or the tools changed, the same
|
|
10
|
+
way in OpenAI Chat Completions, OpenAI Responses and Anthropic Messages.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pip install kvsig
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Python 3.10 or later.
|
|
19
|
+
|
|
20
|
+
## Quickstart
|
|
21
|
+
|
|
22
|
+
```python
|
|
23
|
+
from kvsig import Key, canonicalize, ids
|
|
24
|
+
|
|
25
|
+
key = Key.generate(epoch=1) # one per deployment; keep it secret and keep it
|
|
26
|
+
body = {
|
|
27
|
+
"model": "m",
|
|
28
|
+
"messages": [
|
|
29
|
+
{"role": "system", "content": "You answer geography questions."},
|
|
30
|
+
{"role": "user", "content": "What is the capital of France?"},
|
|
31
|
+
{"role": "assistant", "content": "Paris."},
|
|
32
|
+
{"role": "user", "content": "And Spain?"},
|
|
33
|
+
],
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
canon = canonicalize(body, "openai.chat") # None means "this request gets no ids"
|
|
37
|
+
if canon is not None:
|
|
38
|
+
i = ids(canon, key)
|
|
39
|
+
i.conv # conversation id: stable across turns, reminders, dates and tool changes
|
|
40
|
+
i.nodes[-1] # id of the whole prefix, like a git commit
|
|
41
|
+
i.sys, i.tools # the two halves of the head: which one changed?
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The same conversation sent as `"anthropic.messages"` or `"openai.responses"`
|
|
45
|
+
gives the same ids. Hostile or oversized input never raises; it gives `None`.
|
|
46
|
+
|
|
47
|
+
To check your install against the published test vectors, use the published
|
|
48
|
+
test key (epoch 0) on the vector
|
|
49
|
+
[`openai.chat/conv-base`](https://github.com/Podwarden/kvsig/blob/main/vectors/v1/openai.chat/conv-base.json):
|
|
50
|
+
|
|
51
|
+
```python
|
|
52
|
+
import json
|
|
53
|
+
from kvsig import TEST_KEY, canonicalize, ids
|
|
54
|
+
|
|
55
|
+
v = json.load(open("vectors/v1/openai.chat/conv-base.json"))
|
|
56
|
+
i = ids(canonicalize(v["input"], v["dialect"]), TEST_KEY)
|
|
57
|
+
assert i.conv == v["expect"]["keys"]["0"]["conv"] # "00fdd9bdfb7d14a82cb5d7d4d70ac60046"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## What 0.1 guarantees
|
|
61
|
+
|
|
62
|
+
- For the spec label `kvsig/1` and the loose profile `loose/1` (the default),
|
|
63
|
+
canonical bytes and ids are pinned by the
|
|
64
|
+
[`vectors/v1`](https://github.com/Podwarden/kvsig/tree/main/vectors) test
|
|
65
|
+
vectors. No later release changes them; a change ships under a new label or
|
|
66
|
+
profile version instead.
|
|
67
|
+
- `LOOSE_V2` (`loose/2`, decision 0005) is included but **experimental**: it is
|
|
68
|
+
not covered by the vectors yet and its ids may change until its decision is
|
|
69
|
+
accepted.
|
|
70
|
+
- The full policy is in the [specification](https://github.com/Podwarden/kvsig/blob/main/SPEC.md#versioning-and-compatibility).
|
|
71
|
+
|
|
72
|
+
## Learn more
|
|
73
|
+
|
|
74
|
+
- [Reading the ids](https://github.com/Podwarden/kvsig/blob/main/docs/reading-the-ids.md):
|
|
75
|
+
what each id identifies, and how to tell what changed between two requests.
|
|
76
|
+
- [Conformance runner](https://github.com/Podwarden/kvsig/tree/main/conformance):
|
|
77
|
+
check any implementation, in any language, against the vectors.
|
|
78
|
+
- [Changelog](https://github.com/Podwarden/kvsig/blob/main/CHANGELOG.md).
|
|
79
|
+
|
|
80
|
+
## Development
|
|
81
|
+
|
|
82
|
+
From `python/` in a checkout:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
uv run --with pytest pytest -q
|
|
86
|
+
uv run --with ruff ruff check . && uv run --with ruff ruff format --check .
|
|
87
|
+
python ../conformance/run.py -- python ../conformance/adapters/python_adapter.py
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Licence
|
|
91
|
+
|
|
92
|
+
Apache-2.0. The specification text is licensed separately under CC BY 4.0; see
|
|
93
|
+
[NOTICE](https://github.com/Podwarden/kvsig/blob/main/NOTICE).
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.27"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "kvsig"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Keyed, content-derived ids for LLM chat conversations: the kvsig reference implementation"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
13
|
+
authors = [{ name = "The PodWarden Team" }]
|
|
14
|
+
keywords = [
|
|
15
|
+
"llm",
|
|
16
|
+
"conversation-id",
|
|
17
|
+
"session-affinity",
|
|
18
|
+
"prompt-cache",
|
|
19
|
+
"gateway",
|
|
20
|
+
"routing",
|
|
21
|
+
"openai",
|
|
22
|
+
"anthropic",
|
|
23
|
+
"hmac",
|
|
24
|
+
]
|
|
25
|
+
classifiers = [
|
|
26
|
+
"Development Status :: 3 - Alpha",
|
|
27
|
+
"Intended Audience :: Developers",
|
|
28
|
+
"Operating System :: OS Independent",
|
|
29
|
+
"Programming Language :: Python :: 3",
|
|
30
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
31
|
+
"Programming Language :: Python :: 3.10",
|
|
32
|
+
"Programming Language :: Python :: 3.11",
|
|
33
|
+
"Programming Language :: Python :: 3.12",
|
|
34
|
+
"Programming Language :: Python :: 3.13",
|
|
35
|
+
"Topic :: Internet :: WWW/HTTP :: HTTP Servers",
|
|
36
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
37
|
+
"Topic :: Software Development :: Libraries",
|
|
38
|
+
"Typing :: Typed",
|
|
39
|
+
]
|
|
40
|
+
dependencies = []
|
|
41
|
+
|
|
42
|
+
[project.urls]
|
|
43
|
+
Homepage = "https://github.com/Podwarden/kvsig"
|
|
44
|
+
Source = "https://github.com/Podwarden/kvsig"
|
|
45
|
+
Specification = "https://github.com/Podwarden/kvsig/blob/main/SPEC.md"
|
|
46
|
+
"Test vectors" = "https://github.com/Podwarden/kvsig/tree/main/vectors"
|
|
47
|
+
Changelog = "https://github.com/Podwarden/kvsig/blob/main/CHANGELOG.md"
|
|
48
|
+
Issues = "https://github.com/Podwarden/kvsig/issues"
|
|
49
|
+
|
|
50
|
+
[dependency-groups]
|
|
51
|
+
dev = ["pytest>=8", "ruff>=0.6"]
|
|
52
|
+
|
|
53
|
+
[tool.hatch.version]
|
|
54
|
+
path = "src/kvsig/__init__.py"
|
|
55
|
+
|
|
56
|
+
[tool.hatch.build.targets.wheel]
|
|
57
|
+
packages = ["src/kvsig"]
|
|
58
|
+
|
|
59
|
+
[tool.hatch.build.targets.sdist]
|
|
60
|
+
include = ["src/kvsig", "tests", "README.md", "LICENSE", "NOTICE", "pyproject.toml"]
|
|
61
|
+
exclude = ["__pycache__", "*.py[cod]"]
|
|
62
|
+
|
|
63
|
+
[tool.pytest.ini_options]
|
|
64
|
+
testpaths = ["tests"]
|
|
65
|
+
|
|
66
|
+
[tool.ruff]
|
|
67
|
+
line-length = 100
|
|
68
|
+
target-version = "py310"
|
|
69
|
+
|
|
70
|
+
[tool.ruff.lint]
|
|
71
|
+
select = ["E", "F", "I", "B", "UP", "BLE"]
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
"""kvsig: keyed, content-derived ids for LLM chat conversations.
|
|
2
|
+
|
|
3
|
+
Reference implementation of the kvsig specification (``kvsig/1``, draft 0.1).
|
|
4
|
+
Pure functions, no third-party dependencies. Hostile input never raises: it
|
|
5
|
+
yields ``None``.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from __future__ import annotations
|
|
9
|
+
|
|
10
|
+
import logging
|
|
11
|
+
from collections.abc import Callable
|
|
12
|
+
from typing import Any, TypeVar
|
|
13
|
+
|
|
14
|
+
from kvsig.cbor import encode
|
|
15
|
+
from kvsig.dialects import SUPPORTED, Dialect
|
|
16
|
+
from kvsig.dialects import anthropic_messages as _anthropic_messages
|
|
17
|
+
from kvsig.dialects import openai_chat as _openai_chat
|
|
18
|
+
from kvsig.dialects import openai_responses as _openai_responses
|
|
19
|
+
from kvsig.ids import SPEC_LABEL, IdCache, Ids, ids, ids_all_epochs, message_id, scope_from
|
|
20
|
+
from kvsig.keys import TEST_KEY, InMemoryKeyProvider, Key, KeyProvider, KeyRing
|
|
21
|
+
from kvsig.loose import LOOSE_V1, LOOSE_V2, LooseProfile, loose
|
|
22
|
+
from kvsig.model import DEFAULT_MAX_BYTES, Budget, Canon, Message, NoIds, finish
|
|
23
|
+
|
|
24
|
+
__version__ = "0.1.0"
|
|
25
|
+
|
|
26
|
+
__all__ = [
|
|
27
|
+
"DEFAULT_MAX_BYTES",
|
|
28
|
+
"LOOSE_V1",
|
|
29
|
+
"LOOSE_V2",
|
|
30
|
+
"SUPPORTED",
|
|
31
|
+
"SPEC_LABEL",
|
|
32
|
+
"TEST_KEY",
|
|
33
|
+
"__version__",
|
|
34
|
+
"Canon",
|
|
35
|
+
"Dialect",
|
|
36
|
+
"IdCache",
|
|
37
|
+
"Ids",
|
|
38
|
+
"InMemoryKeyProvider",
|
|
39
|
+
"Key",
|
|
40
|
+
"KeyProvider",
|
|
41
|
+
"KeyRing",
|
|
42
|
+
"LooseProfile",
|
|
43
|
+
"Message",
|
|
44
|
+
"canonicalize",
|
|
45
|
+
"canonicalize_reply",
|
|
46
|
+
"conversation_id",
|
|
47
|
+
"encode",
|
|
48
|
+
"ids",
|
|
49
|
+
"ids_all_epochs",
|
|
50
|
+
"loose",
|
|
51
|
+
"message_id",
|
|
52
|
+
"scope_from",
|
|
53
|
+
]
|
|
54
|
+
|
|
55
|
+
log = logging.getLogger("kvsig")
|
|
56
|
+
|
|
57
|
+
T = TypeVar("T")
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
_ADAPTERS: dict[str, Any] = {
|
|
61
|
+
"openai.chat": _openai_chat,
|
|
62
|
+
"anthropic.messages": _anthropic_messages,
|
|
63
|
+
"openai.responses": _openai_responses,
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
assert set(_ADAPTERS) == set(SUPPORTED), "dialects.SUPPORTED and _ADAPTERS disagree"
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def _adapter(dialect: str) -> Any:
|
|
71
|
+
a = _ADAPTERS.get(dialect)
|
|
72
|
+
if a is None:
|
|
73
|
+
raise NotImplementedError(f"dialect {dialect!r} is not implemented in this release")
|
|
74
|
+
return a
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
def _fail_open(what: str, fn: Callable[[], T | None]) -> T | None:
|
|
78
|
+
"""Run ``fn``; the defined "no ids" outcomes return None quietly. Anything
|
|
79
|
+
else is a bug in this library: it still returns None (an id must never
|
|
80
|
+
fail a request) but is logged, so a broken deployment is visible."""
|
|
81
|
+
try:
|
|
82
|
+
return fn()
|
|
83
|
+
except (NoIds, RecursionError):
|
|
84
|
+
return None
|
|
85
|
+
except Exception: # noqa: BLE001 -- identity must never fail a request
|
|
86
|
+
log.exception("kvsig: unexpected error in %s; returning no ids", what)
|
|
87
|
+
return None
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
def canonicalize(
|
|
91
|
+
body: Any, dialect: Dialect = "openai.chat", *, max_bytes: int = DEFAULT_MAX_BYTES
|
|
92
|
+
) -> Canon | None:
|
|
93
|
+
"""The canonical form of a request body, or None when the request gets no
|
|
94
|
+
ids: not a chat body, over ``max_bytes`` of canonical CBOR, or nested too
|
|
95
|
+
deep. Raises only for an unknown ``dialect``."""
|
|
96
|
+
adapter = _adapter(dialect)
|
|
97
|
+
|
|
98
|
+
def run() -> Canon | None:
|
|
99
|
+
if not isinstance(body, dict):
|
|
100
|
+
return None
|
|
101
|
+
c = adapter.canonicalize(body, Budget(max_bytes))
|
|
102
|
+
return None if c is None else finish(c, max_bytes)
|
|
103
|
+
|
|
104
|
+
return _fail_open("canonicalize", run)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
def canonicalize_reply(
|
|
108
|
+
message: Any, dialect: Dialect = "openai.chat", *, max_bytes: int = DEFAULT_MAX_BYTES
|
|
109
|
+
) -> Message | None:
|
|
110
|
+
"""A response's assistant message, canonicalised alone, so that its
|
|
111
|
+
``message_id`` equals the id of the same message in the next request.
|
|
112
|
+
|
|
113
|
+
``message`` is the assistant message (``openai.chat``: ``choices[i].message``),
|
|
114
|
+
the whole response (``anthropic.messages``), or the whole response with its
|
|
115
|
+
``output`` items (``openai.responses``)."""
|
|
116
|
+
adapter = _adapter(dialect)
|
|
117
|
+
|
|
118
|
+
def run() -> Message | None:
|
|
119
|
+
if not isinstance(message, dict):
|
|
120
|
+
return None
|
|
121
|
+
m = adapter.reply(message, Budget(max_bytes))
|
|
122
|
+
return m if len(encode(m)) <= max_bytes else None
|
|
123
|
+
|
|
124
|
+
return _fail_open("canonicalize_reply", run)
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
def conversation_id(i: Ids) -> str | None:
|
|
128
|
+
return i.conv
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"""Unicode scalar handling shared by every encoder (decision 0001, rule 4)."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import re
|
|
6
|
+
|
|
7
|
+
# A well-formed surrogate pair, or any lone surrogate.
|
|
8
|
+
_SURROGATES = re.compile("[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]")
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def _fix(m: re.Match[str]) -> str:
|
|
12
|
+
g = m.group()
|
|
13
|
+
if len(g) == 2:
|
|
14
|
+
return chr(0x10000 + ((ord(g[0]) - 0xD800) << 10) + (ord(g[1]) - 0xDC00))
|
|
15
|
+
return "\ufffd"
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def scalar(s: str) -> str:
|
|
19
|
+
"""``s`` as Unicode scalar values: a surrogate pair becomes the code point it
|
|
20
|
+
stands for, a lone surrogate becomes U+FFFD. No normalisation."""
|
|
21
|
+
try:
|
|
22
|
+
s.encode("utf-8")
|
|
23
|
+
except UnicodeEncodeError:
|
|
24
|
+
return _SURROGATES.sub(_fix, s)
|
|
25
|
+
return s
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
def utf8(s: str) -> bytes:
|
|
29
|
+
"""UTF-8 bytes of ``scalar(s)``."""
|
|
30
|
+
try:
|
|
31
|
+
return s.encode("utf-8")
|
|
32
|
+
except UnicodeEncodeError:
|
|
33
|
+
return _SURROGATES.sub(_fix, s).encode("utf-8")
|