@nvisy/sdk 0.41.0 → 0.42.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/CHANGELOG.md +14 -1
- package/dist/{client-CmoKiYBW.d.ts → client-xTk64SwL.d.ts} +6 -6
- package/dist/{client-CmoKiYBW.d.ts.map → client-xTk64SwL.d.ts.map} +1 -1
- package/dist/datatypes/index.d.ts +1 -1
- package/dist/{error-D0ZutHVP.js → error-WMvrsPwY.js} +2 -2
- package/dist/{error-D0ZutHVP.js.map → error-WMvrsPwY.js.map} +1 -1
- package/dist/{errors-B0cfPrDB.d.ts → errors-DIGSyhl4.d.ts} +2 -2
- package/dist/{errors-B0cfPrDB.d.ts.map → errors-DIGSyhl4.d.ts.map} +1 -1
- package/dist/{index-Co9cILnx.d.ts → index-B42oglvJ.d.ts} +187 -169
- package/dist/{index-Co9cILnx.d.ts.map → index-B42oglvJ.d.ts.map} +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/services/index.d.ts +1 -1
- package/dist/services/index.js +1 -1
- package/dist/{services-DIm-mBQR.js → services-BUHecjRT.js} +5 -5
- package/dist/services-BUHecjRT.js.map +1 -0
- package/dist/standalone/index.d.ts +1 -1
- package/dist/standalone/index.js +1 -1
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +3 -3
- package/dist/services-DIm-mBQR.js.map +0 -1
|
@@ -5976,7 +5976,7 @@ interface paths {
|
|
|
5976
5976
|
};
|
|
5977
5977
|
/**
|
|
5978
5978
|
* Get detection intermediates
|
|
5979
|
-
* @description Returns the detection's enrichment intermediates — an image's OCR layout, an audio clip's transcript, or tokenized text — as `
|
|
5979
|
+
* @description Returns the detection's enrichment intermediates — an image's OCR layout, an audio clip's transcript, or tokenized text — as an object with a `parts` list, each part carrying its path `id`, `modality`, and the extracted `artifact`, so a client can search the content and add entities the analysis missed. A detection whose analysis ran no enricher has no intermediates (404).
|
|
5980
5980
|
*/
|
|
5981
5981
|
get: {
|
|
5982
5982
|
parameters: {
|
|
@@ -9541,48 +9541,33 @@ interface components {
|
|
|
9541
9541
|
token: string;
|
|
9542
9542
|
};
|
|
9543
9543
|
ArtifactSet: {
|
|
9544
|
-
|
|
9544
|
+
parts: ({
|
|
9545
9545
|
artifact: components["schemas"]["Tokens"];
|
|
9546
|
+
id: string[];
|
|
9546
9547
|
/** @constant */
|
|
9547
9548
|
modality: "text";
|
|
9548
9549
|
} | {
|
|
9549
9550
|
artifact: components["schemas"]["Layout"];
|
|
9551
|
+
id: string[];
|
|
9550
9552
|
/** @constant */
|
|
9551
9553
|
modality: "image";
|
|
9552
9554
|
} | {
|
|
9553
9555
|
artifact: components["schemas"]["Transcription"];
|
|
9556
|
+
id: string[];
|
|
9554
9557
|
/** @constant */
|
|
9555
9558
|
modality: "audio";
|
|
9556
9559
|
} | {
|
|
9557
9560
|
artifact: components["schemas"]["Tokens"];
|
|
9561
|
+
id: string[];
|
|
9558
9562
|
/** @constant */
|
|
9559
9563
|
modality: "tabular";
|
|
9560
|
-
})
|
|
9561
|
-
parts: {
|
|
9562
|
-
[key: string]: {
|
|
9563
|
-
artifact: components["schemas"]["Tokens"];
|
|
9564
|
-
/** @constant */
|
|
9565
|
-
modality: "text";
|
|
9566
|
-
} | {
|
|
9567
|
-
artifact: components["schemas"]["Layout"];
|
|
9568
|
-
/** @constant */
|
|
9569
|
-
modality: "image";
|
|
9570
|
-
} | {
|
|
9571
|
-
artifact: components["schemas"]["Transcription"];
|
|
9572
|
-
/** @constant */
|
|
9573
|
-
modality: "audio";
|
|
9574
|
-
} | {
|
|
9575
|
-
artifact: components["schemas"]["Tokens"];
|
|
9576
|
-
/** @constant */
|
|
9577
|
-
modality: "tabular";
|
|
9578
|
-
};
|
|
9579
|
-
};
|
|
9564
|
+
})[];
|
|
9580
9565
|
};
|
|
9581
9566
|
/**
|
|
9582
9567
|
* @description Author-supplied rationale for a redaction: *under what authority* it was made.
|
|
9583
9568
|
*
|
|
9584
9569
|
* Where the matched selection rule answers *which rule fired*, an
|
|
9585
|
-
* `Attribution` answers *why the policy demanded it
|
|
9570
|
+
* `Attribution` answers *why the policy demanded it*, a compliance clause, an
|
|
9586
9571
|
* internal policy, a data-handling rule. A policy author attaches it to a
|
|
9587
9572
|
* selection rule (`Rule::because` in `elide-redaction`); the anonymizer records
|
|
9588
9573
|
* it on the entity's [`Redaction`] event so an audit can trace a change back to
|
|
@@ -9629,31 +9614,42 @@ interface components {
|
|
|
9629
9614
|
/** @description What the reviewer says this is. */
|
|
9630
9615
|
label: components["schemas"]["LabelRef"];
|
|
9631
9616
|
/**
|
|
9632
|
-
* @description Where it sits, in the coordinates of the
|
|
9617
|
+
* @description Where it sits, in the coordinates of the part it joins.
|
|
9633
9618
|
*
|
|
9634
|
-
*
|
|
9635
|
-
*
|
|
9636
|
-
*
|
|
9637
|
-
*
|
|
9638
|
-
*
|
|
9639
|
-
* engine reverse-resolves.
|
|
9619
|
+
* Each medium addresses its own way: text a character range
|
|
9620
|
+
* over the decoded stream, images a bounding box, audio a time
|
|
9621
|
+
* span, tabular a row and column. A DOCX's
|
|
9622
|
+
* `word/document.xml` text belongs to the document part
|
|
9623
|
+
* itself, not to a nested one.
|
|
9640
9624
|
*
|
|
9625
|
+
* For text specifically, a caller holding raw file bytes
|
|
9626
|
+
* rather than a decoded offset — a reviewer selecting rendered
|
|
9627
|
+
* text, say — leaves [`TextLocation::range`] empty and fills
|
|
9628
|
+
* [`TextLocation::source`] instead, which the engine
|
|
9629
|
+
* reverse-resolves. The other three have no such alternative:
|
|
9630
|
+
* their coordinates are the only way in.
|
|
9631
|
+
*
|
|
9632
|
+
* [`TextLocation::range`]: elide::modality::text::TextLocation::range
|
|
9641
9633
|
* [`TextLocation::source`]: elide::modality::text::TextLocation::source
|
|
9642
9634
|
*/
|
|
9643
9635
|
location: components["schemas"]["AudioLocation"];
|
|
9644
9636
|
/**
|
|
9645
|
-
* @description The
|
|
9646
|
-
* `"word/media/image1.png"
|
|
9637
|
+
* @description The part this belongs to, as a path: `["report.docx"]` for
|
|
9638
|
+
* the document itself, `["report.docx", "word/media/image1.png"]`
|
|
9639
|
+
* for media it embeds. `None` means the request's sole
|
|
9640
|
+
* document, which is the common case and saves a caller
|
|
9641
|
+
* naming what it already sent.
|
|
9647
9642
|
*
|
|
9648
|
-
*
|
|
9649
|
-
* its own
|
|
9650
|
-
*
|
|
9643
|
+
* Nested media needs this: the report holds an embedded image
|
|
9644
|
+
* as its own part, and an addition to one has nowhere to go
|
|
9645
|
+
* without naming it. Text usually does not — where a span came
|
|
9646
|
+
* from is already in `TextLocation::source`, which carries the
|
|
9647
|
+
* part alongside the raw range.
|
|
9651
9648
|
*
|
|
9652
|
-
*
|
|
9653
|
-
*
|
|
9654
|
-
* which carries the part alongside the raw range.
|
|
9649
|
+
* `None` is an error when the request carried several
|
|
9650
|
+
* documents, since there is then no sole document to mean.
|
|
9655
9651
|
*/
|
|
9656
|
-
part?: string;
|
|
9652
|
+
part?: string[];
|
|
9657
9653
|
/** @description The rationale, when one was given. */
|
|
9658
9654
|
reason?: string;
|
|
9659
9655
|
};
|
|
@@ -9839,13 +9835,13 @@ interface components {
|
|
|
9839
9835
|
*
|
|
9840
9836
|
* Carries the encoded audio bytes; an optional filename aids diagnostics
|
|
9841
9837
|
* and encoding inference (the container format a decoder should expect).
|
|
9842
|
-
* The recognizable text
|
|
9838
|
+
* The recognizable text, a timestamped transcript, is *not* held here;
|
|
9843
9839
|
* a speech-to-text [`Enricher`] stamps it onto the call's
|
|
9844
9840
|
* [`artifact`], keeping
|
|
9845
9841
|
* `AudioData` the codec's payload alone.
|
|
9846
9842
|
*
|
|
9847
9843
|
* [`Audio`]: super::Audio
|
|
9848
|
-
* [`Enricher`]: crate::
|
|
9844
|
+
* [`Enricher`]: crate::enrichment::Enricher
|
|
9849
9845
|
* [`artifact`]: crate::recognition::RecognizerContext::artifact
|
|
9850
9846
|
*/
|
|
9851
9847
|
AudioData: {
|
|
@@ -9899,7 +9895,7 @@ interface components {
|
|
|
9899
9895
|
* @description Tamper-evident audit trail: every contributing detection, the fusion
|
|
9900
9896
|
* event if any, and the redaction that hid it, as a hash-linked DAG. It is
|
|
9901
9897
|
* also the single source of truth for whether a reviewer
|
|
9902
|
-
* [suppressed](Self::is_suppressed) the entity
|
|
9898
|
+
* [suppressed](Self::is_suppressed) the entity, a suppression is a
|
|
9903
9899
|
* [`Manual`] event on this trail, not a separate flag.
|
|
9904
9900
|
*
|
|
9905
9901
|
* [`Manual`]: crate::entity::audit::AuditKind::Manual
|
|
@@ -9936,7 +9932,7 @@ interface components {
|
|
|
9936
9932
|
location: components["schemas"]["AudioLocation"];
|
|
9937
9933
|
/**
|
|
9938
9934
|
* @description Byte range of the match in the *recognized text* it was found in (the
|
|
9939
|
-
* OCR layout text, the audio transcript, or the text payload itself)
|
|
9935
|
+
* OCR layout text, the audio transcript, or the text payload itself),
|
|
9940
9936
|
* the stable key back into that enrichment artifact, where the rich
|
|
9941
9937
|
* context lives (which OCR block, which speaker) that the geometric
|
|
9942
9938
|
* [`location`] cannot hold. `None` for entities not found via text
|
|
@@ -9952,11 +9948,11 @@ interface components {
|
|
|
9952
9948
|
* for a nearby value.
|
|
9953
9949
|
*
|
|
9954
9950
|
* Out-of-band by nature: a hint is *not* a sub-span of the value it
|
|
9955
|
-
* informs
|
|
9951
|
+
* informs; it lives elsewhere in the source (a table's column header, a
|
|
9956
9952
|
* JSON object key, a log field name). So `location` points at where the
|
|
9957
9953
|
* hint text actually sits, and `data` is the hint text itself. Carrying
|
|
9958
9954
|
* the location (rather than a bare string) lets a confidence boost record
|
|
9959
|
-
* *which* hint lifted a score and *where* it came from
|
|
9955
|
+
* *which* hint lifted a score and *where* it came from, provenance a
|
|
9960
9956
|
* review consumer can resolve back to the document.
|
|
9961
9957
|
*
|
|
9962
9958
|
* Mirrors [`Entity`]'s `location` + `data` shape, so the same
|
|
@@ -9990,7 +9986,7 @@ interface components {
|
|
|
9990
9986
|
/**
|
|
9991
9987
|
* @description A human override, outside automatic detection: an entity a reviewer added by
|
|
9992
9988
|
* hand, or a detected one they marked to ignore. Its provenance is a person's
|
|
9993
|
-
* decision, not a recognizer's
|
|
9989
|
+
* decision, not a recognizer's, so the trail records *why* (an
|
|
9994
9990
|
* [`Attribution`], when supplied). *Who* made the override is the event's
|
|
9995
9991
|
* [`source`], not a payload field.
|
|
9996
9992
|
*
|
|
@@ -10006,7 +10002,7 @@ interface components {
|
|
|
10006
10002
|
/**
|
|
10007
10003
|
* @description Which human decision this records: including a missed entity, or
|
|
10008
10004
|
* suppressing a detected one. This is the authority on whether the entity
|
|
10009
|
-
* is redacted
|
|
10005
|
+
* is redacted, [`AuditLog::is_suppressed`] reads it, so there is no
|
|
10010
10006
|
* separate flag to keep in sync.
|
|
10011
10007
|
*
|
|
10012
10008
|
* [`AuditLog::is_suppressed`]: crate::entity::audit::AuditLog::is_suppressed
|
|
@@ -10172,16 +10168,18 @@ interface components {
|
|
|
10172
10168
|
*/
|
|
10173
10169
|
context: components["schemas"]["DocumentContext"];
|
|
10174
10170
|
/**
|
|
10175
|
-
* @description The detections: elide's own report,
|
|
10176
|
-
* parts, each entity carrying its provenance
|
|
10171
|
+
* @description The detections: elide's own report, every document and the
|
|
10172
|
+
* parts nested in one, each entity carrying its provenance
|
|
10173
|
+
* chain.
|
|
10177
10174
|
*
|
|
10178
|
-
* Edit it through [`Report`]'s own API — [`
|
|
10179
|
-
* [`
|
|
10175
|
+
* Edit it through [`Report`]'s own API — [`include_part`],
|
|
10176
|
+
* [`suppress_part`], [`part_entities`] — for the decisions
|
|
10177
|
+
* elide models.
|
|
10180
10178
|
*
|
|
10181
10179
|
* [`Report`]: elide::Report
|
|
10182
|
-
* [`
|
|
10183
|
-
* [`
|
|
10184
|
-
* [`
|
|
10180
|
+
* [`include_part`]: elide::Report::include_part
|
|
10181
|
+
* [`suppress_part`]: elide::Report::suppress_part
|
|
10182
|
+
* [`part_entities`]: elide::Report::part_entities
|
|
10185
10183
|
*/
|
|
10186
10184
|
report: components["schemas"]["Report"];
|
|
10187
10185
|
/**
|
|
@@ -10511,7 +10509,7 @@ interface components {
|
|
|
10511
10509
|
ConfidenceThreshold: number;
|
|
10512
10510
|
/**
|
|
10513
10511
|
* @description A competing detection of a *different* label over the same span was resolved
|
|
10514
|
-
* against this (winning) entity
|
|
10512
|
+
* against this (winning) entity, the loser is recorded, not dropped.
|
|
10515
10513
|
*/
|
|
10516
10514
|
Conflict: {
|
|
10517
10515
|
/** @description The loser's confidence at resolution time. */
|
|
@@ -10927,7 +10925,7 @@ interface components {
|
|
|
10927
10925
|
* @description The coarseness a [`GeneralizeDate`] reduces a date/timestamp to.
|
|
10928
10926
|
*
|
|
10929
10927
|
* Every rendering is an ISO-8601 form, so the output is locale-independent
|
|
10930
|
-
* by construction
|
|
10928
|
+
* by construction, no localized month names or week markers to configure.
|
|
10931
10929
|
*/
|
|
10932
10930
|
DateGranularity: "year" | "year_month" | "hour";
|
|
10933
10931
|
/**
|
|
@@ -11606,31 +11604,42 @@ interface components {
|
|
|
11606
11604
|
/** @description What the reviewer says this is. */
|
|
11607
11605
|
label: components["schemas"]["LabelRef"];
|
|
11608
11606
|
/**
|
|
11609
|
-
* @description Where it sits, in the coordinates of the
|
|
11607
|
+
* @description Where it sits, in the coordinates of the part it joins.
|
|
11610
11608
|
*
|
|
11611
|
-
*
|
|
11612
|
-
*
|
|
11613
|
-
*
|
|
11614
|
-
*
|
|
11615
|
-
*
|
|
11616
|
-
* engine reverse-resolves.
|
|
11609
|
+
* Each medium addresses its own way: text a character range
|
|
11610
|
+
* over the decoded stream, images a bounding box, audio a time
|
|
11611
|
+
* span, tabular a row and column. A DOCX's
|
|
11612
|
+
* `word/document.xml` text belongs to the document part
|
|
11613
|
+
* itself, not to a nested one.
|
|
11617
11614
|
*
|
|
11615
|
+
* For text specifically, a caller holding raw file bytes
|
|
11616
|
+
* rather than a decoded offset — a reviewer selecting rendered
|
|
11617
|
+
* text, say — leaves [`TextLocation::range`] empty and fills
|
|
11618
|
+
* [`TextLocation::source`] instead, which the engine
|
|
11619
|
+
* reverse-resolves. The other three have no such alternative:
|
|
11620
|
+
* their coordinates are the only way in.
|
|
11621
|
+
*
|
|
11622
|
+
* [`TextLocation::range`]: elide::modality::text::TextLocation::range
|
|
11618
11623
|
* [`TextLocation::source`]: elide::modality::text::TextLocation::source
|
|
11619
11624
|
*/
|
|
11620
11625
|
location: components["schemas"]["ImageLocation"];
|
|
11621
11626
|
/**
|
|
11622
|
-
* @description The
|
|
11623
|
-
* `"word/media/image1.png"
|
|
11627
|
+
* @description The part this belongs to, as a path: `["report.docx"]` for
|
|
11628
|
+
* the document itself, `["report.docx", "word/media/image1.png"]`
|
|
11629
|
+
* for media it embeds. `None` means the request's sole
|
|
11630
|
+
* document, which is the common case and saves a caller
|
|
11631
|
+
* naming what it already sent.
|
|
11624
11632
|
*
|
|
11625
|
-
*
|
|
11626
|
-
* its own
|
|
11627
|
-
*
|
|
11633
|
+
* Nested media needs this: the report holds an embedded image
|
|
11634
|
+
* as its own part, and an addition to one has nowhere to go
|
|
11635
|
+
* without naming it. Text usually does not — where a span came
|
|
11636
|
+
* from is already in `TextLocation::source`, which carries the
|
|
11637
|
+
* part alongside the raw range.
|
|
11628
11638
|
*
|
|
11629
|
-
*
|
|
11630
|
-
*
|
|
11631
|
-
* which carries the part alongside the raw range.
|
|
11639
|
+
* `None` is an error when the request carried several
|
|
11640
|
+
* documents, since there is then no sole document to mean.
|
|
11632
11641
|
*/
|
|
11633
|
-
part?: string;
|
|
11642
|
+
part?: string[];
|
|
11634
11643
|
/** @description The rationale, when one was given. */
|
|
11635
11644
|
reason?: string;
|
|
11636
11645
|
};
|
|
@@ -11874,7 +11883,7 @@ interface components {
|
|
|
11874
11883
|
* @description Tamper-evident audit trail: every contributing detection, the fusion
|
|
11875
11884
|
* event if any, and the redaction that hid it, as a hash-linked DAG. It is
|
|
11876
11885
|
* also the single source of truth for whether a reviewer
|
|
11877
|
-
* [suppressed](Self::is_suppressed) the entity
|
|
11886
|
+
* [suppressed](Self::is_suppressed) the entity, a suppression is a
|
|
11878
11887
|
* [`Manual`] event on this trail, not a separate flag.
|
|
11879
11888
|
*
|
|
11880
11889
|
* [`Manual`]: crate::entity::audit::AuditKind::Manual
|
|
@@ -11911,7 +11920,7 @@ interface components {
|
|
|
11911
11920
|
location: components["schemas"]["ImageLocation"];
|
|
11912
11921
|
/**
|
|
11913
11922
|
* @description Byte range of the match in the *recognized text* it was found in (the
|
|
11914
|
-
* OCR layout text, the audio transcript, or the text payload itself)
|
|
11923
|
+
* OCR layout text, the audio transcript, or the text payload itself),
|
|
11915
11924
|
* the stable key back into that enrichment artifact, where the rich
|
|
11916
11925
|
* context lives (which OCR block, which speaker) that the geometric
|
|
11917
11926
|
* [`location`] cannot hold. `None` for entities not found via text
|
|
@@ -11927,11 +11936,11 @@ interface components {
|
|
|
11927
11936
|
* for a nearby value.
|
|
11928
11937
|
*
|
|
11929
11938
|
* Out-of-band by nature: a hint is *not* a sub-span of the value it
|
|
11930
|
-
* informs
|
|
11939
|
+
* informs; it lives elsewhere in the source (a table's column header, a
|
|
11931
11940
|
* JSON object key, a log field name). So `location` points at where the
|
|
11932
11941
|
* hint text actually sits, and `data` is the hint text itself. Carrying
|
|
11933
11942
|
* the location (rather than a bare string) lets a confidence boost record
|
|
11934
|
-
* *which* hint lifted a score and *where* it came from
|
|
11943
|
+
* *which* hint lifted a score and *where* it came from, provenance a
|
|
11935
11944
|
* review consumer can resolve back to the document.
|
|
11936
11945
|
*
|
|
11937
11946
|
* Mirrors [`Entity`]'s `location` + `data` shape, so the same
|
|
@@ -11970,7 +11979,7 @@ interface components {
|
|
|
11970
11979
|
/**
|
|
11971
11980
|
* @description A human override, outside automatic detection: an entity a reviewer added by
|
|
11972
11981
|
* hand, or a detected one they marked to ignore. Its provenance is a person's
|
|
11973
|
-
* decision, not a recognizer's
|
|
11982
|
+
* decision, not a recognizer's, so the trail records *why* (an
|
|
11974
11983
|
* [`Attribution`], when supplied). *Who* made the override is the event's
|
|
11975
11984
|
* [`source`], not a payload field.
|
|
11976
11985
|
*
|
|
@@ -11986,7 +11995,7 @@ interface components {
|
|
|
11986
11995
|
/**
|
|
11987
11996
|
* @description Which human decision this records: including a missed entity, or
|
|
11988
11997
|
* suppressing a detected one. This is the authority on whether the entity
|
|
11989
|
-
* is redacted
|
|
11998
|
+
* is redacted, [`AuditLog::is_suppressed`] reads it, so there is no
|
|
11990
11999
|
* separate flag to keep in sync.
|
|
11991
12000
|
*
|
|
11992
12001
|
* [`AuditLog::is_suppressed`]: crate::entity::audit::AuditLog::is_suppressed
|
|
@@ -12255,7 +12264,7 @@ interface components {
|
|
|
12255
12264
|
*
|
|
12256
12265
|
* # Identity
|
|
12257
12266
|
*
|
|
12258
|
-
* Labels are identified by [`id`]
|
|
12267
|
+
* Labels are identified by [`id`], a stable lowercase `snake_case`
|
|
12259
12268
|
* string (`"phone_number"`), never localized, and the catalog key that a
|
|
12260
12269
|
* [`LabelRef`] resolves through. Selectors match by id. Derived equality
|
|
12261
12270
|
* is *structural*: two labels with the same id but different
|
|
@@ -12266,7 +12275,7 @@ interface components {
|
|
|
12266
12275
|
* The display name and description are localized per [`LanguageTag`].
|
|
12267
12276
|
* English (`"en"`) is required at construction and is the fallback when a
|
|
12268
12277
|
* requested locale is absent, so [`localization`] always returns some
|
|
12269
|
-
* text
|
|
12278
|
+
* text, NER and LLM read the analysis language's name and description to
|
|
12270
12279
|
* prompt the model, keyed by the stable id.
|
|
12271
12280
|
*
|
|
12272
12281
|
* # Category and tags
|
|
@@ -12276,7 +12285,7 @@ interface components {
|
|
|
12276
12285
|
* labels ship with one; a custom label has none unless set.
|
|
12277
12286
|
*
|
|
12278
12287
|
* [`tags`] is a free-form list of *cross-cutting* markers a policy selector
|
|
12279
|
-
* matches against
|
|
12288
|
+
* matches against, sensitivity flags a label may carry several of (`pii`,
|
|
12280
12289
|
* `phi`, `pci`, `sad`, `secret`). Distinct from the category: a label has at
|
|
12281
12290
|
* most one category but any number of tags. Custom labels can ship with zero
|
|
12282
12291
|
* of either.
|
|
@@ -12323,7 +12332,7 @@ interface components {
|
|
|
12323
12332
|
* @description A label's human-facing text in one language: a display name and an
|
|
12324
12333
|
* optional fuller description.
|
|
12325
12334
|
*
|
|
12326
|
-
* The `name` is a short, natural-language phrase (`"phone number"`)
|
|
12335
|
+
* The `name` is a short, natural-language phrase (`"phone number"`), the
|
|
12327
12336
|
* label a zero-shot NER model like GLiNER matches on, and the primary
|
|
12328
12337
|
* text an LLM prompt shows. The `description` is optional extra guidance
|
|
12329
12338
|
* for backends that consume it (GLiNER-2.0's bi-encoder, an LLM); leave
|
|
@@ -12484,7 +12493,7 @@ interface components {
|
|
|
12484
12493
|
* @description An image's recognized text, laid out in space.
|
|
12485
12494
|
*
|
|
12486
12495
|
* An ordered set of [`LayoutBlock`]s (the recognized text regions). The flat
|
|
12487
|
-
* [`text`]
|
|
12496
|
+
* [`text`], the blocks joined, is what a recognizer
|
|
12488
12497
|
* inspects; [`resolve`] maps a byte range of that text back
|
|
12489
12498
|
* to the [`ImageLocation`] it occupies, using the blocks' (and their
|
|
12490
12499
|
* words') bounding boxes. Empty when the backend recognized nothing.
|
|
@@ -12533,7 +12542,7 @@ interface components {
|
|
|
12533
12542
|
* < Partial < Irrecoverable`. Surfaced through
|
|
12534
12543
|
* [`Operator::leak_profile`] for policy authoring and audit reporting.
|
|
12535
12544
|
*
|
|
12536
|
-
* [`Operator::leak_profile`]: crate::
|
|
12545
|
+
* [`Operator::leak_profile`]: crate::redaction::Operator::leak_profile
|
|
12537
12546
|
*/
|
|
12538
12547
|
LeakProfile: "recoverable" | "partial" | "irrecoverable";
|
|
12539
12548
|
/** @description Query parameters for listing files. */
|
|
@@ -12613,7 +12622,7 @@ interface components {
|
|
|
12613
12622
|
*
|
|
12614
12623
|
* The reusable mechanism behind any text that varies by language: a
|
|
12615
12624
|
* [`Label`]'s display name and description, a redaction operator's bucket
|
|
12616
|
-
* label, and so on. English (`"en"`) is the conventional anchor
|
|
12625
|
+
* label, and so on. English (`"en"`) is the conventional anchor,
|
|
12617
12626
|
* constructors seed it, and [`resolve`] falls back to it (then to any
|
|
12618
12627
|
* entry) when a requested locale is absent, so a caller that supplied
|
|
12619
12628
|
* English always gets *some* value.
|
|
@@ -12643,7 +12652,7 @@ interface components {
|
|
|
12643
12652
|
rememberMe?: boolean;
|
|
12644
12653
|
};
|
|
12645
12654
|
/**
|
|
12646
|
-
* @description Which human decision a [`Manual`] event records
|
|
12655
|
+
* @description Which human decision a [`Manual`] event records, the reviewer actions on a
|
|
12647
12656
|
* finding: [`Flag`](ManualIntent::Flag) a miss, [`Suppress`](ManualIntent::Suppress)
|
|
12648
12657
|
* a false positive, or [`Amend`](ManualIntent::Amend) an existing finding.
|
|
12649
12658
|
*/
|
|
@@ -12756,9 +12765,9 @@ interface components {
|
|
|
12756
12765
|
version?: string;
|
|
12757
12766
|
};
|
|
12758
12767
|
/**
|
|
12759
|
-
* @description
|
|
12760
|
-
*
|
|
12761
|
-
* pattern recognizer, a language enricher).
|
|
12768
|
+
* @description The model a model-backed recognizer or enricher called, and its token cost.
|
|
12769
|
+
*
|
|
12770
|
+
* Absent from a pure-CPU component (a pattern recognizer, a language enricher).
|
|
12762
12771
|
*/
|
|
12763
12772
|
ModelUsage: {
|
|
12764
12773
|
/** @description Model name the backend called (e.g. `"gpt-4o"`, `"gliner-multi"`). */
|
|
@@ -13832,42 +13841,27 @@ interface components {
|
|
|
13832
13841
|
acceptInvite: boolean;
|
|
13833
13842
|
};
|
|
13834
13843
|
Report: {
|
|
13835
|
-
|
|
13844
|
+
parts: ({
|
|
13836
13845
|
entities: components["schemas"]["TextEntity"][];
|
|
13846
|
+
id: string[];
|
|
13837
13847
|
/** @constant */
|
|
13838
13848
|
modality: "text";
|
|
13839
13849
|
} | {
|
|
13840
13850
|
entities: components["schemas"]["ImageEntity"][];
|
|
13851
|
+
id: string[];
|
|
13841
13852
|
/** @constant */
|
|
13842
13853
|
modality: "image";
|
|
13843
13854
|
} | {
|
|
13844
13855
|
entities: components["schemas"]["AudioEntity"][];
|
|
13856
|
+
id: string[];
|
|
13845
13857
|
/** @constant */
|
|
13846
13858
|
modality: "audio";
|
|
13847
13859
|
} | {
|
|
13848
13860
|
entities: components["schemas"]["TabularEntity"][];
|
|
13861
|
+
id: string[];
|
|
13849
13862
|
/** @constant */
|
|
13850
13863
|
modality: "tabular";
|
|
13851
|
-
})
|
|
13852
|
-
parts: {
|
|
13853
|
-
[key: string]: {
|
|
13854
|
-
entities: components["schemas"]["TextEntity"][];
|
|
13855
|
-
/** @constant */
|
|
13856
|
-
modality: "text";
|
|
13857
|
-
} | {
|
|
13858
|
-
entities: components["schemas"]["ImageEntity"][];
|
|
13859
|
-
/** @constant */
|
|
13860
|
-
modality: "image";
|
|
13861
|
-
} | {
|
|
13862
|
-
entities: components["schemas"]["AudioEntity"][];
|
|
13863
|
-
/** @constant */
|
|
13864
|
-
modality: "audio";
|
|
13865
|
-
} | {
|
|
13866
|
-
entities: components["schemas"]["TabularEntity"][];
|
|
13867
|
-
/** @constant */
|
|
13868
|
-
modality: "tabular";
|
|
13869
|
-
};
|
|
13870
|
-
};
|
|
13864
|
+
})[];
|
|
13871
13865
|
usage?: components["schemas"]["UsageReport"];
|
|
13872
13866
|
};
|
|
13873
13867
|
/**
|
|
@@ -13943,7 +13937,7 @@ interface components {
|
|
|
13943
13937
|
};
|
|
13944
13938
|
/**
|
|
13945
13939
|
* @description A serializable summary of *which selection rule* bound an operator to an
|
|
13946
|
-
* entity
|
|
13940
|
+
* entity, the automatic "why" behind a redaction.
|
|
13947
13941
|
*
|
|
13948
13942
|
* The anonymizer selects an operator by walking an ordered rule list and
|
|
13949
13943
|
* taking the first match. That decision is recorded on the [`Redaction`]
|
|
@@ -13995,8 +13989,8 @@ interface components {
|
|
|
13995
13989
|
* Built once with the `with_*` chain and passed by reference to the
|
|
13996
13990
|
* analyzer, which borrows it into a fresh [`RecognizerContext`] per
|
|
13997
13991
|
* payload. It holds only what the *caller* asserts about the analysis as a
|
|
13998
|
-
* whole
|
|
13999
|
-
* correlation id
|
|
13992
|
+
* whole, languages, jurisdictions, document labels, the target catalog, a
|
|
13993
|
+
* correlation id, none of which depends on the medium, so one [`Scope`]
|
|
14000
13994
|
* drives a text, image, or audio analysis alike.
|
|
14001
13995
|
*
|
|
14002
13996
|
* Per-medium regions (caller-supplied inclusions and exclusions, which are
|
|
@@ -14010,7 +14004,7 @@ interface components {
|
|
|
14010
14004
|
* the *request* driving it.
|
|
14011
14005
|
*
|
|
14012
14006
|
* Three axes of opaque classification strings elide neither ships nor
|
|
14013
|
-
* interprets
|
|
14007
|
+
* interprets, a downstream policy layer chooses what `"medical"` or
|
|
14014
14008
|
* `"fraud_detection"` or `"auditor"` mean. They are read in two places: a
|
|
14015
14009
|
* recognizer may bias its detection on them (the LLM prompt lists them so the
|
|
14016
14010
|
* model attends to the right terms), and a scope-aware operator predicate may
|
|
@@ -14020,7 +14014,7 @@ interface components {
|
|
|
14020
14014
|
* - [`tags`] classify the *document* (`"medical"`, `"gdpr-request"`).
|
|
14021
14015
|
* - [`purpose`] is why the request exists (`"fraud_detection"`).
|
|
14022
14016
|
* - [`audience`] is who the redacted output is for (`"support_agent"`,
|
|
14023
|
-
* `"auditor"`)
|
|
14017
|
+
* `"auditor"`), the axis PCI-style "same document, two masks" branches on.
|
|
14024
14018
|
*
|
|
14025
14019
|
* [`tags`]: Self::tags
|
|
14026
14020
|
* [`purpose`]: Self::purpose
|
|
@@ -14058,7 +14052,7 @@ interface components {
|
|
|
14058
14052
|
tags?: string[];
|
|
14059
14053
|
};
|
|
14060
14054
|
/**
|
|
14061
|
-
* @description An operator was *picked* to hide the entity
|
|
14055
|
+
* @description An operator was *picked* to hide the entity, the redaction decision,
|
|
14062
14056
|
* recorded before it is applied so it can be reviewed (and the entity edited)
|
|
14063
14057
|
* first. The [`Redaction`] event that follows records the operator actually
|
|
14064
14058
|
* run.
|
|
@@ -14076,7 +14070,7 @@ interface components {
|
|
|
14076
14070
|
matched_by: components["schemas"]["RuleMatch"];
|
|
14077
14071
|
/**
|
|
14078
14072
|
* @description Identity (name + version) of the operator picked. Its *config* is not
|
|
14079
|
-
* recorded
|
|
14073
|
+
* recorded; it lives in the policy that will run it, so apply re-resolves
|
|
14080
14074
|
* the configured operator rather than reading it here.
|
|
14081
14075
|
*/
|
|
14082
14076
|
operator: components["schemas"]["OperatorId"];
|
|
@@ -14134,8 +14128,8 @@ interface components {
|
|
|
14134
14128
|
/** @description Sort order direction. */
|
|
14135
14129
|
SortOrder: "asc" | "desc";
|
|
14136
14130
|
/**
|
|
14137
|
-
* @description A reference back to the original source: a byte range, and
|
|
14138
|
-
* whose body spans several files
|
|
14131
|
+
* @description A reference back to the original source: a byte range, and, for a container
|
|
14132
|
+
* whose body spans several files, which part that range indexes.
|
|
14139
14133
|
*
|
|
14140
14134
|
* [`TextLocation`]'s `range` indexes the *decoded* text stream a codec hands
|
|
14141
14135
|
* the pipeline (entities resolved, container parts concatenated). A `SourceRef`
|
|
@@ -14340,31 +14334,42 @@ interface components {
|
|
|
14340
14334
|
/** @description What the reviewer says this is. */
|
|
14341
14335
|
label: components["schemas"]["LabelRef"];
|
|
14342
14336
|
/**
|
|
14343
|
-
* @description Where it sits, in the coordinates of the
|
|
14337
|
+
* @description Where it sits, in the coordinates of the part it joins.
|
|
14344
14338
|
*
|
|
14345
|
-
*
|
|
14346
|
-
*
|
|
14347
|
-
*
|
|
14348
|
-
*
|
|
14349
|
-
*
|
|
14350
|
-
* engine reverse-resolves.
|
|
14339
|
+
* Each medium addresses its own way: text a character range
|
|
14340
|
+
* over the decoded stream, images a bounding box, audio a time
|
|
14341
|
+
* span, tabular a row and column. A DOCX's
|
|
14342
|
+
* `word/document.xml` text belongs to the document part
|
|
14343
|
+
* itself, not to a nested one.
|
|
14351
14344
|
*
|
|
14345
|
+
* For text specifically, a caller holding raw file bytes
|
|
14346
|
+
* rather than a decoded offset — a reviewer selecting rendered
|
|
14347
|
+
* text, say — leaves [`TextLocation::range`] empty and fills
|
|
14348
|
+
* [`TextLocation::source`] instead, which the engine
|
|
14349
|
+
* reverse-resolves. The other three have no such alternative:
|
|
14350
|
+
* their coordinates are the only way in.
|
|
14351
|
+
*
|
|
14352
|
+
* [`TextLocation::range`]: elide::modality::text::TextLocation::range
|
|
14352
14353
|
* [`TextLocation::source`]: elide::modality::text::TextLocation::source
|
|
14353
14354
|
*/
|
|
14354
14355
|
location: components["schemas"]["TabularLocation"];
|
|
14355
14356
|
/**
|
|
14356
|
-
* @description The
|
|
14357
|
-
* `"word/media/image1.png"
|
|
14357
|
+
* @description The part this belongs to, as a path: `["report.docx"]` for
|
|
14358
|
+
* the document itself, `["report.docx", "word/media/image1.png"]`
|
|
14359
|
+
* for media it embeds. `None` means the request's sole
|
|
14360
|
+
* document, which is the common case and saves a caller
|
|
14361
|
+
* naming what it already sent.
|
|
14358
14362
|
*
|
|
14359
|
-
*
|
|
14360
|
-
* its own
|
|
14361
|
-
*
|
|
14363
|
+
* Nested media needs this: the report holds an embedded image
|
|
14364
|
+
* as its own part, and an addition to one has nowhere to go
|
|
14365
|
+
* without naming it. Text usually does not — where a span came
|
|
14366
|
+
* from is already in `TextLocation::source`, which carries the
|
|
14367
|
+
* part alongside the raw range.
|
|
14362
14368
|
*
|
|
14363
|
-
*
|
|
14364
|
-
*
|
|
14365
|
-
* which carries the part alongside the raw range.
|
|
14369
|
+
* `None` is an error when the request carried several
|
|
14370
|
+
* documents, since there is then no sole document to mean.
|
|
14366
14371
|
*/
|
|
14367
|
-
part?: string;
|
|
14372
|
+
part?: string[];
|
|
14368
14373
|
/** @description The rationale, when one was given. */
|
|
14369
14374
|
reason?: string;
|
|
14370
14375
|
};
|
|
@@ -14592,7 +14597,7 @@ interface components {
|
|
|
14592
14597
|
* @description Tamper-evident audit trail: every contributing detection, the fusion
|
|
14593
14598
|
* event if any, and the redaction that hid it, as a hash-linked DAG. It is
|
|
14594
14599
|
* also the single source of truth for whether a reviewer
|
|
14595
|
-
* [suppressed](Self::is_suppressed) the entity
|
|
14600
|
+
* [suppressed](Self::is_suppressed) the entity, a suppression is a
|
|
14596
14601
|
* [`Manual`] event on this trail, not a separate flag.
|
|
14597
14602
|
*
|
|
14598
14603
|
* [`Manual`]: crate::entity::audit::AuditKind::Manual
|
|
@@ -14629,7 +14634,7 @@ interface components {
|
|
|
14629
14634
|
location: components["schemas"]["TabularLocation"];
|
|
14630
14635
|
/**
|
|
14631
14636
|
* @description Byte range of the match in the *recognized text* it was found in (the
|
|
14632
|
-
* OCR layout text, the audio transcript, or the text payload itself)
|
|
14637
|
+
* OCR layout text, the audio transcript, or the text payload itself),
|
|
14633
14638
|
* the stable key back into that enrichment artifact, where the rich
|
|
14634
14639
|
* context lives (which OCR block, which speaker) that the geometric
|
|
14635
14640
|
* [`location`] cannot hold. `None` for entities not found via text
|
|
@@ -14645,11 +14650,11 @@ interface components {
|
|
|
14645
14650
|
* for a nearby value.
|
|
14646
14651
|
*
|
|
14647
14652
|
* Out-of-band by nature: a hint is *not* a sub-span of the value it
|
|
14648
|
-
* informs
|
|
14653
|
+
* informs; it lives elsewhere in the source (a table's column header, a
|
|
14649
14654
|
* JSON object key, a log field name). So `location` points at where the
|
|
14650
14655
|
* hint text actually sits, and `data` is the hint text itself. Carrying
|
|
14651
14656
|
* the location (rather than a bare string) lets a confidence boost record
|
|
14652
|
-
* *which* hint lifted a score and *where* it came from
|
|
14657
|
+
* *which* hint lifted a score and *where* it came from, provenance a
|
|
14653
14658
|
* review consumer can resolve back to the document.
|
|
14654
14659
|
*
|
|
14655
14660
|
* Mirrors [`Entity`]'s `location` + `data` shape, so the same
|
|
@@ -14713,7 +14718,7 @@ interface components {
|
|
|
14713
14718
|
/**
|
|
14714
14719
|
* @description A human override, outside automatic detection: an entity a reviewer added by
|
|
14715
14720
|
* hand, or a detected one they marked to ignore. Its provenance is a person's
|
|
14716
|
-
* decision, not a recognizer's
|
|
14721
|
+
* decision, not a recognizer's, so the trail records *why* (an
|
|
14717
14722
|
* [`Attribution`], when supplied). *Who* made the override is the event's
|
|
14718
14723
|
* [`source`], not a payload field.
|
|
14719
14724
|
*
|
|
@@ -14729,7 +14734,7 @@ interface components {
|
|
|
14729
14734
|
/**
|
|
14730
14735
|
* @description Which human decision this records: including a missed entity, or
|
|
14731
14736
|
* suppressing a detected one. This is the authority on whether the entity
|
|
14732
|
-
* is redacted
|
|
14737
|
+
* is redacted, [`AuditLog::is_suppressed`] reads it, so there is no
|
|
14733
14738
|
* separate flag to keep in sync.
|
|
14734
14739
|
*
|
|
14735
14740
|
* [`AuditLog::is_suppressed`]: crate::entity::audit::AuditLog::is_suppressed
|
|
@@ -14934,31 +14939,42 @@ interface components {
|
|
|
14934
14939
|
/** @description What the reviewer says this is. */
|
|
14935
14940
|
label: components["schemas"]["LabelRef"];
|
|
14936
14941
|
/**
|
|
14937
|
-
* @description Where it sits, in the coordinates of the
|
|
14942
|
+
* @description Where it sits, in the coordinates of the part it joins.
|
|
14938
14943
|
*
|
|
14939
|
-
*
|
|
14940
|
-
*
|
|
14941
|
-
*
|
|
14942
|
-
*
|
|
14943
|
-
*
|
|
14944
|
-
* engine reverse-resolves.
|
|
14944
|
+
* Each medium addresses its own way: text a character range
|
|
14945
|
+
* over the decoded stream, images a bounding box, audio a time
|
|
14946
|
+
* span, tabular a row and column. A DOCX's
|
|
14947
|
+
* `word/document.xml` text belongs to the document part
|
|
14948
|
+
* itself, not to a nested one.
|
|
14945
14949
|
*
|
|
14950
|
+
* For text specifically, a caller holding raw file bytes
|
|
14951
|
+
* rather than a decoded offset — a reviewer selecting rendered
|
|
14952
|
+
* text, say — leaves [`TextLocation::range`] empty and fills
|
|
14953
|
+
* [`TextLocation::source`] instead, which the engine
|
|
14954
|
+
* reverse-resolves. The other three have no such alternative:
|
|
14955
|
+
* their coordinates are the only way in.
|
|
14956
|
+
*
|
|
14957
|
+
* [`TextLocation::range`]: elide::modality::text::TextLocation::range
|
|
14946
14958
|
* [`TextLocation::source`]: elide::modality::text::TextLocation::source
|
|
14947
14959
|
*/
|
|
14948
14960
|
location: components["schemas"]["TextLocation"];
|
|
14949
14961
|
/**
|
|
14950
|
-
* @description The
|
|
14951
|
-
* `"word/media/image1.png"
|
|
14962
|
+
* @description The part this belongs to, as a path: `["report.docx"]` for
|
|
14963
|
+
* the document itself, `["report.docx", "word/media/image1.png"]`
|
|
14964
|
+
* for media it embeds. `None` means the request's sole
|
|
14965
|
+
* document, which is the common case and saves a caller
|
|
14966
|
+
* naming what it already sent.
|
|
14952
14967
|
*
|
|
14953
|
-
*
|
|
14954
|
-
* its own
|
|
14955
|
-
*
|
|
14968
|
+
* Nested media needs this: the report holds an embedded image
|
|
14969
|
+
* as its own part, and an addition to one has nowhere to go
|
|
14970
|
+
* without naming it. Text usually does not — where a span came
|
|
14971
|
+
* from is already in `TextLocation::source`, which carries the
|
|
14972
|
+
* part alongside the raw range.
|
|
14956
14973
|
*
|
|
14957
|
-
*
|
|
14958
|
-
*
|
|
14959
|
-
* which carries the part alongside the raw range.
|
|
14974
|
+
* `None` is an error when the request carried several
|
|
14975
|
+
* documents, since there is then no sole document to mean.
|
|
14960
14976
|
*/
|
|
14961
|
-
part?: string;
|
|
14977
|
+
part?: string[];
|
|
14962
14978
|
/** @description The rationale, when one was given. */
|
|
14963
14979
|
reason?: string;
|
|
14964
14980
|
};
|
|
@@ -15197,7 +15213,7 @@ interface components {
|
|
|
15197
15213
|
* @description Tamper-evident audit trail: every contributing detection, the fusion
|
|
15198
15214
|
* event if any, and the redaction that hid it, as a hash-linked DAG. It is
|
|
15199
15215
|
* also the single source of truth for whether a reviewer
|
|
15200
|
-
* [suppressed](Self::is_suppressed) the entity
|
|
15216
|
+
* [suppressed](Self::is_suppressed) the entity, a suppression is a
|
|
15201
15217
|
* [`Manual`] event on this trail, not a separate flag.
|
|
15202
15218
|
*
|
|
15203
15219
|
* [`Manual`]: crate::entity::audit::AuditKind::Manual
|
|
@@ -15234,7 +15250,7 @@ interface components {
|
|
|
15234
15250
|
location: components["schemas"]["TextLocation"];
|
|
15235
15251
|
/**
|
|
15236
15252
|
* @description Byte range of the match in the *recognized text* it was found in (the
|
|
15237
|
-
* OCR layout text, the audio transcript, or the text payload itself)
|
|
15253
|
+
* OCR layout text, the audio transcript, or the text payload itself),
|
|
15238
15254
|
* the stable key back into that enrichment artifact, where the rich
|
|
15239
15255
|
* context lives (which OCR block, which speaker) that the geometric
|
|
15240
15256
|
* [`location`] cannot hold. `None` for entities not found via text
|
|
@@ -15250,11 +15266,11 @@ interface components {
|
|
|
15250
15266
|
* for a nearby value.
|
|
15251
15267
|
*
|
|
15252
15268
|
* Out-of-band by nature: a hint is *not* a sub-span of the value it
|
|
15253
|
-
* informs
|
|
15269
|
+
* informs; it lives elsewhere in the source (a table's column header, a
|
|
15254
15270
|
* JSON object key, a log field name). So `location` points at where the
|
|
15255
15271
|
* hint text actually sits, and `data` is the hint text itself. Carrying
|
|
15256
15272
|
* the location (rather than a bare string) lets a confidence boost record
|
|
15257
|
-
* *which* hint lifted a score and *where* it came from
|
|
15273
|
+
* *which* hint lifted a score and *where* it came from, provenance a
|
|
15258
15274
|
* review consumer can resolve back to the document.
|
|
15259
15275
|
*
|
|
15260
15276
|
* Mirrors [`Entity`]'s `location` + `data` shape, so the same
|
|
@@ -15298,7 +15314,7 @@ interface components {
|
|
|
15298
15314
|
/**
|
|
15299
15315
|
* @description A human override, outside automatic detection: an entity a reviewer added by
|
|
15300
15316
|
* hand, or a detected one they marked to ignore. Its provenance is a person's
|
|
15301
|
-
* decision, not a recognizer's
|
|
15317
|
+
* decision, not a recognizer's, so the trail records *why* (an
|
|
15302
15318
|
* [`Attribution`], when supplied). *Who* made the override is the event's
|
|
15303
15319
|
* [`source`], not a payload field.
|
|
15304
15320
|
*
|
|
@@ -15314,7 +15330,7 @@ interface components {
|
|
|
15314
15330
|
/**
|
|
15315
15331
|
* @description Which human decision this records: including a missed entity, or
|
|
15316
15332
|
* suppressing a detected one. This is the authority on whether the entity
|
|
15317
|
-
* is redacted
|
|
15333
|
+
* is redacted, [`AuditLog::is_suppressed`] reads it, so there is no
|
|
15318
15334
|
* separate flag to keep in sync.
|
|
15319
15335
|
*
|
|
15320
15336
|
* [`AuditLog::is_suppressed`]: crate::entity::audit::AuditLog::is_suppressed
|
|
@@ -15596,8 +15612,10 @@ interface components {
|
|
|
15596
15612
|
text: string;
|
|
15597
15613
|
};
|
|
15598
15614
|
/**
|
|
15599
|
-
* @description
|
|
15600
|
-
*
|
|
15615
|
+
* @description The token counts a model reported.
|
|
15616
|
+
*
|
|
15617
|
+
* Each is optional because providers differ in what they return: some give
|
|
15618
|
+
* only a total, some none at all.
|
|
15601
15619
|
*/
|
|
15602
15620
|
TokenCounts: {
|
|
15603
15621
|
/**
|
|
@@ -15612,7 +15630,7 @@ interface components {
|
|
|
15612
15630
|
output?: number;
|
|
15613
15631
|
/**
|
|
15614
15632
|
* Format: uint64
|
|
15615
|
-
* @description Total tokens
|
|
15633
|
+
* @description Total tokens, may be reported even when the input/output split is not.
|
|
15616
15634
|
*/
|
|
15617
15635
|
total?: number;
|
|
15618
15636
|
};
|
|
@@ -15639,7 +15657,7 @@ interface components {
|
|
|
15639
15657
|
* consumer-side code assumes this). A context enhancer borrows the underlying
|
|
15640
15658
|
* slice via [`as_slice`](Tokens::as_slice) and walks it by count when scoring an
|
|
15641
15659
|
* entity's neighbourhood. Empty ([`Default`]) until a tokenizing enricher fills
|
|
15642
|
-
* it
|
|
15660
|
+
* it, the enhancer then tokenizes on demand instead.
|
|
15643
15661
|
*/
|
|
15644
15662
|
Tokens: components["schemas"]["Token"][];
|
|
15645
15663
|
/**
|
|
@@ -15684,7 +15702,7 @@ interface components {
|
|
|
15684
15702
|
* @description Timestamped transcript of an audio stream.
|
|
15685
15703
|
*
|
|
15686
15704
|
* An ordered set of [`TranscriptSegment`]s. The flat
|
|
15687
|
-
* [`text`]
|
|
15705
|
+
* [`text`], the segments joined, is what a recognizer
|
|
15688
15706
|
* inspects; [`resolve`] maps a byte range of that text back
|
|
15689
15707
|
* to the [`TimeSpan`] it occupies, using the segments' (and their words')
|
|
15690
15708
|
* timings. Empty when the backend produced nothing (silence, or a no-op
|
|
@@ -16664,4 +16682,4 @@ type RetentionSettings = Schemas["RetentionSettings"];
|
|
|
16664
16682
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
16665
16683
|
//#endregion
|
|
16666
16684
|
export { PolicyRule as $, Token as $i, SyncStatus as $n, ImageHint as $r, ReplyInvite as $t, Color as A, ActivityPayload as Aa, TabularModel as Ai, RedactionResultPage as An, Audit as Ar, NotificationPage as At, Label as B, WebhookActivityParams as Ba, TextEntity as Bi, ConnectionVerification as Bn, Dimensions as Br, MemberSortField as Bt, Language as C, UsageAnalytics as Ca, TabularAuditKind as Ci, DetectionPage as Cn, AudioHint as Cr, DetectionCompletedParams as Ct, ScopeMetadata as D, ActivityExportOptions as Da, TabularHint as Di, RedactDetection as Dn, AudioPattern as Dr, MemberJoinedParams as Dt, Languages as E, Activity as Ea, TabularEntity as Ei, PipelineDetectionsQuery as En, AudioModel as Er, MemberInvitedParams as Et, GdprArticle9Treatment as F, InviteActivityParams as Fa, TextAuditEvent as Fi, ConnectionConfig as Fn, CitedAttribution as Fr, UnreadStatus as Ft, LanguageTag as G, PasswordChange as Ga, TextPattern as Gi, OpenAiCredentials as Gn, FreeformAttribution as Gr, InviteCode as Gt, LabelLocale as H, Account as Ha, TextLocation as Hi, CreateConnection as Hn, Dpi as Hr, CreateInvite as Ht, GdprSensitiveScope as I, MemberActivityParams as Ia, TextAuditKind as Ii, ConnectionId as In, CodecParams as Ir, UpdateNotificationSettings as It, PciDssPart as J, paths as Ja, TimeSpan as Ji, SyncConnection as Jn, ImageAuditKind as Jr, InvitePreview as Jt, LocalizedText as K, PublicAccount as Ka, TextRefinement as Ki, S3Credentials as Kn, ImageAdd as Kr, InviteExpiration as Kt, HipaaAccountNumbers as L, PipelineActivityParams as La, TextAuditLog as Li, ConnectionPage as Ln, Conflict as Lr, ListMembers as Lt, CreatePolicy as M, ConnectionActivityParams as Ma, TabularRefinement as Mi, AnthropicCredentials as Mn, BoundingBox as Mr, NotificationSettings as Mt, DateGranularity as N, DetectionActivityParams as Na, TabularRetag as Ni, AzureCredentials as Nn, Calibration as Nr, RedactionCreatedParams as Nt, AudioRedaction as O, ActivityFilterQuery as Oa, TabularLocation as Oi, RedactionId as On, AudioRefinement as Or, Notification as Ot, DateStyle as P, FileActivityParams as Pa, TextAdd as Pi, Connection as Pn, Category as Pr, UnreadCountEvent as Pt, PolicyDraft as Q, LayoutWord as Qi, SyncScheduleInput as Qn, ImageEntity as Qr, ListInvites as Qt, HipaaDeidMethod as R, PolicyActivityParams as Ra, TextData as Ri, ConnectionSync as Rn, Contested as Rr, Member as Rt, CountryCode as S, Usage as Sa, TabularAuditEvent as Si, DetectionMetadata as Sn, AudioEntity as Sr, ConnectionSyncFailedParams as St, LanguageSpan as T, WorkspaceAnalytics as Ta, TabularEdit as Ti, DetectionStatusEvent as Tn, AudioManual as Tr, MarkedReadStatus as Tt, LabelRef as U, AccountRef as Ua, TextManual as Ui, GcsCredentials as Un, EditSet as Ur, GenerateInviteCode as Ut, LabelEntry as V, WorkspaceActivityParams as Va, TextHint as Vi, ConnectionsQuery as Vn, DocumentContext as Vr, UpdateMember as Vt, LabelScope as W, Handle as Wa, TextModel as Wi, LlmConfig as Wn, EntityCoRef as Wr, Invite as Wt, Policy as X, Layout as Xi, SyncMode as Xn, ImageData as Xr, InviteSortField as Xt, PciPanRender as Y, ArtifactSet as Yi, SyncDeletionPolicy as Yn, ImageAuditLog as Yr, InviteSent as Yt, PolicyDefinition as Z, LayoutBlock as Zi, SyncSchedule as Zn, ImageEdit as Zr, InviteStatus as Zt, WebhookId as _, ProviderType as _a, RuleMatch as _i, ErrorResponse as _n, AudioAuditEvent as _r, PipelineSummaryPage as _t, RetentionSettings as a, ApiTokenPage as aa, ImageRetag as ai, DeletedFiles as an, ChatSessionPage as ar, TabularRedaction as at, WebhookStatus as b, StorageKindEntry as ba, Suppress as bi, Detection as bn, AudioData as br, CursorPagination as bt, WorkspacePage as c, CreateApiToken as ca, ModelEvent as ci, FileKind as cn, SendChatMessage as cr, TextRedaction as ct, CreateWebhook as d, DetectionAnalytics as da, Point as di, ListFiles as dn, RegisteredRecognizer as dr, CreatePipeline as dt, Tokens as ea, ImageLocation as ei, SortOrder as en, SyncTriggerType as er, PolicySummary as et, TestWebhook as f, DetectionDayEntry as fa, Polygon as fi, ModalityToken as fn, AuthToken as fr, Pipeline as ft, WebhookEvent as g, ModelUsageEntry as ga, Report as gi, ExportQuery as gn, AudioAdd as gr, PipelineSummary as gt, WebhookCreated as h, ModelUsage as ha, Redaction as hi, ExportFormat as hn, Attribution as hr, PipelineStatus as ht, RetentionOverride as i, ApiToken as ia, ImageRefinement as ii, DeleteFiles as in, ChatSession as ir, Sha2Algorithm as it, ConfidenceThreshold as j, ActivityType as ja, TabularPattern as ji, WorkspaceDetectionsQuery as jn, AuditHash as jr, NotificationPayload as jt, ClampBucket as k, ActivityPage as ka, TabularManual as ki, RedactionResult as kn, AudioRetag as kr, NotificationEvent as kt, WorkspaceRole as l, TokenExpiration as la, OperatorId as li, FilePage as ln, LabelCatalog as lr, UpdatePolicy as lt, Webhook as m, DetectionTimeSeries as ma, RasterMode as mi, DateWindow as mn, Signup as mr, PipelineFilter as mt, RasterPolicy as n, TranscriptWord as na, ImageModel as ni, Health as nn, ChatMessage as nr, PolicyTemplate as nt, UpdateWorkspace as o, ApiTokenType as oa, LeakProfile as oi, File as on, ChatToken as or, TemplateOrigin as ot, UpdateWebhook as p, DetectionStatusEntry as pa, RangeOfUint as pi, UpdateFile as pn, Login as pr, PipelineDefinition as pt, ModalityRedactions as q, UpdateAccount as qa, TextRetag as qi, StorageConfig as qn, ImageAuditEvent as qr, InvitePage as qt, Retention as r, Transcription as ra, ImagePattern as ri, HealthStatus as rn, ChatRole as rr, Predicate as rt, Workspace as s, ApiTokenWithJWT as sa, ManualIntent as si, FileHash as sn, CreateChatSession as sr, TerminalFallback as st, CreateWorkspace as t, TranscriptSegment as ta, ImageManual as ti, ComponentHealth as tn, UpdateConnection as tr, PolicySummaryPage as tt, WorkspaceSettings as u, UpdateApiToken as ua, PatternEvent as ui, FormatToken as un, RecognizerCatalog as ur, Waveform as ut, WebhookPage as v, RecognizerId as va, Selection as vi, ValidationErrorDetail as vn, AudioAuditKind as vr, PipelineTriggerType as vt, LanguageProvenance as w, UsageReport as wa, TabularAuditLog as wi, DetectionStatus as wn, AudioLocation as wr, DetectionFailedParams as wt, Confidence as x, TokenCounts as xa, TabularAdd as xi, DetectionId as xn, AudioEdit as xr, ConnectionSyncCompletedParams as xt, WebhookResult as y, StorageAnalytics as ya, SourceRef as yi, CreateDetection as yn, AudioAuditLog as yr, UpdatePipeline as yt, ImageRedaction as z, RedactionActivityParams as za, TextEdit as zi, ConnectionSyncPage as zn, Deduplication as zr, MemberPage as zt };
|
|
16667
|
-
//# sourceMappingURL=index-
|
|
16685
|
+
//# sourceMappingURL=index-B42oglvJ.d.ts.map
|