@quba/sensitive-data-protection 0.1.0 → 0.2.2

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.
Files changed (78) hide show
  1. package/README.md +58 -6
  2. package/dist/index.cjs +2884 -569
  3. package/dist/index.d.cts +3059 -765
  4. package/dist/index.d.mts +3059 -765
  5. package/dist/index.mjs +2574 -535
  6. package/docs/Action.md +33 -0
  7. package/docs/AnonymizeFileResponseBody.md +43 -0
  8. package/docs/AnonymizeRequestBody.md +4 -2
  9. package/docs/AnonymizeResponseBody.md +3 -1
  10. package/docs/{AnonymizeResponseBodySpansInner.md → Applied.md} +7 -4
  11. package/docs/At.md +37 -0
  12. package/docs/AttributeSegment.md +37 -0
  13. package/docs/{ValidationErrorLocInner.md → CellKind.md} +5 -4
  14. package/docs/CellNoteSegment.md +35 -0
  15. package/docs/CellSegment.md +43 -0
  16. package/docs/CommentKind.md +33 -0
  17. package/docs/CommentSegment.md +39 -0
  18. package/docs/ComponentSegment.md +39 -0
  19. package/docs/DetectRule.md +3 -1
  20. package/docs/ElementSegment.md +39 -0
  21. package/docs/EncryptRule.md +3 -1
  22. package/docs/{DetectRuleEntitiesInner.md → EndnoteSegment.md} +7 -6
  23. package/docs/{EntitiesAnyOfInner.md → EntityBody.md} +5 -4
  24. package/docs/ErrorCode.md +33 -0
  25. package/docs/ErrorInfo.md +39 -0
  26. package/docs/FieldError.md +51 -0
  27. package/docs/FieldErrorCode.md +33 -0
  28. package/docs/{HTTPValidationError.md → FieldErrorPathInner.md} +5 -6
  29. package/docs/FieldSegment.md +39 -0
  30. package/docs/FileAttributeResult.md +47 -0
  31. package/docs/FileEmbeddedResult.md +43 -0
  32. package/docs/FileModelResult.md +49 -0
  33. package/docs/{AnonymizeResponseBodyResultsInner.md → FileRegexResult.md} +11 -8
  34. package/docs/FileResult.md +51 -0
  35. package/docs/FootnoteSegment.md +37 -0
  36. package/docs/FrameSegment.md +37 -0
  37. package/docs/HMACRule.md +43 -0
  38. package/docs/HeaderFooterSegment.md +37 -0
  39. package/docs/IndexSegment.md +37 -0
  40. package/docs/ItemSegment.md +37 -0
  41. package/docs/KeySegment.md +37 -0
  42. package/docs/Kind.md +33 -0
  43. package/docs/LineSegment.md +39 -0
  44. package/docs/MaskRule.md +3 -1
  45. package/docs/ModelError.md +2 -3
  46. package/docs/ModelResult.md +2 -0
  47. package/docs/ModelStatus.md +45 -0
  48. package/docs/{Entities.md → ModelType.md} +5 -4
  49. package/docs/ParagraphKind.md +33 -0
  50. package/docs/ParagraphSegment.md +39 -0
  51. package/docs/PartSegment.md +39 -0
  52. package/docs/PathSegment.md +79 -0
  53. package/docs/PolicyDocumentRulesInner.md +7 -1
  54. package/docs/{ValidationError.md → PropertySegment.md} +7 -12
  55. package/docs/PseudonymizeRule.md +41 -0
  56. package/docs/RangeKind.md +33 -0
  57. package/docs/RangeSegment.md +39 -0
  58. package/docs/RedactRule.md +3 -1
  59. package/docs/Refusal.md +36 -0
  60. package/docs/RegexResult.md +2 -0
  61. package/docs/RegionSegment.md +43 -0
  62. package/docs/ReplaceRule.md +3 -1
  63. package/docs/{AnonymizeRequestBodyRulesInner.md → RuleBody.md} +12 -5
  64. package/docs/SHA256Rule.md +3 -1
  65. package/docs/SHA512Rule.md +3 -1
  66. package/docs/ScanRequestBody.md +2 -0
  67. package/docs/ScanResponseBody.md +2 -0
  68. package/docs/SegmentSegment.md +39 -0
  69. package/docs/SensitiveDataProtectionApi.md +160 -3
  70. package/docs/ShapeKind.md +33 -0
  71. package/docs/ShapeSegment.md +41 -0
  72. package/docs/SheetSegment.md +39 -0
  73. package/docs/SlideSegment.md +41 -0
  74. package/docs/SpeakerNotesSegment.md +41 -0
  75. package/docs/TableSegment.md +37 -0
  76. package/docs/TagSegment.md +41 -0
  77. package/docs/TextSegment.md +39 -0
  78. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -1,7 +1,7 @@
1
1
  //#region src/runtime.d.ts
2
2
  /**
3
3
  * Sensitive Data Protection API
4
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
4
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
5
5
  *
6
6
  * The version of the OpenAPI document: 0.1.0
7
7
  *
@@ -184,10 +184,10 @@ declare class TextApiResponse {
184
184
  value(): Promise<string>;
185
185
  }
186
186
  //#endregion
187
- //#region src/models/DetectRuleEntitiesInner.d.ts
187
+ //#region src/models/Action.d.ts
188
188
  /**
189
189
  * Sensitive Data Protection API
190
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
190
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
191
191
  *
192
192
  * The version of the OpenAPI document: 0.1.0
193
193
  *
@@ -197,155 +197,362 @@ declare class TextApiResponse {
197
197
  * Do not edit the class manually.
198
198
  */
199
199
  /**
200
+ * What the browser extension does with a match, before the text is sent.
201
+ * `warn`: highlighted; the user may send it as it is. `enforce`: replaced
202
+ * with the rule's transformation before sending; sending is blocked when it
203
+ * can't be.
204
+ * @export
205
+ */
206
+ declare const Action: {
207
+ readonly warn: "warn";
208
+ readonly enforce: "enforce";
209
+ };
210
+ type Action = typeof Action[keyof typeof Action];
211
+ declare function instanceOfAction(value: any): boolean;
212
+ declare function ActionFromJSON(json: any): Action;
213
+ declare function ActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): Action;
214
+ declare function ActionToJSON(value?: Action | null): any;
215
+ declare function ActionToJSONTyped(value: any, ignoreDiscriminator: boolean): Action;
216
+ //#endregion
217
+ //#region src/models/Usage.d.ts
218
+ /**
219
+ * Sensitive Data Protection API
220
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
221
+ *
222
+ * The version of the OpenAPI document: 0.1.0
223
+ *
224
+ *
225
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
226
+ * https://openapi-generator.tech
227
+ * Do not edit the class manually.
228
+ */
229
+ /**
230
+ * What one request cost, the unit billing meters against.
231
+ *
232
+ * Only the text the model scanned is counted. Anonymized output is built from
233
+ * the input by substitution, not generated, so counting it would charge twice
234
+ * for the same text.
235
+ *
236
+ * Counted with the detection model's own tokenizer, excluding special tokens,
237
+ * so the same text always costs the same for a given model.
238
+ * @export
239
+ * @interface Usage
240
+ */
241
+ interface Usage {
242
+ /**
243
+ * Tokens in the text the model scanned.
244
+ * @type {number}
245
+ * @memberof Usage
246
+ */
247
+ input_tokens: number;
248
+ /**
249
+ * Milliseconds spent in the model. Excludes tokenizing, validation and serialization.
250
+ * @type {number}
251
+ * @memberof Usage
252
+ */
253
+ inference_ms: number;
254
+ }
255
+ /**
256
+ * Check if a given object implements the Usage interface.
257
+ */
258
+ declare function instanceOfUsage(value: object): value is Usage;
259
+ declare function UsageFromJSON(json: any): Usage;
260
+ declare function UsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Usage;
261
+ declare function UsageToJSON(json: any): Usage;
262
+ declare function UsageToJSONTyped(value?: Usage | null, ignoreDiscriminator?: boolean): any;
263
+ //#endregion
264
+ //#region src/models/AttributeSegment.d.ts
265
+ /**
266
+ * Sensitive Data Protection API
267
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
200
268
  *
269
+ * The version of the OpenAPI document: 0.1.0
270
+ *
271
+ *
272
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
273
+ * https://openapi-generator.tech
274
+ * Do not edit the class manually.
275
+ */
276
+ /**
277
+ * An XML or HTML attribute of the element before it.
201
278
  * @export
202
- * @interface DetectRuleEntitiesInner
279
+ * @interface AttributeSegment
203
280
  */
204
- interface DetectRuleEntitiesInner {
281
+ interface AttributeSegment {
205
282
  /**
206
283
  *
207
284
  * @type {string}
208
- * @memberof DetectRuleEntitiesInner
285
+ * @memberof AttributeSegment
209
286
  */
210
- type?: DetectRuleEntitiesInnerTypeEnum;
287
+ type: AttributeSegmentTypeEnum;
211
288
  /**
212
- * The regular expression to match.
289
+ *
213
290
  * @type {string}
214
- * @memberof DetectRuleEntitiesInner
291
+ * @memberof AttributeSegment
215
292
  */
216
- value: string;
293
+ name: string;
217
294
  }
218
295
  /**
219
296
  * @export
220
297
  */
221
- declare const DetectRuleEntitiesInnerTypeEnum: {
222
- readonly model: "model";
223
- readonly regex: "regex";
298
+ declare const AttributeSegmentTypeEnum: {
299
+ readonly attribute: "attribute";
300
+ };
301
+ type AttributeSegmentTypeEnum = typeof AttributeSegmentTypeEnum[keyof typeof AttributeSegmentTypeEnum];
302
+ /**
303
+ * Check if a given object implements the AttributeSegment interface.
304
+ */
305
+ declare function instanceOfAttributeSegment(value: object): value is AttributeSegment;
306
+ declare function AttributeSegmentFromJSON(json: any): AttributeSegment;
307
+ declare function AttributeSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttributeSegment;
308
+ declare function AttributeSegmentToJSON(json: any): AttributeSegment;
309
+ declare function AttributeSegmentToJSONTyped(value?: AttributeSegment | null, ignoreDiscriminator?: boolean): any;
310
+ //#endregion
311
+ //#region src/models/CellNoteSegment.d.ts
312
+ /**
313
+ * Sensitive Data Protection API
314
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
315
+ *
316
+ * The version of the OpenAPI document: 0.1.0
317
+ *
318
+ *
319
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
320
+ * https://openapi-generator.tech
321
+ * Do not edit the class manually.
322
+ */
323
+ /**
324
+ * A workbook note on a cell (Excel's "Note", a legacy comment); it follows its cell.
325
+ * @export
326
+ * @interface CellNoteSegment
327
+ */
328
+ interface CellNoteSegment {
329
+ /**
330
+ *
331
+ * @type {string}
332
+ * @memberof CellNoteSegment
333
+ */
334
+ type: CellNoteSegmentTypeEnum;
335
+ }
336
+ /**
337
+ * @export
338
+ */
339
+ declare const CellNoteSegmentTypeEnum: {
340
+ readonly cell_note: "cell_note";
224
341
  };
225
- type DetectRuleEntitiesInnerTypeEnum = typeof DetectRuleEntitiesInnerTypeEnum[keyof typeof DetectRuleEntitiesInnerTypeEnum];
342
+ type CellNoteSegmentTypeEnum = typeof CellNoteSegmentTypeEnum[keyof typeof CellNoteSegmentTypeEnum];
226
343
  /**
227
- * Check if a given object implements the DetectRuleEntitiesInner interface.
344
+ * Check if a given object implements the CellNoteSegment interface.
228
345
  */
229
- declare function instanceOfDetectRuleEntitiesInner(value: object): value is DetectRuleEntitiesInner;
230
- declare function DetectRuleEntitiesInnerFromJSON(json: any): DetectRuleEntitiesInner;
231
- declare function DetectRuleEntitiesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): DetectRuleEntitiesInner;
232
- declare function DetectRuleEntitiesInnerToJSON(json: any): DetectRuleEntitiesInner;
233
- declare function DetectRuleEntitiesInnerToJSONTyped(value?: DetectRuleEntitiesInner | null, ignoreDiscriminator?: boolean): any;
346
+ declare function instanceOfCellNoteSegment(value: object): value is CellNoteSegment;
347
+ declare function CellNoteSegmentFromJSON(json: any): CellNoteSegment;
348
+ declare function CellNoteSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CellNoteSegment;
349
+ declare function CellNoteSegmentToJSON(json: any): CellNoteSegment;
350
+ declare function CellNoteSegmentToJSONTyped(value?: CellNoteSegment | null, ignoreDiscriminator?: boolean): any;
234
351
  //#endregion
235
- //#region src/models/AnonymizeRequestBodyRulesInner.d.ts
352
+ //#region src/models/CellKind.d.ts
236
353
  /**
354
+ * Sensitive Data Protection API
355
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
237
356
  *
357
+ * The version of the OpenAPI document: 0.1.0
358
+ *
359
+ *
360
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
361
+ * https://openapi-generator.tech
362
+ * Do not edit the class manually.
363
+ */
364
+ /**
365
+ * @type CellKind
366
+ * What a cell's text is when it is not its value.
367
+ * @export
368
+ */
369
+ type CellKind = string;
370
+ declare function CellKindFromJSON(json: any): CellKind;
371
+ declare function CellKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): CellKind;
372
+ declare function CellKindToJSON(json: any): any;
373
+ declare function CellKindToJSONTyped(value?: CellKind | null, ignoreDiscriminator?: boolean): any;
374
+ //#endregion
375
+ //#region src/models/CellSegment.d.ts
376
+ /**
377
+ * A cell, from 1, in the data's order (a CSV's header line is row 1); `ref` in
378
+ * A1. No `kind` for its value.
238
379
  * @export
239
- * @interface AnonymizeRequestBodyRulesInner
380
+ * @interface CellSegment
240
381
  */
