@quba/sensitive-data-protection 0.0.6 → 0.0.7

package/dist/index.mjs

@@ -547,7 +547,8 @@ function AnonymizeRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
 	if (json == null) return json;
 	return {
 		"text": json["text"],
-		"rules": json["rules"].map(AnonymizeRequestBodyRulesInnerFromJSON)
+		"rules": json["rules"].map(AnonymizeRequestBodyRulesInnerFromJSON),
+		"confidence_threshold": json["confidence_threshold"] == null ? void 0 : json["confidence_threshold"]
 	};
 }
 function AnonymizeRequestBodyToJSON(json) {
@@ -557,10 +558,158 @@ function AnonymizeRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
 	if (value == null) return value;
 	return {
 		"text": value["text"],
-		"rules": value["rules"].map(AnonymizeRequestBodyRulesInnerToJSON)
+		"rules": value["rules"].map(AnonymizeRequestBodyRulesInnerToJSON),
+		"confidence_threshold": value["confidence_threshold"]
+	};
+}
+
+//#endregion
+//#region src/models/TextRange.ts
+/**
+* Check if a given object implements the TextRange interface.
+*/
+function instanceOfTextRange(value) {
+	if (!("start" in value) || value["start"] === void 0) return false;
+	if (!("end" in value) || value["end"] === void 0) return false;
+	if (!("value" in value) || value["value"] === void 0) return false;
+	return true;
+}
+function TextRangeFromJSON(json) {
+	return TextRangeFromJSONTyped(json, false);
+}
+function TextRangeFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"start": json["start"],
+		"end": json["end"],
+		"value": json["value"]
+	};
+}
+function TextRangeToJSON(json) {
+	return TextRangeToJSONTyped(json, false);
+}
+function TextRangeToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"start": value["start"],
+		"end": value["end"],
+		"value": value["value"]
+	};
+}
+
+//#endregion
+//#region src/models/ModelResult.ts
+/**
+* @export
+*/
+const ModelResultTypeEnum = { model: "model" };
+/**
+* Check if a given object implements the ModelResult interface.
+*/
+function instanceOfModelResult(value) {
+	if (!("rule" in value) || value["rule"] === void 0) return false;
+	if (!("value" in value) || value["value"] === void 0) return false;
+	if (!("input" in value) || value["input"] === void 0) return false;
+	if (!("output" in value) || value["output"] === void 0) return false;
+	return true;
+}
+function ModelResultFromJSON(json) {
+	return ModelResultFromJSONTyped(json, false);
+}
+function ModelResultFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"type": json["type"] == null ? void 0 : json["type"],
+		"rule": json["rule"],
+		"value": json["value"],
+		"input": TextRangeFromJSON(json["input"]),
+		"output": TextRangeFromJSON(json["output"]),
+		"score": json["score"] == null ? void 0 : json["score"]
+	};
+}
+function ModelResultToJSON(json) {
+	return ModelResultToJSONTyped(json, false);
+}
+function ModelResultToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"type": value["type"],
+		"rule": value["rule"],
+		"value": value["value"],
+		"input": TextRangeToJSON(value["input"]),
+		"output": TextRangeToJSON(value["output"]),
+		"score": value["score"]
 	};
 }
 
