sentinel-proof 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.
- sentinel_proof-0.1.0/LICENSE +202 -0
- sentinel_proof-0.1.0/PKG-INFO +201 -0
- sentinel_proof-0.1.0/README.md +172 -0
- sentinel_proof-0.1.0/pyproject.toml +61 -0
- sentinel_proof-0.1.0/setup.cfg +4 -0
- sentinel_proof-0.1.0/src/sentinel_proof/__init__.py +51 -0
- sentinel_proof-0.1.0/src/sentinel_proof/citations.py +67 -0
- sentinel_proof-0.1.0/src/sentinel_proof/cli.py +117 -0
- sentinel_proof-0.1.0/src/sentinel_proof/grounding.py +483 -0
- sentinel_proof-0.1.0/src/sentinel_proof/passages.py +148 -0
- sentinel_proof-0.1.0/src/sentinel_proof/provenance.py +32 -0
- sentinel_proof-0.1.0/src/sentinel_proof/py.typed +0 -0
- sentinel_proof-0.1.0/src/sentinel_proof/refusal.py +58 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/PKG-INFO +201 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/SOURCES.txt +21 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/dependency_links.txt +1 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/entry_points.txt +2 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/requires.txt +5 -0
- sentinel_proof-0.1.0/src/sentinel_proof.egg-info/top_level.txt +1 -0
- sentinel_proof-0.1.0/tests/test_citations.py +86 -0
- sentinel_proof-0.1.0/tests/test_cli.py +64 -0
- sentinel_proof-0.1.0/tests/test_grounding.py +334 -0
- sentinel_proof-0.1.0/tests/test_passages_and_provenance.py +124 -0
|
@@ -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 [yyyy] [name of copyright owner]
|
|
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.
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sentinel-proof
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Deterministic grounding gate for RAG: every number must be in the evidence, every citation must point where it says, and what cannot be verified is refused with a reason.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/92kareeem/sentinel-rag
|
|
7
|
+
Project-URL: Documentation, https://github.com/92kareeem/sentinel-rag/tree/main/packages/sentinel-proof
|
|
8
|
+
Project-URL: Changelog, https://github.com/92kareeem/sentinel-rag/blob/main/packages/sentinel-proof/CHANGELOG.md
|
|
9
|
+
Project-URL: Issues, https://github.com/92kareeem/sentinel-rag/issues
|
|
10
|
+
Keywords: rag,hallucination,grounding,citations,llm,guardrails,verification
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
19
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
20
|
+
Classifier: Typing :: Typed
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Provides-Extra: dev
|
|
25
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
26
|
+
Requires-Dist: ruff>=0.8; extra == "dev"
|
|
27
|
+
Requires-Dist: mypy>=1.13; extra == "dev"
|
|
28
|
+
Dynamic: license-file
|
|
29
|
+
|
|
30
|
+
# sentinel-proof
|
|
31
|
+
|
|
32
|
+
**A deterministic grounding gate for RAG answers.** Every number in a claim
|
|
33
|
+
must appear in the passage it cites. Every citation must point at a passage
|
|
34
|
+
that supports the sentence in front of it. What cannot be verified is stripped,
|
|
35
|
+
and if too much is stripped the answer is refused with a reason code instead
|
|
36
|
+
of shipped.
|
|
37
|
+
|
|
38
|
+
Pure Python. No dependencies. No model calls. Works with any retrieval stack.
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pip install sentinel-proof
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
```python
|
|
45
|
+
from sentinel_proof import verify, passages_from_texts
|
|
46
|
+
|
|
47
|
+
passages = passages_from_texts([
|
|
48
|
+
"Customers may request a refund within 30 days of purchase.",
|
|
49
|
+
"Refund requests above 500 USD require manager approval.",
|
|
50
|
+
])
|
|
51
|
+
|
|
52
|
+
answer = (
|
|
53
|
+
"Customers can get a refund within 30 days [1]. "
|
|
54
|
+
"Requests above 500 USD need manager approval [1]. "
|
|
55
|
+
"Refunds are processed in 2 business days [2]."
|
|
56
|
+
)
|
|
57
|
+
|
|
58
|
+
v = verify(answer, passages, citation_style="numeric")
|
|
59
|
+
|
|
60
|
+
v.ok # True: 2 of 3 claims survive, under the 50% strip limit
|
|
61
|
+
v.answer # "Customers can get a refund within 30 days [1]. Requests above 500 USD need manager approval [2]."
|
|
62
|
+
v.repaired_citations # 1: the second claim cited [1] but only [2] supports it
|
|
63
|
+
v.stripped # the "2 business days" claim: no passage contains a 2
|
|
64
|
+
v.safe_text() # the verified answer, or refusal prose if v.ok is False
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Three things happened there, and all of them are things an LLM judge would
|
|
68
|
+
have scored rather than fixed:
|
|
69
|
+
|
|
70
|
+
1. A fabricated figure was **stripped**, and the rest of the answer still shipped.
|
|
71
|
+
2. A citation that pointed at the wrong passage was **repaired** to the right
|
|
72
|
+
one, so a reader who clicks it lands on the text that supports the sentence.
|
|
73
|
+
3. The result is a **verdict with per-claim detail**, not a float.
|
|
74
|
+
|
|
75
|
+
## Why a deterministic gate
|
|
76
|
+
|
|
77
|
+
LLM-judge metrics (faithfulness, groundedness) are the right tool for *measuring*
|
|
78
|
+
a pipeline offline. They are the wrong *last line* in production: a judge can be
|
|
79
|
+
wrong in exactly the way the model was, it costs a model call per answer, and it
|
|
80
|
+
returns a score, which leaves you to pick a threshold and still ship the whole
|
|
81
|
+
answer or none of it.
|
|
82
|
+
|
|
83
|
+
This gate is string logic. It cannot hallucinate, it runs in microseconds, and it
|
|
84
|
+
edits the answer down to what the evidence supports. It is deliberately **weak**:
|
|
85
|
+
it checks lexical overlap and numbers, not semantic entailment, because a
|
|
86
|
+
deterministic checker that tried to be clever about paraphrase produces false
|
|
87
|
+
refusals on good answers. Use it *under* your judge, not instead of it. The two
|
|
88
|
+
catch different things.
|
|
89
|
+
|
|
90
|
+
The design and its measured trade-offs come from running it in production inside
|
|
91
|
+
[Sentinel](https://github.com/92kareeem/sentinel-rag), where it is the
|
|
92
|
+
last node before the user. The relevant decision record is
|
|
93
|
+
[ADR 0003: grounding is deterministic, and deliberately weak](https://github.com/92kareeem/sentinel-rag/blob/main/docs/adr/0003-grounding-is-deterministic-not-only-an-llm-judge.md).
|
|
94
|
+
|
|
95
|
+
## What it checks, per sentence
|
|
96
|
+
|
|
97
|
+
| Check | Outcome |
|
|
98
|
+
|---|---|
|
|
99
|
+
| Content words overlap the cited passages (≥ 25% by default) and every number in the sentence appears in one of them | **supported**: kept as written |
|
|
100
|
+
| The cited passages fail, but another retrieved passage passes | **repaired**: kept, citation re-pointed |
|
|
101
|
+
| No retrieved passage passes | **stripped**: removed from the answer |
|
|
102
|
+
|
|
103
|
+
Then: if more than `max_stripped_ratio` (default 50%) of the claims were
|
|
104
|
+
stripped, `ok` is `False`, `answer` is empty and `refusal` is
|
|
105
|
+
`UNVERIFIABLE_ANSWER`. An answer with no parseable citations at all fails
|
|
106
|
+
closed. The model's own refusal token (`INSUFFICIENT_CONTEXT`) passes through
|
|
107
|
+
as `is_refusal=True` with reason `INSUFFICIENT_EVIDENCE`.
|
|
108
|
+
|
|
109
|
+
Details that came from real failures, each with a test:
|
|
110
|
+
|
|
111
|
+
- Numbers echoed from the **question** are not fabrications ("is 20 days inside
|
|
112
|
+
the window?" may restate 20 when the evidence says 30).
|
|
113
|
+
- A sentence citing **several passages at once** (`[1][2][3]` after a summary)
|
|
114
|
+
is supported by their union, but each sentence keeps only the passages it
|
|
115
|
+
actually rests on.
|
|
116
|
+
- **List markers** (`1.`), **lead-ins** ("The main ones are:") and passage ids
|
|
117
|
+
the model wrote into the prose are not claims and are not counted.
|
|
118
|
+
- `【1】`, `[ chunk: id ]` and full-width brackets are read as citations;
|
|
119
|
+
`[sic]` is not.
|
|
120
|
+
- `1,200` and `1200` are the same number.
|
|
121
|
+
|
|
122
|
+
## Citation styles
|
|
123
|
+
|
|
124
|
+
| `citation_style` | What the model writes | Mapped to |
|
|
125
|
+
|---|---|---|
|
|
126
|
+
| `"numeric"` | `[1]`, `[2, 3]`, `[1][2]` | 1-based position in `passages` |
|
|
127
|
+
| `"tag"` (default) | `[chunk:<id>]` | `Passage.id` |
|
|
128
|
+
|
|
129
|
+
Numeric is what most RAG prompts already use, so for most stacks nothing in the
|
|
130
|
+
prompt changes. The verified answer is written back in the same style.
|
|
131
|
+
|
|
132
|
+
## Bring your own retriever
|
|
133
|
+
|
|
134
|
+
```python
|
|
135
|
+
from sentinel_proof import from_langchain, from_llamaindex, Passage
|
|
136
|
+
|
|
137
|
+
passages = from_langchain(retriever.invoke(question)) # LangChain Documents
|
|
138
|
+
passages = from_llamaindex(retriever.retrieve(question)) # LlamaIndex nodes / NodeWithScore
|
|
139
|
+
passages = [Passage(text=row.text, id=row.id, source=row.url) for row in my_rows]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
The adapters are duck-typed: this package imports neither library. A `Passage`
|
|
143
|
+
needs only `text`; `section` (a heading path such as `Item 7.2 > Refunds`) is
|
|
144
|
+
counted as evidence, and `source`/`page` ride along into the verdict for display.
|
|
145
|
+
|
|
146
|
+
## Provenance a reader can check
|
|
147
|
+
|
|
148
|
+
Give a passage its span and the source file's checksum, and it gets a hash
|
|
149
|
+
anyone can recompute in any language:
|
|
150
|
+
|
|
151
|
+
```python
|
|
152
|
+
p = Passage(text=quote, document_sha256=sha, char_start=120, char_end=410).with_provenance()
|
|
153
|
+
p.provenance_hash # sha256(f"{sha}|120|410|{quote}")
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Publish the hash with the citation. A client that holds the file can prove the
|
|
157
|
+
quote is that exact span of that exact file, without trusting the server.
|
|
158
|
+
Sentinel's web UI does this in the browser with WebCrypto on every citation.
|
|
159
|
+
|
|
160
|
+
## CLI
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
sentinel-proof check --answer answer.txt --passages passages.json --numeric
|
|
164
|
+
echo "Refunds take 30 days [1]." | sentinel-proof check --passages passages.json --numeric --json
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
Exit code 0 when verified, 1 when not. `--json` gives the full verdict, claims
|
|
168
|
+
included. `passages.json` is a list of strings or of objects with a `text`
|
|
169
|
+
field. Useful as a CI step over a golden set of answers.
|
|
170
|
+
|
|
171
|
+
## API
|
|
172
|
+
|
|
173
|
+
```python
|
|
174
|
+
verify(answer, passages, question="", *, citation_style="tag",
|
|
175
|
+
max_stripped_ratio=0.5, min_lexical_overlap=0.25) -> Verdict
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
`Verdict`: `ok`, `answer`, `claims` (each with `text`, `status`, `cited`,
|
|
179
|
+
`supported_by`, `unsupported_numbers`), `stripped_ratio`, `cited_ids`,
|
|
180
|
+
`repaired_citations`, `refusal`, `is_refusal`, `passed`, `stripped`, `safe_text()`.
|
|
181
|
+
|
|
182
|
+
Also exported: `Passage`, `passages_from_texts`, `from_langchain`,
|
|
183
|
+
`from_llamaindex`, `provenance_hash`, `check_provenance`, `document_sha256`,
|
|
184
|
+
`normalize_citations`, `strip_citations`, `RefusalReason`, `refusal_text`,
|
|
185
|
+
`is_refusal`.
|
|
186
|
+
|
|
187
|
+
## What it is not
|
|
188
|
+
|
|
189
|
+
- Not an entailment model. "The policy allows returns for a month" against a
|
|
190
|
+
passage saying "30 days" is **stripped**, because no overlap carries the
|
|
191
|
+
claim. Pair the gate with an NLI model or an LLM judge for paraphrase.
|
|
192
|
+
- Not a retriever quality metric. If the right passage was never retrieved, the
|
|
193
|
+
gate refuses correctly and tells you nothing about why. That is what the
|
|
194
|
+
casebook and gap report in Sentinel are for.
|
|
195
|
+
- Not multilingual yet. Content words are `[A-Za-z]{2,}`; numbers are
|
|
196
|
+
script-independent. Contributions welcome, with a test.
|
|
197
|
+
|
|
198
|
+
## License
|
|
199
|
+
|
|
200
|
+
Apache-2.0. The Sentinel platform this was extracted from is AGPL-3.0; this
|
|
201
|
+
package is licensed separately so it can be used anywhere.
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# sentinel-proof
|
|
2
|
+
|
|
3
|
+
**A deterministic grounding gate for RAG answers.** Every number in a claim
|
|
4
|
+
must appear in the passage it cites. Every citation must point at a passage
|
|
5
|
+
that supports the sentence in front of it. What cannot be verified is stripped,
|
|
6
|
+
and if too much is stripped the answer is refused with a reason code instead
|
|
7
|
+
of shipped.
|
|
8
|
+
|
|
9
|
+
Pure Python. No dependencies. No model calls. Works with any retrieval stack.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install sentinel-proof
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
```python
|
|
16
|
+
from sentinel_proof import verify, passages_from_texts
|
|
17
|
+
|
|
18
|
+
passages = passages_from_texts([
|
|
19
|
+
"Customers may request a refund within 30 days of purchase.",
|
|
20
|
+
"Refund requests above 500 USD require manager approval.",
|
|
21
|
+
])
|
|
22
|
+
|
|
23
|
+
answer = (
|
|
24
|
+
"Customers can get a refund within 30 days [1]. "
|
|
25
|
+
"Requests above 500 USD need manager approval [1]. "
|
|
26
|
+
"Refunds are processed in 2 business days [2]."
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
v = verify(answer, passages, citation_style="numeric")
|
|
30
|
+
|
|
31
|
+
v.ok # True: 2 of 3 claims survive, under the 50% strip limit
|
|
32
|
+
v.answer # "Customers can get a refund within 30 days [1]. Requests above 500 USD need manager approval [2]."
|
|
33
|
+
v.repaired_citations # 1: the second claim cited [1] but only [2] supports it
|
|
34
|
+
v.stripped # the "2 business days" claim: no passage contains a 2
|
|
35
|
+
v.safe_text() # the verified answer, or refusal prose if v.ok is False
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Three things happened there, and all of them are things an LLM judge would
|
|
39
|
+
have scored rather than fixed:
|
|
40
|
+
|
|
41
|
+
1. A fabricated figure was **stripped**, and the rest of the answer still shipped.
|
|
42
|
+
2. A citation that pointed at the wrong passage was **repaired** to the right
|
|
43
|
+
one, so a reader who clicks it lands on the text that supports the sentence.
|
|
44
|
+
3. The result is a **verdict with per-claim detail**, not a float.
|
|
45
|
+
|
|
46
|
+
## Why a deterministic gate
|
|
47
|
+
|
|
48
|
+
LLM-judge metrics (faithfulness, groundedness) are the right tool for *measuring*
|
|
49
|
+
a pipeline offline. They are the wrong *last line* in production: a judge can be
|
|
50
|
+
wrong in exactly the way the model was, it costs a model call per answer, and it
|
|
51
|
+
returns a score, which leaves you to pick a threshold and still ship the whole
|
|
52
|
+
answer or none of it.
|
|
53
|
+
|
|
54
|
+
This gate is string logic. It cannot hallucinate, it runs in microseconds, and it
|
|
55
|
+
edits the answer down to what the evidence supports. It is deliberately **weak**:
|
|
56
|
+
it checks lexical overlap and numbers, not semantic entailment, because a
|
|
57
|
+
deterministic checker that tried to be clever about paraphrase produces false
|
|
58
|
+
refusals on good answers. Use it *under* your judge, not instead of it. The two
|
|
59
|
+
catch different things.
|
|
60
|
+
|
|
61
|
+
The design and its measured trade-offs come from running it in production inside
|
|
62
|
+
[Sentinel](https://github.com/92kareeem/sentinel-rag), where it is the
|
|
63
|
+
last node before the user. The relevant decision record is
|
|
64
|
+
[ADR 0003: grounding is deterministic, and deliberately weak](https://github.com/92kareeem/sentinel-rag/blob/main/docs/adr/0003-grounding-is-deterministic-not-only-an-llm-judge.md).
|
|
65
|
+
|
|
66
|
+
## What it checks, per sentence
|
|
67
|
+
|
|
68
|
+
| Check | Outcome |
|
|
69
|
+
|---|---|
|
|
70
|
+
| Content words overlap the cited passages (≥ 25% by default) and every number in the sentence appears in one of them | **supported**: kept as written |
|
|
71
|
+
| The cited passages fail, but another retrieved passage passes | **repaired**: kept, citation re-pointed |
|
|
72
|
+
| No retrieved passage passes | **stripped**: removed from the answer |
|
|
73
|
+
|
|
74
|
+
Then: if more than `max_stripped_ratio` (default 50%) of the claims were
|
|
75
|
+
stripped, `ok` is `False`, `answer` is empty and `refusal` is
|
|
76
|
+
`UNVERIFIABLE_ANSWER`. An answer with no parseable citations at all fails
|
|
77
|
+
closed. The model's own refusal token (`INSUFFICIENT_CONTEXT`) passes through
|
|
78
|
+
as `is_refusal=True` with reason `INSUFFICIENT_EVIDENCE`.
|
|
79
|
+
|
|
80
|
+
Details that came from real failures, each with a test:
|
|
81
|
+
|
|
82
|
+
- Numbers echoed from the **question** are not fabrications ("is 20 days inside
|
|
83
|
+
the window?" may restate 20 when the evidence says 30).
|
|
84
|
+
- A sentence citing **several passages at once** (`[1][2][3]` after a summary)
|
|
85
|
+
is supported by their union, but each sentence keeps only the passages it
|
|
86
|
+
actually rests on.
|
|
87
|
+
- **List markers** (`1.`), **lead-ins** ("The main ones are:") and passage ids
|
|
88
|
+
the model wrote into the prose are not claims and are not counted.
|
|
89
|
+
- `【1】`, `[ chunk: id ]` and full-width brackets are read as citations;
|
|
90
|
+
`[sic]` is not.
|
|
91
|
+
- `1,200` and `1200` are the same number.
|
|
92
|
+
|
|
93
|
+
## Citation styles
|
|
94
|
+
|
|
95
|
+
| `citation_style` | What the model writes | Mapped to |
|
|
96
|
+
|---|---|---|
|
|
97
|
+
| `"numeric"` | `[1]`, `[2, 3]`, `[1][2]` | 1-based position in `passages` |
|
|
98
|
+
| `"tag"` (default) | `[chunk:<id>]` | `Passage.id` |
|
|
99
|
+
|
|
100
|
+
Numeric is what most RAG prompts already use, so for most stacks nothing in the
|
|
101
|
+
prompt changes. The verified answer is written back in the same style.
|
|
102
|
+
|
|
103
|
+
## Bring your own retriever
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
from sentinel_proof import from_langchain, from_llamaindex, Passage
|
|
107
|
+
|
|
108
|
+
passages = from_langchain(retriever.invoke(question)) # LangChain Documents
|
|
109
|
+
passages = from_llamaindex(retriever.retrieve(question)) # LlamaIndex nodes / NodeWithScore
|
|
110
|
+
passages = [Passage(text=row.text, id=row.id, source=row.url) for row in my_rows]
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
The adapters are duck-typed: this package imports neither library. A `Passage`
|
|
114
|
+
needs only `text`; `section` (a heading path such as `Item 7.2 > Refunds`) is
|
|
115
|
+
counted as evidence, and `source`/`page` ride along into the verdict for display.
|
|
116
|
+
|
|
117
|
+
## Provenance a reader can check
|
|
118
|
+
|
|
119
|
+
Give a passage its span and the source file's checksum, and it gets a hash
|
|
120
|
+
anyone can recompute in any language:
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
p = Passage(text=quote, document_sha256=sha, char_start=120, char_end=410).with_provenance()
|
|
124
|
+
p.provenance_hash # sha256(f"{sha}|120|410|{quote}")
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Publish the hash with the citation. A client that holds the file can prove the
|
|
128
|
+
quote is that exact span of that exact file, without trusting the server.
|
|
129
|
+
Sentinel's web UI does this in the browser with WebCrypto on every citation.
|
|
130
|
+
|
|
131
|
+
## CLI
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
sentinel-proof check --answer answer.txt --passages passages.json --numeric
|
|
135
|
+
echo "Refunds take 30 days [1]." | sentinel-proof check --passages passages.json --numeric --json
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
Exit code 0 when verified, 1 when not. `--json` gives the full verdict, claims
|
|
139
|
+
included. `passages.json` is a list of strings or of objects with a `text`
|
|
140
|
+
field. Useful as a CI step over a golden set of answers.
|
|
141
|
+
|
|
142
|
+
## API
|
|
143
|
+
|
|
144
|
+
```python
|
|
145
|
+
verify(answer, passages, question="", *, citation_style="tag",
|
|
146
|
+
max_stripped_ratio=0.5, min_lexical_overlap=0.25) -> Verdict
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
`Verdict`: `ok`, `answer`, `claims` (each with `text`, `status`, `cited`,
|
|
150
|
+
`supported_by`, `unsupported_numbers`), `stripped_ratio`, `cited_ids`,
|
|
151
|
+
`repaired_citations`, `refusal`, `is_refusal`, `passed`, `stripped`, `safe_text()`.
|
|
152
|
+
|
|
153
|
+
Also exported: `Passage`, `passages_from_texts`, `from_langchain`,
|
|
154
|
+
`from_llamaindex`, `provenance_hash`, `check_provenance`, `document_sha256`,
|
|
155
|
+
`normalize_citations`, `strip_citations`, `RefusalReason`, `refusal_text`,
|
|
156
|
+
`is_refusal`.
|
|
157
|
+
|
|
158
|
+
## What it is not
|
|
159
|
+
|
|
160
|
+
- Not an entailment model. "The policy allows returns for a month" against a
|
|
161
|
+
passage saying "30 days" is **stripped**, because no overlap carries the
|
|
162
|
+
claim. Pair the gate with an NLI model or an LLM judge for paraphrase.
|
|
163
|
+
- Not a retriever quality metric. If the right passage was never retrieved, the
|
|
164
|
+
gate refuses correctly and tells you nothing about why. That is what the
|
|
165
|
+
casebook and gap report in Sentinel are for.
|
|
166
|
+
- Not multilingual yet. Content words are `[A-Za-z]{2,}`; numbers are
|
|
167
|
+
script-independent. Contributions welcome, with a test.
|
|
168
|
+
|
|
169
|
+
## License
|
|
170
|
+
|
|
171
|
+
Apache-2.0. The Sentinel platform this was extracted from is AGPL-3.0; this
|
|
172
|
+
package is licensed separately so it can be used anywhere.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "sentinel-proof"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Deterministic grounding gate for RAG: every number must be in the evidence, every citation must point where it says, and what cannot be verified is refused with a reason."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.10"
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
license-files = ["LICENSE"]
|
|
9
|
+
keywords = ["rag", "hallucination", "grounding", "citations", "llm", "guardrails", "verification"]
|
|
10
|
+
classifiers = [
|
|
11
|
+
"Development Status :: 4 - Beta",
|
|
12
|
+
"Intended Audience :: Developers",
|
|
13
|
+
"Programming Language :: Python :: 3",
|
|
14
|
+
"Programming Language :: Python :: 3.10",
|
|
15
|
+
"Programming Language :: Python :: 3.11",
|
|
16
|
+
"Programming Language :: Python :: 3.12",
|
|
17
|
+
"Programming Language :: Python :: 3.13",
|
|
18
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
19
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
20
|
+
"Typing :: Typed",
|
|
21
|
+
]
|
|
22
|
+
dependencies = []
|
|
23
|
+
|
|
24
|
+
[project.urls]
|
|
25
|
+
Homepage = "https://github.com/92kareeem/sentinel-rag"
|
|
26
|
+
Documentation = "https://github.com/92kareeem/sentinel-rag/tree/main/packages/sentinel-proof"
|
|
27
|
+
Changelog = "https://github.com/92kareeem/sentinel-rag/blob/main/packages/sentinel-proof/CHANGELOG.md"
|
|
28
|
+
Issues = "https://github.com/92kareeem/sentinel-rag/issues"
|
|
29
|
+
|
|
30
|
+
[project.scripts]
|
|
31
|
+
sentinel-proof = "sentinel_proof.cli:main"
|
|
32
|
+
|
|
33
|
+
[project.optional-dependencies]
|
|
34
|
+
dev = ["pytest>=8", "ruff>=0.8", "mypy>=1.13"]
|
|
35
|
+
|
|
36
|
+
[build-system]
|
|
37
|
+
requires = ["setuptools>=77"]
|
|
38
|
+
build-backend = "setuptools.build_meta"
|
|
39
|
+
|
|
40
|
+
[tool.setuptools.packages.find]
|
|
41
|
+
where = ["src"]
|
|
42
|
+
|
|
43
|
+
[tool.setuptools.package-data]
|
|
44
|
+
sentinel_proof = ["py.typed"]
|
|
45
|
+
|
|
46
|
+
[tool.ruff]
|
|
47
|
+
line-length = 100
|
|
48
|
+
target-version = "py310"
|
|
49
|
+
# Newer ruff also formats the Python blocks inside Markdown. The README's
|
|
50
|
+
# examples align their comments deliberately, so they are left alone.
|
|
51
|
+
extend-exclude = ["*.md"]
|
|
52
|
+
|
|
53
|
+
[tool.ruff.lint]
|
|
54
|
+
select = ["E", "F", "I", "UP", "B", "SIM"]
|
|
55
|
+
|
|
56
|
+
[tool.mypy]
|
|
57
|
+
strict = true
|
|
58
|
+
python_version = "3.10"
|
|
59
|
+
|
|
60
|
+
[tool.pytest.ini_options]
|
|
61
|
+
testpaths = ["tests"]
|