241
- interface AnonymizeRequestBodyRulesInner {
382
+ interface CellSegment {
242
383
  /**
243
384
  *
244
385
  * @type {string}
245
- * @memberof AnonymizeRequestBodyRulesInner
386
+ * @memberof CellSegment
246
387
  */
247
- type?: AnonymizeRequestBodyRulesInnerTypeEnum;
388
+ type: CellSegmentTypeEnum;
248
389
  /**
249
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
250
- * @type {Array<DetectRuleEntitiesInner>}
251
- * @memberof AnonymizeRequestBodyRulesInner
390
+ *
391
+ * @type {number}
392
+ * @memberof CellSegment
252
393
  */
253
- entities: Array<DetectRuleEntitiesInner>;
394
+ row: number;
254
395
  /**
255
- * The fixed string to substitute for each match.
256
- * @type {string}
257
- * @memberof AnonymizeRequestBodyRulesInner
396
+ *
397
+ * @type {number}
398
+ * @memberof CellSegment
258
399
  */
259
- replacement?: string;
400
+ column: number;
260
401
  /**
261
- * Base64 Fernet key. If empty, a key is generated automatically.
402
+ *
262
403
  * @type {string}
263
- * @memberof AnonymizeRequestBodyRulesInner
404
+ * @memberof CellSegment
264
405
  */
265
- key?: string;
406
+ ref: string;
266
407
  /**
267
- * The character used to mask, e.g. '*'.
408
+ *
409
+ * @type {CellKind}
410
+ * @memberof CellSegment
411
+ */
412
+ kind?: CellKind | null;
413
+ }
414
+ /**
415
+ * @export
416
+ */
417
+ declare const CellSegmentTypeEnum: {
418
+ readonly cell: "cell";
419
+ };
420
+ type CellSegmentTypeEnum = typeof CellSegmentTypeEnum[keyof typeof CellSegmentTypeEnum];
421
+ /**
422
+ * Check if a given object implements the CellSegment interface.
423
+ */
424
+ declare function instanceOfCellSegment(value: object): value is CellSegment;
425
+ declare function CellSegmentFromJSON(json: any): CellSegment;
426
+ declare function CellSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CellSegment;
427
+ declare function CellSegmentToJSON(json: any): CellSegment;
428
+ declare function CellSegmentToJSONTyped(value?: CellSegment | null, ignoreDiscriminator?: boolean): any;
429
+ //#endregion
430
+ //#region src/models/CommentKind.d.ts
431
+ /**
432
+ * Sensitive Data Protection API
433
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
434
+ *
435
+ * The version of the OpenAPI document: 0.1.0
436
+ *
437
+ *
438
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
439
+ * https://openapi-generator.tech
440
+ * Do not edit the class manually.
441
+ */
442
+ /**
443
+ * Its author's name or initials.
444
+ * @export
445
+ */
446
+ declare const CommentKind: {
447
+ readonly author: "author";
448
+ };
449
+ type CommentKind = typeof CommentKind[keyof typeof CommentKind];
450
+ declare function instanceOfCommentKind(value: any): boolean;
451
+ declare function CommentKindFromJSON(json: any): CommentKind;
452
+ declare function CommentKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommentKind;
453
+ declare function CommentKindToJSON(value?: CommentKind | null): any;
454
+ declare function CommentKindToJSONTyped(value: any, ignoreDiscriminator: boolean): CommentKind;
455
+ //#endregion
456
+ //#region src/models/CommentSegment.d.ts
457
+ /**
458
+ * A comment (Word `w:comment`, PowerPoint `p:cm`, Excel threaded comment), by
459
+ * its id in the file. In a workbook it follows its cell.
460
+ * @export
461
+ * @interface CommentSegment
462
+ */
463
+ interface CommentSegment {
464
+ /**
465
+ *
268
466
  * @type {string}
269
- * @memberof AnonymizeRequestBodyRulesInner
467
+ * @memberof CommentSegment
270
468
  */
271
- masking_char?: string;
469
+ type: CommentSegmentTypeEnum;
272
470
  /**
273
471
  *
274
- * @type {number}
275
- * @memberof AnonymizeRequestBodyRulesInner
472
+ * @type {string}
473
+ * @memberof CommentSegment
276
474
  */
277
- chars_to_mask?: number;
475
+ id: string;
278
476
  /**
279
- * If true, mask the last N characters instead of the first N.
280
- * @type {boolean}
281
- * @memberof AnonymizeRequestBodyRulesInner
477
+ *
478
+ * @type {CommentKind}
479
+ * @memberof CommentSegment
282
480
  */
283
- from_end?: boolean;
481
+ kind?: CommentKind | null;
284
482
  }
285
483
  /**
286
484
  * @export
287
485
  */
288
- declare const AnonymizeRequestBodyRulesInnerTypeEnum: {
289
- readonly replace: "replace";
290
- readonly redact: "redact";
291
- readonly sha256: "sha256";
292
- readonly sha512: "sha512";
293
- readonly encrypt: "encrypt";
294
- readonly mask: "mask";
295
- readonly detect: "detect";
486
+ declare const CommentSegmentTypeEnum: {
487
+ readonly comment: "comment";
296
488
  };
297
- type AnonymizeRequestBodyRulesInnerTypeEnum = typeof AnonymizeRequestBodyRulesInnerTypeEnum[keyof typeof AnonymizeRequestBodyRulesInnerTypeEnum];
489
+ type CommentSegmentTypeEnum = typeof CommentSegmentTypeEnum[keyof typeof CommentSegmentTypeEnum];
298
490
  /**
299
- * Check if a given object implements the AnonymizeRequestBodyRulesInner interface.
491
+ * Check if a given object implements the CommentSegment interface.
300
492
  */
301
- declare function instanceOfAnonymizeRequestBodyRulesInner(value: object): value is AnonymizeRequestBodyRulesInner;
302
- declare function AnonymizeRequestBodyRulesInnerFromJSON(json: any): AnonymizeRequestBodyRulesInner;
303
- declare function AnonymizeRequestBodyRulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeRequestBodyRulesInner;
304
- declare function AnonymizeRequestBodyRulesInnerToJSON(json: any): AnonymizeRequestBodyRulesInner;
305
- declare function AnonymizeRequestBodyRulesInnerToJSONTyped(value?: AnonymizeRequestBodyRulesInner | null, ignoreDiscriminator?: boolean): any;
493
+ declare function instanceOfCommentSegment(value: object): value is CommentSegment;
494
+ declare function CommentSegmentFromJSON(json: any): CommentSegment;
495
+ declare function CommentSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): CommentSegment;
496
+ declare function CommentSegmentToJSON(json: any): CommentSegment;
497
+ declare function CommentSegmentToJSONTyped(value?: CommentSegment | null, ignoreDiscriminator?: boolean): any;
306
498
  //#endregion
307
- //#region src/models/AnonymizeRequestBody.d.ts
499
+ //#region src/models/ComponentSegment.d.ts
308
500
  /**
309
- * Request body for the anonymize endpoint.
501
+ * Sensitive Data Protection API
502
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
310
503
  *
311
- * Carries the text to anonymize and the list of de-identification rules to
312
- * apply. See ``AnonymizationCommand`` for field-level details.
504
+ * The version of the OpenAPI document: 0.1.0
505
+ *
506
+ *
507
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
508
+ * https://openapi-generator.tech
509
+ * Do not edit the class manually.
510
+ */
511
+ /**
512
+ * An HL7 v2 component of the field before it: `1` in `PID-5.1`.
313
513
  * @export
314
- * @interface AnonymizeRequestBody
514
+ * @interface ComponentSegment
315
515
  */
316
- interface AnonymizeRequestBody {
516
+ interface ComponentSegment {
317
517
  /**
318
- * The text to scan and anonymize. At most 128 KB in UTF-8.
518
+ *
319
519
  * @type {string}
320
- * @memberof AnonymizeRequestBody
520
+ * @memberof ComponentSegment
321
521
  */
322
- text: string;
522
+ type: ComponentSegmentTypeEnum;
323
523
  /**
324
524
  *
325
- * @type {Array<AnonymizeRequestBodyRulesInner>}
326
- * @memberof AnonymizeRequestBody
525
+ * @type {number}
526
+ * @memberof ComponentSegment
327
527
  */
328
- rules?: Array<AnonymizeRequestBodyRulesInner> | null;
528
+ number: number;
329
529
  /**
330
530
  *
331
531
  * @type {number}
332
- * @memberof AnonymizeRequestBody
532
+ * @memberof ComponentSegment
333
533
  */
334
- confidence_threshold?: number | null;
534
+ subcomponent?: number | null;
335
535
  }
336
536
  /**
337
- * Check if a given object implements the AnonymizeRequestBody interface.
537
+ * @export
338
538
  */
339
- declare function instanceOfAnonymizeRequestBody(value: object): value is AnonymizeRequestBody;
340
- declare function AnonymizeRequestBodyFromJSON(json: any): AnonymizeRequestBody;
341
- declare function AnonymizeRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeRequestBody;
342
- declare function AnonymizeRequestBodyToJSON(json: any): AnonymizeRequestBody;
343
- declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody | null, ignoreDiscriminator?: boolean): any;
539
+ declare const ComponentSegmentTypeEnum: {
540
+ readonly component: "component";
541
+ };
542
+ type ComponentSegmentTypeEnum = typeof ComponentSegmentTypeEnum[keyof typeof ComponentSegmentTypeEnum];
543
+ /**
544
+ * Check if a given object implements the ComponentSegment interface.
545
+ */
546
+ declare function instanceOfComponentSegment(value: object): value is ComponentSegment;
547
+ declare function ComponentSegmentFromJSON(json: any): ComponentSegment;
548
+ declare function ComponentSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComponentSegment;
549
+ declare function ComponentSegmentToJSON(json: any): ComponentSegment;
550
+ declare function ComponentSegmentToJSONTyped(value?: ComponentSegment | null, ignoreDiscriminator?: boolean): any;
344
551
  //#endregion
345
- //#region src/models/Usage.d.ts
552
+ //#region src/models/ElementSegment.d.ts
346
553
  /**
347
554
  * Sensitive Data Protection API
348
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
555
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
349
556
  *
350
557
  * The version of the OpenAPI document: 0.1.0
351
558
  *
@@ -355,146 +562,2470 @@ declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody |
355
562
  * Do not edit the class manually.
356
563
  */
357
564
  /**
358
- * What one request cost, the unit billing meters against.
565
+ * An XML or HTML element, by its local name (no namespace prefix): a step
566
+ * towards a value, as in a path of element names.
567
+ * @export
568
+ * @interface ElementSegment
569
+ */
570
+ interface ElementSegment {
571
+ /**
572
+ *
573
+ * @type {string}
574
+ * @memberof ElementSegment
575
+ */
576
+ type: ElementSegmentTypeEnum;
577
+ /**
578
+ *
579
+ * @type {string}
580
+ * @memberof ElementSegment
581
+ */
582
+ name: string;
583
+ /**
584
+ * Among the siblings with this name, from 0.
585
+ * @type {number}
586
+ * @memberof ElementSegment
587
+ */
588
+ index: number;
589
+ }
590
+ /**
591
+ * @export
592
+ */
593
+ declare const ElementSegmentTypeEnum: {
594
+ readonly element: "element";
595
+ };
596
+ type ElementSegmentTypeEnum = typeof ElementSegmentTypeEnum[keyof typeof ElementSegmentTypeEnum];
597
+ /**
598
+ * Check if a given object implements the ElementSegment interface.
599
+ */
600
+ declare function instanceOfElementSegment(value: object): value is ElementSegment;
601
+ declare function ElementSegmentFromJSON(json: any): ElementSegment;
602
+ declare function ElementSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ElementSegment;
603
+ declare function ElementSegmentToJSON(json: any): ElementSegment;
604
+ declare function ElementSegmentToJSONTyped(value?: ElementSegment | null, ignoreDiscriminator?: boolean): any;
605
+ //#endregion
606
+ //#region src/models/EndnoteSegment.d.ts
607
+ /**
608
+ * Sensitive Data Protection API
609
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
359
610
  *
360
- * Only the text the model scanned is counted. Anonymized output is built from
361
- * the input by substitution, not generated, so counting it would charge twice
362
- * for the same text.
611
+ * The version of the OpenAPI document: 0.1.0
363
612
  *
364
- * Counted with the detection model's own tokenizer, excluding special tokens,
365
- * so the same text always costs the same for a given model.
613
+ *
614
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
615
+ * https://openapi-generator.tech
616
+ * Do not edit the class manually.
617
+ */
618
+ /**
619
+ * An endnote (`w:endnote`), by its id.
366
620
  * @export
367
- * @interface Usage
621
+ * @interface EndnoteSegment
368
622
  */
369
- interface Usage {
623
+ interface EndnoteSegment {
624
+ /**
625
+ *
626
+ * @type {string}
627
+ * @memberof EndnoteSegment
628
+ */
629
+ type: EndnoteSegmentTypeEnum;
630
+ /**
631
+ *
632
+ * @type {string}
633
+ * @memberof EndnoteSegment
634
+ */
635
+ id: string;
636
+ }
637
+ /**
638
+ * @export
639
+ */
640
+ declare const EndnoteSegmentTypeEnum: {
641
+ readonly endnote: "endnote";
642
+ };
643
+ type EndnoteSegmentTypeEnum = typeof EndnoteSegmentTypeEnum[keyof typeof EndnoteSegmentTypeEnum];
644
+ /**
645
+ * Check if a given object implements the EndnoteSegment interface.
646
+ */
647
+ declare function instanceOfEndnoteSegment(value: object): value is EndnoteSegment;
648
+ declare function EndnoteSegmentFromJSON(json: any): EndnoteSegment;
649
+ declare function EndnoteSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EndnoteSegment;
650
+ declare function EndnoteSegmentToJSON(json: any): EndnoteSegment;
651
+ declare function EndnoteSegmentToJSONTyped(value?: EndnoteSegment | null, ignoreDiscriminator?: boolean): any;
652
+ //#endregion
653
+ //#region src/models/FieldSegment.d.ts
654
+ /**
655
+ * Sensitive Data Protection API
656
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
657
+ *
658
+ * The version of the OpenAPI document: 0.1.0
659
+ *
660
+ *
661
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
662
+ * https://openapi-generator.tech
663
+ * Do not edit the class manually.
664
+ */
665
+ /**
666
+ * An HL7 v2 field of the segment before it: `5` in `PID-5`.
667
+ * @export
668
+ * @interface FieldSegment
669
+ */
670
+ interface FieldSegment {
671
+ /**
672
+ *
673
+ * @type {string}
674
+ * @memberof FieldSegment
675
+ */
676
+ type: FieldSegmentTypeEnum;
677
+ /**
678
+ * The field's number, as the standard counts them (MSH-1 is the separator).
679
+ * @type {number}
680
+ * @memberof FieldSegment
681
+ */
682
+ number: number;
683
+ /**
684
+ * Which repetition of the field, from 0.
685
+ * @type {number}
686
+ * @memberof FieldSegment
687
+ */
688
+ repetition: number;
689
+ }
690
+ /**
691
+ * @export
692
+ */
693
+ declare const FieldSegmentTypeEnum: {
694
+ readonly field: "field";
695
+ };
696
+ type FieldSegmentTypeEnum = typeof FieldSegmentTypeEnum[keyof typeof FieldSegmentTypeEnum];
697
+ /**
698
+ * Check if a given object implements the FieldSegment interface.
699
+ */
700
+ declare function instanceOfFieldSegment(value: object): value is FieldSegment;
701
+ declare function FieldSegmentFromJSON(json: any): FieldSegment;
702
+ declare function FieldSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldSegment;
703
+ declare function FieldSegmentToJSON(json: any): FieldSegment;
704
+ declare function FieldSegmentToJSONTyped(value?: FieldSegment | null, ignoreDiscriminator?: boolean): any;
705
+ //#endregion
706
+ //#region src/models/FootnoteSegment.d.ts
707
+ /**
708
+ * Sensitive Data Protection API
709
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
710
+ *
711
+ * The version of the OpenAPI document: 0.1.0
712
+ *
713
+ *
714
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
715
+ * https://openapi-generator.tech
716
+ * Do not edit the class manually.
717
+ */
718
+ /**
719
+ * A footnote (`w:footnote`), by its id.
720
+ * @export
721
+ * @interface FootnoteSegment
722
+ */
723
+ interface FootnoteSegment {
724
+ /**
725
+ *
726
+ * @type {string}
727
+ * @memberof FootnoteSegment
728
+ */
729
+ type: FootnoteSegmentTypeEnum;
730
+ /**
731
+ *
732
+ * @type {string}
733
+ * @memberof FootnoteSegment
734
+ */
735
+ id: string;
736
+ }
737
+ /**
738
+ * @export
739
+ */
740
+ declare const FootnoteSegmentTypeEnum: {
741
+ readonly footnote: "footnote";
742
+ };
743
+ type FootnoteSegmentTypeEnum = typeof FootnoteSegmentTypeEnum[keyof typeof FootnoteSegmentTypeEnum];
744
+ /**
745
+ * Check if a given object implements the FootnoteSegment interface.
746
+ */
747
+ declare function instanceOfFootnoteSegment(value: object): value is FootnoteSegment;
748
+ declare function FootnoteSegmentFromJSON(json: any): FootnoteSegment;
749
+ declare function FootnoteSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): FootnoteSegment;
750
+ declare function FootnoteSegmentToJSON(json: any): FootnoteSegment;
751
+ declare function FootnoteSegmentToJSONTyped(value?: FootnoteSegment | null, ignoreDiscriminator?: boolean): any;
752
+ //#endregion
753
+ //#region src/models/FrameSegment.d.ts
754
+ /**
755
+ * Sensitive Data Protection API
756
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
757
+ *
758
+ * The version of the OpenAPI document: 0.1.0
759
+ *
760
+ *
761
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
762
+ * https://openapi-generator.tech
763
+ * Do not edit the class manually.
764
+ */
765
+ /**
766
+ * A frame of DICOM pixel data, from 1.
767
+ * @export
768
+ * @interface FrameSegment
769
+ */
770
+ interface FrameSegment {
771
+ /**
772
+ *
773
+ * @type {string}
774
+ * @memberof FrameSegment
775
+ */
776
+ type: FrameSegmentTypeEnum;
777
+ /**
778
+ *
779
+ * @type {number}
780
+ * @memberof FrameSegment
781
+ */
782
+ number: number;
783
+ }
784
+ /**
785
+ * @export
786
+ */
787
+ declare const FrameSegmentTypeEnum: {
788
+ readonly frame: "frame";
789
+ };
790
+ type FrameSegmentTypeEnum = typeof FrameSegmentTypeEnum[keyof typeof FrameSegmentTypeEnum];
791
+ /**
792
+ * Check if a given object implements the FrameSegment interface.
793
+ */
794
+ declare function instanceOfFrameSegment(value: object): value is FrameSegment;
795
+ declare function FrameSegmentFromJSON(json: any): FrameSegment;
796
+ declare function FrameSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): FrameSegment;
797
+ declare function FrameSegmentToJSON(json: any): FrameSegment;
798
+ declare function FrameSegmentToJSONTyped(value?: FrameSegment | null, ignoreDiscriminator?: boolean): any;
799
+ //#endregion
800
+ //#region src/models/HeaderFooterSegment.d.ts
801
+ /**
802
+ * Sensitive Data Protection API
803
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
804
+ *
805
+ * The version of the OpenAPI document: 0.1.0
806
+ *
807
+ *
808
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
809
+ * https://openapi-generator.tech
810
+ * Do not edit the class manually.
811
+ */
812
+ /**
813
+ * A worksheet's page header or footer, by its element: `oddHeader`, `oddFooter`, `evenHeader`…
814
+ * @export
815
+ * @interface HeaderFooterSegment
816
+ */
817
+ interface HeaderFooterSegment {
818
+ /**
819
+ *
820
+ * @type {string}
821
+ * @memberof HeaderFooterSegment
822
+ */
823
+ type: HeaderFooterSegmentTypeEnum;
824
+ /**
825
+ *
826
+ * @type {string}
827
+ * @memberof HeaderFooterSegment
828
+ */
829
+ name: string;
830
+ }
831
+ /**
832
+ * @export
833
+ */
834
+ declare const HeaderFooterSegmentTypeEnum: {
835
+ readonly header_footer: "header_footer";
836
+ };
837
+ type HeaderFooterSegmentTypeEnum = typeof HeaderFooterSegmentTypeEnum[keyof typeof HeaderFooterSegmentTypeEnum];
838
+ /**
839
+ * Check if a given object implements the HeaderFooterSegment interface.
840
+ */
841
+ declare function instanceOfHeaderFooterSegment(value: object): value is HeaderFooterSegment;
842
+ declare function HeaderFooterSegmentFromJSON(json: any): HeaderFooterSegment;
843
+ declare function HeaderFooterSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeaderFooterSegment;
844
+ declare function HeaderFooterSegmentToJSON(json: any): HeaderFooterSegment;
845
+ declare function HeaderFooterSegmentToJSONTyped(value?: HeaderFooterSegment | null, ignoreDiscriminator?: boolean): any;
846
+ //#endregion
847
+ //#region src/models/IndexSegment.d.ts
848
+ /**
849
+ * Sensitive Data Protection API
850
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
851
+ *
852
+ * The version of the OpenAPI document: 0.1.0
853
+ *
854
+ *
855
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
856
+ * https://openapi-generator.tech
857
+ * Do not edit the class manually.
858
+ */
859
+ /**
860
+ * A JSON array's index, from 0: a step towards a value, as in a JSON Pointer.
861
+ * @export
862
+ * @interface IndexSegment
863
+ */
864
+ interface IndexSegment {
865
+ /**
866
+ *
867
+ * @type {string}
868
+ * @memberof IndexSegment
869
+ */
870
+ type: IndexSegmentTypeEnum;
871
+ /**
872
+ *
873
+ * @type {number}
874
+ * @memberof IndexSegment
875
+ */
876
+ index: number;
877
+ }
878
+ /**
879
+ * @export
880
+ */
881
+ declare const IndexSegmentTypeEnum: {
882
+ readonly index: "index";
883
+ };
884
+ type IndexSegmentTypeEnum = typeof IndexSegmentTypeEnum[keyof typeof IndexSegmentTypeEnum];
885
+ /**
886
+ * Check if a given object implements the IndexSegment interface.
887
+ */
888
+ declare function instanceOfIndexSegment(value: object): value is IndexSegment;
889
+ declare function IndexSegmentFromJSON(json: any): IndexSegment;
890
+ declare function IndexSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexSegment;
891
+ declare function IndexSegmentToJSON(json: any): IndexSegment;
892
+ declare function IndexSegmentToJSONTyped(value?: IndexSegment | null, ignoreDiscriminator?: boolean): any;
893
+ //#endregion
894
+ //#region src/models/ItemSegment.d.ts
895
+ /**
896
+ * Sensitive Data Protection API
897
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
898
+ *
899
+ * The version of the OpenAPI document: 0.1.0
900
+ *
901
+ *
902
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
903
+ * https://openapi-generator.tech
904
+ * Do not edit the class manually.
905
+ */
906
+ /**
907
+ * An item of the DICOM sequence before it, from 1.
908
+ * @export
909
+ * @interface ItemSegment
910
+ */
911
+ interface ItemSegment {
912
+ /**
913
+ *
914
+ * @type {string}
915
+ * @memberof ItemSegment
916
+ */
917
+ type: ItemSegmentTypeEnum;
918
+ /**
919
+ *
920
+ * @type {number}
921
+ * @memberof ItemSegment
922
+ */
923
+ number: number;
924
+ }
925
+ /**
926
+ * @export
927
+ */
928
+ declare const ItemSegmentTypeEnum: {
929
+ readonly item: "item";
930
+ };
931
+ type ItemSegmentTypeEnum = typeof ItemSegmentTypeEnum[keyof typeof ItemSegmentTypeEnum];
932
+ /**
933
+ * Check if a given object implements the ItemSegment interface.
934
+ */
935
+ declare function instanceOfItemSegment(value: object): value is ItemSegment;
936
+ declare function ItemSegmentFromJSON(json: any): ItemSegment;
937
+ declare function ItemSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemSegment;
938
+ declare function ItemSegmentToJSON(json: any): ItemSegment;
939
+ declare function ItemSegmentToJSONTyped(value?: ItemSegment | null, ignoreDiscriminator?: boolean): any;
940
+ //#endregion
941
+ //#region src/models/KeySegment.d.ts
942
+ /**
943
+ * Sensitive Data Protection API
944
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
945
+ *
946
+ * The version of the OpenAPI document: 0.1.0
947
+ *
948
+ *
949
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
950
+ * https://openapi-generator.tech
951
+ * Do not edit the class manually.
952
+ */
953
+ /**
954
+ * A JSON object's key: a step towards a value, as in a JSON Pointer.
955
+ * @export
956
+ * @interface KeySegment
957
+ */
958
+ interface KeySegment {
959
+ /**
960
+ *
961
+ * @type {string}
962
+ * @memberof KeySegment
963
+ */
964
+ type: KeySegmentTypeEnum;
965
+ /**
966
+ *
967
+ * @type {string}
968
+ * @memberof KeySegment
969
+ */
970
+ name: string;
971
+ }
972
+ /**
973
+ * @export
974
+ */
975
+ declare const KeySegmentTypeEnum: {
976
+ readonly key: "key";
977
+ };
978
+ type KeySegmentTypeEnum = typeof KeySegmentTypeEnum[keyof typeof KeySegmentTypeEnum];
979
+ /**
980
+ * Check if a given object implements the KeySegment interface.
981
+ */
982
+ declare function instanceOfKeySegment(value: object): value is KeySegment;
983
+ declare function KeySegmentFromJSON(json: any): KeySegment;
984
+ declare function KeySegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeySegment;
985
+ declare function KeySegmentToJSON(json: any): KeySegment;
986
+ declare function KeySegmentToJSONTyped(value?: KeySegment | null, ignoreDiscriminator?: boolean): any;
987
+ //#endregion
988
+ //#region src/models/LineSegment.d.ts
989
+ /**
990
+ * Sensitive Data Protection API
991
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
992
+ *
993
+ * The version of the OpenAPI document: 0.1.0
994
+ *
995
+ *
996
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
997
+ * https://openapi-generator.tech
998
+ * Do not edit the class manually.
999
+ */
1000
+ /**
1001
+ * Where a value starts in a text file, from 1, as an editor shows it; in an
1002
+ * image, the line read (in reading order) and the character in it.
1003
+ * @export
1004
+ * @interface LineSegment
1005
+ */
1006
+ interface LineSegment {
1007
+ /**
1008
+ *
1009
+ * @type {string}
1010
+ * @memberof LineSegment
1011
+ */
1012
+ type: LineSegmentTypeEnum;
1013
+ /**
1014
+ *
1015
+ * @type {number}
1016
+ * @memberof LineSegment
1017
+ */
1018
+ line: number;
1019
+ /**
1020
+ *
1021
+ * @type {number}
1022
+ * @memberof LineSegment
1023
+ */
1024
+ column: number;
1025
+ }
1026
+ /**
1027
+ * @export
1028
+ */
1029
+ declare const LineSegmentTypeEnum: {
1030
+ readonly line: "line";
1031
+ };
1032
+ type LineSegmentTypeEnum = typeof LineSegmentTypeEnum[keyof typeof LineSegmentTypeEnum];
1033
+ /**
1034
+ * Check if a given object implements the LineSegment interface.
1035
+ */
1036
+ declare function instanceOfLineSegment(value: object): value is LineSegment;
1037
+ declare function LineSegmentFromJSON(json: any): LineSegment;
1038
+ declare function LineSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): LineSegment;
1039
+ declare function LineSegmentToJSON(json: any): LineSegment;
1040
+ declare function LineSegmentToJSONTyped(value?: LineSegment | null, ignoreDiscriminator?: boolean): any;
1041
+ //#endregion
1042
+ //#region src/models/ParagraphKind.d.ts
1043
+ /**
1044
+ * Sensitive Data Protection API
1045
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1046
+ *
1047
+ * The version of the OpenAPI document: 0.1.0
1048
+ *
1049
+ *
1050
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1051
+ * https://openapi-generator.tech
1052
+ * Do not edit the class manually.
1053
+ */
1054
+ /**
1055
+ * @type ParagraphKind
1056
+ * What a paragraph's text is when it is not its own text.
1057
+ * @export
1058
+ */
1059
+ type ParagraphKind = string;
1060
+ declare function ParagraphKindFromJSON(json: any): ParagraphKind;
1061
+ declare function ParagraphKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): ParagraphKind;
1062
+ declare function ParagraphKindToJSON(json: any): any;
1063
+ declare function ParagraphKindToJSONTyped(value?: ParagraphKind | null, ignoreDiscriminator?: boolean): any;
1064
+ //#endregion
1065
+ //#region src/models/ParagraphSegment.d.ts
1066
+ /**
1067
+ * A paragraph (`w:p`, `a:p`), numbered from 1 in what holds it (the part, a
1068
+ * shape, a cell, a comment, a footnote). No `kind` for its own text.
1069
+ * @export
1070
+ * @interface ParagraphSegment
1071
+ */
1072
+ interface ParagraphSegment {
1073
+ /**
1074
+ *
1075
+ * @type {string}
1076
+ * @memberof ParagraphSegment
1077
+ */
1078
+ type: ParagraphSegmentTypeEnum;
1079
+ /**
1080
+ *
1081
+ * @type {number}
1082
+ * @memberof ParagraphSegment
1083
+ */
1084
+ number: number;
1085
+ /**
1086
+ *
1087
+ * @type {ParagraphKind}
1088
+ * @memberof ParagraphSegment
1089
+ */
1090
+ kind?: ParagraphKind | null;
1091
+ }
1092
+ /**
1093
+ * @export
1094
+ */
1095
+ declare const ParagraphSegmentTypeEnum: {
1096
+ readonly paragraph: "paragraph";
1097
+ };
1098
+ type ParagraphSegmentTypeEnum = typeof ParagraphSegmentTypeEnum[keyof typeof ParagraphSegmentTypeEnum];
1099
+ /**
1100
+ * Check if a given object implements the ParagraphSegment interface.
1101
+ */
1102
+ declare function instanceOfParagraphSegment(value: object): value is ParagraphSegment;
1103
+ declare function ParagraphSegmentFromJSON(json: any): ParagraphSegment;
1104
+ declare function ParagraphSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ParagraphSegment;
1105
+ declare function ParagraphSegmentToJSON(json: any): ParagraphSegment;
1106
+ declare function ParagraphSegmentToJSONTyped(value?: ParagraphSegment | null, ignoreDiscriminator?: boolean): any;
1107
+ //#endregion
1108
+ //#region src/models/Kind.d.ts
1109
+ /**
1110
+ * Sensitive Data Protection API
1111
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1112
+ *
1113
+ * The version of the OpenAPI document: 0.1.0
1114
+ *
1115
+ *
1116
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1117
+ * https://openapi-generator.tech
1118
+ * Do not edit the class manually.
1119
+ */
1120
+ /**
1121
+ * @type Kind
1122
+ * What the text is in an Office file, named after its ECMA-376 element or property.
1123
+ * @export
1124
+ */
1125
+ type Kind = string;
1126
+ declare function KindFromJSON(json: any): Kind;
1127
+ declare function KindFromJSONTyped(json: any, ignoreDiscriminator: boolean): Kind;
1128
+ declare function KindToJSON(json: any): any;
1129
+ declare function KindToJSONTyped(value?: Kind | null, ignoreDiscriminator?: boolean): any;
1130
+ //#endregion
1131
+ //#region src/models/PartSegment.d.ts
1132
+ /**
1133
+ * Any other file in an Office zip, e.g. `word/document.xml`, `docProps/core.xml`.
1134
+ * `kind` until finer segments (paragraphs, properties) say where its text is.
1135
+ * @export
1136
+ * @interface PartSegment
1137
+ */
1138
+ interface PartSegment {
1139
+ /**
1140
+ *
1141
+ * @type {string}
1142
+ * @memberof PartSegment
1143
+ */
1144
+ type: PartSegmentTypeEnum;
1145
+ /**
1146
+ *
1147
+ * @type {string}
1148
+ * @memberof PartSegment
1149
+ */
1150
+ part: string;
1151
+ /**
1152
+ *
1153
+ * @type {Kind}
1154
+ * @memberof PartSegment
1155
+ */
1156
+ kind?: Kind | null;
1157
+ }
1158
+ /**
1159
+ * @export
1160
+ */
1161
+ declare const PartSegmentTypeEnum: {
1162
+ readonly part: "part";
1163
+ };
1164
+ type PartSegmentTypeEnum = typeof PartSegmentTypeEnum[keyof typeof PartSegmentTypeEnum];
1165
+ /**
1166
+ * Check if a given object implements the PartSegment interface.
1167
+ */
1168
+ declare function instanceOfPartSegment(value: object): value is PartSegment;
1169
+ declare function PartSegmentFromJSON(json: any): PartSegment;
1170
+ declare function PartSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PartSegment;
1171
+ declare function PartSegmentToJSON(json: any): PartSegment;
1172
+ declare function PartSegmentToJSONTyped(value?: PartSegment | null, ignoreDiscriminator?: boolean): any;
1173
+ //#endregion
1174
+ //#region src/models/PropertySegment.d.ts
1175
+ /**
1176
+ * Sensitive Data Protection API
1177
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1178
+ *
1179
+ * The version of the OpenAPI document: 0.1.0
1180
+ *
1181
+ *
1182
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1183
+ * https://openapi-generator.tech
1184
+ * Do not edit the class manually.
1185
+ */
1186
+ /**
1187
+ * A document property: a core one by its element (`creator`, `title`,
1188
+ * `lastModifiedBy`), an extended one likewise (`Company`, `Manager`), a custom
1189
+ * one by its name.
1190
+ * @export
1191
+ * @interface PropertySegment
1192
+ */
1193
+ interface PropertySegment {
1194
+ /**
1195
+ *
1196
+ * @type {string}
1197
+ * @memberof PropertySegment
1198
+ */
1199
+ type: PropertySegmentTypeEnum;
1200
+ /**
1201
+ *
1202
+ * @type {string}
1203
+ * @memberof PropertySegment
1204
+ */
1205
+ name: string;
1206
+ }
1207
+ /**
1208
+ * @export
1209
+ */
1210
+ declare const PropertySegmentTypeEnum: {
1211
+ readonly property: "property";
1212
+ };
1213
+ type PropertySegmentTypeEnum = typeof PropertySegmentTypeEnum[keyof typeof PropertySegmentTypeEnum];
1214
+ /**
1215
+ * Check if a given object implements the PropertySegment interface.
1216
+ */
1217
+ declare function instanceOfPropertySegment(value: object): value is PropertySegment;
1218
+ declare function PropertySegmentFromJSON(json: any): PropertySegment;
1219
+ declare function PropertySegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PropertySegment;
1220
+ declare function PropertySegmentToJSON(json: any): PropertySegment;
1221
+ declare function PropertySegmentToJSONTyped(value?: PropertySegment | null, ignoreDiscriminator?: boolean): any;
1222
+ //#endregion
1223
+ //#region src/models/RangeKind.d.ts
1224
+ /**
1225
+ * Sensitive Data Protection API
1226
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1227
+ *
1228
+ * The version of the OpenAPI document: 0.1.0
1229
+ *
1230
+ *
1231
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1232
+ * https://openapi-generator.tech
1233
+ * Do not edit the class manually.
1234
+ */
1235
+ /**
1236
+ * A data validation's prompt, error message or list of values.
1237
+ * @export
1238
+ */
1239
+ declare const RangeKind: {
1240
+ readonly data_validation: "data_validation";
1241
+ };
1242
+ type RangeKind = typeof RangeKind[keyof typeof RangeKind];
1243
+ declare function instanceOfRangeKind(value: any): boolean;
1244
+ declare function RangeKindFromJSON(json: any): RangeKind;
1245
+ declare function RangeKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): RangeKind;
1246
+ declare function RangeKindToJSON(value?: RangeKind | null): any;
1247
+ declare function RangeKindToJSONTyped(value: any, ignoreDiscriminator: boolean): RangeKind;
1248
+ //#endregion
1249
+ //#region src/models/RangeSegment.d.ts
1250
+ /**
1251
+ * Cells, in A1 (`A2:A100`): a data validation's.
1252
+ * @export
1253
+ * @interface RangeSegment
1254
+ */
1255
+ interface RangeSegment {
1256
+ /**
1257
+ *
1258
+ * @type {string}
1259
+ * @memberof RangeSegment
1260
+ */
1261
+ type: RangeSegmentTypeEnum;
1262
+ /**
1263
+ *
1264
+ * @type {string}
1265
+ * @memberof RangeSegment
1266
+ */
1267
+ ref: string;
1268
+ /**
1269
+ *
1270
+ * @type {RangeKind}
1271
+ * @memberof RangeSegment
1272
+ */
1273
+ kind: RangeKind;
1274
+ }
1275
+ /**
1276
+ * @export
1277
+ */
1278
+ declare const RangeSegmentTypeEnum: {
1279
+ readonly range: "range";
1280
+ };
1281
+ type RangeSegmentTypeEnum = typeof RangeSegmentTypeEnum[keyof typeof RangeSegmentTypeEnum];
1282
+ /**
1283
+ * Check if a given object implements the RangeSegment interface.
1284
+ */
1285
+ declare function instanceOfRangeSegment(value: object): value is RangeSegment;
1286
+ declare function RangeSegmentFromJSON(json: any): RangeSegment;
1287
+ declare function RangeSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): RangeSegment;
1288
+ declare function RangeSegmentToJSON(json: any): RangeSegment;
1289
+ declare function RangeSegmentToJSONTyped(value?: RangeSegment | null, ignoreDiscriminator?: boolean): any;
1290
+ //#endregion
1291
+ //#region src/models/RegionSegment.d.ts
1292
+ /**
1293
+ * Sensitive Data Protection API
1294
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1295
+ *
1296
+ * The version of the OpenAPI document: 0.1.0
1297
+ *
1298
+ *
1299
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1300
+ * https://openapi-generator.tech
1301
+ * Do not edit the class manually.
1302
+ */
1303
+ /**
1304
+ * A box on an image, in its upright pixels, padded as painted: where a value
1305
+ * found in it is. A value over several boxes has a path for each.
1306
+ * @export
1307
+ * @interface RegionSegment
1308
+ */
1309
+ interface RegionSegment {
1310
+ /**
1311
+ *
1312
+ * @type {string}
1313
+ * @memberof RegionSegment
1314
+ */
1315
+ type: RegionSegmentTypeEnum;
1316
+ /**
1317
+ *
1318
+ * @type {number}
1319
+ * @memberof RegionSegment
1320
+ */
1321
+ x: number;
1322
+ /**
1323
+ *
1324
+ * @type {number}
1325
+ * @memberof RegionSegment
1326
+ */
1327
+ y: number;
1328
+ /**
1329
+ *
1330
+ * @type {number}
1331
+ * @memberof RegionSegment
1332
+ */
1333
+ w: number;
1334
+ /**
1335
+ *
1336
+ * @type {number}
1337
+ * @memberof RegionSegment
1338
+ */
1339
+ h: number;
1340
+ }
1341
+ /**
1342
+ * @export
1343
+ */
1344
+ declare const RegionSegmentTypeEnum: {
1345
+ readonly region: "region";
1346
+ };
1347
+ type RegionSegmentTypeEnum = typeof RegionSegmentTypeEnum[keyof typeof RegionSegmentTypeEnum];
1348
+ /**
1349
+ * Check if a given object implements the RegionSegment interface.
1350
+ */
1351
+ declare function instanceOfRegionSegment(value: object): value is RegionSegment;
1352
+ declare function RegionSegmentFromJSON(json: any): RegionSegment;
1353
+ declare function RegionSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegionSegment;
1354
+ declare function RegionSegmentToJSON(json: any): RegionSegment;
1355
+ declare function RegionSegmentToJSONTyped(value?: RegionSegment | null, ignoreDiscriminator?: boolean): any;
1356
+ //#endregion
1357
+ //#region src/models/SegmentSegment.d.ts
1358
+ /**
1359
+ * Sensitive Data Protection API
1360
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1361
+ *
1362
+ * The version of the OpenAPI document: 0.1.0
1363
+ *
1364
+ *
1365
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1366
+ * https://openapi-generator.tech
1367
+ * Do not edit the class manually.
1368
+ */
1369
+ /**
1370
+ * An HL7 v2 segment (`PID`).
1371
+ * @export
1372
+ * @interface SegmentSegment
1373
+ */
1374
+ interface SegmentSegment {
1375
+ /**
1376
+ *
1377
+ * @type {string}
1378
+ * @memberof SegmentSegment
1379
+ */
1380
+ type: SegmentSegmentTypeEnum;
1381
+ /**
1382
+ *
1383
+ * @type {string}
1384
+ * @memberof SegmentSegment
1385
+ */
1386
+ name: string;
1387
+ /**
1388
+ * Among the segments with this name, from 0.
1389
+ * @type {number}
1390
+ * @memberof SegmentSegment
1391
+ */
1392
+ index: number;
1393
+ }
1394
+ /**
1395
+ * @export
1396
+ */
1397
+ declare const SegmentSegmentTypeEnum: {
1398
+ readonly segment: "segment";
1399
+ };
1400
+ type SegmentSegmentTypeEnum = typeof SegmentSegmentTypeEnum[keyof typeof SegmentSegmentTypeEnum];
1401
+ /**
1402
+ * Check if a given object implements the SegmentSegment interface.
1403
+ */
1404
+ declare function instanceOfSegmentSegment(value: object): value is SegmentSegment;
1405
+ declare function SegmentSegmentFromJSON(json: any): SegmentSegment;
1406
+ declare function SegmentSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SegmentSegment;
1407
+ declare function SegmentSegmentToJSON(json: any): SegmentSegment;
1408
+ declare function SegmentSegmentToJSONTyped(value?: SegmentSegment | null, ignoreDiscriminator?: boolean): any;
1409
+ //#endregion
1410
+ //#region src/models/ShapeKind.d.ts
1411
+ /**
1412
+ * Sensitive Data Protection API
1413
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1414
+ *
1415
+ * The version of the OpenAPI document: 0.1.0
1416
+ *
1417
+ *
1418
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1419
+ * https://openapi-generator.tech
1420
+ * Do not edit the class manually.
1421
+ */
1422
+ /**
1423
+ * @type ShapeKind
1424
+ * What a shape's text is when it is not its own text.
1425
+ * @export
1426
+ */
1427
+ type ShapeKind = string;
1428
+ declare function ShapeKindFromJSON(json: any): ShapeKind;
1429
+ declare function ShapeKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShapeKind;
1430
+ declare function ShapeKindToJSON(json: any): any;
1431
+ declare function ShapeKindToJSONTyped(value?: ShapeKind | null, ignoreDiscriminator?: boolean): any;
1432
+ //#endregion
1433
+ //#region src/models/ShapeSegment.d.ts
1434
+ /**
1435
+ * A shape: a text box, picture, table, group; its `cNvPr` / `docPr` id and name.
1436
+ * No `kind` for its own text.
1437
+ * @export
1438
+ * @interface ShapeSegment
1439
+ */
1440
+ interface ShapeSegment {
1441
+ /**
1442
+ *
1443
+ * @type {string}
1444
+ * @memberof ShapeSegment
1445
+ */
1446
+ type: ShapeSegmentTypeEnum;
1447
+ /**
1448
+ *
1449
+ * @type {number}
1450
+ * @memberof ShapeSegment
1451
+ */
1452
+ id: number;
1453
+ /**
1454
+ *
1455
+ * @type {string}
1456
+ * @memberof ShapeSegment
1457
+ */
1458
+ name: string;
1459
+ /**
1460
+ *
1461
+ * @type {ShapeKind}
1462
+ * @memberof ShapeSegment
1463
+ */
1464
+ kind?: ShapeKind | null;
1465
+ }
1466
+ /**
1467
+ * @export
1468
+ */
1469
+ declare const ShapeSegmentTypeEnum: {
1470
+ readonly shape: "shape";
1471
+ };
1472
+ type ShapeSegmentTypeEnum = typeof ShapeSegmentTypeEnum[keyof typeof ShapeSegmentTypeEnum];
1473
+ /**
1474
+ * Check if a given object implements the ShapeSegment interface.
1475
+ */
1476
+ declare function instanceOfShapeSegment(value: object): value is ShapeSegment;
1477
+ declare function ShapeSegmentFromJSON(json: any): ShapeSegment;
1478
+ declare function ShapeSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShapeSegment;
1479
+ declare function ShapeSegmentToJSON(json: any): ShapeSegment;
1480
+ declare function ShapeSegmentToJSONTyped(value?: ShapeSegment | null, ignoreDiscriminator?: boolean): any;
1481
+ //#endregion
1482
+ //#region src/models/SheetSegment.d.ts
1483
+ /**
1484
+ * Sensitive Data Protection API
1485
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1486
+ *
1487
+ * The version of the OpenAPI document: 0.1.0
1488
+ *
1489
+ *
1490
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1491
+ * https://openapi-generator.tech
1492
+ * Do not edit the class manually.
1493
+ */
1494
+ /**
1495
+ * A worksheet: its name on the tab, and its part.
1496
+ * @export
1497
+ * @interface SheetSegment
1498
+ */
1499
+ interface SheetSegment {
1500
+ /**
1501
+ *
1502
+ * @type {string}
1503
+ * @memberof SheetSegment
1504
+ */
1505
+ type: SheetSegmentTypeEnum;
1506
+ /**
1507
+ *
1508
+ * @type {string}
1509
+ * @memberof SheetSegment
1510
+ */
1511
+ name: string;
1512
+ /**
1513
+ *
1514
+ * @type {string}
1515
+ * @memberof SheetSegment
1516
+ */
1517
+ part: string;
1518
+ }
1519
+ /**
1520
+ * @export
1521
+ */
1522
+ declare const SheetSegmentTypeEnum: {
1523
+ readonly sheet: "sheet";
1524
+ };
1525
+ type SheetSegmentTypeEnum = typeof SheetSegmentTypeEnum[keyof typeof SheetSegmentTypeEnum];
1526
+ /**
1527
+ * Check if a given object implements the SheetSegment interface.
1528
+ */
1529
+ declare function instanceOfSheetSegment(value: object): value is SheetSegment;
1530
+ declare function SheetSegmentFromJSON(json: any): SheetSegment;
1531
+ declare function SheetSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SheetSegment;
1532
+ declare function SheetSegmentToJSON(json: any): SheetSegment;
1533
+ declare function SheetSegmentToJSONTyped(value?: SheetSegment | null, ignoreDiscriminator?: boolean): any;
1534
+ //#endregion
1535
+ //#region src/models/SlideSegment.d.ts
1536
+ /**
1537
+ * A slide, numbered as PowerPoint shows it, and its part. `kind` until shapes
1538
+ * hold all of a slide's text.
1539
+ * @export
1540
+ * @interface SlideSegment
1541
+ */
1542
+ interface SlideSegment {
1543
+ /**
1544
+ *
1545
+ * @type {string}
1546
+ * @memberof SlideSegment
1547
+ */
1548
+ type: SlideSegmentTypeEnum;
1549
+ /**
1550
+ *
1551
+ * @type {number}
1552
+ * @memberof SlideSegment
1553
+ */
1554
+ number: number;
1555
+ /**
1556
+ *
1557
+ * @type {string}
1558
+ * @memberof SlideSegment
1559
+ */
1560
+ part: string;
1561
+ /**
1562
+ *
1563
+ * @type {Kind}
1564
+ * @memberof SlideSegment
1565
+ */
1566
+ kind?: Kind | null;
1567
+ }
1568
+ /**
1569
+ * @export
1570
+ */
1571
+ declare const SlideSegmentTypeEnum: {
1572
+ readonly slide: "slide";
1573
+ };
1574
+ type SlideSegmentTypeEnum = typeof SlideSegmentTypeEnum[keyof typeof SlideSegmentTypeEnum];
1575
+ /**
1576
+ * Check if a given object implements the SlideSegment interface.
1577
+ */
1578
+ declare function instanceOfSlideSegment(value: object): value is SlideSegment;
1579
+ declare function SlideSegmentFromJSON(json: any): SlideSegment;
1580
+ declare function SlideSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SlideSegment;
1581
+ declare function SlideSegmentToJSON(json: any): SlideSegment;
1582
+ declare function SlideSegmentToJSONTyped(value?: SlideSegment | null, ignoreDiscriminator?: boolean): any;
1583
+ //#endregion
1584
+ //#region src/models/SpeakerNotesSegment.d.ts
1585
+ /**
1586
+ * A slide's speaker notes (`speaker_notes`): the slide's number, and the notes' part. `kind` until
1587
+ * shapes hold all of their text.
1588
+ * @export
1589
+ * @interface SpeakerNotesSegment
1590
+ */
1591
+ interface SpeakerNotesSegment {
1592
+ /**
1593
+ *
1594
+ * @type {string}
1595
+ * @memberof SpeakerNotesSegment
1596
+ */
1597
+ type: SpeakerNotesSegmentTypeEnum;
1598
+ /**
1599
+ *
1600
+ * @type {number}
1601
+ * @memberof SpeakerNotesSegment
1602
+ */
1603
+ slide: number;
1604
+ /**
1605
+ *
1606
+ * @type {string}
1607
+ * @memberof SpeakerNotesSegment
1608
+ */
1609
+ part: string;
1610
+ /**
1611
+ *
1612
+ * @type {Kind}
1613
+ * @memberof SpeakerNotesSegment
1614
+ */
1615
+ kind?: Kind | null;
1616
+ }
1617
+ /**
1618
+ * @export
1619
+ */
1620
+ declare const SpeakerNotesSegmentTypeEnum: {
1621
+ readonly speaker_notes: "speaker_notes";
1622
+ };
1623
+ type SpeakerNotesSegmentTypeEnum = typeof SpeakerNotesSegmentTypeEnum[keyof typeof SpeakerNotesSegmentTypeEnum];
1624
+ /**
1625
+ * Check if a given object implements the SpeakerNotesSegment interface.
1626
+ */
1627
+ declare function instanceOfSpeakerNotesSegment(value: object): value is SpeakerNotesSegment;
1628
+ declare function SpeakerNotesSegmentFromJSON(json: any): SpeakerNotesSegment;
1629
+ declare function SpeakerNotesSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): SpeakerNotesSegment;
1630
+ declare function SpeakerNotesSegmentToJSON(json: any): SpeakerNotesSegment;
1631
+ declare function SpeakerNotesSegmentToJSONTyped(value?: SpeakerNotesSegment | null, ignoreDiscriminator?: boolean): any;
1632
+ //#endregion
1633
+ //#region src/models/TableSegment.d.ts
1634
+ /**
1635
+ * Sensitive Data Protection API
1636
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1637
+ *
1638
+ * The version of the OpenAPI document: 0.1.0
1639
+ *
1640
+ *
1641
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1642
+ * https://openapi-generator.tech
1643
+ * Do not edit the class manually.
1644
+ */
1645
+ /**
1646
+ * A table in a Word document or on a slide, numbered from 1 in what holds it.
1647
+ * @export
1648
+ * @interface TableSegment
1649
+ */
1650
+ interface TableSegment {
1651
+ /**
1652
+ *
1653
+ * @type {string}
1654
+ * @memberof TableSegment
1655
+ */
1656
+ type: TableSegmentTypeEnum;
1657
+ /**
1658
+ *
1659
+ * @type {number}
1660
+ * @memberof TableSegment
1661
+ */
1662
+ number: number;
1663
+ }
1664
+ /**
1665
+ * @export
1666
+ */
1667
+ declare const TableSegmentTypeEnum: {
1668
+ readonly table: "table";
1669
+ };
1670
+ type TableSegmentTypeEnum = typeof TableSegmentTypeEnum[keyof typeof TableSegmentTypeEnum];
1671
+ /**
1672
+ * Check if a given object implements the TableSegment interface.
1673
+ */
1674
+ declare function instanceOfTableSegment(value: object): value is TableSegment;
1675
+ declare function TableSegmentFromJSON(json: any): TableSegment;
1676
+ declare function TableSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TableSegment;
1677
+ declare function TableSegmentToJSON(json: any): TableSegment;
1678
+ declare function TableSegmentToJSONTyped(value?: TableSegment | null, ignoreDiscriminator?: boolean): any;
1679
+ //#endregion
1680
+ //#region src/models/TagSegment.d.ts
1681
+ /**
1682
+ * Sensitive Data Protection API
1683
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1684
+ *
1685
+ * The version of the OpenAPI document: 0.1.0
1686
+ *
1687
+ *
1688
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1689
+ * https://openapi-generator.tech
1690
+ * Do not edit the class manually.
1691
+ */
1692
+ /**
1693
+ * A DICOM attribute: its tag, as four hex digits each, and its keyword
1694
+ * (`PatientName`) when the standard names it; none for a private one.
1695
+ * @export
1696
+ * @interface TagSegment
1697
+ */
1698
+ interface TagSegment {
1699
+ /**
1700
+ *
1701
+ * @type {string}
1702
+ * @memberof TagSegment
1703
+ */
1704
+ type: TagSegmentTypeEnum;
1705
+ /**
1706
+ *
1707
+ * @type {string}
1708
+ * @memberof TagSegment
1709
+ */
1710
+ group: string;
1711
+ /**
1712
+ *
1713
+ * @type {string}
1714
+ * @memberof TagSegment
1715
+ */
1716
+ element: string;
1717
+ /**
1718
+ *
1719
+ * @type {string}
1720
+ * @memberof TagSegment
1721
+ */
1722
+ keyword?: string | null;
1723
+ }
1724
+ /**
1725
+ * @export
1726
+ */
1727
+ declare const TagSegmentTypeEnum: {
1728
+ readonly tag: "tag";
1729
+ };
1730
+ type TagSegmentTypeEnum = typeof TagSegmentTypeEnum[keyof typeof TagSegmentTypeEnum];
1731
+ /**
1732
+ * Check if a given object implements the TagSegment interface.
1733
+ */
1734
+ declare function instanceOfTagSegment(value: object): value is TagSegment;
1735
+ declare function TagSegmentFromJSON(json: any): TagSegment;
1736
+ declare function TagSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TagSegment;
1737
+ declare function TagSegmentToJSON(json: any): TagSegment;
1738
+ declare function TagSegmentToJSONTyped(value?: TagSegment | null, ignoreDiscriminator?: boolean): any;
1739
+ //#endregion
1740
+ //#region src/models/TextRange.d.ts
1741
+ /**
1742
+ * Sensitive Data Protection API
1743
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1744
+ *
1745
+ * The version of the OpenAPI document: 0.1.0
1746
+ *
1747
+ *
1748
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1749
+ * https://openapi-generator.tech
1750
+ * Do not edit the class manually.
1751
+ */
1752
+ /**
1753
+ * A character range within a text, carrying the substring it covers.
1754
+ * @export
1755
+ * @interface TextRange
1756
+ */
1757
+ interface TextRange {
1758
+ /**
1759
+ * Start offset (inclusive), in Unicode code points (in JavaScript, index `[...text]`: UTF-16 counts an emoji twice).
1760
+ * @type {number}
1761
+ * @memberof TextRange
1762
+ */
1763
+ start: number;
1764
+ /**
1765
+ * End offset (exclusive), in Unicode code points.
1766
+ * @type {number}
1767
+ * @memberof TextRange
1768
+ */
1769
+ end: number;
1770
+ /**
1771
+ * The substring at [start, end).
1772
+ * @type {string}
1773
+ * @memberof TextRange
1774
+ */
1775
+ value: string;
1776
+ }
1777
+ /**
1778
+ * Check if a given object implements the TextRange interface.
1779
+ */
1780
+ declare function instanceOfTextRange(value: object): value is TextRange;
1781
+ declare function TextRangeFromJSON(json: any): TextRange;
1782
+ declare function TextRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextRange;
1783
+ declare function TextRangeToJSON(json: any): TextRange;
1784
+ declare function TextRangeToJSONTyped(value?: TextRange | null, ignoreDiscriminator?: boolean): any;
1785
+ //#endregion
1786
+ //#region src/models/TextSegment.d.ts
1787
+ /**
1788
+ * The last segment of a found value's path: its piece in the object the path
1789
+ * leads to, in the file as it was and as it is now. Offsets from the start of
1790
+ * the cell (xlsx, CSV, TSV), the paragraph (docx, pptx), the line (other text
1791
+ * files) or the JSON value, as `/anonymize` counts them.
1792
+ * @export
1793
+ * @interface TextSegment
1794
+ */
1795
+ interface TextSegment {
1796
+ /**
1797
+ *
1798
+ * @type {string}
1799
+ * @memberof TextSegment
1800
+ */
1801
+ type: TextSegmentTypeEnum;
1802
+ /**
1803
+ *
1804
+ * @type {TextRange}
1805
+ * @memberof TextSegment
1806
+ */
1807
+ input: TextRange;
1808
+ /**
1809
+ *
1810
+ * @type {TextRange}
1811
+ * @memberof TextSegment
1812
+ */
1813
+ output: TextRange;
1814
+ }
1815
+ /**
1816
+ * @export
1817
+ */
1818
+ declare const TextSegmentTypeEnum: {
1819
+ readonly text: "text";
1820
+ };
1821
+ type TextSegmentTypeEnum = typeof TextSegmentTypeEnum[keyof typeof TextSegmentTypeEnum];
1822
+ /**
1823
+ * Check if a given object implements the TextSegment interface.
1824
+ */
1825
+ declare function instanceOfTextSegment(value: object): value is TextSegment;
1826
+ declare function TextSegmentFromJSON(json: any): TextSegment;
1827
+ declare function TextSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextSegment;
1828
+ declare function TextSegmentToJSON(json: any): TextSegment;
1829
+ declare function TextSegmentToJSONTyped(value?: TextSegment | null, ignoreDiscriminator?: boolean): any;
1830
+ //#endregion
1831
+ //#region src/models/PathSegment.d.ts
1832
+ /**
1833
+ * @type PathSegment
1834
+ * One step of where a result is, outermost first: a container (a worksheet, a
1835
+ * slide, another file in an Office zip), the shapes it is in, where the text
1836
+ * is, then `text`: the characters found there, before and after. `kind`, on
1837
+ * the segment before `text` only, says what the text is there.
1838
+ *
1839
+ * Paths grow: later versions add segment types inside these (paragraphs,
1840
+ * tables, comments, properties), so the same text may get a longer path.
1841
+ * Read `text` and `kind` from the end and find segments by `type`; do not
1842
+ * compare whole paths.
1843
+ * @export
1844
+ */
1845
+ type PathSegment = {
1846
+ type: 'attribute';
1847
+ } & AttributeSegment | {
1848
+ type: 'cell';
1849
+ } & CellSegment | {
1850
+ type: 'cell_note';
1851
+ } & CellNoteSegment | {
1852
+ type: 'comment';
1853
+ } & CommentSegment | {
1854
+ type: 'component';
1855
+ } & ComponentSegment | {
1856
+ type: 'element';
1857
+ } & ElementSegment | {
1858
+ type: 'endnote';
1859
+ } & EndnoteSegment | {
1860
+ type: 'field';
1861
+ } & FieldSegment | {
1862
+ type: 'footnote';
1863
+ } & FootnoteSegment | {
1864
+ type: 'frame';
1865
+ } & FrameSegment | {
1866
+ type: 'header_footer';
1867
+ } & HeaderFooterSegment | {
1868
+ type: 'index';
1869
+ } & IndexSegment | {
1870
+ type: 'item';
1871
+ } & ItemSegment | {
1872
+ type: 'key';
1873
+ } & KeySegment | {
1874
+ type: 'line';
1875
+ } & LineSegment | {
1876
+ type: 'paragraph';
1877
+ } & ParagraphSegment | {
1878
+ type: 'part';
1879
+ } & PartSegment | {
1880
+ type: 'property';
1881
+ } & PropertySegment | {
1882
+ type: 'range';
1883
+ } & RangeSegment | {
1884
+ type: 'region';
1885
+ } & RegionSegment | {
1886
+ type: 'segment';
1887
+ } & SegmentSegment | {
1888
+ type: 'shape';
1889
+ } & ShapeSegment | {
1890
+ type: 'sheet';
1891
+ } & SheetSegment | {
1892
+ type: 'slide';
1893
+ } & SlideSegment | {
1894
+ type: 'speaker_notes';
1895
+ } & SpeakerNotesSegment | {
1896
+ type: 'table';
1897
+ } & TableSegment | {
1898
+ type: 'tag';
1899
+ } & TagSegment | {
1900
+ type: 'text';
1901
+ } & TextSegment;
1902
+ declare function PathSegmentFromJSON(json: any): PathSegment;
1903
+ declare function PathSegmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathSegment;
1904
+ declare function PathSegmentToJSON(json: any): any;
1905
+ declare function PathSegmentToJSONTyped(value?: PathSegment | null, ignoreDiscriminator?: boolean): any;
1906
+ //#endregion
1907
+ //#region src/models/FileAttributeResult.d.ts
1908
+ /**
1909
+ * A DICOM attribute the confidentiality profile (PS3.15 Annex E) acted on, or
1910
+ * content kept unread.
1911
+ * @export
1912
+ * @interface FileAttributeResult
1913
+ */
1914
+ interface FileAttributeResult {
1915
+ /**
1916
+ *
1917
+ * @type {string}
1918
+ * @memberof FileAttributeResult
1919
+ */
1920
+ type: FileAttributeResultTypeEnum;
1921
+ /**
1922
+ * As a model result's `id`; only in the `done` list.
1923
+ * @type {number}
1924
+ * @memberof FileAttributeResult
1925
+ */
1926
+ id: number;
1927
+ /**
1928
+ * What was done: `remove`, `empty` (kept without a value), `dummy` (a
1929
+ * placeholder value), `uid` (a new UID, the same for every copy of the
1930
+ * old one), `clean` (a removed value taken out of kept text), or
1931
+ * `unscanned`: kept as it is, not read (pixel data without an image
1932
+ * model, an encapsulated document).
1933
+ * @type {string}
1934
+ * @memberof FileAttributeResult
1935
+ */
1936
+ rule: string;
1937
+ /**
1938
+ * The value as it was, its values joined by `\`; empty for binary data and sequences.
1939
+ * @type {string}
1940
+ * @memberof FileAttributeResult
1941
+ */
1942
+ input: string;
1943
+ /**
1944
+ * What it became; empty when removed.
1945
+ * @type {string}
1946
+ * @memberof FileAttributeResult
1947
+ */
1948
+ output: string;
1949
+ /**
1950
+ *
1951
+ * @type {string}
1952
+ * @memberof FileAttributeResult
1953
+ */
1954
+ content_type?: string | null;
1955
+ /**
1956
+ * Where: one path of `tag` and `item` segments, outermost first, with no `text`.
1957
+ * @type {Array<Array<PathSegment>>}
1958
+ * @memberof FileAttributeResult
1959
+ */
1960
+ path: Array<Array<PathSegment>>;
1961
+ }
1962
+ /**
1963
+ * @export
1964
+ */
1965
+ declare const FileAttributeResultTypeEnum: {
1966
+ readonly attribute: "attribute";
1967
+ };
1968
+ type FileAttributeResultTypeEnum = typeof FileAttributeResultTypeEnum[keyof typeof FileAttributeResultTypeEnum];
1969
+ /**
1970
+ * Check if a given object implements the FileAttributeResult interface.
1971
+ */
1972
+ declare function instanceOfFileAttributeResult(value: object): value is FileAttributeResult;
1973
+ declare function FileAttributeResultFromJSON(json: any): FileAttributeResult;
1974
+ declare function FileAttributeResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileAttributeResult;
1975
+ declare function FileAttributeResultToJSON(json: any): FileAttributeResult;
1976
+ declare function FileAttributeResultToJSONTyped(value?: FileAttributeResult | null, ignoreDiscriminator?: boolean): any;
1977
+ //#endregion
1978
+ //#region src/models/FileEmbeddedResult.d.ts
1979
+ /**
1980
+ * Embedded content taken out of the file: embedded files, OLE objects,
1981
+ * media, a FHIR photo's data; and the thumbnail, which is always removed.
1982
+ * @export
1983
+ * @interface FileEmbeddedResult
1984
+ */
1985
+ interface FileEmbeddedResult {
1986
+ /**
1987
+ *
1988
+ * @type {string}
1989
+ * @memberof FileEmbeddedResult
1990
+ */
1991
+ type: FileEmbeddedResultTypeEnum;
1992
+ /**
1993
+ * As a model result's `id`; only in the `done` list.
1994
+ * @type {number}
1995
+ * @memberof FileEmbeddedResult
1996
+ */
1997
+ id: number;
1998
+ /**
1999
+ * `remove`.
2000
+ * @type {string}
2001
+ * @memberof FileEmbeddedResult
2002
+ */
2003
+ rule: string;
2004
+ /**
2005
+ * As the file gives it; `application/octet-stream` for a photo with no `contentType`.
2006
+ * @type {string}
2007
+ * @memberof FileEmbeddedResult
2008
+ */
2009
+ content_type: string;
2010
+ /**
2011
+ * The removed file inside the Office zip, or a FHIR photo's `data`
2012
+ * (keys and indexes): one path, with no `text`.
2013
+ * @type {Array<Array<PathSegment>>}
2014
+ * @memberof FileEmbeddedResult
2015
+ */
2016
+ path: Array<Array<PathSegment>>;
2017
+ }
2018
+ /**
2019
+ * @export
2020
+ */
2021
+ declare const FileEmbeddedResultTypeEnum: {
2022
+ readonly embedded: "embedded";
2023
+ };
2024
+ type FileEmbeddedResultTypeEnum = typeof FileEmbeddedResultTypeEnum[keyof typeof FileEmbeddedResultTypeEnum];
2025
+ /**
2026
+ * Check if a given object implements the FileEmbeddedResult interface.
2027
+ */
2028
+ declare function instanceOfFileEmbeddedResult(value: object): value is FileEmbeddedResult;
2029
+ declare function FileEmbeddedResultFromJSON(json: any): FileEmbeddedResult;
2030
+ declare function FileEmbeddedResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileEmbeddedResult;
2031
+ declare function FileEmbeddedResultToJSON(json: any): FileEmbeddedResult;
2032
+ declare function FileEmbeddedResultToJSONTyped(value?: FileEmbeddedResult | null, ignoreDiscriminator?: boolean): any;
2033
+ //#endregion
2034
+ //#region src/models/FileModelResult.d.ts
2035
+ /**
2036
+ * The model found the value. Another copy of a value already replaced is
2037
+ * reported as the first one was.
2038
+ * @export
2039
+ * @interface FileModelResult
2040
+ */
2041
+ interface FileModelResult {
2042
+ /**
2043
+ *
2044
+ * @type {string}
2045
+ * @memberof FileModelResult
2046
+ */
2047
+ type: FileModelResultTypeEnum;
2048
+ /**
2049
+ * Unique in a run, from 0, not always consecutive: a `batch` event's
2050
+ * result and the `done` list's with the same `id` are the same find,
2051
+ * `done`'s final.
2052
+ * @type {number}
2053
+ * @memberof FileModelResult
2054
+ */
2055
+ id: number;
2056
+ /**
2057
+ * The rule applied, e.g. `replace`, `mask`; `detect` changes nothing.
2058
+ * @type {string}
2059
+ * @memberof FileModelResult
2060
+ */
2061
+ rule: string;
2062
+ /**
2063
+ * The model entity type, e.g. `person`.
2064
+ * @type {string}
2065
+ * @memberof FileModelResult
2066
+ */
2067
+ value: string;
2068
+ /**
2069
+ * The model's confidence, 0.0–1.0.
2070
+ * @type {number}
2071
+ * @memberof FileModelResult
2072
+ */
2073
+ score: number;
2074
+ /**
2075
+ * The value as it was. Split across objects: as the model read it, the
2076
+ * pieces joined by what stood between them (a tab between cells).
2077
+ * @type {string}
2078
+ * @memberof FileModelResult
2079
+ */
2080
+ input: string;
2081
+ /**
2082
+ * What it became, in each object it is in.
2083
+ * @type {string}
2084
+ * @memberof FileModelResult
2085
+ */
2086
+ output: string;
2087
+ /**
2088
+ * Where the value is, each path ending in its `text`: one path, or one per
2089
+ * object for a value split across objects side by side (two table cells,
2090
+ * a text box and its paragraph, two shapes level on a slide), in reading order.
2091
+ * @type {Array<Array<PathSegment>>}
2092
+ * @memberof FileModelResult
2093
+ */
2094
+ path: Array<Array<PathSegment>>;
2095
+ }
2096
+ /**
2097
+ * @export
2098
+ */
2099
+ declare const FileModelResultTypeEnum: {
2100
+ readonly model: "model";
2101
+ };
2102
+ type FileModelResultTypeEnum = typeof FileModelResultTypeEnum[keyof typeof FileModelResultTypeEnum];
2103
+ /**
2104
+ * Check if a given object implements the FileModelResult interface.
2105
+ */
2106
+ declare function instanceOfFileModelResult(value: object): value is FileModelResult;
2107
+ declare function FileModelResultFromJSON(json: any): FileModelResult;
2108
+ declare function FileModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileModelResult;
2109
+ declare function FileModelResultToJSON(json: any): FileModelResult;
2110
+ declare function FileModelResultToJSONTyped(value?: FileModelResult | null, ignoreDiscriminator?: boolean): any;
2111
+ //#endregion
2112
+ //#region src/models/FileRegexResult.d.ts
2113
+ /**
2114
+ * A regex rule matched.
2115
+ * @export
2116
+ * @interface FileRegexResult
2117
+ */
2118
+ interface FileRegexResult {
2119
+ /**
2120
+ *
2121
+ * @type {string}
2122
+ * @memberof FileRegexResult
2123
+ */
2124
+ type: FileRegexResultTypeEnum;
2125
+ /**
2126
+ * As a model result's `id`.
2127
+ * @type {number}
2128
+ * @memberof FileRegexResult
2129
+ */
2130
+ id: number;
2131
+ /**
2132
+ *
2133
+ * @type {string}
2134
+ * @memberof FileRegexResult
2135
+ */
2136
+ rule: string;
2137
+ /**
2138
+ * The pattern that matched.
2139
+ * @type {string}
2140
+ * @memberof FileRegexResult
2141
+ */
2142
+ value: string;
2143
+ /**
2144
+ * The value as it was. Split across objects: as the model read it, the
2145
+ * pieces joined by what stood between them (a tab between cells).
2146
+ * @type {string}
2147
+ * @memberof FileRegexResult
2148
+ */
2149
+ input: string;
2150
+ /**
2151
+ * What it became, in each object it is in.
2152
+ * @type {string}
2153
+ * @memberof FileRegexResult
2154
+ */
2155
+ output: string;
2156
+ /**
2157
+ * Where the value is, each path ending in its `text`: one path, or one per
2158
+ * object for a value split across objects side by side (two table cells,
2159
+ * a text box and its paragraph, two shapes level on a slide), in reading order.
2160
+ * @type {Array<Array<PathSegment>>}
2161
+ * @memberof FileRegexResult
2162
+ */
2163
+ path: Array<Array<PathSegment>>;
2164
+ }
2165
+ /**
2166
+ * @export
2167
+ */
2168
+ declare const FileRegexResultTypeEnum: {
2169
+ readonly regex: "regex";
2170
+ };
2171
+ type FileRegexResultTypeEnum = typeof FileRegexResultTypeEnum[keyof typeof FileRegexResultTypeEnum];
2172
+ /**
2173
+ * Check if a given object implements the FileRegexResult interface.
2174
+ */
2175
+ declare function instanceOfFileRegexResult(value: object): value is FileRegexResult;
2176
+ declare function FileRegexResultFromJSON(json: any): FileRegexResult;
2177
+ declare function FileRegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileRegexResult;
2178
+ declare function FileRegexResultToJSON(json: any): FileRegexResult;
2179
+ declare function FileRegexResultToJSONTyped(value?: FileRegexResult | null, ignoreDiscriminator?: boolean): any;
2180
+ //#endregion
2181
+ //#region src/models/FileResult.d.ts
2182
+ /**
2183
+ * @type FileResult
2184
+ * One change made to the file, by what found it.
2185
+ * @export
2186
+ */
2187
+ type FileResult = {
2188
+ type: 'attribute';
2189
+ } & FileAttributeResult | {
2190
+ type: 'embedded';
2191
+ } & FileEmbeddedResult | {
2192
+ type: 'model';
2193
+ } & FileModelResult | {
2194
+ type: 'regex';
2195
+ } & FileRegexResult;
2196
+ declare function FileResultFromJSON(json: any): FileResult;
2197
+ declare function FileResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): FileResult;
2198
+ declare function FileResultToJSON(json: any): any;
2199
+ declare function FileResultToJSONTyped(value?: FileResult | null, ignoreDiscriminator?: boolean): any;
2200
+ //#endregion
2201
+ //#region src/models/AnonymizeFileResponseBody.d.ts
2202
+ /**
2203
+ * Response from the document endpoint: the anonymized file and what changed in it.
2204
+ * @export
2205
+ * @interface AnonymizeFileResponseBody
2206
+ */
2207
+ interface AnonymizeFileResponseBody {
2208
+ /**
2209
+ * Token counts for this request: the document's text.
2210
+ * @type {Usage}
2211
+ * @memberof AnonymizeFileResponseBody
2212
+ */
2213
+ usage: Usage;
2214
+ /**
2215
+ * The models that ran, ids from `GET /models`: the text model, then the image reader when images were read.
2216
+ * @type {Array<string>}
2217
+ * @memberof AnonymizeFileResponseBody
2218
+ */
2219
+ models: Array<string>;
2220
+ /**
2221
+ * `docx`, `xlsx`, `pptx`, `csv`, `tsv`, `txt`, `md`, `log`, `json`, `jsonl`, `png`, `jpg`, `webp`, `bmp`, `tiff` or `dcm`.
2222
+ * @type {string}
2223
+ * @memberof AnonymizeFileResponseBody
2224
+ */
2225
+ format: string;
2226
+ /**
2227
+ * Each change made to the file: values the model or a regex found (replaced, or
2228
+ * left as they were by a detect rule), then embedded content removed.
2229
+ * @type {Array<FileResult>}
2230
+ * @memberof AnonymizeFileResponseBody
2231
+ */
2232
+ results: Array<FileResult>;
2233
+ /**
2234
+ * The anonymized file, base64-encoded, in the format it came in.
2235
+ * @type {string}
2236
+ * @memberof AnonymizeFileResponseBody
2237
+ */
2238
+ file: string;
2239
+ }
2240
+ /**
2241
+ * Check if a given object implements the AnonymizeFileResponseBody interface.
2242
+ */
2243
+ declare function instanceOfAnonymizeFileResponseBody(value: object): value is AnonymizeFileResponseBody;
2244
+ declare function AnonymizeFileResponseBodyFromJSON(json: any): AnonymizeFileResponseBody;
2245
+ declare function AnonymizeFileResponseBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeFileResponseBody;
2246
+ declare function AnonymizeFileResponseBodyToJSON(json: any): AnonymizeFileResponseBody;
2247
+ declare function AnonymizeFileResponseBodyToJSONTyped(value?: AnonymizeFileResponseBody | null, ignoreDiscriminator?: boolean): any;
2248
+ //#endregion
2249
+ //#region src/models/ModelEntity.d.ts
2250
+ /**
2251
+ * Sensitive Data Protection API
2252
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
2253
+ *
2254
+ * The version of the OpenAPI document: 0.1.0
2255
+ *
2256
+ *
2257
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2258
+ * https://openapi-generator.tech
2259
+ * Do not edit the class manually.
2260
+ */
2261
+ /**
2262
+ * An AI-model entity type to target, e.g. 'person', 'email', 'phone_number'.
2263
+ * @export
2264
+ * @interface ModelEntity
2265
+ */
2266
+ interface ModelEntity {
2267
+ /**
2268
+ *
2269
+ * @type {string}
2270
+ * @memberof ModelEntity
2271
+ */
2272
+ type: ModelEntityTypeEnum;
2273
+ /**
2274
+ * The model entity type name, e.g. 'person'.
2275
+ * @type {string}
2276
+ * @memberof ModelEntity
2277
+ */
2278
+ value: string;
2279
+ }
2280
+ /**
2281
+ * @export
2282
+ */
2283
+ declare const ModelEntityTypeEnum: {
2284
+ readonly model: "model";
2285
+ };
2286
+ type ModelEntityTypeEnum = typeof ModelEntityTypeEnum[keyof typeof ModelEntityTypeEnum];
2287
+ /**
2288
+ * Check if a given object implements the ModelEntity interface.
2289
+ */
2290
+ declare function instanceOfModelEntity(value: object): value is ModelEntity;
2291
+ declare function ModelEntityFromJSON(json: any): ModelEntity;
2292
+ declare function ModelEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelEntity;
2293
+ declare function ModelEntityToJSON(json: any): ModelEntity;
2294
+ declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscriminator?: boolean): any;
2295
+ //#endregion
2296
+ //#region src/models/RegexEntity.d.ts
2297
+ /**
2298
+ * Sensitive Data Protection API
2299
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
2300
+ *
2301
+ * The version of the OpenAPI document: 0.1.0
2302
+ *
2303
+ *
2304
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2305
+ * https://openapi-generator.tech
2306
+ * Do not edit the class manually.
2307
+ */
2308
+ /**
2309
+ * A regex pattern to target, e.g. a custom ID or date format.
2310
+ * @export
2311
+ * @interface RegexEntity
2312
+ */
2313
+ interface RegexEntity {
2314
+ /**
2315
+ *
2316
+ * @type {string}
2317
+ * @memberof RegexEntity
2318
+ */
2319
+ type: RegexEntityTypeEnum;
2320
+ /**
2321
+ * The regular expression to match.
2322
+ * @type {string}
2323
+ * @memberof RegexEntity
2324
+ */
2325
+ value: string;
2326
+ }
2327
+ /**
2328
+ * @export
2329
+ */
2330
+ declare const RegexEntityTypeEnum: {
2331
+ readonly regex: "regex";
2332
+ };
2333
+ type RegexEntityTypeEnum = typeof RegexEntityTypeEnum[keyof typeof RegexEntityTypeEnum];
2334
+ /**
2335
+ * Check if a given object implements the RegexEntity interface.
2336
+ */
2337
+ declare function instanceOfRegexEntity(value: object): value is RegexEntity;
2338
+ declare function RegexEntityFromJSON(json: any): RegexEntity;
2339
+ declare function RegexEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexEntity;
2340
+ declare function RegexEntityToJSON(json: any): RegexEntity;
2341
+ declare function RegexEntityToJSONTyped(value?: RegexEntity | null, ignoreDiscriminator?: boolean): any;
2342
+ //#endregion
2343
+ //#region src/models/EntityBody.d.ts
2344
+ /**
2345
+ * @type EntityBody
2346
+ * An entity to target, chosen by its `type`.
2347
+ * @export
2348
+ */
2349
+ type EntityBody = {
2350
+ type: 'model';
2351
+ } & ModelEntity | {
2352
+ type: 'regex';
2353
+ } & RegexEntity;
2354
+ declare function EntityBodyFromJSON(json: any): EntityBody;
2355
+ declare function EntityBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): EntityBody;
2356
+ declare function EntityBodyToJSON(json: any): any;
2357
+ declare function EntityBodyToJSONTyped(value?: EntityBody | null, ignoreDiscriminator?: boolean): any;
2358
+ //#endregion
2359
+ //#region src/models/DetectRule.d.ts
2360
+ /**
2361
+ * Report each matched value without changing it.
2362
+ *
2363
+ * The match is recorded in the results like any other rule, but the text is
2364
+ * returned untouched — this is how a policy says "flag this, don't rewrite
2365
+ * it", which is what the browser extension needs when it must not edit the
2366
+ * user's prompt.
2367
+ *
2368
+ * Because overlapping spans are resolved first-match-wins, placing a detect
2369
+ * rule before a transform also shields those spans from being rewritten.
2370
+ * @export
2371
+ * @interface DetectRule
2372
+ */
2373
+ interface DetectRule {
2374
+ /**
2375
+ *
2376
+ * @type {string}
2377
+ * @memberof DetectRule
2378
+ */
2379
+ type: DetectRuleTypeEnum;
2380
+ /**
2381
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2382
+ * @type {Array<EntityBody>}
2383
+ * @memberof DetectRule
2384
+ */
2385
+ entities: Array<EntityBody>;
2386
+ /**
2387
+ *
2388
+ * @type {Action}
2389
+ * @memberof DetectRule
2390
+ */
2391
+ action?: Action;
2392
+ }
2393
+ /**
2394
+ * @export
2395
+ */
2396
+ declare const DetectRuleTypeEnum: {
2397
+ readonly detect: "detect";
2398
+ };
2399
+ type DetectRuleTypeEnum = typeof DetectRuleTypeEnum[keyof typeof DetectRuleTypeEnum];
2400
+ /**
2401
+ * Check if a given object implements the DetectRule interface.
2402
+ */
2403
+ declare function instanceOfDetectRule(value: object): value is DetectRule;
2404
+ declare function DetectRuleFromJSON(json: any): DetectRule;
2405
+ declare function DetectRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): DetectRule;
2406
+ declare function DetectRuleToJSON(json: any): DetectRule;
2407
+ declare function DetectRuleToJSONTyped(value?: DetectRule | null, ignoreDiscriminator?: boolean): any;
2408
+ //#endregion
2409
+ //#region src/models/EncryptRule.d.ts
2410
+ /**
2411
+ * Replace each matched value with a Fernet-encrypted token.
2412
+ *
2413
+ * If no key is supplied, a new Fernet key is generated per rule instance.
2414
+ * @export
2415
+ * @interface EncryptRule
2416
+ */
2417
+ interface EncryptRule {
2418
+ /**
2419
+ *
2420
+ * @type {string}
2421
+ * @memberof EncryptRule
2422
+ */
2423
+ type: EncryptRuleTypeEnum;
2424
+ /**
2425
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2426
+ * @type {Array<EntityBody>}
2427
+ * @memberof EncryptRule
2428
+ */
2429
+ entities: Array<EntityBody>;
2430
+ /**
2431
+ *
2432
+ * @type {Action}
2433
+ * @memberof EncryptRule
2434
+ */
2435
+ action?: Action;
2436
+ /**
2437
+ * Base64 Fernet key. If empty, a key is generated automatically.
2438
+ * @type {string}
2439
+ * @memberof EncryptRule
2440
+ */
2441
+ key?: string;
2442
+ }
2443
+ /**
2444
+ * @export
2445
+ */
2446
+ declare const EncryptRuleTypeEnum: {
2447
+ readonly encrypt: "encrypt";
2448
+ };
2449
+ type EncryptRuleTypeEnum = typeof EncryptRuleTypeEnum[keyof typeof EncryptRuleTypeEnum];
2450
+ /**
2451
+ * Check if a given object implements the EncryptRule interface.
2452
+ */
2453
+ declare function instanceOfEncryptRule(value: object): value is EncryptRule;
2454
+ declare function EncryptRuleFromJSON(json: any): EncryptRule;
2455
+ declare function EncryptRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): EncryptRule;
2456
+ declare function EncryptRuleToJSON(json: any): EncryptRule;
2457
+ declare function EncryptRuleToJSONTyped(value?: EncryptRule | null, ignoreDiscriminator?: boolean): any;
2458
+ //#endregion
2459
+ //#region src/models/HMACRule.d.ts
2460
+ /**
2461
+ * Replace each matched value with its HMAC-SHA256 under `key`, in hex.
2462
+ *
2463
+ * The same value and key always give the same digest, so records can still be
2464
+ * joined; without the key, values can't be recovered by hashing guesses (a
2465
+ * plain SHA-256 of a phone number can).
2466
+ * @export
2467
+ * @interface HMACRule
2468
+ */
2469
+ interface HMACRule {
2470
+ /**
2471
+ *
2472
+ * @type {string}
2473
+ * @memberof HMACRule
2474
+ */
2475
+ type: HMACRuleTypeEnum;
2476
+ /**
2477
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2478
+ * @type {Array<EntityBody>}
2479
+ * @memberof HMACRule
2480
+ */
2481
+ entities: Array<EntityBody>;
2482
+ /**
2483
+ *
2484
+ * @type {Action}
2485
+ * @memberof HMACRule
2486
+ */
2487
+ action?: Action;
2488
+ /**
2489
+ * The secret key, at least 32 characters. Keep it: the same key gives the same digests.
2490
+ * @type {string}
2491
+ * @memberof HMACRule
2492
+ */
2493
+ key: string;
2494
+ /**
2495
+ * How many hex characters of the digest to keep, from the start.
2496
+ * @type {number}
2497
+ * @memberof HMACRule
2498
+ */
2499
+ length?: number;
2500
+ }
2501
+ /**
2502
+ * @export
2503
+ */
2504
+ declare const HMACRuleTypeEnum: {
2505
+ readonly hmac: "hmac";
2506
+ };
2507
+ type HMACRuleTypeEnum = typeof HMACRuleTypeEnum[keyof typeof HMACRuleTypeEnum];
2508
+ /**
2509
+ * Check if a given object implements the HMACRule interface.
2510
+ */
2511
+ declare function instanceOfHMACRule(value: object): value is HMACRule;
2512
+ declare function HMACRuleFromJSON(json: any): HMACRule;
2513
+ declare function HMACRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): HMACRule;
2514
+ declare function HMACRuleToJSON(json: any): HMACRule;
2515
+ declare function HMACRuleToJSONTyped(value?: HMACRule | null, ignoreDiscriminator?: boolean): any;
2516
+ //#endregion
2517
+ //#region src/models/MaskRule.d.ts
2518
+ /**
2519
+ * Mask part of each matched value with a repeated character.
2520
+ *
2521
+ * By default the whole value is masked; set ``chars_to_mask`` to mask only a
2522
+ * portion, and ``from_end`` to mask the trailing characters instead of leading.
2523
+ * @export
2524
+ * @interface MaskRule
2525
+ */
2526
+ interface MaskRule {
2527
+ /**
2528
+ *
2529
+ * @type {string}
2530
+ * @memberof MaskRule
2531
+ */
2532
+ type: MaskRuleTypeEnum;
2533
+ /**
2534
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2535
+ * @type {Array<EntityBody>}
2536
+ * @memberof MaskRule
2537
+ */
2538
+ entities: Array<EntityBody>;
2539
+ /**
2540
+ *
2541
+ * @type {Action}
2542
+ * @memberof MaskRule
2543
+ */
2544
+ action?: Action;
2545
+ /**
2546
+ * The character used to mask, e.g. '*'.
2547
+ * @type {string}
2548
+ * @memberof MaskRule
2549
+ */
2550
+ masking_char?: string;
2551
+ /**
2552
+ *
2553
+ * @type {number}
2554
+ * @memberof MaskRule
2555
+ */
2556
+ chars_to_mask?: number | null;
2557
+ /**
2558
+ * If true, mask the last N characters instead of the first N.
2559
+ * @type {boolean}
2560
+ * @memberof MaskRule
2561
+ */
2562
+ from_end?: boolean;
2563
+ }
2564
+ /**
2565
+ * @export
2566
+ */
2567
+ declare const MaskRuleTypeEnum: {
2568
+ readonly mask: "mask";
2569
+ };
2570
+ type MaskRuleTypeEnum = typeof MaskRuleTypeEnum[keyof typeof MaskRuleTypeEnum];
2571
+ /**
2572
+ * Check if a given object implements the MaskRule interface.
2573
+ */
2574
+ declare function instanceOfMaskRule(value: object): value is MaskRule;
2575
+ declare function MaskRuleFromJSON(json: any): MaskRule;
2576
+ declare function MaskRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): MaskRule;
2577
+ declare function MaskRuleToJSON(json: any): MaskRule;
2578
+ declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminator?: boolean): any;
2579
+ //#endregion
2580
+ //#region src/models/PseudonymizeRule.d.ts
2581
+ /**
2582
+ * Replace each matched value with its label and a number, e.g. '[PERSON_1]'.
2583
+ *
2584
+ * The same value gets the same tag throughout one request (or one file), a
2585
+ * different value the next number. Each result pairs the tag with the value
2586
+ * it stands for: the mapping to restore the values in a reply. It is not
2587
+ * kept. Pseudonymize rules in one request number together: two rules
2588
+ * tagging 'person' never both give '[PERSON_1]'.
2589
+ * @export
2590
+ * @interface PseudonymizeRule
2591
+ */
2592
+ interface PseudonymizeRule {
2593
+ /**
2594
+ *
2595
+ * @type {string}
2596
+ * @memberof PseudonymizeRule
2597
+ */
2598
+ type: PseudonymizeRuleTypeEnum;
2599
+ /**
2600
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2601
+ * @type {Array<EntityBody>}
2602
+ * @memberof PseudonymizeRule
2603
+ */
2604
+ entities: Array<EntityBody>;
2605
+ /**
2606
+ *
2607
+ * @type {Action}
2608
+ * @memberof PseudonymizeRule
2609
+ */
2610
+ action?: Action;
2611
+ /**
2612
+ *
2613
+ * @type {string}
2614
+ * @memberof PseudonymizeRule
2615
+ */
2616
+ tag?: string | null;
2617
+ }
2618
+ /**
2619
+ * @export
2620
+ */
2621
+ declare const PseudonymizeRuleTypeEnum: {
2622
+ readonly pseudonymize: "pseudonymize";
2623
+ };
2624
+ type PseudonymizeRuleTypeEnum = typeof PseudonymizeRuleTypeEnum[keyof typeof PseudonymizeRuleTypeEnum];
2625
+ /**
2626
+ * Check if a given object implements the PseudonymizeRule interface.
2627
+ */
2628
+ declare function instanceOfPseudonymizeRule(value: object): value is PseudonymizeRule;
2629
+ declare function PseudonymizeRuleFromJSON(json: any): PseudonymizeRule;
2630
+ declare function PseudonymizeRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PseudonymizeRule;
2631
+ declare function PseudonymizeRuleToJSON(json: any): PseudonymizeRule;
2632
+ declare function PseudonymizeRuleToJSONTyped(value?: PseudonymizeRule | null, ignoreDiscriminator?: boolean): any;
2633
+ //#endregion
2634
+ //#region src/models/RedactRule.d.ts
2635
+ /**
2636
+ * Remove each matched value entirely (replace with an empty string).
2637
+ * @export
2638
+ * @interface RedactRule
2639
+ */
2640
+ interface RedactRule {
2641
+ /**
2642
+ *
2643
+ * @type {string}
2644
+ * @memberof RedactRule
2645
+ */
2646
+ type: RedactRuleTypeEnum;
2647
+ /**
2648
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2649
+ * @type {Array<EntityBody>}
2650
+ * @memberof RedactRule
2651
+ */
2652
+ entities: Array<EntityBody>;
2653
+ /**
2654
+ *
2655
+ * @type {Action}
2656
+ * @memberof RedactRule
2657
+ */
2658
+ action?: Action;
2659
+ }
2660
+ /**
2661
+ * @export
2662
+ */
2663
+ declare const RedactRuleTypeEnum: {
2664
+ readonly redact: "redact";
2665
+ };
2666
+ type RedactRuleTypeEnum = typeof RedactRuleTypeEnum[keyof typeof RedactRuleTypeEnum];
2667
+ /**
2668
+ * Check if a given object implements the RedactRule interface.
2669
+ */
2670
+ declare function instanceOfRedactRule(value: object): value is RedactRule;
2671
+ declare function RedactRuleFromJSON(json: any): RedactRule;
2672
+ declare function RedactRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): RedactRule;
2673
+ declare function RedactRuleToJSON(json: any): RedactRule;
2674
+ declare function RedactRuleToJSONTyped(value?: RedactRule | null, ignoreDiscriminator?: boolean): any;
2675
+ //#endregion
2676
+ //#region src/models/ReplaceRule.d.ts
2677
+ /**
2678
+ * Replace each matched value with a fixed string (default '****').
2679
+ * @export
2680
+ * @interface ReplaceRule
2681
+ */
2682
+ interface ReplaceRule {
2683
+ /**
2684
+ *
2685
+ * @type {string}
2686
+ * @memberof ReplaceRule
2687
+ */
2688
+ type: ReplaceRuleTypeEnum;
2689
+ /**
2690
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2691
+ * @type {Array<EntityBody>}
2692
+ * @memberof ReplaceRule
2693
+ */
2694
+ entities: Array<EntityBody>;
2695
+ /**
2696
+ *
2697
+ * @type {Action}
2698
+ * @memberof ReplaceRule
2699
+ */
2700
+ action?: Action;
2701
+ /**
2702
+ * The fixed string to substitute for each match.
2703
+ * @type {string}
2704
+ * @memberof ReplaceRule
2705
+ */
2706
+ replacement?: string;
2707
+ }
2708
+ /**
2709
+ * @export
2710
+ */
2711
+ declare const ReplaceRuleTypeEnum: {
2712
+ readonly replace: "replace";
2713
+ };
2714
+ type ReplaceRuleTypeEnum = typeof ReplaceRuleTypeEnum[keyof typeof ReplaceRuleTypeEnum];
2715
+ /**
2716
+ * Check if a given object implements the ReplaceRule interface.
2717
+ */
2718
+ declare function instanceOfReplaceRule(value: object): value is ReplaceRule;
2719
+ declare function ReplaceRuleFromJSON(json: any): ReplaceRule;
2720
+ declare function ReplaceRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReplaceRule;
2721
+ declare function ReplaceRuleToJSON(json: any): ReplaceRule;
2722
+ declare function ReplaceRuleToJSONTyped(value?: ReplaceRule | null, ignoreDiscriminator?: boolean): any;
2723
+ //#endregion
2724
+ //#region src/models/SHA256Rule.d.ts
2725
+ /**
2726
+ * Replace each matched value with its SHA-256 hex digest.
2727
+ * @export
2728
+ * @interface SHA256Rule
2729
+ */
2730
+ interface SHA256Rule {
2731
+ /**
2732
+ *
2733
+ * @type {string}
2734
+ * @memberof SHA256Rule
2735
+ */
2736
+ type: SHA256RuleTypeEnum;
2737
+ /**
2738
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2739
+ * @type {Array<EntityBody>}
2740
+ * @memberof SHA256Rule
2741
+ */
2742
+ entities: Array<EntityBody>;
2743
+ /**
2744
+ *
2745
+ * @type {Action}
2746
+ * @memberof SHA256Rule
2747
+ */
2748
+ action?: Action;
2749
+ }
2750
+ /**
2751
+ * @export
2752
+ */
2753
+ declare const SHA256RuleTypeEnum: {
2754
+ readonly sha256: "sha256";
2755
+ };
2756
+ type SHA256RuleTypeEnum = typeof SHA256RuleTypeEnum[keyof typeof SHA256RuleTypeEnum];
2757
+ /**
2758
+ * Check if a given object implements the SHA256Rule interface.
2759
+ */
2760
+ declare function instanceOfSHA256Rule(value: object): value is SHA256Rule;
2761
+ declare function SHA256RuleFromJSON(json: any): SHA256Rule;
2762
+ declare function SHA256RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA256Rule;
2763
+ declare function SHA256RuleToJSON(json: any): SHA256Rule;
2764
+ declare function SHA256RuleToJSONTyped(value?: SHA256Rule | null, ignoreDiscriminator?: boolean): any;
2765
+ //#endregion
2766
+ //#region src/models/SHA512Rule.d.ts
2767
+ /**
2768
+ * Replace each matched value with its SHA-512 hex digest.
2769
+ * @export
2770
+ * @interface SHA512Rule
2771
+ */
2772
+ interface SHA512Rule {
2773
+ /**
2774
+ *
2775
+ * @type {string}
2776
+ * @memberof SHA512Rule
2777
+ */
2778
+ type: SHA512RuleTypeEnum;
2779
+ /**
2780
+ * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
2781
+ * @type {Array<EntityBody>}
2782
+ * @memberof SHA512Rule
2783
+ */
2784
+ entities: Array<EntityBody>;
2785
+ /**
2786
+ *
2787
+ * @type {Action}
2788
+ * @memberof SHA512Rule
2789
+ */
2790
+ action?: Action;
2791
+ }
2792
+ /**
2793
+ * @export
2794
+ */
2795
+ declare const SHA512RuleTypeEnum: {
2796
+ readonly sha512: "sha512";
2797
+ };
2798
+ type SHA512RuleTypeEnum = typeof SHA512RuleTypeEnum[keyof typeof SHA512RuleTypeEnum];
2799
+ /**
2800
+ * Check if a given object implements the SHA512Rule interface.
2801
+ */
2802
+ declare function instanceOfSHA512Rule(value: object): value is SHA512Rule;
2803
+ declare function SHA512RuleFromJSON(json: any): SHA512Rule;
2804
+ declare function SHA512RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA512Rule;
2805
+ declare function SHA512RuleToJSON(json: any): SHA512Rule;
2806
+ declare function SHA512RuleToJSONTyped(value?: SHA512Rule | null, ignoreDiscriminator?: boolean): any;
2807
+ //#endregion
2808
+ //#region src/models/RuleBody.d.ts
2809
+ /**
2810
+ * @type RuleBody
2811
+ * One rule, chosen by its `type`.
2812
+ * @export
2813
+ */
2814
+ type RuleBody = {
2815
+ type: 'detect';
2816
+ } & DetectRule | {
2817
+ type: 'encrypt';
2818
+ } & EncryptRule | {
2819
+ type: 'hmac';
2820
+ } & HMACRule | {
2821
+ type: 'mask';
2822
+ } & MaskRule | {
2823
+ type: 'pseudonymize';
2824
+ } & PseudonymizeRule | {
2825
+ type: 'redact';
2826
+ } & RedactRule | {
2827
+ type: 'replace';
2828
+ } & ReplaceRule | {
2829
+ type: 'sha256';
2830
+ } & SHA256Rule | {
2831
+ type: 'sha512';
2832
+ } & SHA512Rule;
2833
+ declare function RuleBodyFromJSON(json: any): RuleBody;
2834
+ declare function RuleBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): RuleBody;
2835
+ declare function RuleBodyToJSON(json: any): any;
2836
+ declare function RuleBodyToJSONTyped(value?: RuleBody | null, ignoreDiscriminator?: boolean): any;
2837
+ //#endregion
2838
+ //#region src/models/AnonymizeRequestBody.d.ts
2839
+ /**
2840
+ * Request body for the anonymize endpoint.
2841
+ *
2842
+ * Carries the text to anonymize and the list of de-identification rules to
2843
+ * apply.
2844
+ * @export
2845
+ * @interface AnonymizeRequestBody
2846
+ */
2847
+ interface AnonymizeRequestBody {
370
2848
  /**
371
- * Tokens in the text the model scanned.
372
- * @type {number}
373
- * @memberof Usage
2849
+ * The text to scan and anonymize. At most 128 KB in UTF-8.
2850
+ * @type {string}
2851
+ * @memberof AnonymizeRequestBody
374
2852
  */
375
- input_tokens: number;
2853
+ text: string;
376
2854
  /**
377
- * Milliseconds spent in the model. Excludes tokenizing, validation and serialization.
2855
+ *
2856
+ * @type {Array<RuleBody>}
2857
+ * @memberof AnonymizeRequestBody
2858
+ */
2859
+ rules?: Array<RuleBody> | null;
2860
+ /**
2861
+ *
378
2862
  * @type {number}
379
- * @memberof Usage
2863
+ * @memberof AnonymizeRequestBody
380
2864
  */
381
- inference_ms: number;
2865
+ confidence_threshold?: number | null;
2866
+ /**
2867
+ *
2868
+ * @type {Array<string>}
2869
+ * @memberof AnonymizeRequestBody
2870
+ */
2871
+ models?: Array<string> | null;
382
2872
  }
