dissent 0.0.0-stage → 0.1.0
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.
- package/LICENSE +202 -0
- package/README.md +282 -2
- package/dist/index.d.ts +493 -0
- package/dist/index.js +3793 -0
- package/dist/index.js.map +1 -0
- package/package.json +73 -4
package/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
|
+
|
package/README.md
CHANGED
|
@@ -1,3 +1,283 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Dissent
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Ask several AI models the same question, and see where they disagree before you ship.**
|
|
4
|
+
|
|
5
|
+
One model gives you one confident answer. Dissent asks several models independently through the [Vercel AI SDK](https://ai-sdk.dev) using structured output, compares their answers with deterministic code field by field, records witness failures and provenance signals, optionally reconciles deterministic tool checks via `adjudicate()`, and formats an escaped report for humans and CI.
|
|
6
|
+
|
|
7
|
+
Dissent **compares** and **records**. It does not verify truth, summarize opinions with another model, or vote a winner.
|
|
8
|
+
|
|
9
|
+
> Tested live against `openai/gpt-4o-mini`, `google/gemini-2.5-flash`, and `zai/glm-4.7-flash` via the Vercel AI Gateway; works with any AI SDK `LanguageModel`.
|
|
10
|
+
|
|
11
|
+
## Principles
|
|
12
|
+
|
|
13
|
+
- **Models are witnesses, never judges.** Model outputs are claims to compare, not verdicts. No model gets the final word, and there is no majority-vote override.
|
|
14
|
+
- **The comparison is code, not another model.** Identical inputs and outputs produce the same `fingerprint` and `Ledger`.
|
|
15
|
+
- **Only artifact evidence decides.** A `confirmed` or `rejected` verdict appears only when you supply deterministic artifact-level evidence (tests, typechecks, linters). Without it, Dissent returns `uncertain` plus an `advisory`, and a human decides.
|
|
16
|
+
- **Failures are recorded, never hidden.** If a witness times out, refuses, hits an API error, or returns non-JSON / truncated output, the failure is recorded under a 7-kind taxonomy (`invalid-output`, `truncated`, `refused`, `api-error`, `timeout`, `aborted`, `unknown`). Nothing is backfilled or retried silently.
|
|
17
|
+
|
|
18
|
+
## How Dissent Differs from `llm-council` / LLM-as-a-Judge
|
|
19
|
+
|
|
20
|
+
- **No judge LLM:** Dissent never sends witness answers to another model to rank, synthesize, or break ties.
|
|
21
|
+
- **Schema-aware comparison:** Booleans, enums, numbers (with tolerance), sets, keyed object arrays, and discriminated unions are compared deterministically at field resolution rather than collapsing answers into prose or a single scalar score.
|
|
22
|
+
- **Evidence-only verdicts:** Witness splits settle only when matched against deterministic field-bound evidence (`claim: { path, value }`), and overall outcomes (`confirmed` / `rejected`) depend strictly on artifact-level checks (`claim: { scope: 'artifact' }`).
|
|
23
|
+
- **Provenance and independence checks:** Flags shared providers (`single-provider`), duplicate served model IDs (`duplicate-served-model`), and author-model self-grading (`self-grading` / `excludeAuthor`).
|
|
24
|
+
|
|
25
|
+
## Install
|
|
26
|
+
|
|
27
|
+
Dissent targets Node `>=22` (and pure comparison/adjudication/rendering modules have zero Node built-ins or `ai` runtime imports for edge runtimes). `ai` (`^7.0.162`) is a peer dependency.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm add dissent ai zod
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Quick Start
|
|
34
|
+
|
|
35
|
+
See [`examples/api-change-review.ts`](./examples/api-change-review.ts) for a complete runnable script using free-tier AI Gateway models, `tsc --noEmit` artifact evidence, and a deterministic diff-export check:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import { adjudicate, corroborate, formatLedger } from 'dissent';
|
|
39
|
+
import { z } from 'zod';
|
|
40
|
+
|
|
41
|
+
const ReviewSchema = z.object({
|
|
42
|
+
changesPublicApi: z.boolean(),
|
|
43
|
+
affectedExports: z.array(z.string()),
|
|
44
|
+
risk: z.enum(['low', 'medium', 'high']),
|
|
45
|
+
confidence: z.number(),
|
|
46
|
+
reasoning: z.string(),
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
const ledger = await corroborate({
|
|
50
|
+
witnesses: {
|
|
51
|
+
openai: 'openai/gpt-4o-mini',
|
|
52
|
+
google: 'google/gemini-2.5-flash',
|
|
53
|
+
zai: 'zai/glm-4.7-flash',
|
|
54
|
+
},
|
|
55
|
+
schema: ReviewSchema,
|
|
56
|
+
schemaName: 'ApiChangeReview',
|
|
57
|
+
instructions: 'Review the TypeScript diff for public API changes.',
|
|
58
|
+
prompt: diffText,
|
|
59
|
+
compare: {
|
|
60
|
+
changesPublicApi: { onSplit: 'critical' },
|
|
61
|
+
affectedExports: 'set',
|
|
62
|
+
confidence: { tolerance: { absolute: 0.05 }, onSplit: 'info' },
|
|
63
|
+
},
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
const adjudication = await adjudicate(ledger, [
|
|
67
|
+
{
|
|
68
|
+
source: 'tsc --noEmit',
|
|
69
|
+
outcome: 'pass',
|
|
70
|
+
claim: { scope: 'artifact' },
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
source: 'diff-export-check',
|
|
74
|
+
outcome: 'pass',
|
|
75
|
+
claim: { path: 'changesPublicApi', value: true },
|
|
76
|
+
},
|
|
77
|
+
]);
|
|
78
|
+
|
|
79
|
+
console.log(formatLedger(ledger, { adjudication, format: 'markdown' }));
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Schema Design Advice
|
|
83
|
+
|
|
84
|
+
Dissent derives a deterministic `FieldPlan` from your JSON Schema before calling any model:
|
|
85
|
+
|
|
86
|
+
- **Use booleans and enums for what matters.** `boolean`, `enum`, `const`, and `integer` default to `exact` comparison. These are the cleanest signals for catching real disagreement.
|
|
87
|
+
- **Use enum items for arrays you want compared.** If an array holds a known finite vocabulary (e.g. `z.array(z.enum(['auth', 'billing', 'api']))`), witnesses pick from the same tokens and `'set'` comparison works reliably. **Free-text `z.array(z.string())` items almost always split** because different models phrase string elements differently (`"login flow"` vs `"authentication"`).
|
|
88
|
+
- **Keep free text (`z.string()`) for reasoning and summaries.** Unconstrained strings and numbers without a tolerance default to `'none'` (`not-compared`) by policy. Their answers are still preserved per witness and shown side by side in rendered output without triggering false splits.
|
|
89
|
+
- **Specify tolerances on floats.** `z.number()` defaults to `'none'` (`number-without-tolerance`). Pass `compare: { confidence: { tolerance: { absolute: 0.05 } } }` (or `{ relative: ... }`) to group numbers with single-linkage clustering.
|
|
90
|
+
- **Override comparators when structure needs help.** Supported overrides in `compare`: `'exact'`, `'set'`, `'none'`, `{ tolerance: { absolute?, relative? }, onSplit? }`, `{ key: 'id', onSplit? }` (for arrays of objects matched by unique key), and `{ onSplit: 'info' | 'warn' | 'critical' }`.
|
|
91
|
+
|
|
92
|
+
## Coverage, Findings, and Advisory
|
|
93
|
+
|
|
94
|
+
- **`coverage`:** Tracks every leaf and composite entry in the comparison plan:
|
|
95
|
+
- `compared`: fields actively compared (`exact`, `tolerance`, `set`, `keyed-set`, `discriminated-union`).
|
|
96
|
+
- `notComparedByPolicy`: fields intentionally skipped (`free-text`, `number-without-tolerance`, `caller-none`). These do **not** lower `coverage.ratio`.
|
|
97
|
+
- `unsupported` / `failedAtRuntime`: schema constructs Dissent does not compare (for example object arrays without `{ key }`, untyped schemas, external `$ref`s) or runtime key collisions (`duplicate-key`). These **do** lower `coverage.ratio = compared / (fields - notComparedByPolicy)`.
|
|
98
|
+
- **`findings` and `advisory`:** Deterministic rollup of quorum, witness failures/exclusions, field splits (`info` | `warn` | `critical`), duplicate keys, coverage drops, and independence checks (`single-provider`, `duplicate-served-model`, `self-grading`).
|
|
99
|
+
- Any `critical` finding produces `advisory: 'review-required'`.
|
|
100
|
+
- Any `warn` finding produces `advisory: 'warnings'`.
|
|
101
|
+
- Otherwise `advisory: 'clear'`.
|
|
102
|
+
|
|
103
|
+
## Adjudication and Evidence
|
|
104
|
+
|
|
105
|
+
`adjudicate(ledger, evidence, options?)` keeps witness comparison and tool truth strictly separate:
|
|
106
|
+
|
|
107
|
+
1. **Field-bound settlements (`claim: { path, value }`):** Checks whether deterministic evidence agrees with each answering witness on a compared field (`witnessesAgreeing`, `witnessesDissenting`, `witnessesSilent`). Field-bound evidence **never** sets the overall verdict.
|
|
108
|
+
2. **Artifact verdict (`claim: { scope: 'artifact' }`):** Drives `verdict` and `verdictReason`:
|
|
109
|
+
- Zero artifact evidence → `uncertain` (`no-artifact-evidence`)
|
|
110
|
+
- Any artifact `fail` → `rejected` (`artifact-evidence-failed`)
|
|
111
|
+
- Any artifact `error` or `unknown` without a `fail` → `uncertain` (`artifact-evidence-inconclusive`)
|
|
112
|
+
- All artifact checks `pass` (and `escalateOnReview` not triggered) → `confirmed` (`artifact-evidence-passed`)
|
|
113
|
+
- All artifact checks `pass` + `escalateOnReview: true` + `ledger.advisory === 'review-required'` → `uncertain` (`escalated-on-review`)
|
|
114
|
+
3. **Unbound evidence:** Evidence without a `claim`, targeting an unknown path, or targeting a path inside a keyed array item is recorded in `unbound` without moving `verdict`.
|
|
115
|
+
|
|
116
|
+
> **Experimental APIs:** `Evidence.claims`, `Evidence.receipt`, `validateOfflineReceipt()`, and `AdjudicateOptions.requireOfflineReceipt` are marked `@experimental` and may change in a minor release before an external sandbox receipt producer is added.
|
|
117
|
+
|
|
118
|
+
## Rendering (`formatLedger`)
|
|
119
|
+
|
|
120
|
+
`formatLedger(ledger, options?)` formats ledgers and optional `Adjudication` results in two layouts:
|
|
121
|
+
|
|
122
|
+
- `'markdown'` (default): GitHub-flavored Markdown with headers, witness status table, independence summary, field results, coverage, findings, adjudication verdict/settlements, and dynamic-fence untrusted blocks.
|
|
123
|
+
- `'ascii'`: 78-column plain-ASCII layout suitable for terminals and CI logs, free of ANSI/OSC escape sequences and BiDi control characters.
|
|
124
|
+
|
|
125
|
+
All untrusted strings (model outputs, error messages, evidence sources, model IDs) are sanitized and escaped before emission.
|
|
126
|
+
|
|
127
|
+
## Privacy and Cost Notes
|
|
128
|
+
|
|
129
|
+
- **Privacy:** Your `instructions`, `prompt` / `messages`, and `schema` are sent to **every** non-excluded model configured in `witnesses` (each witness provider receives the full request). By default (`includeInput: 'hash'`), the returned `Ledger` records only SHA-256 hashes of inputs rather than the prompt text; pass `includeInput: 'full'` only when storing raw inputs in ledgers is acceptable. Error messages captured from SDK errors are stripped of control characters and redacted for common bearer/key/credential tokens before storage.
|
|
130
|
+
- **Cost and Latency:** Corroborating across `N` witnesses makes `N` independent `generateText` requests, consuming roughly `N×` input/output tokens and billing across the providers you configure. Requests run concurrently up to `maxConcurrency` (default `8`), and token totals are aggregated in `ledger.usage`.
|
|
131
|
+
|
|
132
|
+
## Running the Example
|
|
133
|
+
|
|
134
|
+
Run the end-to-end API change review example locally with a Vercel AI Gateway key (`AI_GATEWAY_API_KEY`):
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
AI_GATEWAY_API_KEY=... pnpm exec unrun examples/api-change-review.ts
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Or load the key from a local env file:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
node --env-file=.env.local node_modules/unrun/dist/cli.mjs examples/api-change-review.ts
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Live Run Output
|
|
147
|
+
|
|
148
|
+
Captured live from `examples/api-change-review.ts` against `google/gemini-2.5-flash`, `openai/gpt-4o-mini`, and `zai/glm-4.7-flash` via Vercel AI Gateway:
|
|
149
|
+
|
|
150
|
+
- All three models agreed on `/changesPublicApi` (`true`, 3/3) and `/risk` (`"high"`, 3/3).
|
|
151
|
+
- `/affectedExports` (`z.array(z.string())`) split (`J=0.75`, 3 in intersection, 4 in union), illustrating why finite vocabularies should use `z.array(z.enum([...]))`.
|
|
152
|
+
- `/confidence` split within `[0.9, 1.0]` (`spread 0.1` > `0.05` tolerance), recorded at `info` severity (`onSplit: 'info'`).
|
|
153
|
+
- `tsc --noEmit` (`scope: 'artifact'`, `pass`) drove the `confirmed` verdict, while `diff-export-check` settled `/changesPublicApi` (`agree=[google, openai, zai]`).
|
|
154
|
+
|
|
155
|
+
````markdown
|
|
156
|
+
## Dissent Ledger
|
|
157
|
+
|
|
158
|
+
- **Protocol:** dissent-ledger/1
|
|
159
|
+
- **Fingerprint:** 1c9c638599f8dfe6909f0d265ba2dd9739c38ff8b89dc52539ebb2d2f7b45d79
|
|
160
|
+
- **Created:** 2026-11-14T18:41:34.314Z
|
|
161
|
+
|
|
162
|
+
Advisory: warnings · Quorum: 3/3 answered (0 failed, 0 excluded) · Coverage: compared 4 of 5 fields (100%)
|
|
163
|
+
|
|
164
|
+
### Witnesses
|
|
165
|
+
|
|
166
|
+
| Label | Requested | Served | Status | Detail | Duration | Tokens |
|
|
167
|
+
| ------ | -------------------------- | -------------------------- | -------- | ------ | -------: | -----: |
|
|
168
|
+
| google | google/gemini\-2\.5\-flash | google/gemini\-2\.5\-flash | answered | — | 5134ms | 1162 |
|
|
169
|
+
| openai | openai/gpt\-4o\-mini | openai/gpt\-4o\-mini | answered | — | 2619ms | 440 |
|
|
170
|
+
| zai | zai/glm\-4\.7\-flash | zai/glm\-4\.7\-flash | answered | — | 2095ms | 703 |
|
|
171
|
+
|
|
172
|
+
### Fields
|
|
173
|
+
|
|
174
|
+
| Path | Comparator | Status | Summary |
|
|
175
|
+
| ----------------- | ---------- | ------------ | -------------------------------------------- |
|
|
176
|
+
| /affectedExports | set | split | ∩ 3 · ∪ 4 · J=0.75: `"runReview"` (2/3) |
|
|
177
|
+
| /changesPublicApi | exact | agree | `true` (3/3) |
|
|
178
|
+
| /confidence | tolerance | split | 0.9–1 (spread 0.1) · 0.9–0.95 (2/3), 1 (1/3) |
|
|
179
|
+
| /reasoning | none | not-compared | policy/free\-text |
|
|
180
|
+
| /risk | exact | agree | `"high"` (3/3) |
|
|
181
|
+
|
|
182
|
+
### Read side by side
|
|
183
|
+
|
|
184
|
+
- **/reasoning — google:**
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
The diff introduces multiple breaking changes to the public API. The `ReviewOptions` interface has removed the `system` property (previously deprecated) and introduced `instructions`. The `ReviewResult.score` property's type has changed from a number to a union of string literals ('low' | 'medium' | 'high'), which is a fundamental type change. Furthermore, the main exported function `runReview` has been renamed to `executeReview`. All these changes will require consumers to update their code, leading to a high migration risk.
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
- **/reasoning — openai:**
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
The renaming of the function `runReview` to `executeReview` and the change in type for the `score` property in the `ReviewResult` interface from a number range to a specific string union type ('low' | 'medium' | 'high') are both breaking changes. Additionally, the deprecation of the `system` property in `ReviewOptions` towards `instructions` may affect users who were relying on the old structure.
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
- **/reasoning — zai:**
|
|
197
|
+
|
|
198
|
+
```
|
|
199
|
+
The diff introduces a breaking API change: the `runReview` function has been renamed to `executeReview`, renaming the only public export of type `Promise<ReviewResult>`. In addition, the `ReviewOptions` interface changed the incompatible `system?: string` to `instructions?: string`, requiring code to update all callers. The `ReviewResult.score` property has changed from `number` to a union string type (`'low' | 'medium' | 'high'`), and a new property `score` was added and marked as breaking. Since all top-level exports in `src/client.ts` are affected and the changes are not additive or safe defaults, this is a high-risk migration.
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Findings
|
|
203
|
+
|
|
204
|
+
| Severity | Code | Target | Witnesses |
|
|
205
|
+
| -------- | ----------- | ---------------- | ------------------- |
|
|
206
|
+
| warn | field-split | /affectedExports | google, openai, zai |
|
|
207
|
+
| info | field-split | /confidence | google, openai, zai |
|
|
208
|
+
|
|
209
|
+
### Independence
|
|
210
|
+
|
|
211
|
+
- **Unique requested providers:** 3
|
|
212
|
+
|
|
213
|
+
### Adjudication
|
|
214
|
+
|
|
215
|
+
- **Verdict:** confirmed (artifact-evidence-passed)
|
|
216
|
+
- **Artifact evidence:** pass=1, fail=0, error=0, unknown=0
|
|
217
|
+
- **Unbound:** 0
|
|
218
|
+
- **Conflicts:** 0
|
|
219
|
+
|
|
220
|
+
| Path | Value | Source | Outcome | Agreeing | Dissenting | Silent |
|
|
221
|
+
| ----------------- | ------ | ------------------- | ------- | ------------------- | ---------- | ------ |
|
|
222
|
+
| /changesPublicApi | `true` | diff\-export\-check | pass | google, openai, zai | — | — |
|
|
223
|
+
````
|
|
224
|
+
|
|
225
|
+
<details>
|
|
226
|
+
<summary>ASCII output from the same run</summary>
|
|
227
|
+
|
|
228
|
+
```text
|
|
229
|
+
==============================================================================
|
|
230
|
+
Dissent Ledger
|
|
231
|
+
==============================================================================
|
|
232
|
+
Protocol : dissent-ledger/1
|
|
233
|
+
Fingerprint : 1c9c638599f8…
|
|
234
|
+
Created : 2026-11-14T18:41:34.314Z
|
|
235
|
+
|
|
236
|
+
Advisory: warnings · Quorum: 3/3 answered (0 failed, 0 excluded) · Coverage: compared 4 of 5 fields (100%)
|
|
237
|
+
|
|
238
|
+
Witnesses
|
|
239
|
+
------------------------------------------------------------------------------
|
|
240
|
+
google : status=answered, req=google/gemini-2.5-flash, served=google/gemini-2.5-flash, detail=—, duration=5134ms, tokens=1162
|
|
241
|
+
openai : status=answered, req=openai/gpt-4o-mini, served=openai/gpt-4o-mini, detail=—, duration=2619ms, tokens=440
|
|
242
|
+
zai : status=answered, req=zai/glm-4.7-flash, served=zai/glm-4.7-flash, detail=—, duration=2095ms, tokens=703
|
|
243
|
+
|
|
244
|
+
Fields
|
|
245
|
+
------------------------------------------------------------------------------
|
|
246
|
+
/affectedExports : set [split] -- ∩ 3 · ∪ 4 · J=0.75: "runReview" (2/3)
|
|
247
|
+
/changesPublicApi : exact [agree] -- true (3/3)
|
|
248
|
+
/confidence : tolerance [split] -- 0.9–1 (spread 0.1) · 0.9–0.95 (2/3), 1 (1/3)
|
|
249
|
+
/reasoning : none [not-compared] -- policy/free-text
|
|
250
|
+
/risk : exact [agree] -- "high" (3/3)
|
|
251
|
+
|
|
252
|
+
Read side by side
|
|
253
|
+
------------------------------------------------------------------------------
|
|
254
|
+
/reasoning (google) :
|
|
255
|
+
The diff introduces multiple breaking changes to the public API. The `ReviewOptions` interface has removed the `system` property (previously deprecated) and introduced `instructions`. The `ReviewResult.score` property's type has changed from a number to a union of string literals ('low' | 'medium' | 'high'), which is a fundamental type change. Furthermore, the main exported function `runReview` has been renamed to `executeReview`. All these changes will require consumers to update their code, leading to a high migration risk.
|
|
256
|
+
/reasoning (openai) :
|
|
257
|
+
The renaming of the function `runReview` to `executeReview` and the change in type for the `score` property in the `ReviewResult` interface from a number range to a specific string union type ('low' | 'medium' | 'high') are both breaking changes. Additionally, the deprecation of the `system` property in `ReviewOptions` towards `instructions` may affect users who were relying on the old structure.
|
|
258
|
+
/reasoning (zai) :
|
|
259
|
+
The diff introduces a breaking API change: the `runReview` function has been renamed to `executeReview`, renaming the only public export of type `Promise<ReviewResult>`. In addition, the `ReviewOptions` interface changed the incompatible `system?: string` to `instructions?: string`, requiring code to update all callers. The `ReviewResult.score` property has changed from `number` to a union string type (`'low' | 'medium' | 'high'`), and a new property `score` was added and marked as breaking. Since all top-level exports in `src/client.ts` are affected and the changes are not additive or safe defaults, this is a high-risk migration.
|
|
260
|
+
|
|
261
|
+
Findings
|
|
262
|
+
------------------------------------------------------------------------------
|
|
263
|
+
warn : field-split, target=/affectedExports, witnesses=google, openai, zai
|
|
264
|
+
info : field-split, target=/confidence, witnesses=google, openai, zai
|
|
265
|
+
|
|
266
|
+
Independence
|
|
267
|
+
------------------------------------------------------------------------------
|
|
268
|
+
Unique requested providers : 3
|
|
269
|
+
|
|
270
|
+
Adjudication
|
|
271
|
+
------------------------------------------------------------------------------
|
|
272
|
+
Verdict : confirmed (artifact-evidence-passed)
|
|
273
|
+
Artifact evidence : pass=1, fail=0, error=0, unknown=0
|
|
274
|
+
Unbound : 0
|
|
275
|
+
Conflicts : 0
|
|
276
|
+
/changesPublicApi : value=true, source=diff-export-check, outcome=pass, agree=[google, openai, zai], dissent=[—], silent=[—]
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
</details>
|
|
280
|
+
|
|
281
|
+
## License
|
|
282
|
+
|
|
283
|
+
[Apache-2.0](./LICENSE)
|