+//#endregion
+//#region src/models/RegexResult.ts
+/**
+* @export
+*/
+const RegexResultTypeEnum = { regex: "regex" };
+/**
+* Check if a given object implements the RegexResult interface.
+*/
+function instanceOfRegexResult(value) {
+	if (!("rule" in value) || value["rule"] === void 0) return false;
+	if (!("value" in value) || value["value"] === void 0) return false;
+	if (!("input" in value) || value["input"] === void 0) return false;
+	if (!("output" in value) || value["output"] === void 0) return false;
+	return true;
+}
+function RegexResultFromJSON(json) {
+	return RegexResultFromJSONTyped(json, false);
+}
+function RegexResultFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	return {
+		"type": json["type"] == null ? void 0 : json["type"],
+		"rule": json["rule"],
+		"value": json["value"],
+		"input": TextRangeFromJSON(json["input"]),
+		"output": TextRangeFromJSON(json["output"])
+	};
+}
+function RegexResultToJSON(json) {
+	return RegexResultToJSONTyped(json, false);
+}
+function RegexResultToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	return {
+		"type": value["type"],
+		"rule": value["rule"],
+		"value": value["value"],
+		"input": TextRangeToJSON(value["input"]),
+		"output": TextRangeToJSON(value["output"])
+	};
+}
+
+//#endregion
+//#region src/models/AnonymizeResponseBodySpansInner.ts
+function AnonymizeResponseBodySpansInnerFromJSON(json) {
+	return AnonymizeResponseBodySpansInnerFromJSONTyped(json, false);
+}
+function AnonymizeResponseBodySpansInnerFromJSONTyped(json, ignoreDiscriminator) {
+	if (json == null) return json;
+	switch (json["type"]) {
+		case "model": return Object.assign({}, ModelResultFromJSONTyped(json, true), { type: "model" });
+		case "regex": return Object.assign({}, RegexResultFromJSONTyped(json, true), { type: "regex" });
+		default: return json;
+	}
+}
+function AnonymizeResponseBodySpansInnerToJSON(json) {
+	return AnonymizeResponseBodySpansInnerToJSONTyped(json, false);
+}
+function AnonymizeResponseBodySpansInnerToJSONTyped(value, ignoreDiscriminator = false) {
+	if (value == null) return value;
+	switch (value["type"]) {
+		case "model": return Object.assign({}, ModelResultToJSON(value), { type: "model" });
+		case "regex": return Object.assign({}, RegexResultToJSON(value), { type: "regex" });
+		default: return value;
+	}
+}
+
 //#endregion
 //#region src/models/AnonymizeResponseBody.ts
 /**
@@ -577,7 +726,7 @@ function AnonymizeResponseBodyFromJSONTyped(json, ignoreDiscriminator) {
 	if (json == null) return json;
 	return {
 		"text": json["text"],
-		"map": json["map"] == null ? void 0 : json["map"]
+		"spans": json["spans"] == null ? void 0 : json["spans"].map(AnonymizeResponseBodySpansInnerFromJSON)
 	};
 }
 function AnonymizeResponseBodyToJSON(json) {
@@ -587,7 +736,7 @@ function AnonymizeResponseBodyToJSONTyped(value, ignoreDiscriminator = false) {
 	if (value == null) return value;
 	return {
 		"text": value["text"],
-		"map": value["map"]
+		"spans": value["spans"] == null ? void 0 : value["spans"].map(AnonymizeResponseBodySpansInnerToJSON)
 	};
 }
 
@@ -762,119 +911,6 @@ function HTTPValidationErrorToJSONTyped(value, ignoreDiscriminator = false) {
 	return { "detail": value["detail"] == null ? void 0 : value["detail"].map(ValidationErrorToJSON) };
 }
 
-//#endregion
-//#region src/models/ModelSpan.ts
-/**
-* @export
-*/
-const ModelSpanTypeEnum = { model: "model" };
-/**
-* Check if a given object implements the ModelSpan interface.
-*/
-function instanceOfModelSpan(value) {
-	if (!("start" in value) || value["start"] === void 0) return false;
-	if (!("end" in value) || value["end"] === void 0) return false;
-	if (!("value" in value) || value["value"] === void 0) return false;
-	if (!("text" in value) || value["text"] === void 0) return false;
-	return true;
-}
-function ModelSpanFromJSON(json) {
-	return ModelSpanFromJSONTyped(json, false);
-}
-function ModelSpanFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	return {
-		"type": json["type"] == null ? void 0 : json["type"],
-		"start": json["start"],
-		"end": json["end"],
-		"value": json["value"],
-		"text": json["text"],
-		"score": json["score"] == null ? void 0 : json["score"]
-	};
-}
-function ModelSpanToJSON(json) {
-	return ModelSpanToJSONTyped(json, false);
-}
-function ModelSpanToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	return {
-		"type": value["type"],
-		"start": value["start"],
-		"end": value["end"],
-		"value": value["value"],
-		"text": value["text"],
-		"score": value["score"]
-	};
-}
-
-//#endregion
-//#region src/models/RegexSpan.ts
-/**
-* @export
-*/
-const RegexSpanTypeEnum = { regex: "regex" };
-/**
-* Check if a given object implements the RegexSpan interface.
-*/
-function instanceOfRegexSpan(value) {
-	if (!("start" in value) || value["start"] === void 0) return false;
-	if (!("end" in value) || value["end"] === void 0) return false;
-	if (!("value" in value) || value["value"] === void 0) return false;
-	if (!("text" in value) || value["text"] === void 0) return false;
-	return true;
-}
-function RegexSpanFromJSON(json) {
-	return RegexSpanFromJSONTyped(json, false);
-}
-function RegexSpanFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	return {
-		"type": json["type"] == null ? void 0 : json["type"],
-		"start": json["start"],
-		"end": json["end"],
-		"value": json["value"],
-		"text": json["text"]
-	};
-}
-function RegexSpanToJSON(json) {
-	return RegexSpanToJSONTyped(json, false);
-}
-function RegexSpanToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	return {
-		"type": value["type"],
-		"start": value["start"],
-		"end": value["end"],
-		"value": value["value"],
-		"text": value["text"]
-	};
-}
-
-//#endregion
-//#region src/models/MapValueInner.ts
-function MapValueInnerFromJSON(json) {
-	return MapValueInnerFromJSONTyped(json, false);
-}
-function MapValueInnerFromJSONTyped(json, ignoreDiscriminator) {
-	if (json == null) return json;
-	switch (json["type"]) {
-		case "model": return Object.assign({}, ModelSpanFromJSONTyped(json, true), { type: "model" });
-		case "regex": return Object.assign({}, RegexSpanFromJSONTyped(json, true), { type: "regex" });
-		default: return json;
-	}
-}
-function MapValueInnerToJSON(json) {
-	return MapValueInnerToJSONTyped(json, false);
-}
-function MapValueInnerToJSONTyped(value, ignoreDiscriminator = false) {
-	if (value == null) return value;
-	switch (value["type"]) {
-		case "model": return Object.assign({}, ModelSpanToJSON(value), { type: "model" });
-		case "regex": return Object.assign({}, RegexSpanToJSON(value), { type: "regex" });
-		default: return value;
-	}
-}
-
 //#endregion
 //#region src/models/ScanRequestBody.ts
 /**
@@ -1061,4 +1097,4 @@ var SensitiveDataProtectionApi = class extends BaseAPI {
 };
 
 //#endregion
-export { AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, DefaultConfig, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, MapValueInnerFromJSON, MapValueInnerFromJSONTyped, MapValueInnerToJSON, MapValueInnerToJSONTyped, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelSpanFromJSON, ModelSpanFromJSONTyped, ModelSpanToJSON, ModelSpanToJSONTyped, ModelSpanTypeEnum, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexSpanFromJSON, RegexSpanFromJSONTyped, RegexSpanToJSON, RegexSpanToJSONTyped, RegexSpanTypeEnum, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequiredError, ResponseError, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, ValidationErrorLocInnerFromJSON, ValidationErrorLocInnerFromJSONTyped, ValidationErrorLocInnerToJSON, ValidationErrorLocInnerToJSONTyped, ValidationErrorToJSON, ValidationErrorToJSONTyped, VoidApiResponse, canConsumeForm, exists, instanceOfAnonymizeRequestBody, instanceOfAnonymizeResponseBody, instanceOfEncryptRule, instanceOfEntities, instanceOfHTTPValidationError, instanceOfMaskRule, instanceOfModelEntity, instanceOfModelSpan, instanceOfRedactRule, instanceOfRegexEntity, instanceOfRegexSpan, instanceOfReplaceRule, instanceOfSHA256Rule, instanceOfSHA512Rule, instanceOfScanRequestBody, instanceOfScanResponseBody, instanceOfScanResult, instanceOfValidationError, instanceOfValidationErrorLocInner, mapValues, querystring };
+export { AnonymizeRequestBodyFromJSON, AnonymizeRequestBodyFromJSONTyped, AnonymizeRequestBodyRulesInnerFromJSON, AnonymizeRequestBodyRulesInnerFromJSONTyped, AnonymizeRequestBodyRulesInnerToJSON, AnonymizeRequestBodyRulesInnerToJSONTyped, AnonymizeRequestBodyToJSON, AnonymizeRequestBodyToJSONTyped, AnonymizeResponseBodyFromJSON, AnonymizeResponseBodyFromJSONTyped, AnonymizeResponseBodySpansInnerFromJSON, AnonymizeResponseBodySpansInnerFromJSONTyped, AnonymizeResponseBodySpansInnerToJSON, AnonymizeResponseBodySpansInnerToJSONTyped, AnonymizeResponseBodyToJSON, AnonymizeResponseBodyToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, Configuration, DefaultConfig, EncryptRuleFromJSON, EncryptRuleFromJSONTyped, EncryptRuleToJSON, EncryptRuleToJSONTyped, EncryptRuleTypeEnum, EntitiesAnyOfInnerFromJSON, EntitiesAnyOfInnerFromJSONTyped, EntitiesAnyOfInnerToJSON, EntitiesAnyOfInnerToJSONTyped, EntitiesFromJSON, EntitiesFromJSONTyped, EntitiesToJSON, EntitiesToJSONTyped, FetchError, HTTPValidationErrorFromJSON, HTTPValidationErrorFromJSONTyped, HTTPValidationErrorToJSON, HTTPValidationErrorToJSONTyped, JSONApiResponse, MaskRuleFromJSON, MaskRuleFromJSONTyped, MaskRuleToJSON, MaskRuleToJSONTyped, MaskRuleTypeEnum, ModelEntityFromJSON, ModelEntityFromJSONTyped, ModelEntityToJSON, ModelEntityToJSONTyped, ModelEntityTypeEnum, ModelResultFromJSON, ModelResultFromJSONTyped, ModelResultToJSON, ModelResultToJSONTyped, ModelResultTypeEnum, RedactRuleFromJSON, RedactRuleFromJSONTyped, RedactRuleToJSON, RedactRuleToJSONTyped, RedactRuleTypeEnum, RegexEntityFromJSON, RegexEntityFromJSONTyped, RegexEntityToJSON, RegexEntityToJSONTyped, RegexEntityTypeEnum, RegexResultFromJSON, RegexResultFromJSONTyped, RegexResultToJSON, RegexResultToJSONTyped, RegexResultTypeEnum, ReplaceRuleFromJSON, ReplaceRuleFromJSONTyped, ReplaceRuleToJSON, ReplaceRuleToJSONTyped, ReplaceRuleTypeEnum, RequiredError, ResponseError, SHA256RuleFromJSON, SHA256RuleFromJSONTyped, SHA256RuleToJSON, SHA256RuleToJSONTyped, SHA256RuleTypeEnum, SHA512RuleFromJSON, SHA512RuleFromJSONTyped, SHA512RuleToJSON, SHA512RuleToJSONTyped, SHA512RuleTypeEnum, ScanRequestBodyFromJSON, ScanRequestBodyFromJSONTyped, ScanRequestBodyToJSON, ScanRequestBodyToJSONTyped, ScanResponseBodyFromJSON, ScanResponseBodyFromJSONTyped, ScanResponseBodyToJSON, ScanResponseBodyToJSONTyped, ScanResultFromJSON, ScanResultFromJSONTyped, ScanResultToJSON, ScanResultToJSONTyped, SensitiveDataProtectionApi, TextApiResponse, TextRangeFromJSON, TextRangeFromJSONTyped, TextRangeToJSON, TextRangeToJSONTyped, ValidationErrorFromJSON, ValidationErrorFromJSONTyped, 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/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.6",
+  "version": "0.0.7",
   "keywords": [
     "sensitive data protection",
     "sdp",