383
2873
  /**
384
- * Check if a given object implements the Usage interface.
2874
+ * Check if a given object implements the AnonymizeRequestBody interface.
385
2875
  */
386
- declare function instanceOfUsage(value: object): value is Usage;
387
- declare function UsageFromJSON(json: any): Usage;
388
- declare function UsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Usage;
389
- declare function UsageToJSON(json: any): Usage;
390
- declare function UsageToJSONTyped(value?: Usage | null, ignoreDiscriminator?: boolean): any;
2876
+ declare function instanceOfAnonymizeRequestBody(value: object): value is AnonymizeRequestBody;
2877
+ declare function AnonymizeRequestBodyFromJSON(json: any): AnonymizeRequestBody;
2878
+ declare function AnonymizeRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeRequestBody;
2879
+ declare function AnonymizeRequestBodyToJSON(json: any): AnonymizeRequestBody;
2880
+ declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody | null, ignoreDiscriminator?: boolean): any;
391
2881
  //#endregion
392
- //#region src/models/TextRange.d.ts
2882
+ //#region src/models/ModelResult.d.ts
393
2883
  /**
394
- * Sensitive Data Protection API
395
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
396
- *
397
- * The version of the OpenAPI document: 0.1.0
398
- *
2884
+ * Record of an AI model detection and its anonymization.
399
2885
  *
400
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
401
- * https://openapi-generator.tech
402
- * Do not edit the class manually.
403
- */
404
- /**
405
- * A character range within a text, carrying the substring it covers.
2886
+ * Created when an AI model identifies an entity (e.g. person, email)
2887
+ * and a rule anonymizes the matched text.
406
2888
  * @export
407
- * @interface TextRange
2889
+ * @interface ModelResult
408
2890
  */
