@quba/sensitive-data-protection 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/index.cjs +174 -133
- package/dist/index.d.cts +116 -82
- package/dist/index.d.mts +116 -82
- package/dist/index.mjs +154 -118
- package/docs/AnonymizeRequestBody.md +2 -0
- package/docs/AnonymizeResponseBody.md +2 -2
- package/docs/{MapValueInner.md → AnonymizeResponseBodySpansInner.md} +10 -10
- package/docs/ModelResult.md +45 -0
- package/docs/{ModelSpan.md → RegexResult.md} +11 -13
- package/docs/{RegexSpan.md → TextRange.md} +5 -9
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -500,6 +500,12 @@ interface AnonymizeRequestBody {
|
|
|
500
500
|
* @memberof AnonymizeRequestBody
|
|
501
501
|
*/
|
|
502
502
|
rules: Array<AnonymizeRequestBodyRulesInner>;
|
|
503
|
+
/**
|
|
504
|
+
*
|
|
505
|
+
* @type {number}
|
|
506
|
+
* @memberof AnonymizeRequestBody
|
|
507
|
+
*/
|
|
508
|
+
confidence_threshold?: number | null;
|
|
503
509
|
}
|
|
504
510
|
/**
|
|
505
511
|
* Check if a given object implements the AnonymizeRequestBody interface.
|
|
@@ -510,7 +516,7 @@ declare function AnonymizeRequestBodyFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
510
516
|
declare function AnonymizeRequestBodyToJSON(json: any): AnonymizeRequestBody;
|
|
511
517
|
declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody | null, ignoreDiscriminator?: boolean): any;
|
|
512
518
|
//#endregion
|
|
513
|
-
//#region src/models/
|
|
519
|
+
//#region src/models/TextRange.d.ts
|
|
514
520
|
/**
|
|
515
521
|
* Sensitive Data Protection API
|
|
516
522
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -523,144 +529,174 @@ declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody |
|
|
|
523
529
|
* Do not edit the class manually.
|
|
524
530
|
*/
|
|
525
531
|
/**
|
|
526
|
-
* A
|
|
532
|
+
* A character range within a text, carrying the substring it covers.
|
|
527
533
|
* @export
|
|
528
|
-
* @interface
|
|
534
|
+
* @interface TextRange
|
|
529
535
|
*/
|
|
530
|
-
interface
|
|
536
|
+
interface TextRange {
|
|
531
537
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @type {string}
|
|
534
|
-
* @memberof ModelSpan
|
|
535
|
-
*/
|
|
536
|
-
type?: ModelSpanTypeEnum;
|
|
537
|
-
/**
|
|
538
|
-
*
|
|
538
|
+
* Start character offset (inclusive).
|
|
539
539
|
* @type {number}
|
|
540
|
-
* @memberof
|
|
540
|
+
* @memberof TextRange
|
|
541
541
|
*/
|
|
542
542
|
start: number;
|
|
543
543
|
/**
|
|
544
|
-
*
|
|
544
|
+
* End character offset (exclusive).
|
|
545
545
|
* @type {number}
|
|
546
|
-
* @memberof
|
|
546
|
+
* @memberof TextRange
|
|
547
547
|
*/
|
|
548
548
|
end: number;
|
|
549
549
|
/**
|
|
550
|
-
*
|
|
550
|
+
* The substring at [start, end).
|
|
551
551
|
* @type {string}
|
|
552
|
-
* @memberof
|
|
552
|
+
* @memberof TextRange
|
|
553
553
|
*/
|
|
554
554
|
value: string;
|
|
555
|
+
}
|
|
556
|
+
/**
|
|
557
|
+
* Check if a given object implements the TextRange interface.
|
|
558
|
+
*/
|
|
559
|
+
declare function instanceOfTextRange(value: object): value is TextRange;
|
|
560
|
+
declare function TextRangeFromJSON(json: any): TextRange;
|
|
561
|
+
declare function TextRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextRange;
|
|
562
|
+
declare function TextRangeToJSON(json: any): TextRange;
|
|
563
|
+
declare function TextRangeToJSONTyped(value?: TextRange | null, ignoreDiscriminator?: boolean): any;
|
|
564
|
+
//#endregion
|
|
565
|
+
//#region src/models/ModelResult.d.ts
|
|
566
|
+
/**
|
|
567
|
+
* Record of an AI model detection and its anonymization.
|
|
568
|
+
*
|
|
569
|
+
* Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
|
|
570
|
+
* and a rule anonymizes the matched text.
|
|
571
|
+
* @export
|
|
572
|
+
* @interface ModelResult
|
|
573
|
+
*/
|
|
574
|
+
interface ModelResult {
|
|
555
575
|
/**
|
|
556
576
|
*
|
|
557
577
|
* @type {string}
|
|
558
|
-
* @memberof
|
|
578
|
+
* @memberof ModelResult
|
|
559
579
|
*/
|
|
560
|
-
|
|
580
|
+
type?: ModelResultTypeEnum;
|
|
561
581
|
/**
|
|
562
|
-
*
|
|
582
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof ModelResult
|
|
585
|
+
*/
|
|
586
|
+
rule: string;
|
|
587
|
+
/**
|
|
588
|
+
* The model entity type that matched, e.g. 'PERSON'.
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof ModelResult
|
|
591
|
+
*/
|
|
592
|
+
value: string;
|
|
593
|
+
/**
|
|
594
|
+
* The detected range in the original text.
|
|
595
|
+
* @type {TextRange}
|
|
596
|
+
* @memberof ModelResult
|
|
597
|
+
*/
|
|
598
|
+
input: TextRange;
|
|
599
|
+
/**
|
|
600
|
+
* The anonymized range in the result text.
|
|
601
|
+
* @type {TextRange}
|
|
602
|
+
* @memberof ModelResult
|
|
603
|
+
*/
|
|
604
|
+
output: TextRange;
|
|
605
|
+
/**
|
|
606
|
+
* Confidence score from the AI model (0.0–1.0).
|
|
563
607
|
* @type {number}
|
|
564
|
-
* @memberof
|
|
608
|
+
* @memberof ModelResult
|
|
565
609
|
*/
|
|
566
610
|
score?: number;
|
|
567
611
|
}
|
|
568
612
|
/**
|
|
569
613
|
* @export
|
|
570
614
|
*/
|
|
571
|
-
declare const
|
|
615
|
+
declare const ModelResultTypeEnum: {
|
|
572
616
|
readonly model: "model";
|
|
573
617
|
};
|
|
574
|
-
type
|
|
618
|
+
type ModelResultTypeEnum = typeof ModelResultTypeEnum[keyof typeof ModelResultTypeEnum];
|
|
575
619
|
/**
|
|
576
|
-
* Check if a given object implements the
|
|
620
|
+
* Check if a given object implements the ModelResult interface.
|
|
577
621
|
*/
|
|
578
|
-
declare function
|
|
579
|
-
declare function
|
|
580
|
-
declare function
|
|
581
|
-
declare function
|
|
582
|
-
declare function
|
|
622
|
+
declare function instanceOfModelResult(value: object): value is ModelResult;
|
|
623
|
+
declare function ModelResultFromJSON(json: any): ModelResult;
|
|
624
|
+
declare function ModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelResult;
|
|
625
|
+
declare function ModelResultToJSON(json: any): ModelResult;
|
|
626
|
+
declare function ModelResultToJSONTyped(value?: ModelResult | null, ignoreDiscriminator?: boolean): any;
|
|
583
627
|
//#endregion
|
|
584
|
-
//#region src/models/
|
|
628
|
+
//#region src/models/RegexResult.d.ts
|
|
585
629
|
/**
|
|
586
|
-
*
|
|
587
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
588
|
-
*
|
|
589
|
-
* The version of the OpenAPI document: 0.0.1
|
|
630
|
+
* Record of a regex detection and its anonymization.
|
|
590
631
|
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
* https://openapi-generator.tech
|
|
594
|
-
* Do not edit the class manually.
|
|
595
|
-
*/
|
|
596
|
-
/**
|
|
597
|
-
* A detected regex span.
|
|
632
|
+
* Created when a regex pattern matches text
|
|
633
|
+
* and a rule anonymizes the matched text.
|
|
598
634
|
* @export
|
|
599
|
-
* @interface
|
|
635
|
+
* @interface RegexResult
|
|
600
636
|
*/
|
|
601
|
-
interface
|
|
637
|
+
interface RegexResult {
|
|
602
638
|
/**
|
|
603
639
|
*
|
|
604
640
|
* @type {string}
|
|
605
|
-
* @memberof
|
|
641
|
+
* @memberof RegexResult
|
|
606
642
|
*/
|
|
607
|
-
type?:
|
|
643
|
+
type?: RegexResultTypeEnum;
|
|
608
644
|
/**
|
|
609
|
-
*
|
|
610
|
-
* @type {
|
|
611
|
-
* @memberof
|
|
612
|
-
*/
|
|
613
|
-
start: number;
|
|
614
|
-
/**
|
|
615
|
-
*
|
|
616
|
-
* @type {number}
|
|
617
|
-
* @memberof RegexSpan
|
|
645
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
646
|
+
* @type {string}
|
|
647
|
+
* @memberof RegexResult
|
|
618
648
|
*/
|
|
619
|
-
|
|
649
|
+
rule: string;
|
|
620
650
|
/**
|
|
621
|
-
*
|
|
651
|
+
* The regex pattern that matched.
|
|
622
652
|
* @type {string}
|
|
623
|
-
* @memberof
|
|
653
|
+
* @memberof RegexResult
|
|
624
654
|
*/
|
|
625
655
|
value: string;
|
|
626
656
|
/**
|
|
627
|
-
*
|
|
628
|
-
* @type {
|
|
629
|
-
* @memberof
|
|
657
|
+
* The detected range in the original text.
|
|
658
|
+
* @type {TextRange}
|
|
659
|
+
* @memberof RegexResult
|
|
630
660
|
*/
|
|
631
|
-
|
|
661
|
+
input: TextRange;
|
|
662
|
+
/**
|
|
663
|
+
* The anonymized range in the result text.
|
|
664
|
+
* @type {TextRange}
|
|
665
|
+
* @memberof RegexResult
|
|
666
|
+
*/
|
|
667
|
+
output: TextRange;
|
|
632
668
|
}
|
|
633
669
|
/**
|
|
634
670
|
* @export
|
|
635
671
|
*/
|
|
636
|
-
declare const
|
|
672
|
+
declare const RegexResultTypeEnum: {
|
|
637
673
|
readonly regex: "regex";
|
|
638
674
|
};
|
|
639
|
-
type
|
|
675
|
+
type RegexResultTypeEnum = typeof RegexResultTypeEnum[keyof typeof RegexResultTypeEnum];
|
|
640
676
|
/**
|
|
641
|
-
* Check if a given object implements the
|
|
677
|
+
* Check if a given object implements the RegexResult interface.
|
|
642
678
|
*/
|
|
643
|
-
declare function
|
|
644
|
-
declare function
|
|
645
|
-
declare function
|
|
646
|
-
declare function
|
|
647
|
-
declare function
|
|
679
|
+
declare function instanceOfRegexResult(value: object): value is RegexResult;
|
|
680
|
+
declare function RegexResultFromJSON(json: any): RegexResult;
|
|
681
|
+
declare function RegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexResult;
|
|
682
|
+
declare function RegexResultToJSON(json: any): RegexResult;
|
|
683
|
+
declare function RegexResultToJSONTyped(value?: RegexResult | null, ignoreDiscriminator?: boolean): any;
|
|
648
684
|
//#endregion
|
|
649
|
-
//#region src/models/
|
|
685
|
+
//#region src/models/AnonymizeResponseBodySpansInner.d.ts
|
|
650
686
|
/**
|
|
651
|
-
* @type
|
|
687
|
+
* @type AnonymizeResponseBodySpansInner
|
|
652
688
|
*
|
|
653
689
|
* @export
|
|
654
690
|
*/
|
|
655
|
-
type
|
|
691
|
+
type AnonymizeResponseBodySpansInner = {
|
|
656
692
|
type: 'model';
|
|
657
|
-
} &
|
|
693
|
+
} & ModelResult | {
|
|
658
694
|
type: 'regex';
|
|
659
|
-
} &
|
|
660
|
-
declare function
|
|
661
|
-
declare function
|
|
662
|
-
declare function
|
|
663
|
-
declare function
|
|
695
|
+
} & RegexResult;
|
|
696
|
+
declare function AnonymizeResponseBodySpansInnerFromJSON(json: any): AnonymizeResponseBodySpansInner;
|
|
697
|
+
declare function AnonymizeResponseBodySpansInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeResponseBodySpansInner;
|
|
698
|
+
declare function AnonymizeResponseBodySpansInnerToJSON(json: any): any;
|
|
699
|
+
declare function AnonymizeResponseBodySpansInnerToJSONTyped(value?: AnonymizeResponseBodySpansInner | null, ignoreDiscriminator?: boolean): any;
|
|
664
700
|
//#endregion
|
|
665
701
|
//#region src/models/AnonymizeResponseBody.d.ts
|
|
666
702
|
/**
|
|
@@ -677,12 +713,10 @@ interface AnonymizeResponseBody {
|
|
|
677
713
|
text: string;
|
|
678
714
|
/**
|
|
679
715
|
*
|
|
680
|
-
* @type {
|
|
716
|
+
* @type {Array<AnonymizeResponseBodySpansInner>}
|
|
681
717
|
* @memberof AnonymizeResponseBody
|
|
682
718
|
*/
|
|
683
|
-
|
|
684
|
-
[key: string]: Array<MapValueInner>;
|
|
685
|
-
};
|
|
719
|
+
spans?: Array<AnonymizeResponseBodySpansInner>;
|
|
686
720
|
}
|
|
687
721
|
/**
|
|
688
722
|
* Check if a given object implements the AnonymizeResponseBody interface.
|
|
@@ -1058,4 +1092,4 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
|
|
|
1058
1092
|
scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
|
|
1059
1093
|
}
|
|
1060
1094
|
//#endregion
|
|
1061
|
-
export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, DefaultConfig, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, Entities, EntitiesAnyOfInner, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, ErrorContext, FetchAPI, FetchError, FetchParams, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json,
|
|
1095
|
+
export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodySpansInner, AnonymizeResponseBodySpansInnerFromJSON, AnonymizeResponseBodySpansInnerFromJSONTyped, AnonymizeResponseBodySpansInnerToJSON, AnonymizeResponseBodySpansInnerToJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, DefaultConfig, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, Entities, EntitiesAnyOfInner, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, ErrorContext, FetchAPI, FetchError, FetchParams, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, 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, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeResponseBody, instanceOfEncryptRule, instanceOfEntities, instanceOfHTTPValidationError, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelResult, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
|
package/dist/index.d.mts
CHANGED
|
@@ -500,6 +500,12 @@ interface AnonymizeRequestBody {
|
|
|
500
500
|
* @memberof AnonymizeRequestBody
|
|
501
501
|
*/
|
|
502
502
|
rules: Array<AnonymizeRequestBodyRulesInner>;
|
|
503
|
+
/**
|
|
504
|
+
*
|
|
505
|
+
* @type {number}
|
|
506
|
+
* @memberof AnonymizeRequestBody
|
|
507
|
+
*/
|
|
508
|
+
confidence_threshold?: number | null;
|
|
503
509
|
}
|
|
504
510
|
/**
|
|
505
511
|
* Check if a given object implements the AnonymizeRequestBody interface.
|
|
@@ -510,7 +516,7 @@ declare function AnonymizeRequestBodyFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
510
516
|
declare function AnonymizeRequestBodyToJSON(json: any): AnonymizeRequestBody;
|
|
511
517
|
declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody | null, ignoreDiscriminator?: boolean): any;
|
|
512
518
|
//#endregion
|
|
513
|
-
//#region src/models/
|
|
519
|
+
//#region src/models/TextRange.d.ts
|
|
514
520
|
/**
|
|
515
521
|
* Sensitive Data Protection API
|
|
516
522
|
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
@@ -523,144 +529,174 @@ declare function AnonymizeRequestBodyToJSONTyped(value?: AnonymizeRequestBody |
|
|
|
523
529
|
* Do not edit the class manually.
|
|
524
530
|
*/
|
|
525
531
|
/**
|
|
526
|
-
* A
|
|
532
|
+
* A character range within a text, carrying the substring it covers.
|
|
527
533
|
* @export
|
|
528
|
-
* @interface
|
|
534
|
+
* @interface TextRange
|
|
529
535
|
*/
|
|
530
|
-
interface
|
|
536
|
+
interface TextRange {
|
|
531
537
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @type {string}
|
|
534
|
-
* @memberof ModelSpan
|
|
535
|
-
*/
|
|
536
|
-
type?: ModelSpanTypeEnum;
|
|
537
|
-
/**
|
|
538
|
-
*
|
|
538
|
+
* Start character offset (inclusive).
|
|
539
539
|
* @type {number}
|
|
540
|
-
* @memberof
|
|
540
|
+
* @memberof TextRange
|
|
541
541
|
*/
|
|
542
542
|
start: number;
|
|
543
543
|
/**
|
|
544
|
-
*
|
|
544
|
+
* End character offset (exclusive).
|
|
545
545
|
* @type {number}
|
|
546
|
-
* @memberof
|
|
546
|
+
* @memberof TextRange
|
|
547
547
|
*/
|
|
548
548
|
end: number;
|
|
549
549
|
/**
|
|
550
|
-
*
|
|
550
|
+
* The substring at [start, end).
|
|
551
551
|
* @type {string}
|
|
552
|
-
* @memberof
|
|
552
|
+
* @memberof TextRange
|
|
553
553
|
*/
|
|
554
554
|
value: string;
|
|
555
|
+
}
|
|
556
|
+
/**
|
|
557
|
+
* Check if a given object implements the TextRange interface.
|
|
558
|
+
*/
|
|
559
|
+
declare function instanceOfTextRange(value: object): value is TextRange;
|
|
560
|
+
declare function TextRangeFromJSON(json: any): TextRange;
|
|
561
|
+
declare function TextRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextRange;
|
|
562
|
+
declare function TextRangeToJSON(json: any): TextRange;
|
|
563
|
+
declare function TextRangeToJSONTyped(value?: TextRange | null, ignoreDiscriminator?: boolean): any;
|
|
564
|
+
//#endregion
|
|
565
|
+
//#region src/models/ModelResult.d.ts
|
|
566
|
+
/**
|
|
567
|
+
* Record of an AI model detection and its anonymization.
|
|
568
|
+
*
|
|
569
|
+
* Created when an AI model identifies an entity (e.g. PERSON, EMAIL)
|
|
570
|
+
* and a rule anonymizes the matched text.
|
|
571
|
+
* @export
|
|
572
|
+
* @interface ModelResult
|
|
573
|
+
*/
|
|
574
|
+
interface ModelResult {
|
|
555
575
|
/**
|
|
556
576
|
*
|
|
557
577
|
* @type {string}
|
|
558
|
-
* @memberof
|
|
578
|
+
* @memberof ModelResult
|
|
559
579
|
*/
|
|
560
|
-
|
|
580
|
+
type?: ModelResultTypeEnum;
|
|
561
581
|
/**
|
|
562
|
-
*
|
|
582
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof ModelResult
|
|
585
|
+
*/
|
|
586
|
+
rule: string;
|
|
587
|
+
/**
|
|
588
|
+
* The model entity type that matched, e.g. 'PERSON'.
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof ModelResult
|
|
591
|
+
*/
|
|
592
|
+
value: string;
|
|
593
|
+
/**
|
|
594
|
+
* The detected range in the original text.
|
|
595
|
+
* @type {TextRange}
|
|
596
|
+
* @memberof ModelResult
|
|
597
|
+
*/
|
|
598
|
+
input: TextRange;
|
|
599
|
+
/**
|
|
600
|
+
* The anonymized range in the result text.
|
|
601
|
+
* @type {TextRange}
|
|
602
|
+
* @memberof ModelResult
|
|
603
|
+
*/
|
|
604
|
+
output: TextRange;
|
|
605
|
+
/**
|
|
606
|
+
* Confidence score from the AI model (0.0–1.0).
|
|
563
607
|
* @type {number}
|
|
564
|
-
* @memberof
|
|
608
|
+
* @memberof ModelResult
|
|
565
609
|
*/
|
|
566
610
|
score?: number;
|
|
567
611
|
}
|
|
568
612
|
/**
|
|
569
613
|
* @export
|
|
570
614
|
*/
|
|
571
|
-
declare const
|
|
615
|
+
declare const ModelResultTypeEnum: {
|
|
572
616
|
readonly model: "model";
|
|
573
617
|
};
|
|
574
|
-
type
|
|
618
|
+
type ModelResultTypeEnum = typeof ModelResultTypeEnum[keyof typeof ModelResultTypeEnum];
|
|
575
619
|
/**
|
|
576
|
-
* Check if a given object implements the
|
|
620
|
+
* Check if a given object implements the ModelResult interface.
|
|
577
621
|
*/
|
|
578
|
-
declare function
|
|
579
|
-
declare function
|
|
580
|
-
declare function
|
|
581
|
-
declare function
|
|
582
|
-
declare function
|
|
622
|
+
declare function instanceOfModelResult(value: object): value is ModelResult;
|
|
623
|
+
declare function ModelResultFromJSON(json: any): ModelResult;
|
|
624
|
+
declare function ModelResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelResult;
|
|
625
|
+
declare function ModelResultToJSON(json: any): ModelResult;
|
|
626
|
+
declare function ModelResultToJSONTyped(value?: ModelResult | null, ignoreDiscriminator?: boolean): any;
|
|
583
627
|
//#endregion
|
|
584
|
-
//#region src/models/
|
|
628
|
+
//#region src/models/RegexResult.d.ts
|
|
585
629
|
/**
|
|
586
|
-
*
|
|
587
|
-
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
588
|
-
*
|
|
589
|
-
* The version of the OpenAPI document: 0.0.1
|
|
630
|
+
* Record of a regex detection and its anonymization.
|
|
590
631
|
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
* https://openapi-generator.tech
|
|
594
|
-
* Do not edit the class manually.
|
|
595
|
-
*/
|
|
596
|
-
/**
|
|
597
|
-
* A detected regex span.
|
|
632
|
+
* Created when a regex pattern matches text
|
|
633
|
+
* and a rule anonymizes the matched text.
|
|
598
634
|
* @export
|
|
599
|
-
* @interface
|
|
635
|
+
* @interface RegexResult
|
|
600
636
|
*/
|
|
601
|
-
interface
|
|
637
|
+
interface RegexResult {
|
|
602
638
|
/**
|
|
603
639
|
*
|
|
604
640
|
* @type {string}
|
|
605
|
-
* @memberof
|
|
641
|
+
* @memberof RegexResult
|
|
606
642
|
*/
|
|
607
|
-
type?:
|
|
643
|
+
type?: RegexResultTypeEnum;
|
|
608
644
|
/**
|
|
609
|
-
*
|
|
610
|
-
* @type {
|
|
611
|
-
* @memberof
|
|
612
|
-
*/
|
|
613
|
-
start: number;
|
|
614
|
-
/**
|
|
615
|
-
*
|
|
616
|
-
* @type {number}
|
|
617
|
-
* @memberof RegexSpan
|
|
645
|
+
* The rule type that was applied, e.g. 'replace', 'mask'.
|
|
646
|
+
* @type {string}
|
|
647
|
+
* @memberof RegexResult
|
|
618
648
|
*/
|
|
619
|
-
|
|
649
|
+
rule: string;
|
|
620
650
|
/**
|
|
621
|
-
*
|
|
651
|
+
* The regex pattern that matched.
|
|
622
652
|
* @type {string}
|
|
623
|
-
* @memberof
|
|
653
|
+
* @memberof RegexResult
|
|
624
654
|
*/
|
|
625
655
|
value: string;
|
|
626
656
|
/**
|
|
627
|
-
*
|
|
628
|
-
* @type {
|
|
629
|
-
* @memberof
|
|
657
|
+
* The detected range in the original text.
|
|
658
|
+
* @type {TextRange}
|
|
659
|
+
* @memberof RegexResult
|
|
630
660
|
*/
|
|
631
|
-
|
|
661
|
+
input: TextRange;
|
|
662
|
+
/**
|
|
663
|
+
* The anonymized range in the result text.
|
|
664
|
+
* @type {TextRange}
|
|
665
|
+
* @memberof RegexResult
|
|
666
|
+
*/
|
|
667
|
+
output: TextRange;
|
|
632
668
|
}
|
|
633
669
|
/**
|
|
634
670
|
* @export
|
|
635
671
|
*/
|
|
636
|
-
declare const
|
|
672
|
+
declare const RegexResultTypeEnum: {
|
|
637
673
|
readonly regex: "regex";
|
|
638
674
|
};
|
|
639
|
-
type
|
|
675
|
+
type RegexResultTypeEnum = typeof RegexResultTypeEnum[keyof typeof RegexResultTypeEnum];
|
|
640
676
|
/**
|
|
641
|
-
* Check if a given object implements the
|
|
677
|
+
* Check if a given object implements the RegexResult interface.
|
|
642
678
|
*/
|
|
643
|
-
declare function
|
|
644
|
-
declare function
|
|
645
|
-
declare function
|
|
646
|
-
declare function
|
|
647
|
-
declare function
|
|
679
|
+
declare function instanceOfRegexResult(value: object): value is RegexResult;
|
|
680
|
+
declare function RegexResultFromJSON(json: any): RegexResult;
|
|
681
|
+
declare function RegexResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): RegexResult;
|
|
682
|
+
declare function RegexResultToJSON(json: any): RegexResult;
|
|
683
|
+
declare function RegexResultToJSONTyped(value?: RegexResult | null, ignoreDiscriminator?: boolean): any;
|
|
648
684
|
//#endregion
|
|
649
|
-
//#region src/models/
|
|
685
|
+
//#region src/models/AnonymizeResponseBodySpansInner.d.ts
|
|
650
686
|
/**
|
|
651
|
-
* @type
|
|
687
|
+
* @type AnonymizeResponseBodySpansInner
|
|
652
688
|
*
|
|
653
689
|
* @export
|
|
654
690
|
*/
|
|
655
|
-
type
|
|
691
|
+
type AnonymizeResponseBodySpansInner = {
|
|
656
692
|
type: 'model';
|
|
657
|
-
} &
|
|
693
|
+
} & ModelResult | {
|
|
658
694
|
type: 'regex';
|
|
659
|
-
} &
|
|
660
|
-
declare function
|
|
661
|
-
declare function
|
|
662
|
-
declare function
|
|
663
|
-
declare function
|
|
695
|
+
} & RegexResult;
|
|
696
|
+
declare function AnonymizeResponseBodySpansInnerFromJSON(json: any): AnonymizeResponseBodySpansInner;
|
|
697
|
+
declare function AnonymizeResponseBodySpansInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnonymizeResponseBodySpansInner;
|
|
698
|
+
declare function AnonymizeResponseBodySpansInnerToJSON(json: any): any;
|
|
699
|
+
declare function AnonymizeResponseBodySpansInnerToJSONTyped(value?: AnonymizeResponseBodySpansInner | null, ignoreDiscriminator?: boolean): any;
|
|
664
700
|
//#endregion
|
|
665
701
|
//#region src/models/AnonymizeResponseBody.d.ts
|
|
666
702
|
/**
|
|
@@ -677,12 +713,10 @@ interface AnonymizeResponseBody {
|
|
|
677
713
|
text: string;
|
|
678
714
|
/**
|
|
679
715
|
*
|
|
680
|
-
* @type {
|
|
716
|
+
* @type {Array<AnonymizeResponseBodySpansInner>}
|
|
681
717
|
* @memberof AnonymizeResponseBody
|
|
682
718
|
*/
|
|
683
|
-
|
|
684
|
-
[key: string]: Array<MapValueInner>;
|
|
685
|
-
};
|
|
719
|
+
spans?: Array<AnonymizeResponseBodySpansInner>;
|
|
686
720
|
}
|
|
687
721
|
/**
|
|
688
722
|
* Check if a given object implements the AnonymizeResponseBody interface.
|
|
@@ -1058,4 +1092,4 @@ declare class SensitiveDataProtectionApi extends BaseAPI {
|
|
|
1058
1092
|
scanText(ScanRequestBody: ScanRequestBody, initOverrides?: RequestInit | InitOverrideFunction): Promise<ScanResponseBody>;
|
|
1059
1093
|
}
|
|
1060
1094
|
//#endregion
|
|
1061
|
-
export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, DefaultConfig, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, Entities, EntitiesAnyOfInner, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, ErrorContext, FetchAPI, FetchError, FetchParams, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json,
|
|
1095
|
+
export { AnonymizeRequestBody, AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInner, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBody, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodySpansInner, AnonymizeResponseBodySpansInnerFromJSON, AnonymizeResponseBodySpansInnerFromJSONTyped, AnonymizeResponseBodySpansInnerToJSON, AnonymizeResponseBodySpansInnerToJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, AnonymizeTextRequest, ApiResponse, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, ConfigurationParameters, Consume, DefaultConfig, EncryptRule, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, Entities, EntitiesAnyOfInner, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, ErrorContext, FetchAPI, FetchError, FetchParams, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HTTPValidationError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, InitOverrideFunction, JSONApiResponse, Json, MaskRule, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, Middleware, ModelEntity, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelPropertyNaming, ModelResult, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, 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, ValidationError, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInner, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeResponseBody, instanceOfEncryptRule, instanceOfEntities, instanceOfHTTPValidationError, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelResult, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexResult, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfTextRange, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
|