@quba/sensitive-data-protection 0.0.5 → 0.0.7

package/docs/AnonymizeRequestBody.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `text` | string
 `rules` | [Array<AnonymizeRequestBodyRulesInner>](AnonymizeRequestBodyRulesInner.md)
+`confidence_threshold` | number
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { AnonymizeRequestBody } from '@quba/sensitive-data-protection'
 const example = {
   "text": null,
   "rules": null,
+  "confidence_threshold": null,
 } satisfies AnonymizeRequestBody
 
 console.log(example)

package/docs/AnonymizeResponseBody.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `text` | string
-`map` | { [key: string]: Array<MapValueInner>; }
+`spans` | [Array<AnonymizeResponseBodySpansInner>](AnonymizeResponseBodySpansInner.md)
 
 ## Example
 
@@ -17,7 +17,7 @@ import type { AnonymizeResponseBody } from '@quba/sensitive-data-protection'
 // TODO: Update the object below with actual values
 const example = {
   "text": null,
-  "map": null,
+  "spans": null,
 } satisfies AnonymizeResponseBody
 
 console.log(example)

package/docs/{MapValueInner.md → AnonymizeResponseBodySpansInner.md}

@@ -1,5 +1,5 @@
 
-# MapValueInner
+# AnonymizeResponseBodySpansInner
 
 
 ## Properties
@@ -7,26 +7,26 @@
 Name | Type
 ------------ | -------------
 `type` | string
-`start` | number
-`end` | number
+`rule` | string
 `value` | string
-`text` | string
+`input` | [TextRange](TextRange.md)
+`output` | [TextRange](TextRange.md)
 `score` | number
 
 ## Example
 
 ```typescript
-import type { MapValueInner } from '@quba/sensitive-data-protection'
+import type { AnonymizeResponseBodySpansInner } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
-  "start": null,
-  "end": null,
+  "rule": null,
   "value": null,
-  "text": null,
+  "input": null,
+  "output": null,
   "score": null,
-} satisfies MapValueInner
+} satisfies AnonymizeResponseBodySpansInner
 
 console.log(example)
 
@@ -35,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MapValueInner
+const exampleParsed = JSON.parse(exampleJSON) as AnonymizeResponseBodySpansInner
 console.log(exampleParsed)
 ```
 

package/docs/ModelResult.md

@@ -0,0 +1,45 @@
+
+# ModelResult
+
+Record of an AI model detection and its anonymization.  Created when an AI model identifies an entity (e.g. PERSON, EMAIL) and a rule anonymizes the matched text.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`rule` | string
+`value` | string
+`input` | [TextRange](TextRange.md)
+`output` | [TextRange](TextRange.md)
+`score` | number
+
+## Example
+
+```typescript
+import type { ModelResult } from '@quba/sensitive-data-protection'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "rule": null,
+  "value": null,
+  "input": null,
+  "output": null,
+  "score": null,
+} satisfies ModelResult
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelResult
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/{ModelSpan.md → RegexResult.md}

@@ -1,33 +1,31 @@
 
-# ModelSpan
+# RegexResult
 
-A detected model span.
+Record of a regex detection and its anonymization.  Created when a regex pattern matches text and a rule anonymizes the matched text.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `type` | string
-`start` | number
-`end` | number
+`rule` | string
 `value` | string
-`text` | string
-`score` | number
+`input` | [TextRange](TextRange.md)
+`output` | [TextRange](TextRange.md)
 
 ## Example
 
 ```typescript
-import type { ModelSpan } from '@quba/sensitive-data-protection'
+import type { RegexResult } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
-  "start": null,
-  "end": null,
+  "rule": null,
   "value": null,
-  "text": null,
-  "score": null,
-} satisfies ModelSpan
+  "input": null,
+  "output": null,
+} satisfies RegexResult
 
 console.log(example)
 
@@ -36,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ModelSpan
+const exampleParsed = JSON.parse(exampleJSON) as RegexResult
 console.log(exampleParsed)
 ```
 

package/docs/{RegexSpan.md → TextRange.md}

@@ -1,31 +1,27 @@
 
-# RegexSpan
+# TextRange
 
-A detected regex span.
+A character range within a text, carrying the substring it covers.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`type` | string
 `start` | number
 `end` | number
 `value` | string
-`text` | string
 
 ## Example
 
 ```typescript
-import type { RegexSpan } from '@quba/sensitive-data-protection'
+import type { TextRange } from '@quba/sensitive-data-protection'
 
 // TODO: Update the object below with actual values
 const example = {
-  "type": null,
   "start": null,
   "end": null,
   "value": null,
-  "text": null,
-} satisfies RegexSpan
+} satisfies TextRange
 
 console.log(example)
 
@@ -34,7 +30,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as RegexSpan
+const exampleParsed = JSON.parse(exampleJSON) as TextRange
 console.log(exampleParsed)
 ```
 

package/package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "type": "module",
   "homepage": "https://quba.ae",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "keywords": [
     "sensitive data protection",
     "sdp",