409
- interface TextRange {
2891
+ interface ModelResult {
410
2892
  /**
411
- * Start character offset (inclusive).
412
- * @type {number}
413
- * @memberof TextRange
2893
+ *
2894
+ * @type {string}
2895
+ * @memberof ModelResult
414
2896
  */
415
- start: number;
2897
+ type: ModelResultTypeEnum;
416
2898
  /**
417
- * End character offset (exclusive).
418
- * @type {number}
419
- * @memberof TextRange
2899
+ * The rule type that was applied, e.g. 'replace', 'mask'.
2900
+ * @type {string}
2901
+ * @memberof ModelResult
420
2902
  */
421
- end: number;
2903
+ rule: string;
422
2904
  /**
423
- * The substring at [start, end).
2905
+ * The model entity type that matched, e.g. 'person'.
424
2906
  * @type {string}
425
- * @memberof TextRange
2907
+ * @memberof ModelResult
426
2908
  */
427
2909
  value: string;
2910
+ /**
2911
+ * The detected range in the original text.
2912
+ * @type {TextRange}
2913
+ * @memberof ModelResult
2914
+ */
2915
+ input: TextRange;
2916
+ /**
2917
+ * The anonymized range in the result text.
2918
+ * @type {TextRange}
2919
+ * @memberof ModelResult
2920
+ */
2921
+ output: TextRange;
2922
+ /**
2923
+ * Confidence score from the AI model (0.0–1.0).
2924
+ * @type {number}
2925
+ * @memberof ModelResult
2926
+ */
2927
+ score?: number;
2928
+ /**
2929
+ * What the browser extension does with it: `enforce` when the rule says so; omitted for `warn`.
2930
+ * @type {Action}
2931
+ * @memberof ModelResult
2932
+ */
2933
+ action?: Action;
428
2934
  }
429
2935
  /**
430
- * Check if a given object implements the TextRange interface.
2936
+ * @export
431
2937
  */
432
- declare function instanceOfTextRange(value: object): value is TextRange;
433
- declare function TextRangeFromJSON(json: any): TextRange;
434
- declare function TextRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextRange;
435
- declare function TextRangeToJSON(json: any): TextRange;
436
- declare function TextRangeToJSONTyped(value?: TextRange | null, ignoreDiscriminator?: boolean): any;
2938
+ declare const ModelResultTypeEnum: {
2939
+ readonly model: "model";
2940
+ };
2941
+ type ModelResultTypeEnum = typeof ModelResultTypeEnum[keyof typeof ModelResultTypeEnum];
2942
+ /**
2943
+ * Check if a given object implements the ModelResult interface.
2944
+ */
2945
+ declare function instanceOfModelResult(value: object): value is ModelResult;
2946
+ declare function ModelResultFromJSON(json: any): ModelResult;
2947
+ declare function ModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelResult;
2948
+ declare function ModelResultToJSON(json: any): ModelResult;
2949
+ declare function ModelResultToJSONTyped(value?: ModelResult | null, ignoreDiscriminator?: boolean): any;
437
2950
  //#endregion
438
- //#region src/models/AnonymizeResponseBodyResultsInner.d.ts
2951
+ //#region src/models/RegexResult.d.ts
439
2952
  /**
2953
+ * Record of a regex detection and its anonymization.
440
2954
  *
2955
+ * Created when a regex pattern matches text
2956
+ * and a rule anonymizes the matched text.
441
2957
  * @export
442
- * @interface AnonymizeResponseBodyResultsInner
2958
+ * @interface RegexResult
443
2959
  */
444
- interface AnonymizeResponseBodyResultsInner {
2960
+ interface RegexResult {
445
2961
  /**
446
2962
  *
447
2963
  * @type {string}
448
- * @memberof AnonymizeResponseBodyResultsInner
2964
+ * @memberof RegexResult
449
2965
  */
450
- type?: AnonymizeResponseBodyResultsInnerTypeEnum;
2966
+ type: RegexResultTypeEnum;
451
2967
  /**
452
2968
  * The rule type that was applied, e.g. 'replace', 'mask'.
453
2969
  * @type {string}
454
- * @memberof AnonymizeResponseBodyResultsInner
2970
+ * @memberof RegexResult
455
2971
  */
456
2972
  rule: string;
457
2973
  /**
458
2974
  * The regex pattern that matched.
459
2975
  * @type {string}
460
- * @memberof AnonymizeResponseBodyResultsInner
2976
+ * @memberof RegexResult
461
2977
  */
462
2978
  value: string;
463
2979
  /**
464
2980
  * The detected range in the original text.
465
2981
  * @type {TextRange}
466
- * @memberof AnonymizeResponseBodyResultsInner
2982
+ * @memberof RegexResult
467
2983
  */
468
2984
  input: TextRange;
469
2985
  /**
470
2986
  * The anonymized range in the result text.
471
2987
  * @type {TextRange}
472
- * @memberof AnonymizeResponseBodyResultsInner
2988
+ * @memberof RegexResult
473
2989
  */
474
2990
  output: TextRange;
475
2991
  /**
476
- * Confidence score from the AI model (0.0–1.0).
477
- * @type {number}
478
- * @memberof AnonymizeResponseBodyResultsInner
2992
+ * What the browser extension does with it: `enforce` when the rule says so; omitted for `warn`.
2993
+ * @type {Action}
2994
+ * @memberof RegexResult
479
2995
  */
480
- score?: number;
2996
+ action?: Action;
481
2997
  }
482
2998
  /**
483
2999
  * @export
484
3000
  */
485
- declare const AnonymizeResponseBodyResultsInnerTypeEnum: {
486
- readonly model: "model";
3001
+ declare const RegexResultTypeEnum: {
487
3002
  readonly regex: "regex";
488
3003
  };
489
- type AnonymizeResponseBodyResultsInnerTypeEnum = typeof AnonymizeResponseBodyResultsInnerTypeEnum[keyof typeof AnonymizeResponseBodyResultsInnerTypeEnum];
3004
+ type RegexResultTypeEnum = typeof RegexResultTypeEnum[keyof typeof RegexResultTypeEnum];
3005
+ /**
3006
+ * Check if a given object implements the RegexResult interface.
3007
+ */
3008
+ declare function instanceOfRegexResult(value: object): value is RegexResult;
3009
+ declare function RegexResultFromJSON(json: any): RegexResult;
3010
+ declare function RegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexResult;
3011
+ declare function RegexResultToJSON(json: any): RegexResult;
3012
+ declare function RegexResultToJSONTyped(value?: RegexResult | null, ignoreDiscriminator?: boolean): any;
3013
+ //#endregion
3014
+ //#region src/models/Applied.d.ts
490
3015
  /**
491
- * Check if a given object implements the AnonymizeResponseBodyResultsInner interface.
3016
+ * @type Applied
3017
+ * One rewrite, from a model detection or a regex match.
3018
+ * @export
492
3019
  */
493
- declare function instanceOfAnonymizeResponseBodyResultsInner(value: object): value is AnonymizeResponseBodyResultsInner;
494
- declare function AnonymizeResponseBodyResultsInnerFromJSON(json: any): AnonymizeResponseBodyResultsInner;
495
- declare function AnonymizeResponseBodyResultsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeResponseBodyResultsInner;
496
- declare function AnonymizeResponseBodyResultsInnerToJSON(json: any): AnonymizeResponseBodyResultsInner;
497
- declare function AnonymizeResponseBodyResultsInnerToJSONTyped(value?: AnonymizeResponseBodyResultsInner | null, ignoreDiscriminator?: boolean): any;
3020
+ type Applied = {
3021
+ type: 'model';
3022
+ } & ModelResult | {
3023
+ type: 'regex';
3024
+ } & RegexResult;
3025
+ declare function AppliedFromJSON(json: any): Applied;
3026
+ declare function AppliedFromJSONTyped(json: any, ignoreDiscriminator: boolean): Applied;
3027
+ declare function AppliedToJSON(json: any): any;
3028
+ declare function AppliedToJSONTyped(value?: Applied | null, ignoreDiscriminator?: boolean): any;
498
3029
  //#endregion
499
3030
  //#region src/models/AnonymizeResponseBody.d.ts
500
3031
  /**
@@ -512,16 +3043,22 @@ interface AnonymizeResponseBody {
512
3043
  text: string;
513
3044
  /**
514
3045
  * Records of each anonymization performed, ordered by position.
515
- * @type {Array<AnonymizeResponseBodyResultsInner>}
3046
+ * @type {Array<Applied>}
516
3047
  * @memberof AnonymizeResponseBody
517
3048
  */
518
- results?: Array<AnonymizeResponseBodyResultsInner>;
3049
+ results?: Array<Applied>;
519
3050
  /**
520
3051
  * Token counts for this request.
521
3052
  * @type {Usage}
522
3053
  * @memberof AnonymizeResponseBody
523
3054
  */
524
3055
  usage: Usage;
3056
+ /**
3057
+ * The text model that ran, as `[id]` with the id from `GET /models`.
3058
+ * @type {Array<string>}
3059
+ * @memberof AnonymizeResponseBody
3060
+ */
3061
+ models: Array<string>;
525
3062
  }
526
3063
  /**
527
3064
  * Check if a given object implements the AnonymizeResponseBody interface.
@@ -532,76 +3069,63 @@ declare function AnonymizeResponseBodyFromJSONTyped(json: any, ignoreDiscriminat
532
3069
  declare function AnonymizeResponseBodyToJSON(json: any): AnonymizeResponseBody;
533
3070
  declare function AnonymizeResponseBodyToJSONTyped(value?: AnonymizeResponseBody | null, ignoreDiscriminator?: boolean): any;
534
3071
  //#endregion
535
- //#region src/models/PolicyDocumentRulesInner.d.ts
3072
+ //#region src/models/At.d.ts
536
3073
  /**
537
- *
3074
+ * How far reading has got: the last unit of a batch.
538
3075
  * @export
539
- * @interface PolicyDocumentRulesInner
3076
+ * @interface At
540
3077
  */
541
- interface PolicyDocumentRulesInner {
542
- /**
543
- *
544
- * @type {string}
545
- * @memberof PolicyDocumentRulesInner
546
- */
547
- type?: PolicyDocumentRulesInnerTypeEnum;
548
- /**
549
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
550
- * @type {Array<DetectRuleEntitiesInner>}
551
- * @memberof PolicyDocumentRulesInner
552
- */
553
- entities: Array<DetectRuleEntitiesInner>;
554
- /**
555
- * The fixed string to substitute for each match.
556
- * @type {string}
557
- * @memberof PolicyDocumentRulesInner
558
- */
559
- replacement?: string;
560
- /**
561
- * The character used to mask, e.g. '*'.
562
- * @type {string}
563
- * @memberof PolicyDocumentRulesInner
564
- */
565
- masking_char?: string;
566
- /**
567
- *
568
- * @type {number}
569
- * @memberof PolicyDocumentRulesInner
570
- */
571
- chars_to_mask?: number;
3078
+ interface At {
572
3079
  /**
573
- * If true, mask the last N characters instead of the first N.
574
- * @type {boolean}
575
- * @memberof PolicyDocumentRulesInner
3080
+ * Where it is, as a result's `path`: its start.
3081
+ * @type {Array<PathSegment>}
3082
+ * @memberof At
576
3083
  */
577
- from_end?: boolean;
3084
+ path: Array<PathSegment>;
578
3085
  /**
579
- * Base64 Fernet key. If empty, a key is generated automatically.
3086
+ * The start of its text, for a viewer to find it on the page; for JSON its first value, decoded.
580
3087
  * @type {string}
581
- * @memberof PolicyDocumentRulesInner
3088
+ * @memberof At
582
3089
  */
583
- key?: string;
3090
+ text: string;
584
3091
  }
585
3092
  /**
586
- * @export
3093
+ * Check if a given object implements the At interface.
587
3094
  */
588
- declare const PolicyDocumentRulesInnerTypeEnum: {
589
- readonly detect: "detect";
590
- readonly redact: "redact";
591
- readonly replace: "replace";
592
- readonly mask: "mask";
593
- readonly sha256: "sha256";
594
- readonly sha512: "sha512";
595
- readonly encrypt: "encrypt";
596
- };
597
- type PolicyDocumentRulesInnerTypeEnum = typeof PolicyDocumentRulesInnerTypeEnum[keyof typeof PolicyDocumentRulesInnerTypeEnum];
3095
+ declare function instanceOfAt(value: object): value is At;
3096
+ declare function AtFromJSON(json: any): At;
3097
+ declare function AtFromJSONTyped(json: any, ignoreDiscriminator: boolean): At;
3098
+ declare function AtToJSON(json: any): At;
3099
+ declare function AtToJSONTyped(value?: At | null, ignoreDiscriminator?: boolean): any;
3100
+ //#endregion
3101
+ //#region src/models/PolicyDocumentRulesInner.d.ts
598
3102
  /**
599
- * Check if a given object implements the PolicyDocumentRulesInner interface.
3103
+ * @type PolicyDocumentRulesInner
3104
+ *
3105
+ * @export
600
3106
  */
601
- declare function instanceOfPolicyDocumentRulesInner(value: object): value is PolicyDocumentRulesInner;
3107
+ type PolicyDocumentRulesInner = {
3108
+ type: 'detect';
3109
+ } & DetectRule | {
3110
+ type: 'encrypt';
3111
+ } & EncryptRule | {
3112
+ type: 'hmac';
3113
+ } & HMACRule | {
3114
+ type: 'mask';
3115
+ } & MaskRule | {
3116
+ type: 'pseudonymize';
3117
+ } & PseudonymizeRule | {
3118
+ type: 'redact';
3119
+ } & RedactRule | {
3120
+ type: 'replace';
3121
+ } & ReplaceRule | {
3122
+ type: 'sha256';
3123
+ } & SHA256Rule | {
3124
+ type: 'sha512';
3125
+ } & SHA512Rule;
602
3126
  declare function PolicyDocumentRulesInnerFromJSON(json: any): PolicyDocumentRulesInner;
603
3127
  declare function PolicyDocumentRulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PolicyDocumentRulesInner;
604
- declare function PolicyDocumentRulesInnerToJSON(json: any): PolicyDocumentRulesInner;
3128
+ declare function PolicyDocumentRulesInnerToJSON(json: any): any;
605
3129
  declare function PolicyDocumentRulesInnerToJSONTyped(value?: PolicyDocumentRulesInner | null, ignoreDiscriminator?: boolean): any;
606
3130
  //#endregion
607
3131
  //#region src/models/PolicyDocument.d.ts
@@ -652,127 +3176,78 @@ declare function PolicyDocumentFromJSONTyped(json: any, ignoreDiscriminator: boo
652
3176
  declare function PolicyDocumentToJSON(json: any): PolicyDocument;
653
3177
  declare function PolicyDocumentToJSONTyped(value?: PolicyDocument | null, ignoreDiscriminator?: boolean): any;
654
3178
  //#endregion
655
- //#region src/models/CreatePolicyRequest.d.ts
656
- /**
657
- *
658
- * @export
659
- * @interface CreatePolicyRequest
660
- */
661
- interface CreatePolicyRequest {
662
- /**
663
- *
664
- * @type {string}
665
- * @memberof CreatePolicyRequest
666
- */
667
- name: string;
668
- /**
669
- *
670
- * @type {PolicyDocument}
671
- * @memberof CreatePolicyRequest
672
- */
673
- document: PolicyDocument;
674
- }
675
- /**
676
- * Check if a given object implements the CreatePolicyRequest interface.
677
- */
678
- declare function instanceOfCreatePolicyRequest(value: object): value is CreatePolicyRequest;
679
- declare function CreatePolicyRequestFromJSON(json: any): CreatePolicyRequest;
680
- declare function CreatePolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePolicyRequest;
681
- declare function CreatePolicyRequestToJSON(json: any): CreatePolicyRequest;
682
- declare function CreatePolicyRequestToJSONTyped(value?: CreatePolicyRequest | null, ignoreDiscriminator?: boolean): any;
683
- //#endregion
684
- //#region src/models/DetectRule.d.ts
685
- /**
686
- * Report each matched value without changing it.
687
- *
688
- * The match is recorded in the results like any other rule, but the text is
689
- * returned untouched — this is how a policy says "flag this, don't rewrite
690
- * it", which is what the browser extension needs when it must not edit the
691
- * user's prompt.
692
- *
693
- * Because overlapping spans are resolved first-match-wins, placing a detect
694
- * rule before a transform also shields those spans from being rewritten.
695
- * @export
696
- * @interface DetectRule
697
- */
698
- interface DetectRule {
699
- /**
700
- *
701
- * @type {string}
702
- * @memberof DetectRule
703
- */
704
- type?: DetectRuleTypeEnum;
705
- /**
706
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
707
- * @type {Array<DetectRuleEntitiesInner>}
708
- * @memberof DetectRule
709
- */
710
- entities: Array<DetectRuleEntitiesInner>;
711
- }
712
- /**
713
- * @export
714
- */
715
- declare const DetectRuleTypeEnum: {
716
- readonly detect: "detect";
717
- };
718
- type DetectRuleTypeEnum = typeof DetectRuleTypeEnum[keyof typeof DetectRuleTypeEnum];
719
- /**
720
- * Check if a given object implements the DetectRule interface.
721
- */
722
- declare function instanceOfDetectRule(value: object): value is DetectRule;
723
- declare function DetectRuleFromJSON(json: any): DetectRule;
724
- declare function DetectRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): DetectRule;
725
- declare function DetectRuleToJSON(json: any): DetectRule;
726
- declare function DetectRuleToJSONTyped(value?: DetectRule | null, ignoreDiscriminator?: boolean): any;
727
- //#endregion
728
- //#region src/models/EncryptRule.d.ts
3179
+ //#region src/models/CreatePolicyRequest.d.ts
729
3180
  /**
730
- * Replace each matched value with a Fernet-encrypted token.
731
3181
  *
732
- * If no key is supplied, a new Fernet key is generated per rule instance.
733
3182
  * @export
734
- * @interface EncryptRule
3183
+ * @interface CreatePolicyRequest
735
3184
  */
736
- interface EncryptRule {
3185
+ interface CreatePolicyRequest {
737
3186
  /**
738
3187
  *
739
3188
  * @type {string}
740
- * @memberof EncryptRule
741
- */
742
- type?: EncryptRuleTypeEnum;
743
- /**
744
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
745
- * @type {Array<DetectRuleEntitiesInner>}
746
- * @memberof EncryptRule
3189
+ * @memberof CreatePolicyRequest
747
3190
  */
748
- entities: Array<DetectRuleEntitiesInner>;
3191
+ name: string;
749
3192
  /**
750
- * Base64 Fernet key. If empty, a key is generated automatically.
751
- * @type {string}
752
- * @memberof EncryptRule
3193
+ *
3194
+ * @type {PolicyDocument}
3195
+ * @memberof CreatePolicyRequest
753
3196
  */
754
- key?: string;
3197
+ document: PolicyDocument;
755
3198
  }
756
3199
  /**
757
- * @export
3200
+ * Check if a given object implements the CreatePolicyRequest interface.
758
3201
  */
759
- declare const EncryptRuleTypeEnum: {
760
- readonly encrypt: "encrypt";
761
- };
762
- type EncryptRuleTypeEnum = typeof EncryptRuleTypeEnum[keyof typeof EncryptRuleTypeEnum];
3202
+ declare function instanceOfCreatePolicyRequest(value: object): value is CreatePolicyRequest;
3203
+ declare function CreatePolicyRequestFromJSON(json: any): CreatePolicyRequest;
3204
+ declare function CreatePolicyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePolicyRequest;
3205
+ declare function CreatePolicyRequestToJSON(json: any): CreatePolicyRequest;
3206
+ declare function CreatePolicyRequestToJSONTyped(value?: CreatePolicyRequest | null, ignoreDiscriminator?: boolean): any;
3207
+ //#endregion
3208
+ //#region src/models/ErrorCode.d.ts
763
3209
  /**
764
- * Check if a given object implements the EncryptRule interface.
3210
+ * Sensitive Data Protection API
3211
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
3212
+ *
3213
+ * The version of the OpenAPI document: 0.1.0
3214
+ *
3215
+ *
3216
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3217
+ * https://openapi-generator.tech
3218
+ * Do not edit the class manually.
765
3219
  */
766
- declare function instanceOfEncryptRule(value: object): value is EncryptRule;
767
- declare function EncryptRuleFromJSON(json: any): EncryptRule;
768
- declare function EncryptRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): EncryptRule;
769
- declare function EncryptRuleToJSON(json: any): EncryptRule;
770
- declare function EncryptRuleToJSONTyped(value?: EncryptRule | null, ignoreDiscriminator?: boolean): any;
3220
+ /**
3221
+ * What went wrong, for callers to branch on. `invalid_json` (400): the body
3222
+ * is not JSON. `invalid_request` (422): some fields are invalid, `details`
3223
+ * says which. `unauthorized` (401), `not_found` (404), `method_not_allowed`
3224
+ * (405). `internal` (500): the request failed; retrying may help.
3225
+ * `unavailable` (503): the model is not loaded.
3226
+ * `forbidden` (403): the caller's assigned policy sets the rules or threshold. `policy_unreadable` (409): that policy cannot be read.
3227
+ * @export
3228
+ */
3229
+ declare const ErrorCode: {
3230
+ readonly invalid_json: "invalid_json";
3231
+ readonly invalid_request: "invalid_request";
3232
+ readonly unauthorized: "unauthorized";
3233
+ readonly not_found: "not_found";
3234
+ readonly method_not_allowed: "method_not_allowed";
3235
+ readonly internal: "internal";
3236
+ readonly unavailable: "unavailable";
3237
+ readonly forbidden: "forbidden";
3238
+ readonly policy_unreadable: "policy_unreadable";
3239
+ };
3240
+ type ErrorCode = typeof ErrorCode[keyof typeof ErrorCode];
3241
+ declare function instanceOfErrorCode(value: any): boolean;
3242
+ declare function ErrorCodeFromJSON(json: any): ErrorCode;
3243
+ declare function ErrorCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorCode;
3244
+ declare function ErrorCodeToJSON(value?: ErrorCode | null): any;
3245
+ declare function ErrorCodeToJSONTyped(value: any, ignoreDiscriminator: boolean): ErrorCode;
771
3246
  //#endregion
772
- //#region src/models/ValidationErrorLocInner.d.ts
3247
+ //#region src/models/FieldErrorPathInner.d.ts
773
3248
  /**
774
3249
  * Sensitive Data Protection API
775
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3250
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
776
3251
  *
777
3252
  * The version of the OpenAPI document: 0.1.0
778
3253
  *
@@ -782,94 +3257,174 @@ declare function EncryptRuleToJSONTyped(value?: EncryptRule | null, ignoreDiscri
782
3257
  * Do not edit the class manually.
783
3258
  */
784
3259
  /**
785
- *
3260
+ * One step of a path into the request body: a field name or a list index.
786
3261
  * @export
787
- * @interface ValidationErrorLocInner
3262
+ * @interface FieldErrorPathInner
788
3263
  */
789
- interface ValidationErrorLocInner {}
3264
+ interface FieldErrorPathInner {}
790
3265
  /**
791
- * Check if a given object implements the ValidationErrorLocInner interface.
3266
+ * Check if a given object implements the FieldErrorPathInner interface.
792
3267
  */
793
- declare function instanceOfValidationErrorLocInner(value: object): value is ValidationErrorLocInner;
794
- declare function ValidationErrorLocInnerFromJSON(json: any): ValidationErrorLocInner;
795
- declare function ValidationErrorLocInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationErrorLocInner;
796
- declare function ValidationErrorLocInnerToJSON(json: any): ValidationErrorLocInner;
797
- declare function ValidationErrorLocInnerToJSONTyped(value?: ValidationErrorLocInner | null, ignoreDiscriminator?: boolean): any;
3268
+ declare function instanceOfFieldErrorPathInner(value: object): value is FieldErrorPathInner;
3269
+ declare function FieldErrorPathInnerFromJSON(json: any): FieldErrorPathInner;
3270
+ declare function FieldErrorPathInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldErrorPathInner;
3271
+ declare function FieldErrorPathInnerToJSON(json: any): FieldErrorPathInner;
3272
+ declare function FieldErrorPathInnerToJSONTyped(value?: FieldErrorPathInner | null, ignoreDiscriminator?: boolean): any;
798
3273
  //#endregion
799
- //#region src/models/ValidationError.d.ts
3274
+ //#region src/models/FieldErrorCode.d.ts
800
3275
  /**
3276
+ * Sensitive Data Protection API
3277
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
3278
+ *
3279
+ * The version of the OpenAPI document: 0.1.0
801
3280
  *
3281
+ *
3282
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3283
+ * https://openapi-generator.tech
3284
+ * Do not edit the class manually.
3285
+ */
3286
+ /**
3287
+ * Why one field was refused. `missing`; `wrong_type` (see `expected`);
3288
+ * `too_short`/`too_long` in characters and `too_large` in UTF-8 bytes (see
3289
+ * `limit`); `too_few`/`too_many` items (see `limit`); `out_of_range` (see
3290
+ * `min`, `max`); `blank`: only whitespace; `unknown_type` (see `allowed`);
3291
+ * `invalid_pattern`: not a regular expression the engine runs;
3292
+ * `invalid_key`: not a Fernet key; `labels_over_budget`: the labels leave
3293
+ * the model too little room for text (see `tokens`, `limit`).
3294
+ * @export
3295
+ */
3296
+ declare const FieldErrorCode: {
3297
+ readonly missing: "missing";
3298
+ readonly wrong_type: "wrong_type";
3299
+ readonly too_short: "too_short";
3300
+ readonly too_long: "too_long";
3301
+ readonly too_large: "too_large";
3302
+ readonly too_few: "too_few";
3303
+ readonly too_many: "too_many";
3304
+ readonly out_of_range: "out_of_range";
3305
+ readonly blank: "blank";
3306
+ readonly unknown_type: "unknown_type";
3307
+ readonly invalid_pattern: "invalid_pattern";
3308
+ readonly invalid_key: "invalid_key";
3309
+ readonly labels_over_budget: "labels_over_budget";
3310
+ };
3311
+ type FieldErrorCode = typeof FieldErrorCode[keyof typeof FieldErrorCode];
3312
+ declare function instanceOfFieldErrorCode(value: any): boolean;
3313
+ declare function FieldErrorCodeFromJSON(json: any): FieldErrorCode;
3314
+ declare function FieldErrorCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldErrorCode;
3315
+ declare function FieldErrorCodeToJSON(value?: FieldErrorCode | null): any;
3316
+ declare function FieldErrorCodeToJSONTyped(value: any, ignoreDiscriminator: boolean): FieldErrorCode;
3317
+ //#endregion
3318
+ //#region src/models/FieldError.d.ts
3319
+ /**
3320
+ * One refused field.
802
3321
  * @export
803
- * @interface ValidationError
3322
+ * @interface FieldError
804
3323
  */
805
- interface ValidationError {
3324
+ interface FieldError {
806
3325
  /**
807
- *
808
- * @type {Array<ValidationErrorLocInner>}
809
- * @memberof ValidationError
3326
+ * Where in the request body: field names and list indices. Empty for the body itself.
3327
+ * @type {Array<FieldErrorPathInner>}
3328
+ * @memberof FieldError
810
3329
  */
811
- loc: Array<ValidationErrorLocInner>;
3330
+ path: Array<FieldErrorPathInner>;
812
3331
  /**
813
3332
  *
3333
+ * @type {FieldErrorCode}
3334
+ * @memberof FieldError
3335
+ */
3336
+ code: FieldErrorCode;
3337
+ /**
3338
+ * What is wrong, in English.
814
3339
  * @type {string}
815
- * @memberof ValidationError
3340
+ * @memberof FieldError
816
3341
  */
817
- msg: string;
3342
+ message: string;
818
3343
  /**
819
- *
3344
+ * The bound a size refusal holds to.
3345
+ * @type {number}
3346
+ * @memberof FieldError
3347
+ */
3348
+ limit?: number;
3349
+ /**
3350
+ * The lowest value accepted.
3351
+ * @type {number}
3352
+ * @memberof FieldError
3353
+ */
3354
+ min?: number;
3355
+ /**
3356
+ * The highest value accepted.
3357
+ * @type {number}
3358
+ * @memberof FieldError
3359
+ */
3360
+ max?: number;
3361
+ /**
3362
+ * The JSON type expected: string, number, integer, boolean, array or object.
820
3363
  * @type {string}
821
- * @memberof ValidationError
3364
+ * @memberof FieldError
822
3365
  */
823
- type: string;
3366
+ expected?: string;
824
3367
  /**
825
- *
826
- * @type {any}
827
- * @memberof ValidationError
3368
+ * The values accepted.
3369
+ * @type {Array<string>}
3370
+ * @memberof FieldError
828
3371
  */
829
- input?: any | null;
3372
+ allowed?: Array<string>;
830
3373
  /**
831
- *
832
- * @type {object}
833
- * @memberof ValidationError
3374
+ * Tokens the labels use.
3375
+ * @type {number}
3376
+ * @memberof FieldError
834
3377
  */
835
- ctx?: object;
3378
+ tokens?: number;
836
3379
  }
837
3380
  /**
838
- * Check if a given object implements the ValidationError interface.
3381
+ * Check if a given object implements the FieldError interface.
839
3382
  */
840
- declare function instanceOfValidationError(value: object): value is ValidationError;
841
- declare function ValidationErrorFromJSON(json: any): ValidationError;
842
- declare function ValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidationError;
843
- declare function ValidationErrorToJSON(json: any): ValidationError;
844
- declare function ValidationErrorToJSONTyped(value?: ValidationError | null, ignoreDiscriminator?: boolean): any;
3383
+ declare function instanceOfFieldError(value: object): value is FieldError;
3384
+ declare function FieldErrorFromJSON(json: any): FieldError;
3385
+ declare function FieldErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldError;
3386
+ declare function FieldErrorToJSON(json: any): FieldError;
3387
+ declare function FieldErrorToJSONTyped(value?: FieldError | null, ignoreDiscriminator?: boolean): any;
845
3388
  //#endregion
846
- //#region src/models/HTTPValidationError.d.ts
3389
+ //#region src/models/ErrorInfo.d.ts
847
3390
  /**
848
- *
3391
+ * The error itself.
849
3392
  * @export
850
- * @interface HTTPValidationError
3393
+ * @interface ErrorInfo
851
3394
  */
852
- interface HTTPValidationError {
3395
+ interface ErrorInfo {
853
3396
  /**
854
3397
  *
855
- * @type {Array<ValidationError>}
856
- * @memberof HTTPValidationError
3398
+ * @type {ErrorCode}
3399
+ * @memberof ErrorInfo
3400
+ */
3401
+ code: ErrorCode;
3402
+ /**
3403
+ * What went wrong, in English.
3404
+ * @type {string}
3405
+ * @memberof ErrorInfo
857
3406
  */
858
- detail?: Array<ValidationError>;
3407
+ message: string;
3408
+ /**
3409
+ * The refused fields, for `invalid_request`.
3410
+ * @type {Array<FieldError>}
3411
+ * @memberof ErrorInfo
3412
+ */
3413
+ details?: Array<FieldError>;
859
3414
  }
860
3415
  /**
861
- * Check if a given object implements the HTTPValidationError interface.
3416
+ * Check if a given object implements the ErrorInfo interface.
862
3417
  */
863
- declare function instanceOfHTTPValidationError(value: object): value is HTTPValidationError;
864
- declare function HTTPValidationErrorFromJSON(json: any): HTTPValidationError;
865
- declare function HTTPValidationErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): HTTPValidationError;
866
- declare function HTTPValidationErrorToJSON(json: any): HTTPValidationError;
867
- declare function HTTPValidationErrorToJSONTyped(value?: HTTPValidationError | null, ignoreDiscriminator?: boolean): any;
3418
+ declare function instanceOfErrorInfo(value: object): value is ErrorInfo;
3419
+ declare function ErrorInfoFromJSON(json: any): ErrorInfo;
3420
+ declare function ErrorInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorInfo;
3421
+ declare function ErrorInfoToJSON(json: any): ErrorInfo;
3422
+ declare function ErrorInfoToJSONTyped(value?: ErrorInfo | null, ignoreDiscriminator?: boolean): any;
868
3423
  //#endregion
869
3424
  //#region src/models/PolicySummary.d.ts
870
3425
  /**
871
3426
  * Sensitive Data Protection API
872
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3427
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
873
3428
  *
874
3429
  * The version of the OpenAPI document: 0.1.0
875
3430
  *
@@ -947,67 +3502,33 @@ declare function ListPolicies200ResponseFromJSONTyped(json: any, ignoreDiscrimin
947
3502
  declare function ListPolicies200ResponseToJSON(json: any): ListPolicies200Response;
948
3503
  declare function ListPolicies200ResponseToJSONTyped(value?: ListPolicies200Response | null, ignoreDiscriminator?: boolean): any;
949
3504
  //#endregion
950
- //#region src/models/MaskRule.d.ts
3505
+ //#region src/models/ModelError.d.ts
951
3506
  /**
952
- * Mask part of each matched value with a repeated character.
953
- *
954
- * By default the whole value is masked; set ``chars_to_mask`` to mask only a
955
- * portion, and ``from_end`` to mask the trailing characters instead of leading.
3507
+ * Every error response's body.
956
3508
  * @export
957
- * @interface MaskRule
3509
+ * @interface ModelError
958
3510
  */
959
- interface MaskRule {
960
- /**
961
- *
962
- * @type {string}
963
- * @memberof MaskRule
964
- */
965
- type?: MaskRuleTypeEnum;
966
- /**
967
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
968
- * @type {Array<DetectRuleEntitiesInner>}
969
- * @memberof MaskRule
970
- */
971
- entities: Array<DetectRuleEntitiesInner>;
972
- /**
973
- * The character used to mask, e.g. '*'.
974
- * @type {string}
975
- * @memberof MaskRule
976
- */
977
- masking_char?: string;
3511
+ interface ModelError {
978
3512
  /**
979
3513
  *
980
- * @type {number}
981
- * @memberof MaskRule
982
- */
983
- chars_to_mask?: number | null;
984
- /**
985
- * If true, mask the last N characters instead of the first N.
986
- * @type {boolean}
987
- * @memberof MaskRule
3514
+ * @type {ErrorInfo}
3515
+ * @memberof ModelError
988
3516
  */
989
- from_end?: boolean;
3517
+ error: ErrorInfo;
990
3518
  }
991
3519
  /**
992
- * @export
993
- */
994
- declare const MaskRuleTypeEnum: {
995
- readonly mask: "mask";
996
- };
997
- type MaskRuleTypeEnum = typeof MaskRuleTypeEnum[keyof typeof MaskRuleTypeEnum];
998
- /**
999
- * Check if a given object implements the MaskRule interface.
3520
+ * Check if a given object implements the ModelError interface.
1000
3521
  */
1001
- declare function instanceOfMaskRule(value: object): value is MaskRule;
1002
- declare function MaskRuleFromJSON(json: any): MaskRule;
1003
- declare function MaskRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): MaskRule;
1004
- declare function MaskRuleToJSON(json: any): MaskRule;
1005
- declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminator?: boolean): any;
3522
+ declare function instanceOfModelError(value: object): value is ModelError;
3523
+ declare function ModelErrorFromJSON(json: any): ModelError;
3524
+ declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError;
3525
+ declare function ModelErrorToJSON(json: any): ModelError;
3526
+ declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any;
1006
3527
  //#endregion
1007
- //#region src/models/ModelEntity.d.ts
3528
+ //#region src/models/ModelType.d.ts
1008
3529
  /**
1009
3530
  * Sensitive Data Protection API
1010
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3531
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1011
3532
  *
1012
3533
  * The version of the OpenAPI document: 0.1.0
1013
3534
  *
@@ -1017,142 +3538,68 @@ declare function MaskRuleToJSONTyped(value?: MaskRule | null, ignoreDiscriminato
1017
3538
  * Do not edit the class manually.
1018
3539
  */
1019
3540
  /**
1020
- * An AI-model entity type to target, e.g. 'person', 'email', 'phone_number'.
1021
- * @export
1022
- * @interface ModelEntity
1023
- */
1024
- interface ModelEntity {
1025
- /**
1026
- *
1027
- * @type {string}
1028
- * @memberof ModelEntity
1029
- */
1030
- type?: ModelEntityTypeEnum;
1031
- /**
1032
- * The model entity type name, e.g. 'person'.
1033
- * @type {string}
1034
- * @memberof ModelEntity
1035
- */
1036
- value: string;
1037
- }
1038
- /**
3541
+ * @type ModelType
3542
+ * What a model reads.
1039
3543
  * @export
1040
3544
  */
1041
- declare const ModelEntityTypeEnum: {
1042
- readonly model: "model";
1043
- };
1044
- type ModelEntityTypeEnum = typeof ModelEntityTypeEnum[keyof typeof ModelEntityTypeEnum];
1045
- /**
1046
- * Check if a given object implements the ModelEntity interface.
1047
- */
1048
- declare function instanceOfModelEntity(value: object): value is ModelEntity;
1049
- declare function ModelEntityFromJSON(json: any): ModelEntity;
1050
- declare function ModelEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelEntity;
1051
- declare function ModelEntityToJSON(json: any): ModelEntity;
1052
- declare function ModelEntityToJSONTyped(value?: ModelEntity | null, ignoreDiscriminator?: boolean): any;
3545
+ type ModelType = string;
3546
+ declare function ModelTypeFromJSON(json: any): ModelType;
3547
+ declare function ModelTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelType;
3548
+ declare function ModelTypeToJSON(json: any): any;
3549
+ declare function ModelTypeToJSONTyped(value?: ModelType | null, ignoreDiscriminator?: boolean): any;
1053
3550
  //#endregion
1054
- //#region src/models/ModelError.d.ts
3551
+ //#region src/models/ModelStatus.d.ts
1055
3552
  /**
1056
- * Sensitive Data Protection API
1057
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
1058
- *
1059
- * The version of the OpenAPI document: 0.1.0
1060
- *
1061
- *
1062
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1063
- * https://openapi-generator.tech
1064
- * Do not edit the class manually.
1065
- */
1066
- /**
1067
- *
3553
+ * One model the server offers.
1068
3554
  * @export
1069
- * @interface ModelError
3555
+ * @interface ModelStatus
1070
3556
  */
1071
- interface ModelError {
3557
+ interface ModelStatus {
1072
3558
  /**
1073
- *
3559
+ * What a request names it by, in `models`.
1074
3560
  * @type {string}
1075
- * @memberof ModelError
3561
+ * @memberof ModelStatus
1076
3562
  */
1077
- error: string;
3563
+ id: string;
1078
3564
  /**
1079
- * Present on anonymous refusals: an account lifts the limit.
1080
- * @type {boolean}
1081
- * @memberof ModelError
3565
+ * What it reads: `text` or `image`.
3566
+ * @type {ModelType}
3567
+ * @memberof ModelStatus
1082
3568
  */
1083
- signup?: boolean;
1084
- }
1085
- /**
1086
- * Check if a given object implements the ModelError interface.
1087
- */
1088
- declare function instanceOfModelError(value: object): value is ModelError;
1089
- declare function ModelErrorFromJSON(json: any): ModelError;
1090
- declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError;
1091
- declare function ModelErrorToJSON(json: any): ModelError;
1092
- declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any;
1093
- //#endregion
1094
- //#region src/models/ModelResult.d.ts
1095
- /**
1096
- * Record of an AI model detection and its anonymization.
1097
- *
1098
- * Created when an AI model identifies an entity (e.g. person, email)
1099
- * and a rule anonymizes the matched text.
1100
- * @export
1101
- * @interface ModelResult
1102
- */
1103
- interface ModelResult {
3569
+ type: ModelType;
1104
3570
  /**
1105
- *
1106
- * @type {string}
1107
- * @memberof ModelResult
3571
+ * What a request naming no model of this type runs on now: the first ready (largest first), else the first. One per type.
3572
+ * @type {boolean}
3573
+ * @memberof ModelStatus
1108
3574
  */
1109
- type?: ModelResultTypeEnum;
3575
+ _default: boolean;
1110
3576
  /**
1111
- * The rule type that was applied, e.g. 'replace', 'mask'.
1112
- * @type {string}
1113
- * @memberof ModelResult
3577
+ * Loaded.
3578
+ * @type {boolean}
3579
+ * @memberof ModelStatus
1114
3580
  */
1115
- rule: string;
3581
+ ready: boolean;
1116
3582
  /**
1117
- * The model entity type that matched, e.g. 'person'.
3583
+ *
1118
3584
  * @type {string}
1119
- * @memberof ModelResult
1120
- */
1121
- value: string;
1122
- /**
1123
- * The detected range in the original text.
1124
- * @type {TextRange}
1125
- * @memberof ModelResult
1126
- */
1127
- input: TextRange;
1128
- /**
1129
- * The anonymized range in the result text.
1130
- * @type {TextRange}
1131
- * @memberof ModelResult
1132
- */
1133
- output: TextRange;
1134
- /**
1135
- * Confidence score from the AI model (0.0–1.0).
1136
- * @type {number}
1137
- * @memberof ModelResult
3585
+ * @memberof ModelStatus
1138
3586
  */
1139
- score?: number;
1140
- }
1141
- /**
1142
- * @export
1143
- */
1144
- declare const ModelResultTypeEnum: {
1145
- readonly model: "model";
1146
- };
1147
- type ModelResultTypeEnum = typeof ModelResultTypeEnum[keyof typeof ModelResultTypeEnum];
3587
+ description?: string | null;
3588
+ /**
3589
+ *
3590
+ * @type {string}
3591
+ * @memberof ModelStatus
3592
+ */
3593
+ error?: string | null;
3594
+ }
1148
3595
  /**
1149
- * Check if a given object implements the ModelResult interface.
3596
+ * Check if a given object implements the ModelStatus interface.
1150
3597
  */
1151
- declare function instanceOfModelResult(value: object): value is ModelResult;
1152
- declare function ModelResultFromJSON(json: any): ModelResult;
1153
- declare function ModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelResult;
1154
- declare function ModelResultToJSON(json: any): ModelResult;
1155
- declare function ModelResultToJSONTyped(value?: ModelResult | null, ignoreDiscriminator?: boolean): any;
3598
+ declare function instanceOfModelStatus(value: object): value is ModelStatus;
3599
+ declare function ModelStatusFromJSON(json: any): ModelStatus;
3600
+ declare function ModelStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelStatus;
3601
+ declare function ModelStatusToJSON(json: any): ModelStatus;
3602
+ declare function ModelStatusToJSONTyped(value?: ModelStatus | null, ignoreDiscriminator?: boolean): any;
1156
3603
  //#endregion
1157
3604
  //#region src/models/Policy.d.ts
1158
3605
  /**
@@ -1207,46 +3654,10 @@ declare function PolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
1207
3654
  declare function PolicyToJSON(json: any): Policy;
1208
3655
  declare function PolicyToJSONTyped(value?: Policy | null, ignoreDiscriminator?: boolean): any;
1209
3656
  //#endregion
1210
- //#region src/models/RedactRule.d.ts
1211
- /**
1212
- * Remove each matched value entirely (replace with an empty string).
1213
- * @export
1214
- * @interface RedactRule
1215
- */
1216
- interface RedactRule {
1217
- /**
1218
- *
1219
- * @type {string}
1220
- * @memberof RedactRule
1221
- */
1222
- type?: RedactRuleTypeEnum;
1223
- /**
1224
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
1225
- * @type {Array<DetectRuleEntitiesInner>}
1226
- * @memberof RedactRule
1227
- */
1228
- entities: Array<DetectRuleEntitiesInner>;
1229
- }
1230
- /**
1231
- * @export
1232
- */
1233
- declare const RedactRuleTypeEnum: {
1234
- readonly redact: "redact";
1235
- };
1236
- type RedactRuleTypeEnum = typeof RedactRuleTypeEnum[keyof typeof RedactRuleTypeEnum];
1237
- /**
1238
- * Check if a given object implements the RedactRule interface.
1239
- */
1240
- declare function instanceOfRedactRule(value: object): value is RedactRule;
1241
- declare function RedactRuleFromJSON(json: any): RedactRule;
1242
- declare function RedactRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): RedactRule;
1243
- declare function RedactRuleToJSON(json: any): RedactRule;
1244
- declare function RedactRuleToJSONTyped(value?: RedactRule | null, ignoreDiscriminator?: boolean): any;
1245
- //#endregion
1246
- //#region src/models/RegexEntity.d.ts
3657
+ //#region src/models/Refusal.d.ts
1247
3658
  /**
1248
3659
  * Sensitive Data Protection API
1249
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3660
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1250
3661
  *
1251
3662
  * The version of the OpenAPI document: 0.1.0
1252
3663
  *
@@ -1256,215 +3667,37 @@ declare function RedactRuleToJSONTyped(value?: RedactRule | null, ignoreDiscrimi
1256
3667
  * Do not edit the class manually.
1257
3668
  */
1258
3669
  /**
1259
- * A regex pattern to target, e.g. a custom ID or date format.
1260
- * @export
1261
- * @interface RegexEntity
1262
- */
1263
- interface RegexEntity {
1264
- /**
1265
- *
1266
- * @type {string}
1267
- * @memberof RegexEntity
1268
- */
1269
- type?: RegexEntityTypeEnum;
1270
- /**
1271
- * The regular expression to match.
1272
- * @type {string}
1273
- * @memberof RegexEntity
1274
- */
1275
- value: string;
1276
- }
1277
- /**
1278
- * @export
1279
- */
1280
- declare const RegexEntityTypeEnum: {
1281
- readonly regex: "regex";
1282
- };
1283
- type RegexEntityTypeEnum = typeof RegexEntityTypeEnum[keyof typeof RegexEntityTypeEnum];
1284
- /**
1285
- * Check if a given object implements the RegexEntity interface.
1286
- */
1287
- declare function instanceOfRegexEntity(value: object): value is RegexEntity;
1288
- declare function RegexEntityFromJSON(json: any): RegexEntity;
1289
- declare function RegexEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexEntity;
1290
- declare function RegexEntityToJSON(json: any): RegexEntity;
1291
- declare function RegexEntityToJSONTyped(value?: RegexEntity | null, ignoreDiscriminator?: boolean): any;
1292
- //#endregion
1293
- //#region src/models/RegexResult.d.ts
1294
- /**
1295
- * Record of a regex detection and its anonymization.
1296
3670
  *
1297
- * Created when a regex pattern matches text
1298
- * and a rule anonymizes the matched text.
1299
- * @export
1300
- * @interface RegexResult
1301
- */
1302
- interface RegexResult {
1303
- /**
1304
- *
1305
- * @type {string}
1306
- * @memberof RegexResult
1307
- */
1308
- type?: RegexResultTypeEnum;
1309
- /**
1310
- * The rule type that was applied, e.g. 'replace', 'mask'.
1311
- * @type {string}
1312
- * @memberof RegexResult
1313
- */
1314
- rule: string;
1315
- /**
1316
- * The regex pattern that matched.
1317
- * @type {string}
1318
- * @memberof RegexResult
1319
- */
1320
- value: string;
1321
- /**
1322
- * The detected range in the original text.
1323
- * @type {TextRange}
1324
- * @memberof RegexResult
1325
- */
1326
- input: TextRange;
1327
- /**
1328
- * The anonymized range in the result text.
1329
- * @type {TextRange}
1330
- * @memberof RegexResult
1331
- */
1332
- output: TextRange;
1333
- }
1334
- /**
1335
- * @export
1336
- */
1337
- declare const RegexResultTypeEnum: {
1338
- readonly regex: "regex";
1339
- };
1340
- type RegexResultTypeEnum = typeof RegexResultTypeEnum[keyof typeof RegexResultTypeEnum];
1341
- /**
1342
- * Check if a given object implements the RegexResult interface.
1343
- */
1344
- declare function instanceOfRegexResult(value: object): value is RegexResult;
1345
- declare function RegexResultFromJSON(json: any): RegexResult;
1346
- declare function RegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexResult;
1347
- declare function RegexResultToJSON(json: any): RegexResult;
1348
- declare function RegexResultToJSONTyped(value?: RegexResult | null, ignoreDiscriminator?: boolean): any;
1349
- //#endregion
1350
- //#region src/models/ReplaceRule.d.ts
1351
- /**
1352
- * Replace each matched value with a fixed string (default '****').
1353
- * @export
1354
- * @interface ReplaceRule
1355
- */
1356
- interface ReplaceRule {
1357
- /**
1358
- *
1359
- * @type {string}
1360
- * @memberof ReplaceRule
1361
- */
1362
- type?: ReplaceRuleTypeEnum;
1363
- /**
1364
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
1365
- * @type {Array<DetectRuleEntitiesInner>}
1366
- * @memberof ReplaceRule
1367
- */
1368
- entities: Array<DetectRuleEntitiesInner>;
1369
- /**
1370
- * The fixed string to substitute for each match.
1371
- * @type {string}
1372
- * @memberof ReplaceRule
1373
- */
1374
- replacement?: string;
1375
- }
1376
- /**
1377
- * @export
1378
- */
1379
- declare const ReplaceRuleTypeEnum: {
1380
- readonly replace: "replace";
1381
- };
1382
- type ReplaceRuleTypeEnum = typeof ReplaceRuleTypeEnum[keyof typeof ReplaceRuleTypeEnum];
1383
- /**
1384
- * Check if a given object implements the ReplaceRule interface.
1385
- */
1386
- declare function instanceOfReplaceRule(value: object): value is ReplaceRule;
1387
- declare function ReplaceRuleFromJSON(json: any): ReplaceRule;
1388
- declare function ReplaceRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReplaceRule;
1389
- declare function ReplaceRuleToJSON(json: any): ReplaceRule;
1390
- declare function ReplaceRuleToJSONTyped(value?: ReplaceRule | null, ignoreDiscriminator?: boolean): any;
1391
- //#endregion
1392
- //#region src/models/SHA256Rule.d.ts
1393
- /**
1394
- * Replace each matched value with its SHA-256 hex digest.
1395
- * @export
1396
- * @interface SHA256Rule
1397
- */
1398
- interface SHA256Rule {
1399
- /**
1400
- *
1401
- * @type {string}
1402
- * @memberof SHA256Rule
1403
- */
1404
- type?: SHA256RuleTypeEnum;
1405
- /**
1406
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
1407
- * @type {Array<DetectRuleEntitiesInner>}
1408
- * @memberof SHA256Rule
1409
- */
1410
- entities: Array<DetectRuleEntitiesInner>;
1411
- }
1412
- /**
1413
- * @export
1414
- */
1415
- declare const SHA256RuleTypeEnum: {
1416
- readonly sha256: "sha256";
1417
- };
1418
- type SHA256RuleTypeEnum = typeof SHA256RuleTypeEnum[keyof typeof SHA256RuleTypeEnum];
1419
- /**
1420
- * Check if a given object implements the SHA256Rule interface.
1421
- */
1422
- declare function instanceOfSHA256Rule(value: object): value is SHA256Rule;
1423
- declare function SHA256RuleFromJSON(json: any): SHA256Rule;
1424
- declare function SHA256RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA256Rule;
1425
- declare function SHA256RuleToJSON(json: any): SHA256Rule;
1426
- declare function SHA256RuleToJSONTyped(value?: SHA256Rule | null, ignoreDiscriminator?: boolean): any;
1427
- //#endregion
1428
- //#region src/models/SHA512Rule.d.ts
1429
- /**
1430
- * Replace each matched value with its SHA-512 hex digest.
1431
3671
  * @export
1432
- * @interface SHA512Rule
3672
+ * @interface Refusal
1433
3673
  */
1434
- interface SHA512Rule {
3674
+ interface Refusal {
1435
3675
  /**
1436
3676
  *
1437
3677
  * @type {string}
1438
- * @memberof SHA512Rule
3678
+ * @memberof Refusal
1439
3679
  */
1440
- type?: SHA512RuleTypeEnum;
3680
+ error: string;
1441
3681
  /**
1442
- * The entities this rule targets: model entities (e.g. ModelEntity(value='email')) and/or regex entities (e.g. RegexEntity(value='\d{4}-\d{2}-\d{2}')).
1443
- * @type {Array<DetectRuleEntitiesInner>}
1444
- * @memberof SHA512Rule
3682
+ * Present on anonymous refusals: an account lifts the limit.
3683
+ * @type {boolean}
3684
+ * @memberof Refusal
1445
3685
  */
1446
- entities: Array<DetectRuleEntitiesInner>;
3686
+ signup?: boolean;
1447
3687
  }
1448
3688
  /**
1449
- * @export
1450
- */
1451
- declare const SHA512RuleTypeEnum: {
1452
- readonly sha512: "sha512";
1453
- };
1454
- type SHA512RuleTypeEnum = typeof SHA512RuleTypeEnum[keyof typeof SHA512RuleTypeEnum];
1455
- /**
1456
- * Check if a given object implements the SHA512Rule interface.
3689
+ * Check if a given object implements the Refusal interface.
1457
3690
  */
1458
- declare function instanceOfSHA512Rule(value: object): value is SHA512Rule;
1459
- declare function SHA512RuleFromJSON(json: any): SHA512Rule;
1460
- declare function SHA512RuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): SHA512Rule;
1461
- declare function SHA512RuleToJSON(json: any): SHA512Rule;
1462
- declare function SHA512RuleToJSONTyped(value?: SHA512Rule | null, ignoreDiscriminator?: boolean): any;
3691
+ declare function instanceOfRefusal(value: object): value is Refusal;
3692
+ declare function RefusalFromJSON(json: any): Refusal;
3693
+ declare function RefusalFromJSONTyped(json: any, ignoreDiscriminator: boolean): Refusal;
3694
+ declare function RefusalToJSON(json: any): Refusal;
3695
+ declare function RefusalToJSONTyped(value?: Refusal | null, ignoreDiscriminator?: boolean): any;
1463
3696
  //#endregion
1464
3697
  //#region src/models/ScanRequestBody.d.ts
1465
3698
  /**
1466
3699
  * Sensitive Data Protection API
1467
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3700
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1468
3701
  *
1469
3702
  * The version of the OpenAPI document: 0.1.0
1470
3703
  *
@@ -1504,6 +3737,12 @@ interface ScanRequestBody {
1504
3737
  * @memberof ScanRequestBody
1505
3738
  */
1506
3739
  confidence_threshold?: number | null;
3740
+ /**
3741
+ *
3742
+ * @type {Array<string>}
3743
+ * @memberof ScanRequestBody
3744
+ */
3745
+ models?: Array<string> | null;
1507
3746
  }
1508
3747
  /**
1509
3748
  * Check if a given object implements the ScanRequestBody interface.
@@ -1517,7 +3756,7 @@ declare function ScanRequestBodyToJSONTyped(value?: ScanRequestBody | null, igno
1517
3756
  //#region src/models/ScanResult.d.ts
1518
3757
  /**
1519
3758
  * Sensitive Data Protection API
1520
- * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, hash, or encrypt).
3759
+ * Detect and de-identify sensitive data (PII) in text. Use `scan` to locate sensitive entities such as emails, phone numbers, and names, and `anonymize` to transform them using configurable rules (redact, mask, replace, pseudonymize, hash, or encrypt).
1521
3760
  *
1522
3761
  * The version of the OpenAPI document: 0.1.0
1523
3762
  *
@@ -1586,6 +3825,12 @@ interface ScanResponseBody {
1586
3825
  * @memberof ScanResponseBody
1587
3826
  */
1588
3827
  usage: Usage;
3828
+ /**
3829
+ * The text model that ran, as `[id]` with the id from `GET /models`.
3830
+ * @type {Array<string>}
3831
+ * @memberof ScanResponseBody
3832
+ */
3833
+ models: Array<string>;
1589
3834
  }
