@nvisy/sdk 0.56.0 → 0.57.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 +21 -1
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{errors-DeUtOGAV.d.ts → errors-Dyt_dmuq.d.ts} +2 -2
- package/dist/{errors-DeUtOGAV.d.ts.map → errors-Dyt_dmuq.d.ts.map} +1 -1
- package/dist/guest/index.d.ts +1 -1
- package/dist/guest/index.js +2 -2
- package/dist/{http-CmImjBaZ.js → http-C7Gsf0ja.js} +2 -2
- package/dist/{http-CmImjBaZ.js.map → http-C7Gsf0ja.js.map} +1 -1
- package/dist/{index-D2ihRMUe.d.ts → index-Cf0KFY6M.d.ts} +353 -134
- package/dist/index-Cf0KFY6M.d.ts.map +1 -0
- package/dist/{index-tS6AFFSf.d.ts → index-Drr49LBP.d.ts} +11 -2
- package/dist/{index-tS6AFFSf.d.ts.map → index-Drr49LBP.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-BnCYM6gZ.js → services-BdI0UOFE.js} +17 -2
- package/dist/services-BdI0UOFE.js.map +1 -0
- package/dist/webhooks/index.d.ts +2 -2
- package/package.json +1 -1
- package/dist/index-D2ihRMUe.d.ts.map +0 -1
- package/dist/services-BnCYM6gZ.js.map +0 -1
|
@@ -8150,135 +8150,6 @@ interface paths {
|
|
|
8150
8150
|
};
|
|
8151
8151
|
trace?: never;
|
|
8152
8152
|
};
|
|
8153
|
-
"/workspaces/{workspaceId}/pipelines/detections": {
|
|
8154
|
-
parameters: {
|
|
8155
|
-
query?: never;
|
|
8156
|
-
header?: never;
|
|
8157
|
-
path?: never;
|
|
8158
|
-
cookie?: never;
|
|
8159
|
-
};
|
|
8160
|
-
/**
|
|
8161
|
-
* List workspace detections
|
|
8162
|
-
* @description Returns all detections across the workspace, most recent first, with optional status, document, pipeline, trigger-account, and trigger-type filters.
|
|
8163
|
-
*/
|
|
8164
|
-
get: {
|
|
8165
|
-
parameters: {
|
|
8166
|
-
query?: {
|
|
8167
|
-
/**
|
|
8168
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
8169
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
8170
|
-
*/
|
|
8171
|
-
after?: string;
|
|
8172
|
-
/**
|
|
8173
|
-
* @description Whether to include the total item count in the response's `total` field.
|
|
8174
|
-
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
8175
|
-
* only when the count is actually needed.
|
|
8176
|
-
*/
|
|
8177
|
-
includeCount?: boolean;
|
|
8178
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
8179
|
-
limit?: number;
|
|
8180
|
-
/** @description Filter by the source document the detection analyzes. */
|
|
8181
|
-
documentId?: string;
|
|
8182
|
-
/** @description Filter by the owning pipeline. */
|
|
8183
|
-
pipelineId?: string;
|
|
8184
|
-
/** @description Filter by detection status. */
|
|
8185
|
-
status?: components["schemas"]["DetectionStatus"];
|
|
8186
|
-
/** @description Filter by how the detection was initiated (user vs system). */
|
|
8187
|
-
triggerType?: components["schemas"]["PipelineTriggerType"];
|
|
8188
|
-
/** @description Filter by the account that triggered the detection. */
|
|
8189
|
-
triggeredBy?: string;
|
|
8190
|
-
};
|
|
8191
|
-
header?: never;
|
|
8192
|
-
path: {
|
|
8193
|
-
/** @description Workspace identifier. */
|
|
8194
|
-
workspaceId: string;
|
|
8195
|
-
};
|
|
8196
|
-
cookie?: never;
|
|
8197
|
-
};
|
|
8198
|
-
requestBody?: never;
|
|
8199
|
-
responses: {
|
|
8200
|
-
/**
|
|
8201
|
-
* @description Generic paginated response wrapper.
|
|
8202
|
-
*
|
|
8203
|
-
* Provides a consistent structure for all paginated API responses with
|
|
8204
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
8205
|
-
* are more items to fetch.
|
|
8206
|
-
*/
|
|
8207
|
-
200: {
|
|
8208
|
-
headers: {
|
|
8209
|
-
[name: string]: unknown;
|
|
8210
|
-
};
|
|
8211
|
-
content: {
|
|
8212
|
-
"application/json": components["schemas"]["WorkspaceDetectionPage"];
|
|
8213
|
-
};
|
|
8214
|
-
};
|
|
8215
|
-
/**
|
|
8216
|
-
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8217
|
-
* that [`Error`] renders to at the response boundary.
|
|
8218
|
-
*
|
|
8219
|
-
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8220
|
-
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8221
|
-
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8222
|
-
* (`context` is logged, `status` sets the HTTP status line).
|
|
8223
|
-
*
|
|
8224
|
-
* [`Error`]: crate::response::Error
|
|
8225
|
-
*/
|
|
8226
|
-
401: {
|
|
8227
|
-
headers: {
|
|
8228
|
-
[name: string]: unknown;
|
|
8229
|
-
};
|
|
8230
|
-
content: {
|
|
8231
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
8232
|
-
};
|
|
8233
|
-
};
|
|
8234
|
-
/**
|
|
8235
|
-
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8236
|
-
* that [`Error`] renders to at the response boundary.
|
|
8237
|
-
*
|
|
8238
|
-
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8239
|
-
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8240
|
-
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8241
|
-
* (`context` is logged, `status` sets the HTTP status line).
|
|
8242
|
-
*
|
|
8243
|
-
* [`Error`]: crate::response::Error
|
|
8244
|
-
*/
|
|
8245
|
-
403: {
|
|
8246
|
-
headers: {
|
|
8247
|
-
[name: string]: unknown;
|
|
8248
|
-
};
|
|
8249
|
-
content: {
|
|
8250
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
8251
|
-
};
|
|
8252
|
-
};
|
|
8253
|
-
/**
|
|
8254
|
-
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8255
|
-
* that [`Error`] renders to at the response boundary.
|
|
8256
|
-
*
|
|
8257
|
-
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8258
|
-
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8259
|
-
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8260
|
-
* (`context` is logged, `status` sets the HTTP status line).
|
|
8261
|
-
*
|
|
8262
|
-
* [`Error`]: crate::response::Error
|
|
8263
|
-
*/
|
|
8264
|
-
404: {
|
|
8265
|
-
headers: {
|
|
8266
|
-
[name: string]: unknown;
|
|
8267
|
-
};
|
|
8268
|
-
content: {
|
|
8269
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
8270
|
-
};
|
|
8271
|
-
};
|
|
8272
|
-
};
|
|
8273
|
-
};
|
|
8274
|
-
put?: never;
|
|
8275
|
-
post?: never;
|
|
8276
|
-
delete?: never;
|
|
8277
|
-
options?: never;
|
|
8278
|
-
head?: never;
|
|
8279
|
-
patch?: never;
|
|
8280
|
-
trace?: never;
|
|
8281
|
-
};
|
|
8282
8153
|
"/workspaces/{workspaceId}/pipelines/{pipelineId}/detections": {
|
|
8283
8154
|
parameters: {
|
|
8284
8155
|
query?: never;
|
|
@@ -8589,7 +8460,120 @@ interface paths {
|
|
|
8589
8460
|
path?: never;
|
|
8590
8461
|
cookie?: never;
|
|
8591
8462
|
};
|
|
8592
|
-
|
|
8463
|
+
/**
|
|
8464
|
+
* List workspace detections
|
|
8465
|
+
* @description Returns all detections across the workspace, most recent first, with optional status, document, pipeline, trigger-account, and trigger-type filters.
|
|
8466
|
+
*/
|
|
8467
|
+
get: {
|
|
8468
|
+
parameters: {
|
|
8469
|
+
query?: {
|
|
8470
|
+
/**
|
|
8471
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
8472
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
8473
|
+
*/
|
|
8474
|
+
after?: string;
|
|
8475
|
+
/**
|
|
8476
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
8477
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
8478
|
+
* only when the count is actually needed.
|
|
8479
|
+
*/
|
|
8480
|
+
includeCount?: boolean;
|
|
8481
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
8482
|
+
limit?: number;
|
|
8483
|
+
/** @description Filter by the source document the detection analyzes. */
|
|
8484
|
+
documentId?: string;
|
|
8485
|
+
/** @description Filter by the owning pipeline. */
|
|
8486
|
+
pipelineId?: string;
|
|
8487
|
+
/** @description Filter by detection status. */
|
|
8488
|
+
status?: components["schemas"]["DetectionStatus"];
|
|
8489
|
+
/** @description Filter by how the detection was initiated (user vs system). */
|
|
8490
|
+
triggerType?: components["schemas"]["PipelineTriggerType"];
|
|
8491
|
+
/** @description Filter by the account that triggered the detection. */
|
|
8492
|
+
triggeredBy?: string;
|
|
8493
|
+
};
|
|
8494
|
+
header?: never;
|
|
8495
|
+
path: {
|
|
8496
|
+
/** @description Workspace identifier. */
|
|
8497
|
+
workspaceId: string;
|
|
8498
|
+
};
|
|
8499
|
+
cookie?: never;
|
|
8500
|
+
};
|
|
8501
|
+
requestBody?: never;
|
|
8502
|
+
responses: {
|
|
8503
|
+
/**
|
|
8504
|
+
* @description Generic paginated response wrapper.
|
|
8505
|
+
*
|
|
8506
|
+
* Provides a consistent structure for all paginated API responses with
|
|
8507
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
8508
|
+
* are more items to fetch.
|
|
8509
|
+
*/
|
|
8510
|
+
200: {
|
|
8511
|
+
headers: {
|
|
8512
|
+
[name: string]: unknown;
|
|
8513
|
+
};
|
|
8514
|
+
content: {
|
|
8515
|
+
"application/json": components["schemas"]["WorkspaceDetectionPage"];
|
|
8516
|
+
};
|
|
8517
|
+
};
|
|
8518
|
+
/**
|
|
8519
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8520
|
+
* that [`Error`] renders to at the response boundary.
|
|
8521
|
+
*
|
|
8522
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8523
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8524
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8525
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
8526
|
+
*
|
|
8527
|
+
* [`Error`]: crate::response::Error
|
|
8528
|
+
*/
|
|
8529
|
+
401: {
|
|
8530
|
+
headers: {
|
|
8531
|
+
[name: string]: unknown;
|
|
8532
|
+
};
|
|
8533
|
+
content: {
|
|
8534
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
8535
|
+
};
|
|
8536
|
+
};
|
|
8537
|
+
/**
|
|
8538
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8539
|
+
* that [`Error`] renders to at the response boundary.
|
|
8540
|
+
*
|
|
8541
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8542
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8543
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8544
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
8545
|
+
*
|
|
8546
|
+
* [`Error`]: crate::response::Error
|
|
8547
|
+
*/
|
|
8548
|
+
403: {
|
|
8549
|
+
headers: {
|
|
8550
|
+
[name: string]: unknown;
|
|
8551
|
+
};
|
|
8552
|
+
content: {
|
|
8553
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
8554
|
+
};
|
|
8555
|
+
};
|
|
8556
|
+
/**
|
|
8557
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
8558
|
+
* that [`Error`] renders to at the response boundary.
|
|
8559
|
+
*
|
|
8560
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
8561
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
8562
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
8563
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
8564
|
+
*
|
|
8565
|
+
* [`Error`]: crate::response::Error
|
|
8566
|
+
*/
|
|
8567
|
+
404: {
|
|
8568
|
+
headers: {
|
|
8569
|
+
[name: string]: unknown;
|
|
8570
|
+
};
|
|
8571
|
+
content: {
|
|
8572
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
8573
|
+
};
|
|
8574
|
+
};
|
|
8575
|
+
};
|
|
8576
|
+
};
|
|
8593
8577
|
put?: never;
|
|
8594
8578
|
/**
|
|
8595
8579
|
* Start an ad-hoc detection
|
|
@@ -9623,6 +9607,129 @@ interface paths {
|
|
|
9623
9607
|
patch?: never;
|
|
9624
9608
|
trace?: never;
|
|
9625
9609
|
};
|
|
9610
|
+
"/workspaces/{workspaceId}/redactions": {
|
|
9611
|
+
parameters: {
|
|
9612
|
+
query?: never;
|
|
9613
|
+
header?: never;
|
|
9614
|
+
path?: never;
|
|
9615
|
+
cookie?: never;
|
|
9616
|
+
};
|
|
9617
|
+
/**
|
|
9618
|
+
* List workspace redactions
|
|
9619
|
+
* @description Returns all redactions across the workspace, most recent first, cursor-paginated, with optional detection and document filters. Each redaction is one redact pass with its own reviewer edits, output document, and review audit.
|
|
9620
|
+
*/
|
|
9621
|
+
get: {
|
|
9622
|
+
parameters: {
|
|
9623
|
+
query?: {
|
|
9624
|
+
/**
|
|
9625
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
9626
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
9627
|
+
*/
|
|
9628
|
+
after?: string;
|
|
9629
|
+
/**
|
|
9630
|
+
* @description Whether to include the total item count in the response's `total` field.
|
|
9631
|
+
* Defaults to `false`, since counting is an extra query; set it to `true`
|
|
9632
|
+
* only when the count is actually needed.
|
|
9633
|
+
*/
|
|
9634
|
+
includeCount?: boolean;
|
|
9635
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
9636
|
+
limit?: number;
|
|
9637
|
+
/** @description Filter to the redactions produced from a specific detection. */
|
|
9638
|
+
detectionId?: string;
|
|
9639
|
+
/** @description Filter to the redactions of detections analyzing a specific document. */
|
|
9640
|
+
documentId?: string;
|
|
9641
|
+
};
|
|
9642
|
+
header?: never;
|
|
9643
|
+
path: {
|
|
9644
|
+
/** @description Workspace identifier. */
|
|
9645
|
+
workspaceId: string;
|
|
9646
|
+
};
|
|
9647
|
+
cookie?: never;
|
|
9648
|
+
};
|
|
9649
|
+
requestBody?: never;
|
|
9650
|
+
responses: {
|
|
9651
|
+
/**
|
|
9652
|
+
* @description Generic paginated response wrapper.
|
|
9653
|
+
*
|
|
9654
|
+
* Provides a consistent structure for all paginated API responses with
|
|
9655
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
9656
|
+
* are more items to fetch.
|
|
9657
|
+
*/
|
|
9658
|
+
200: {
|
|
9659
|
+
headers: {
|
|
9660
|
+
[name: string]: unknown;
|
|
9661
|
+
};
|
|
9662
|
+
content: {
|
|
9663
|
+
"application/json": components["schemas"]["WorkspaceRedactionResultPage"];
|
|
9664
|
+
};
|
|
9665
|
+
};
|
|
9666
|
+
/**
|
|
9667
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
9668
|
+
* that [`Error`] renders to at the response boundary.
|
|
9669
|
+
*
|
|
9670
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
9671
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
9672
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
9673
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
9674
|
+
*
|
|
9675
|
+
* [`Error`]: crate::response::Error
|
|
9676
|
+
*/
|
|
9677
|
+
401: {
|
|
9678
|
+
headers: {
|
|
9679
|
+
[name: string]: unknown;
|
|
9680
|
+
};
|
|
9681
|
+
content: {
|
|
9682
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9683
|
+
};
|
|
9684
|
+
};
|
|
9685
|
+
/**
|
|
9686
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
9687
|
+
* that [`Error`] renders to at the response boundary.
|
|
9688
|
+
*
|
|
9689
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
9690
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
9691
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
9692
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
9693
|
+
*
|
|
9694
|
+
* [`Error`]: crate::response::Error
|
|
9695
|
+
*/
|
|
9696
|
+
403: {
|
|
9697
|
+
headers: {
|
|
9698
|
+
[name: string]: unknown;
|
|
9699
|
+
};
|
|
9700
|
+
content: {
|
|
9701
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9702
|
+
};
|
|
9703
|
+
};
|
|
9704
|
+
/**
|
|
9705
|
+
* @description The serialized shape of an HTTP error: the inert wire/OpenAPI-schema view
|
|
9706
|
+
* that [`Error`] renders to at the response boundary.
|
|
9707
|
+
*
|
|
9708
|
+
* It carries no builder logic — [`Error`] is the type handlers construct and
|
|
9709
|
+
* thread through `Result`, and it builds an `ErrorResponse` directly in its
|
|
9710
|
+
* `IntoResponse` impl. `context` and `status` are not part of the JSON body
|
|
9711
|
+
* (`context` is logged, `status` sets the HTTP status line).
|
|
9712
|
+
*
|
|
9713
|
+
* [`Error`]: crate::response::Error
|
|
9714
|
+
*/
|
|
9715
|
+
404: {
|
|
9716
|
+
headers: {
|
|
9717
|
+
[name: string]: unknown;
|
|
9718
|
+
};
|
|
9719
|
+
content: {
|
|
9720
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
9721
|
+
};
|
|
9722
|
+
};
|
|
9723
|
+
};
|
|
9724
|
+
};
|
|
9725
|
+
put?: never;
|
|
9726
|
+
post?: never;
|
|
9727
|
+
delete?: never;
|
|
9728
|
+
options?: never;
|
|
9729
|
+
head?: never;
|
|
9730
|
+
patch?: never;
|
|
9731
|
+
trace?: never;
|
|
9732
|
+
};
|
|
9626
9733
|
"/workspaces/{workspaceId}/redactions/{redactionId}/review": {
|
|
9627
9734
|
parameters: {
|
|
9628
9735
|
query?: never;
|
|
@@ -15216,6 +15323,17 @@ interface components {
|
|
|
15216
15323
|
* [`part_entities`]: elide::Report::part_entities
|
|
15217
15324
|
*/
|
|
15218
15325
|
report: components["schemas"]["Report"];
|
|
15326
|
+
/**
|
|
15327
|
+
* @description Which recognizers this request selected.
|
|
15328
|
+
*
|
|
15329
|
+
* Carried back for the same reason [`codec`] is. Anonymize
|
|
15330
|
+
* compiles its analyzers afresh, and a lineup narrower than
|
|
15331
|
+
* the one analyze detected with would leave an entity found
|
|
15332
|
+
* and then silently not redacted.
|
|
15333
|
+
*
|
|
15334
|
+
* [`codec`]: Audit::codec
|
|
15335
|
+
*/
|
|
15336
|
+
selection?: components["schemas"]["ComponentSelection"];
|
|
15219
15337
|
/**
|
|
15220
15338
|
* @description What the analyze pass cost: one entry per recognizer and
|
|
15221
15339
|
* enricher that ran, each self-identifying by the name the
|
|
@@ -15400,6 +15518,44 @@ interface components {
|
|
|
15400
15518
|
* opinion passes [`CodecParams::default`].
|
|
15401
15519
|
*/
|
|
15402
15520
|
CodecParams: {
|
|
15521
|
+
/**
|
|
15522
|
+
* Format: uint8
|
|
15523
|
+
* @description The CSV field separator, or [`None`] to auto-detect it.
|
|
15524
|
+
*
|
|
15525
|
+
* Defaults to [`None`], the codec's own behaviour. Detection
|
|
15526
|
+
* falls back to a comma when nothing stands out, which can
|
|
15527
|
+
* misread a TSV or semicolon-delimited file, so pass the byte
|
|
15528
|
+
* when the format is known.
|
|
15529
|
+
*/
|
|
15530
|
+
csvDelimiter?: number;
|
|
15531
|
+
/**
|
|
15532
|
+
* @description Whether a CSV's first row is its header.
|
|
15533
|
+
*
|
|
15534
|
+
* Defaults to `true`, the codec's own behaviour. A header row
|
|
15535
|
+
* gains column-name context hints for the data below it, but
|
|
15536
|
+
* is protected from a row-drop redaction — so a *headerless*
|
|
15537
|
+
* file needs `false`, or its first row of real data cannot be
|
|
15538
|
+
* dropped.
|
|
15539
|
+
* @default true
|
|
15540
|
+
*/
|
|
15541
|
+
csvHasHeaders?: boolean;
|
|
15542
|
+
/**
|
|
15543
|
+
* @description What happens to an image's EXIF metadata on re-encode.
|
|
15544
|
+
*
|
|
15545
|
+
* Defaults to [`ExifPolicy::default`], which the codec also
|
|
15546
|
+
* registers — [`Strip`](ExifPolicy::Strip) today: metadata
|
|
15547
|
+
* goes unless a request asks to keep it. Deferring to the
|
|
15548
|
+
* enum rather than naming a variant keeps this from drifting
|
|
15549
|
+
* if the codec's own bias changes again.
|
|
15550
|
+
*
|
|
15551
|
+
* This governs the output only when no metadata pipeline ran:
|
|
15552
|
+
* a wired EXIF recognizer and anonymizer strip through the
|
|
15553
|
+
* `#exif` sub-part and always win. It is the knob for
|
|
15554
|
+
* stripping — or deliberately preserving — *without* wiring
|
|
15555
|
+
* one.
|
|
15556
|
+
* @default strip
|
|
15557
|
+
*/
|
|
15558
|
+
exifPolicy?: components["schemas"]["ExifPolicy"];
|
|
15403
15559
|
/**
|
|
15404
15560
|
* @description How container formats carrying both a text layer and page
|
|
15405
15561
|
* images treat OCR.
|
|
@@ -15459,6 +15615,32 @@ interface components {
|
|
|
15459
15615
|
/** @description Status of this component. */
|
|
15460
15616
|
status: components["schemas"]["HealthStatus"];
|
|
15461
15617
|
};
|
|
15618
|
+
/**
|
|
15619
|
+
* @description Which of the available components one request wants to run.
|
|
15620
|
+
*
|
|
15621
|
+
* Empty by default, meaning every component the caller has
|
|
15622
|
+
* available. A request that expresses no opinion gets full
|
|
15623
|
+
* detection — the opposite would let an omitted field quietly
|
|
15624
|
+
* disable redaction.
|
|
15625
|
+
*/
|
|
15626
|
+
ComponentSelection: {
|
|
15627
|
+
/**
|
|
15628
|
+
* @description Names or tags to run, or [`None`] for all available.
|
|
15629
|
+
*
|
|
15630
|
+
* An empty `Vec` is not the same as [`None`]: it selects
|
|
15631
|
+
* nothing and is refused, because a request that can detect
|
|
15632
|
+
* nothing is a mistake rather than a request for an empty
|
|
15633
|
+
* report.
|
|
15634
|
+
*/
|
|
15635
|
+
only?: string[];
|
|
15636
|
+
/**
|
|
15637
|
+
* @description Names or tags to skip, applied after `only`.
|
|
15638
|
+
*
|
|
15639
|
+
* Lets a caller run everything but one component without
|
|
15640
|
+
* enumerating the rest.
|
|
15641
|
+
*/
|
|
15642
|
+
skip?: string[];
|
|
15643
|
+
};
|
|
15462
15644
|
/**
|
|
15463
15645
|
* Format: float
|
|
15464
15646
|
* @description Confidence score in the closed range `0.0..=1.0`.
|
|
@@ -16192,6 +16374,14 @@ interface components {
|
|
|
16192
16374
|
/** @description The error name/type identifier. */
|
|
16193
16375
|
name: string;
|
|
16194
16376
|
};
|
|
16377
|
+
/**
|
|
16378
|
+
* @description What to do with an image's EXIF metadata when re-encoding it.
|
|
16379
|
+
*
|
|
16380
|
+
* EXIF mixes privacy-sensitive fields (GPS, device serial, capture timestamp)
|
|
16381
|
+
* with benign ones (orientation, colour profile) that a viewer needs to render
|
|
16382
|
+
* the image correctly, so the choice is a policy, not a fixed behaviour.
|
|
16383
|
+
*/
|
|
16384
|
+
ExifPolicy: "strip" | "strip_sensitive" | "retain";
|
|
16195
16385
|
/** @description The file format an export is rendered as. */
|
|
16196
16386
|
ExportFormat: "csv" | "json";
|
|
16197
16387
|
/**
|
|
@@ -18319,8 +18509,6 @@ interface components {
|
|
|
18319
18509
|
* header.
|
|
18320
18510
|
*/
|
|
18321
18511
|
RegisteredRecognizer: {
|
|
18322
|
-
/** @description Optional human-readable description. */
|
|
18323
|
-
description?: string;
|
|
18324
18512
|
/**
|
|
18325
18513
|
* @description Recognizer name: the identifier a request's allowlist
|
|
18326
18514
|
* picks by.
|
|
@@ -18339,6 +18527,15 @@ interface components {
|
|
|
18339
18527
|
* engine-side construction stays free.
|
|
18340
18528
|
*/
|
|
18341
18529
|
provider: string;
|
|
18530
|
+
/**
|
|
18531
|
+
* @description The groupings this component belongs to, as the deployment
|
|
18532
|
+
* tagged it.
|
|
18533
|
+
*
|
|
18534
|
+
* What a request's selection and the engine's availability
|
|
18535
|
+
* match on besides the name, so a caller listing components
|
|
18536
|
+
* can see which families it may ask for.
|
|
18537
|
+
*/
|
|
18538
|
+
tags?: string[];
|
|
18342
18539
|
};
|
|
18343
18540
|
/** @description Request payload to rename a review (set its title). */
|
|
18344
18541
|
RenameWorkspaceReview: {
|
|
@@ -21833,6 +22030,25 @@ interface components {
|
|
|
21833
22030
|
*/
|
|
21834
22031
|
total?: number;
|
|
21835
22032
|
};
|
|
22033
|
+
/**
|
|
22034
|
+
* @description Query parameters for listing a workspace's redactions.
|
|
22035
|
+
*
|
|
22036
|
+
* Every field is an optional filter; unset fields impose no constraint. A
|
|
22037
|
+
* redaction has no status of its own, so it narrows by its owning detection and
|
|
22038
|
+
* the document that detection analyzed.
|
|
22039
|
+
*/
|
|
22040
|
+
WorkspaceRedactionsQuery: {
|
|
22041
|
+
/**
|
|
22042
|
+
* Format: uuid
|
|
22043
|
+
* @description Filter to the redactions produced from a specific detection.
|
|
22044
|
+
*/
|
|
22045
|
+
detectionId?: string;
|
|
22046
|
+
/**
|
|
22047
|
+
* Format: uuid
|
|
22048
|
+
* @description Filter to the redactions of detections analyzing a specific document.
|
|
22049
|
+
*/
|
|
22050
|
+
documentId?: string;
|
|
22051
|
+
};
|
|
21836
22052
|
/**
|
|
21837
22053
|
* @description Response type for a review: a named discussion on a document with a manual
|
|
21838
22054
|
* sign-off lifecycle (0..N per document), opened explicitly. It carries a
|
|
@@ -22397,9 +22613,11 @@ type Schemas$19 = components["schemas"];
|
|
|
22397
22613
|
type Audit = Schemas$19["Audit"];
|
|
22398
22614
|
type DocumentContext = Schemas$19["DocumentContext"];
|
|
22399
22615
|
type CodecParams = Schemas$19["CodecParams"];
|
|
22616
|
+
type ExifPolicy = Schemas$19["ExifPolicy"];
|
|
22400
22617
|
type EntityCoRef = Schemas$19["EntityCoRef"];
|
|
22401
22618
|
type Report = Schemas$19["Report"];
|
|
22402
22619
|
type Recognition = Schemas$19["Recognition"];
|
|
22620
|
+
type ComponentSelection = Schemas$19["ComponentSelection"];
|
|
22403
22621
|
type EditSet = Schemas$19["EditSet"];
|
|
22404
22622
|
type RasterMode = Schemas$19["RasterMode"];
|
|
22405
22623
|
type Dpi = Schemas$19["Dpi"];
|
|
@@ -22566,6 +22784,7 @@ type RedactionId = Schemas$15["RedactionId"];
|
|
|
22566
22784
|
type RedactWorkspaceDetection = Schemas$15["RedactWorkspaceDetection"];
|
|
22567
22785
|
type WorkspaceRedactionResult = Schemas$15["WorkspaceRedactionResult"];
|
|
22568
22786
|
type WorkspaceRedactionResultPage = Schemas$15["WorkspaceRedactionResultPage"];
|
|
22787
|
+
type WorkspaceRedactionsQuery = Schemas$15["WorkspaceRedactionsQuery"];
|
|
22569
22788
|
//#endregion
|
|
22570
22789
|
//#region src/datatypes/document.d.ts
|
|
22571
22790
|
type Schemas$14 = components["schemas"];
|
|
@@ -22763,5 +22982,5 @@ type Retention = Schemas["Retention"];
|
|
|
22763
22982
|
type RetentionSettings = Schemas["RetentionSettings"];
|
|
22764
22983
|
type RetentionOverride = Schemas["RetentionOverride"];
|
|
22765
22984
|
//#endregion
|
|
22766
|
-
export { ConfidenceThreshold as $,
|
|
22767
|
-
//# sourceMappingURL=index-
|
|
22985
|
+
export { ConfidenceThreshold as $, CreateAccountApiToken as $a, RangeOfUint as $i, WorkspaceDetectionPage as $n, AudioAuditLog as $r, DetectionCompletedParams as $t, RenameWorkspaceReview as A, TextEntity as Aa, ImageAdd as Ai, DateWindow as An, WorkspaceActivity as Ao, WorkspaceConnection as Ar, UpdateWorkspacePolicy as At, WorkspaceReviewsQuery as B, ArtifactSet as Ba, ImageMetadata as Bi, UpdateWorkspaceDocument as Bn, IdentityProvider as Bo, ConnectorCapabilities as Br, UpdateWorkspacePipeline as Bt, Language as C, TextAdd as Ca, Dimensions as Ci, WorkspaceInvite as Cn, PipelineActivityParams as Co, SyncDeletionPolicy as Cr, PolicyTemplate as Ct, ScopeMetadata as D, TextCoord as Da, EntityCoRef as Di, ComponentHealth as Dn, ReviewActivityParams as Do, SyncTriggerType as Dr, TemplateOrigin as Dt, Languages as E, TextAuditLog as Ea, EditSet as Ei, WorkspaceInviteSent as En, RedactionActivityParams as Eo, SyncStatus as Er, TabularRedaction as Et, WorkspaceReviewEntry as F, TextModel as Fa, ImageEdit as Fi, DocumentHash as Fn, Account as Fo, WorkspaceConnectionsQuery as Fr, WorkspacePolicySummaryPage as Ft, ProviderType as G, Tokens as Ga, LeakProfile as Gi, CreateWorkspaceDetection as Gn, paths as Go, AccountDesktopToken as Gr, CursorPagination as Gt, InferenceConfig as H, LayoutBlock as Ha, ImagePattern as Hi, WorkspaceDocument as Hn, PublicAccount as Ho, LabelCatalog as Hr, WorkspacePipelineFilter as Ht, WorkspaceReviewEntryPage as I, TextPattern as Ia, ImageEntity as Ii, DocumentKind as In, AccountIdentities as Io, WorkspacePickerToken as Ir, CreateWorkspacePipeline as It, WorkspaceProviderPage as J, Transcription as Ja, ModelEvent as Ji, DetectionStatus as Jn, Signup as Jr, AccountNotificationPage as Jt, UpdateWorkspaceProvider as K, TranscriptSegment as Ka, ManualIntent as Ki, DetectionId as Kn, DesktopTokenRequest as Kr, AccountMarkedReadStatus as Kt, WorkspaceReviewEvent as L, TextRefinement as La, ImageHint as Li, FormatToken as Ln, AccountIdentity as Lo, WorkspacePickerTokenRequest as Lr, PipelineDefinition as Lt, UpdateWorkspaceComment as M, TextLocation as Ma, ImageAuditKind as Mi, ExportQuery as Mn, WorkspaceActivityFilterQuery as Mo, WorkspaceConnectionSync as Mr, WorkspacePoliciesQuery as Mt, WorkspaceComment as N, TextManual as Na, ImageAuditLog as Ni, ErrorResponse as Nn, WorkspaceActivityPage as No, WorkspaceConnectionSyncPage as Nr, WorkspacePolicy as Nt, CreateWorkspaceComment as O, TextData as Oa, ExifPolicy as Oi, Health as On, ReviewCommentActivityParams as Oo, UnauthenticatedProvider as Or, TerminalFallback as Ot, WorkspaceReview as P, TextMetadata as Pa, ImageData as Pi, DeleteWorkspaceDocuments as Pn, WorkspaceActivityParams as Po, WorkspaceConnectionVerification as Pr, WorkspacePolicySummary as Pt, Color as Q, ApiTokenType as Qa, Polygon as Qi, WorkspaceDetection as Qn, AudioAuditKind as Qr, ConnectionSyncFailedParams as Qt, WorkspaceReviewEventPage as R, TextRetag as Ra, ImageLocation as Ri, ListWorkspaceDocuments as Rn, AccountRef as Ro, WorkspaceSyncSchedule as Rr, PipelineStatus as Rt, CountryCode as S, TabularRetag as Sa, Deduplication as Si, ReplyWorkspaceInvite as Sn, MemberActivityParams as So, StorageConfig as Sr, PolicyRule as St, LanguageSpan as T, TextAuditKind as Ta, Dpi as Ti, WorkspaceInvitePage as Tn, ProviderActivityParams as To, SyncScheduleInput as Tr, Sha2Algorithm as Tt, ProviderConfig as U, LayoutWord as Ua, ImageRefinement as Ui, WorkspaceDocumentPage as Un, SetPassword as Uo, RecognizerCatalog as Ur, WorkspacePipelineSummary as Ut, CreateWorkspaceProvider as V, Layout as Va, ImageModel as Vi, WorkspaceDeletedDocuments as Vn, OidcStartResponse as Vo, FileProviders as Vr, WorkspacePipeline as Vt, ProviderId as W, Token as Wa, ImageRetag as Wi, CreateAdhocWorkspaceDetection as Wn, UpdateAccount as Wo, RegisteredRecognizer as Wr, WorkspacePipelineSummaryPage as Wt, AudioRedaction as X, AccountApiTokenPage as Xa, PatternEvent as Xi, RedactWorkspaceDetection as Xn, AudioAdd as Xr, CommentMentionedParams as Xt, WorkspaceProvidersQuery as Y, AccountApiToken as Ya, OperatorId as Yi, DetectionStatusEvent as Yn, Attribution as Yr, AccountUnreadStatus as Yt, ClampBucket as Z, AccountApiTokenWithJwt as Za, Point as Zi, RedactionId as Zn, AudioAuditEvent as Zr, ConnectionSyncCompletedParams as Zt, WorkspaceWebhook as _, TabularManual as _a, CodecParams as _i, InviteExpiration as _n, ActivityType as _o, OAuthStartResponse as _r, PciDssPart as _t, RetentionSettings as a, Selection as aa, AudioManual as ai, ReviewAssignedParams as an, Usage as ao, AuthenticatedProvider as ar, GdprSensitiveScope as at, WorkspaceWebhookResult as b, TabularPattern as ba, Contested as bi, InviteStatus as bn, DocumentActivityParams as bo, S3Credentials as br, PolicyDraft as bt, WorkspacePage as c, Suppress as ca, AudioPattern as ci, WorkspaceNotificationSettings as cn, WorkspaceDetectionAnalytics as co, ConnectionId as cr, ImageRedaction as ct, CreateWorkspaceWebhook as d, TabularAuditKind as da, Audit as di, UpdateWorkspaceMember as dn, WorkspaceDetectionTimeSeries as do, ExportWorkspaceFiles as dr, LabelLocale as dt, RasterMode as ea, AudioData as ei, DetectionFailedParams as en, TokenExpiration as eo, WorkspaceDetectionsQuery as er, CreateWorkspacePolicy as et, TestWorkspaceWebhook as f, TabularAuditLog as fa, AuditHash as fi, WorkspaceMember as fn, WorkspaceModelUsageEntry as fo, FileServiceConfig as fr, LabelRef as ft, WebhookStatus as g, TabularLocation as ga, CitedAttribution as gi, GenerateWorkspaceInviteCode as gn, ActivityPayload as go, LlmConfig as gr, ModalityRedactions as gt, WebhookId as h, TabularHint as ha, Category as hi, Direction as hn, WorkspaceUsageAnalytics as ho, ImportWorkspaceFiles as hr, LocalizedText as ht, RetentionOverride as i, RuleMatch as ia, AudioLocation as ii, RedactionCreatedParams as in, TokenCounts as io, WorkspaceRedactionsQuery as ir, GdprArticle9Treatment as it, ReviewStatus as j, TextHint as ja, ImageAuditEvent as ji, ExportFormat as jn, WorkspaceActivityExportOptions as jo, WorkspaceConnectionPage as jr, Waveform as jt, CreateWorkspaceReview as k, TextEdit as ka, FreeformAttribution as ki, HealthStatus as kn, WebhookActivityParams as ko, UpdateWorkspaceConnection as kr, TextRedaction as kt, WorkspaceRole as l, TabularAdd as la, AudioRefinement as li, ListWorkspaceMembers as ln, WorkspaceDetectionDayEntry as lo, ConnectionType as lr, Label as lt, WebhookEvent as m, TabularEntity as ma, Calibration as mi, CreateWorkspaceInvite as mn, WorkspaceStorageKindEntry as mo, GcsCredentials as mr, LanguageTag as mt, RasterPolicy as n, Redaction as na, AudioEntity as ni, NotificationEvent as nn, ModelUsage as no, WorkspaceRedactionResult as nr, DateGranularity as nt, UpdateWorkspace as o, SourceRef as oa, AudioMetadata as oi, UnreadCountEvent as on, UsageReport as oo, AzureCredentials as or, HipaaAccountNumbers as ot, UpdateWorkspaceWebhook as p, TabularEdit as pa, BoundingBox as pi, WorkspaceMemberPage as pn, WorkspaceStorageAnalytics as po, FileServiceProvider as pr, LabelScope as pt, WorkspaceProvider as q, TranscriptWord as qa, MetadataEvent as qi, DetectionMetadata as qn, Login as qr, AccountNotification as qt, Retention as r, Report as ra, AudioHint as ri, NotificationPayload as rn, RecognizerId as ro, WorkspaceRedactionResultPage as rr, DateStyle as rt, Workspace as s, SourceSpan as sa, AudioModel as si, UpdateWorkspaceNotificationSettings as sn, WorkspaceAnalytics as so, ConnectionConfig as sr, HipaaDeidMethod as st, CreateWorkspace as t, Recognition as ta, AudioEdit as ti, MemberJoinedParams as tn, UpdateAccountApiToken as to, WorkspacePipelineDetectionsQuery as tr, CustomMatcher as tt, WorkspaceSettings as u, TabularAuditEvent as ua, AudioRetag as ui, MemberSortField as un, WorkspaceDetectionStatusEntry as uo, CreateWorkspaceConnection as ur, LabelEntry as ut, WorkspaceWebhookCreated as v, TabularMetadata as va, ComponentSelection as vi, InvitePreview as vn, ConnectionActivityParams as vo, OAuthTokens as vr, PciPanRender as vt, LanguageProvenance as w, TextAuditEvent as wa, DocumentContext as wi, WorkspaceInviteCode as wn, PolicyActivityParams as wo, SyncMode as wr, Predicate as wt, Confidence as x, TabularRefinement as xa, DecodedSpan as xi, ListWorkspaceInvites as xn, InviteActivityParams as xo, StartFileServiceOAuth as xr, PolicyKind as xt, WorkspaceWebhookPage as y, TabularModel as ya, Conflict as yi, InviteSortField as yn, DetectionActivityParams as yo, PickedFile as yr, Policy as yt, WorkspaceReviewPage as z, TimeSpan as za, ImageManual as zi, ModalityToken as zn, Handle as zo, AuthCapabilities as zr, PipelineTriggerType as zt };
|
|
22986
|
+
//# sourceMappingURL=index-Cf0KFY6M.d.ts.map
|