1590
3835
  /**
1591
3836
  * Check if a given object implements the ScanResponseBody interface.
@@ -1686,6 +3931,15 @@ declare class PoliciesApi extends BaseAPI {
1686
3931
  }
1687
3932
  //#endregion
1688
3933
  //#region src/apis/SensitiveDataProtectionApi.d.ts
3934
+ interface AnonymizeFileRequest {
3935
+ file: Blob;
3936
+ rules?: string;
3937
+ confidence_threshold?: number;
3938
+ embedded_rules?: AnonymizeFileEmbeddedRulesEnum;
3939
+ table_headers?: AnonymizeFileTableHeadersEnum;
3940
+ models?: string;
3941
+ dicom_options?: string;
3942
+ }
1689
3943
  interface AnonymizeTextRequest {
1690
3944
  AnonymizeRequestBody: AnonymizeRequestBody;
1691
3945
  }
@@ -1697,12 +3951,22 @@ interface ScanTextRequest {
1697
3951
  */
1698
3952
  declare class SensitiveDataProtectionApi extends BaseAPI {
1699
3953
  /**
1700
- * Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
3954
+ * Anonymize sensitive data in a file. Reads the file\'s text (Office parts, cells, lines), applies the rules as `/anonymize` does, and returns the file in its own format with every change made: each value found, with where it is (`path`), and each part removed. With `Accept: application/x-ndjson`, answers with one JSON event per line: `start`, a `batch` per step of reading, then `done` (the same body) or `error`. An Office file\'s images and kept embedded files are read as files of their own beside its text: each has `task` events (queued, started, then done, stopped or failed), and its own `start` and `batch` events carry its `task` path.
3955
+ * Anonymize File
3956
+ */
3957
+ anonymizeFileRaw(requestParameters: AnonymizeFileRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AnonymizeFileResponseBody>>;
3958
+ /**
3959
+ * Anonymize sensitive data in a file. Reads the file\'s text (Office parts, cells, lines), applies the rules as `/anonymize` does, and returns the file in its own format with every change made: each value found, with where it is (`path`), and each part removed. With `Accept: application/x-ndjson`, answers with one JSON event per line: `start`, a `batch` per step of reading, then `done` (the same body) or `error`. An Office file\'s images and kept embedded files are read as files of their own beside its text: each has `task` events (queued, started, then done, stopped or failed), and its own `start` and `batch` events carry its `task` path.
3960
+ * Anonymize File
3961
+ */
3962
+ anonymizeFile(file: Blob, rules?: string, confidence_threshold?: number, embedded_rules?: AnonymizeFileEmbeddedRulesEnum, table_headers?: AnonymizeFileTableHeadersEnum, models?: string, dicom_options?: string, initOverrides?: RequestInit | InitOverrideFunction): Promise<AnonymizeFileResponseBody>;
3963
+ /**
3964
+ * Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, pseudonymize, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
1701
3965
  * Anonymize Text
1702
3966
  */
1703
3967
  anonymizeTextRaw(requestParameters: AnonymizeTextRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<AnonymizeResponseBody>>;
1704
3968
  /**
1705
- * Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
3969
+ * Anonymize sensitive data in text. Scans the request text for the entities targeted by each supplied rule and applies that rule\'s operation (replace, redact, mask, pseudonymize, hash, or encrypt) to every match. Returns the anonymized text together with a record of each transformation, including the original and resulting character ranges.
1706
3970
  * Anonymize Text
1707
3971
  */
1708
3972
  anonymizeText(AnonymizeRequestBody: AnonymizeRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<AnonymizeResponseBody>;
@@ -1716,6 +3980,16 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
1716
3980
  * Health
1717
3981
  */
1718
3982
  healthCheck(initOverrides?: RequestInit | InitOverrideFunction): Promise<string>;
3983
+ /**
3984
+ * The models this server offers: text models (`type: text`, run on every request), then image readers (`type: image`, read a file\'s images), each type largest first. A request lists ids in `models`, each type\'s in order of preference: of each type, the first `ready` runs. If none of a type it names is ready, it is refused with a 503, with `Retry-After` while one still loads. A type it names none of runs on its `default`: the first `ready`, largest first (so `default` moves as models load); at startup, before any is ready, the request waits for the first to load. An unknown id is a 422.
3985
+ * List Models
3986
+ */
3987
+ listModelsRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Array<ModelStatus>>>;
3988
+ /**
3989
+ * The models this server offers: text models (`type: text`, run on every request), then image readers (`type: image`, read a file\'s images), each type largest first. A request lists ids in `models`, each type\'s in order of preference: of each type, the first `ready` runs. If none of a type it names is ready, it is refused with a 503, with `Retry-After` while one still loads. A type it names none of runs on its `default`: the first `ready`, largest first (so `default` moves as models load); at startup, before any is ready, the request waits for the first to load. An unknown id is a 422.
3990
+ * List Models
3991
+ */
3992
+ listModels(initOverrides?: RequestInit | InitOverrideFunction): Promise<Array<ModelStatus>>;
1719
3993
  /**
1720
3994
  * Scan text for sensitive data. Runs the configured detection entities over the request text and returns every match as a character range with its entity type and confidence score. Detections below the confidence threshold are omitted.
1721
3995
  * Scan Text
@@ -1727,5 +4001,25 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
1727
4001
  */
1728
4002
  scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
1729
4003
  }
4004
+ /**
4005
+ * @export
4006
+ */
4007
+ declare const AnonymizeFileEmbeddedRulesEnum: {
4008
+ readonly anonymize: "anonymize";
4009
+ readonly anonymize_or_keep: "anonymize_or_keep";
4010
+ readonly remove: "remove";
4011
+ readonly keep: "keep";
4012
+ };
4013
+ type AnonymizeFileEmbeddedRulesEnum = typeof AnonymizeFileEmbeddedRulesEnum[keyof typeof AnonymizeFileEmbeddedRulesEnum];
4014
+ /**
4015
+ * @export
4016
+ */
4017
+ declare const AnonymizeFileTableHeadersEnum: {
4018
+ readonly none: "none";
4019
+ readonly first_row: "first_row";
4020
+ readonly first_column: "first_column";
4021
+ readonly last_column: "last_column";
4022
+ };
4023
+ type AnonymizeFileTableHeadersEnum = typeof AnonymizeFileTableHeadersEnum[keyof typeof AnonymizeFileTableHeadersEnum];
1730
4024
  //#endregion
1731
- export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyRulesInnerTypeEnum, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyResultsInner, AnonymizeResponseBodyResultsInnerFromJSON, AnonymizeResponseBodyResultsInnerFromJSONTyped, AnonymizeResponseBodyResultsInnerToJSON, AnonymizeResponseBodyResultsInnerToJSONTyped, AnonymizeResponseBodyResultsInnerTypeEnum, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleEntitiesInner, DetectRuleEntitiesInnerFromJSON, DetectRuleEntitiesInnerFromJSONTyped, DetectRuleEntitiesInnerToJSON, DetectRuleEntitiesInnerToJSONTyped, DetectRuleEntitiesInnerTypeEnum, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, ErrorContext, FetchAPI, FetchError, FetchParams, GetPolicyRequest, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelError, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentRulesInnerTypeEnum, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SensitiveDataProtectionApi, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeRequestBodyRulesInner, instanceOfAnonymizeResponseBody, instanceOfAnonymizeResponseBodyResultsInner, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfDetectRuleEntitiesInner, instanceOfEncryptRule, instanceOfHTTPValidationError, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelError, instanceOfModelResult, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicyDocumentRulesInner, instanceOfPolicySummary, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfUpdatePolicyRequest, instanceOfUsage, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
4025
+ export { Action, ActionFromJSON, ActionFromJSONTyped, ActionToJSON, ActionToJSONTyped, AnonymizeFileEmbeddedRulesEnum, AnonymizeFileRequest, AnonymizeFileResponseBody, AnonymizeFileResponseBodyFromJSON, AnonymizeFileResponseBodyFromJSONTyped, AnonymizeFileResponseBodyToJSON, AnonymizeFileResponseBodyToJSONTyped, AnonymizeFileTableHeadersEnum, AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, Applied, AppliedFromJSON, AppliedFromJSONTyped, AppliedToJSON, AppliedToJSONTyped, At, AtFromJSON, AtFromJSONTyped, AtToJSON, AtToJSONTyped, AttributeSegment, AttributeSegmentFromJSON, AttributeSegmentFromJSONTyped, AttributeSegmentToJSON, AttributeSegmentToJSONTyped, AttributeSegmentTypeEnum, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, CellKind, CellKindFromJSON, CellKindFromJSONTyped, CellKindToJSON, CellKindToJSONTyped, CellNoteSegment, CellNoteSegmentFromJSON, CellNoteSegmentFromJSONTyped, CellNoteSegmentToJSON, CellNoteSegmentToJSONTyped, CellNoteSegmentTypeEnum, CellSegment, CellSegmentFromJSON, CellSegmentFromJSONTyped, CellSegmentToJSON, CellSegmentToJSONTyped, CellSegmentTypeEnum, CommentKind, CommentKindFromJSON, CommentKindFromJSONTyped, CommentKindToJSON, CommentKindToJSONTyped, CommentSegment, CommentSegmentFromJSON, CommentSegmentFromJSONTyped, CommentSegmentToJSON, CommentSegmentToJSONTyped, CommentSegmentTypeEnum, ComponentSegment, ComponentSegmentFromJSON, ComponentSegmentFromJSONTyped, ComponentSegmentToJSON, ComponentSegmentToJSONTyped, ComponentSegmentTypeEnum, Configuration, ConfigurationParameters, Consume, CreatePolicyOperationRequest, CreatePolicyRequest, CreatePolicyRequestFromJSON, CreatePolicyRequestFromJSONTyped, CreatePolicyRequestToJSON, CreatePolicyRequestToJSONTyped, DefaultConfig, DeletePolicyRequest, DetectRule, DetectRuleFromJSON, DetectRuleFromJSONTyped, DetectRuleToJSON, DetectRuleToJSONTyped, DetectRuleTypeEnum, ElementSegment, ElementSegmentFromJSON, ElementSegmentFromJSONTyped, ElementSegmentToJSON, ElementSegmentToJSONTyped, ElementSegmentTypeEnum, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, EndnoteSegment, EndnoteSegmentFromJSON, EndnoteSegmentFromJSONTyped, EndnoteSegmentToJSON, EndnoteSegmentToJSONTyped, EndnoteSegmentTypeEnum, EntityBody, EntityBodyFromJSON, EntityBodyFromJSONTyped, EntityBodyToJSON, EntityBodyToJSONTyped, ErrorCode, ErrorCodeFromJSON, ErrorCodeFromJSONTyped, ErrorCodeToJSON, ErrorCodeToJSONTyped, ErrorContext, ErrorInfo, ErrorInfoFromJSON, ErrorInfoFromJSONTyped, ErrorInfoToJSON, ErrorInfoToJSONTyped, FetchAPI, FetchError, FetchParams, FieldError, FieldErrorCode, FieldErrorCodeFromJSON, FieldErrorCodeFromJSONTyped, FieldErrorCodeToJSON, FieldErrorCodeToJSONTyped, FieldErrorFromJSON, FieldErrorFromJSONTyped, FieldErrorPathInner, FieldErrorPathInnerFromJSON, FieldErrorPathInnerFromJSONTyped, FieldErrorPathInnerToJSON, FieldErrorPathInnerToJSONTyped, FieldErrorToJSON, FieldErrorToJSONTyped, FieldSegment, FieldSegmentFromJSON, FieldSegmentFromJSONTyped, FieldSegmentToJSON, FieldSegmentToJSONTyped, FieldSegmentTypeEnum, FileAttributeResult, FileAttributeResultFromJSON, FileAttributeResultFromJSONTyped, FileAttributeResultToJSON, FileAttributeResultToJSONTyped, FileAttributeResultTypeEnum, FileEmbeddedResult, FileEmbeddedResultFromJSON, FileEmbeddedResultFromJSONTyped, FileEmbeddedResultToJSON, FileEmbeddedResultToJSONTyped, FileEmbeddedResultTypeEnum, FileModelResult, FileModelResultFromJSON, FileModelResultFromJSONTyped, FileModelResultToJSON, FileModelResultToJSONTyped, FileModelResultTypeEnum, FileRegexResult, FileRegexResultFromJSON, FileRegexResultFromJSONTyped, FileRegexResultToJSON, FileRegexResultToJSONTyped, FileRegexResultTypeEnum, FileResult, FileResultFromJSON, FileResultFromJSONTyped, FileResultToJSON, FileResultToJSONTyped, FootnoteSegment, FootnoteSegmentFromJSON, FootnoteSegmentFromJSONTyped, FootnoteSegmentToJSON, FootnoteSegmentToJSONTyped, FootnoteSegmentTypeEnum, FrameSegment, FrameSegmentFromJSON, FrameSegmentFromJSONTyped, FrameSegmentToJSON, FrameSegmentToJSONTyped, FrameSegmentTypeEnum, GetPolicyRequest, HMACRule, HMACRuleFromJSON, HMACRuleFromJSONTyped, HMACRuleToJSON, HMACRuleToJSONTyped, HMACRuleTypeEnum, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HeaderFooterSegment, HeaderFooterSegmentFromJSON, HeaderFooterSegmentFromJSONTyped, HeaderFooterSegmentToJSON, HeaderFooterSegmentToJSONTyped, HeaderFooterSegmentTypeEnum, IndexSegment, IndexSegmentFromJSON, IndexSegmentFromJSONTyped, IndexSegmentToJSON, IndexSegmentToJSONTyped, IndexSegmentTypeEnum, InitOverrideFunction, ItemSegment, ItemSegmentFromJSON, ItemSegmentFromJSONTyped, ItemSegmentToJSON, ItemSegmentToJSONTyped, ItemSegmentTypeEnum, JSONApiResponse, Json, KeySegment, KeySegmentFromJSON, KeySegmentFromJSONTyped, KeySegmentToJSON, KeySegmentToJSONTyped, KeySegmentTypeEnum, Kind, KindFromJSON, KindFromJSONTyped, KindToJSON, KindToJSONTyped, LineSegment, LineSegmentFromJSON, LineSegmentFromJSONTyped, LineSegmentToJSON, LineSegmentToJSONTyped, LineSegmentTypeEnum, ListPolicies200Response, ListPolicies200ResponseFromJSON, ListPolicies200ResponseFromJSONTyped, ListPolicies200ResponseToJSON, ListPolicies200ResponseToJSONTyped, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelError, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, ModelStatus, ModelStatusFromJSON, ModelStatusFromJSONTyped, ModelStatusToJSON, ModelStatusToJSONTyped, ModelType, ModelTypeFromJSON, ModelTypeFromJSONTyped, ModelTypeToJSON, ModelTypeToJSONTyped, ParagraphKind, ParagraphKindFromJSON, ParagraphKindFromJSONTyped, ParagraphKindToJSON, ParagraphKindToJSONTyped, ParagraphSegment, ParagraphSegmentFromJSON, ParagraphSegmentFromJSONTyped, ParagraphSegmentToJSON, ParagraphSegmentToJSONTyped, ParagraphSegmentTypeEnum, PartSegment, PartSegmentFromJSON, PartSegmentFromJSONTyped, PartSegmentToJSON, PartSegmentToJSONTyped, PartSegmentTypeEnum, PathSegment, PathSegmentFromJSON, PathSegmentFromJSONTyped, PathSegmentToJSON, PathSegmentToJSONTyped, PoliciesApi, Policy, PolicyDocument, PolicyDocumentFromJSON, PolicyDocumentFromJSONTyped, PolicyDocumentRulesInner, PolicyDocumentRulesInnerFromJSON, PolicyDocumentRulesInnerFromJSONTyped, PolicyDocumentRulesInnerToJSON, PolicyDocumentRulesInnerToJSONTyped, PolicyDocumentSchemaVersionEnum, PolicyDocumentToJSON, PolicyDocumentToJSONTyped, PolicyFromJSON, PolicyFromJSONTyped, PolicySummary, PolicySummaryFromJSON, PolicySummaryFromJSONTyped, PolicySummaryToJSON, PolicySummaryToJSONTyped, PolicyToJSON, PolicyToJSONTyped, PropertySegment, PropertySegmentFromJSON, PropertySegmentFromJSONTyped, PropertySegmentToJSON, PropertySegmentToJSONTyped, PropertySegmentTypeEnum, PseudonymizeRule, PseudonymizeRuleFromJSON, PseudonymizeRuleFromJSONTyped, PseudonymizeRuleToJSON, PseudonymizeRuleToJSONTyped, PseudonymizeRuleTypeEnum, RangeKind, RangeKindFromJSON, RangeKindFromJSONTyped, RangeKindToJSON, RangeKindToJSONTyped, RangeSegment, RangeSegmentFromJSON, RangeSegmentFromJSONTyped, RangeSegmentToJSON, RangeSegmentToJSONTyped, RangeSegmentTypeEnum, RedactRule, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, Refusal, RefusalFromJSON, RefusalFromJSONTyped, RefusalToJSON, RefusalToJSONTyped, RegexEntity, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResult, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, RegionSegment, RegionSegmentFromJSON, RegionSegmentFromJSONTyped, RegionSegmentToJSON, RegionSegmentToJSONTyped, RegionSegmentTypeEnum, ReplaceRule, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, RuleBody, RuleBodyFromJSON, RuleBodyFromJSONTyped, RuleBodyToJSON, RuleBodyToJSONTyped, SHA256Rule, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512Rule, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBody, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBody, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResult, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, ScanTextRequest, SegmentSegment, SegmentSegmentFromJSON, SegmentSegmentFromJSONTyped, SegmentSegmentToJSON, SegmentSegmentToJSONTyped, SegmentSegmentTypeEnum, SensitiveDataProtectionApi, ShapeKind, ShapeKindFromJSON, ShapeKindFromJSONTyped, ShapeKindToJSON, ShapeKindToJSONTyped, ShapeSegment, ShapeSegmentFromJSON, ShapeSegmentFromJSONTyped, ShapeSegmentToJSON, ShapeSegmentToJSONTyped, ShapeSegmentTypeEnum, SheetSegment, SheetSegmentFromJSON, SheetSegmentFromJSONTyped, SheetSegmentToJSON, SheetSegmentToJSONTyped, SheetSegmentTypeEnum, SlideSegment, SlideSegmentFromJSON, SlideSegmentFromJSONTyped, SlideSegmentToJSON, SlideSegmentToJSONTyped, SlideSegmentTypeEnum, SpeakerNotesSegment, SpeakerNotesSegmentFromJSON, SpeakerNotesSegmentFromJSONTyped, SpeakerNotesSegmentToJSON, SpeakerNotesSegmentToJSONTyped, SpeakerNotesSegmentTypeEnum, TableSegment, TableSegmentFromJSON, TableSegmentFromJSONTyped, TableSegmentToJSON, TableSegmentToJSONTyped, TableSegmentTypeEnum, TagSegment, TagSegmentFromJSON, TagSegmentFromJSONTyped, TagSegmentToJSON, TagSegmentToJSONTyped, TagSegmentTypeEnum, TextApiResponse, TextRange, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, TextSegment, TextSegmentFromJSON, TextSegmentFromJSONTyped, TextSegmentToJSON, TextSegmentToJSONTyped, TextSegmentTypeEnum, UpdatePolicyOperationRequest, UpdatePolicyRequest, UpdatePolicyRequestFromJSON, UpdatePolicyRequestFromJSONTyped, UpdatePolicyRequestToJSON, UpdatePolicyRequestToJSONTyped, Usage, UsageFromJSON, UsageFromJSONTyped, UsageToJSON, UsageToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAction, instanceOfAnonymizeFileResponseBody, instanceOfAnonymizeRequestBody, instanceOfAnonymizeResponseBody, instanceOfAt, instanceOfAttributeSegment, instanceOfCellNoteSegment, instanceOfCellSegment, instanceOfCommentKind, instanceOfCommentSegment, instanceOfComponentSegment, instanceOfCreatePolicyRequest, instanceOfDetectRule, instanceOfElementSegment, instanceOfEncryptRule, instanceOfEndnoteSegment, instanceOfErrorCode, instanceOfErrorInfo, instanceOfFieldError, instanceOfFieldErrorCode, instanceOfFieldErrorPathInner, instanceOfFieldSegment, instanceOfFileAttributeResult, instanceOfFileEmbeddedResult, instanceOfFileModelResult, instanceOfFileRegexResult, instanceOfFootnoteSegment, instanceOfFrameSegment, instanceOfHMACRule, instanceOfHeaderFooterSegment, instanceOfIndexSegment, instanceOfItemSegment, instanceOfKeySegment, instanceOfLineSegment, instanceOfListPolicies200Response, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelError, instanceOfModelResult, instanceOfModelStatus, instanceOfParagraphSegment, instanceOfPartSegment, instanceOfPolicy, instanceOfPolicyDocument, instanceOfPolicySummary, instanceOfPropertySegment, instanceOfPseudonymizeRule, instanceOfRangeKind, instanceOfRangeSegment, instanceOfRedactRule, instanceOfRefusal, instanceOfRegexEntity, instanceOfRegexResult, instanceOfRegionSegment, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfSegmentSegment, instanceOfShapeSegment, instanceOfSheetSegment, instanceOfSlideSegment, instanceOfSpeakerNotesSegment, instanceOfTableSegment, instanceOfTagSegment, instanceOfTextRange, instanceOfTextSegment, instanceOfUpdatePolicyRequest, instanceOfUsage, mapValues, querystring };