@azure-rest/health-deidentification 1.0.0 → 1.1.0-beta.1

package/LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,9 +1,10 @@
 # Azure Health Data Services de-identification service REST client library for JavaScript
 
-This package contains a client library for the de-identification service in Azure Health Data Services which 
+This package contains a client library for the de-identification service in Azure Health Data Services which
 enables users to tag, redact, or surrogate health data containing Protected Health Information (PHI).
 
 Use the client library for the de-identification service to:
+
 - Discover PHI in unstructured text
 - Replace PHI in unstructured text with placeholder values
 - Replace PHI in unstructured text with realistic surrogate values
@@ -11,12 +12,6 @@ Use the client library for the de-identification service to:
 
 **Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library.**
 
-Use the client library for the de-identification service to:
-- Discover PHI in unstructured text
-- Replace PHI in unstructured text with placeholder values
-- Replace PHI in unstructured text with realistic surrogate values
-- Manage asynchronous jobs to de-identify documents in Azure Storage
-
 Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthdataaiservices/health-deidentification-rest)
@@ -64,32 +59,46 @@ Here's an example of setting an environment variable in Bash using Azure CLI:
 
 ```bash
 # Get the service URL for the resource
-export DEID_SERVICE_ENDPOINT=$(az deidservice show --name "<resource-name>" --resource-group "<resource-group-name>" --query "properties.serviceUrl")
+export HEALTHDATAAISERVICES_DEID_SERVICE_ENDPOINT=$(az deidservice show --name "<resource-name>" --resource-group "<resource-group-name>" --query "properties.serviceUrl")
 ```
 
 Create a client with the endpoint and credential:
+
 ```ts snippet:CreateClient
 import { DefaultAzureCredential } from "@azure/identity";
 import DeidentificationClient from "@azure-rest/health-deidentification";
 
 const credential = new DefaultAzureCredential();
-const serviceEndpoint = process.env.DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
+const serviceEndpoint =
+  process.env.HEALTHDATAAISERVICES_DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
 const client = DeidentificationClient(serviceEndpoint, credential);
 ```
 
 ## Key concepts
 
 ### De-identification operations:
+
 Given an input text, the de-identification service can perform three main operations:
+
 - `Tag` returns the category and location within the text of detected PHI entities.
 - `Redact` returns output text where detected PHI entities are replaced with placeholder text. For example `John` replaced with `[name]`.
 - `Surrogate` returns output text where detected PHI entities are replaced with realistic replacement values. For example, `My name is John Smith` could become `My name is Tom Jones`.
+- `SurrogateOnly` returns output text where user-defined PHI entities are replaced with realistic replacement values.
+
+### String Encoding
+
+When using the `Tag` operation, the service will return the locations of PHI entities in the input text. These locations will be represented as offsets and lengths, each of which is a [StringIndex][string_index] containing
+three properties corresponding to three different text encodings. **JavaScript applications should use the `utf16` property.**
+
+For more on text encoding, see [Character encoding in .NET][character_encoding].
 
 ### Available endpoints
-There are two ways to interact with the de-identification service. You can send text directly, or you can create jobs 
+
+There are two ways to interact with the de-identification service. You can send text directly, or you can create jobs
 to de-identify documents in Azure Storage.
 
 You can de-identify text directly using the `DeidentificationClient`:
+
 ```ts snippet:DeidentifyText
 import { DefaultAzureCredential } from "@azure/identity";
 import DeidentificationClient, {
@@ -98,7 +107,8 @@ import DeidentificationClient, {
 } from "@azure-rest/health-deidentification";
 
 const credential = new DefaultAzureCredential();
-const serviceEndpoint = process.env.DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
+const serviceEndpoint =
+  process.env.HEALTHDATAAISERVICES_DEID_SERVICE_ENDPOINT || "https://example.api.deid.azure.com";
 const client = DeidentificationClient(serviceEndpoint, credential);
 
 const content: DeidentificationContent = {
@@ -117,6 +127,7 @@ console.log(response.body.outputText); // Hello, Tom!
 To de-identify documents in Azure Storage, you'll need a storage account with a container to which the de-identification service has been granted an appropriate role. See [Tutorial: Configure Azure Storage to de-identify documents][deid_configure_storage] for prerequisites and configuration options. You can upload the files in the [test data folder][test_data] as blobs, like: `https://<storageaccount>.blob.core.windows.net/<container>/example_patient_1/doctor_dictation.txt`.
 
 You can create jobs to de-identify documents in the source Azure Storage account and container with an optional input prefix. If there's no input prefix, all blobs in the container will be de-identified. Azure Storage blobs can use `/` in the blob name to emulate a folder or directory layout. For more on blob naming, see [Naming and Referencing Containers, Blobs, and Metadata][blob_names]. The files you've uploaded can be de-identified by providing `example_patient_1` as the input prefix:
+
 ```
 <container>/
 ├── example_patient_1/
@@ -126,6 +137,7 @@ You can create jobs to de-identify documents in the source Azure Storage account
 ```
 
 Your target Azure Storage account and container where documents will be written can be the same as the source, or a different account or container. In the examples below, the source and target account and container are the same. You can specify an output prefix to indicate where the job's output documents should be written (defaulting to `_output`). Each document processed by the job will have the same relative blob name with the input prefix replaced by the output prefix:
+
 ```
 <container>/
 ├── example_patient_1/
@@ -139,13 +151,15 @@ Your target Azure Storage account and container where documents will be written
 ```
 
 Set the following environment variables, updating the storage account and container with real values:
+
 ```bash
-export AZURE_STORAGE_ACCOUNT_LOCATION="https://<storageaccount>.blob.core.windows.net/<container>"
+export HEALTHDATAAISERVICES_STORAGE_ACCOUNT_LOCATION="https://<storageaccount>.blob.core.windows.net/<container>"
 export INPUT_PREFIX="example_patient_1"
 export OUTPUT_PREFIX="_output"
 ```
 
 You can create and view job status using the client:
+
 ```ts snippet:DeidentifyDocuments
 import { DefaultAzureCredential } from "@azure/identity";
 import DeidentificationClient, {
@@ -157,8 +171,10 @@ import DeidentificationClient, {
 
 const credential = new DefaultAzureCredential();
 const serviceEndpoint =
-  process.env["DEID_SERVICE_ENDPOINT"] || "https://example.api.deid.azure.com";
-const storageLocation = `https://${process.env["STORAGE_ACCOUNT_NAME"]}.blob.core.windows.net/${process.env["STORAGE_CONTAINER_NAME"]}`;
+  process.env["HEALTHDATAAISERVICES_DEID_SERVICE_ENDPOINT"] || "https://example.api.deid.azure.com";
+const storageLocation =
+  process.env["HEALTHDATAAISERVICES_STORAGE_ACCOUNT_LOCATION"] ||
+  "https://example.blob.core.windows.net/example-container";
 const inputPrefix = "example_patient_1";
 const outputPrefix = process.env["OUTPUT_PREFIX"] || "_output";
 
@@ -190,7 +206,7 @@ Find a bug, or have feedback? Raise an issue with the [Health Deidentification][
 ## Troubleshooting
 
 - **Unable to Access Source or Target Storage**
-  - Ensure you create your deid service with a system assigned managed identity
+  - Ensure you create your de-identification service with a system assigned managed identity
   - Ensure your storage account has given permissions to that managed identity
 
 ### Logging
@@ -206,12 +222,15 @@ setLogLevel("info");
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 <!-- LINKS -->
+
 [azure_sub]: https://azure.microsoft.com/free/
 [deid_quickstart]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/quickstart
+[string_index]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/healthdataaiservices/health-deidentification-rest/src/outputModels.ts#L175
+[character_encoding]: https://learn.microsoft.com/dotnet/standard/base-types/character-encoding-introduction
 [deid_redact]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format
 [deid_rbac]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/manage-access-rbac
 [deid_managed_identity]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/managed-identities
 [deid_configure_storage]: https://learn.microsoft.com/azure/healthcare-apis/deidentification/configure-storage
 [azure_cli]: https://learn.microsoft.com/cli/azure/healthcareapis/deidservice?view=azure-cli-latest
 [azure_portal]: https://ms.portal.azure.com
-[github_issue_label]: https://github.com/Azure/azure-sdk-for-js/labels/Health%20Deidentification
+[github_issue_label]: https://github.com/Azure/azure-sdk-for-js/labels/Health%20Deidentification

package/dist/browser/deidentificationClient.js

@@ -1,6 +1,5 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { __rest } from "tslib";
 import { getClient } from "@azure-rest/core-client";
 import { logger } from "./logger.js";
 /**
@@ -9,21 +8,24 @@ import { logger } from "./logger.js";
  * @param credentials - uniquely identify client credential
  * @param options - the parameter for all optional parameters
  */
-export default function createClient(endpointParam, credentials, _a = {}) {
-    var _b, _c, _d, _e, _f, _g;
-    var { apiVersion = "2024-11-15" } = _a, options = __rest(_a, ["apiVersion"]);
-    const endpointUrl = (_c = (_b = options.endpoint) !== null && _b !== void 0 ? _b : options.baseUrl) !== null && _c !== void 0 ? _c : `${endpointParam}`;
+export default function createClient(endpointParam, credentials, { apiVersion = "2025-07-15-preview", ...options } = {}) {
+    const endpointUrl = options.endpoint ?? `${endpointParam}`;
     const userAgentInfo = `azsdk-js-health-deidentification-rest/1.0.0-beta.1`;
     const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`
         : `${userAgentInfo}`;
-    options = Object.assign(Object.assign({}, options), { userAgentOptions: {
+    options = {
+        ...options,
+        userAgentOptions: {
             userAgentPrefix,
-        }, loggingOptions: {
-            logger: (_e = (_d = options.loggingOptions) === null || _d === void 0 ? void 0 : _d.logger) !== null && _e !== void 0 ? _e : logger.info,
-        }, credentials: {
-            scopes: (_g = (_f = options.credentials) === null || _f === void 0 ? void 0 : _f.scopes) !== null && _g !== void 0 ? _g : ["https://deid.azure.com/.default"],
-        } });
+        },
+        loggingOptions: {
+            logger: options.loggingOptions?.logger ?? logger.info,
+        },
+        credentials: {
+            scopes: options.credentials?.scopes ?? ["https://deid.azure.com/.default"],
+        },
+    };
     const client = getClient(endpointUrl, credentials, options);
     client.pipeline.removePolicy({ name: "ApiVersionPolicy" });
     client.pipeline.addPolicy({

package/dist/browser/deidentificationClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"deidentificationClient.js","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4B,EAC5B,KAA2E,EAAE;;QAA7E,EAAE,UAAU,GAAG,YAAY,OAAkD,EAA7C,OAAO,cAAvC,cAAyC,CAAF;IAEvC,MAAM,WAAW,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,mCAAI,OAAO,CAAC,OAAO,mCAAI,GAAG,aAAa,EAAE,CAAC;IAC9E,MAAM,aAAa,GAAG,oDAAoD,CAAC;IAC3E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,mCACF,OAAO,KACV,gBAAgB,EAAE;YAChB,eAAe;SAChB,EACD,cAAc,EAAE;YACd,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,cAAc,0CAAE,MAAM,mCAAI,MAAM,CAAC,IAAI;SACtD,EACD,WAAW,EAAE;YACX,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,WAAW,0CAAE,MAAM,mCAAI,CAAC,iCAAiC,CAAC;SAC3E,GACF,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAA2B,CAAC;IAEtF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { DeidentificationClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface DeidentificationClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `DeidentificationClient`\n * @param endpointParam - Url of your De-identification Service.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential,\n  { apiVersion = \"2024-11-15\", ...options }: DeidentificationClientOptions = {},\n): DeidentificationClient {\n  const endpointUrl = options.endpoint ?? options.baseUrl ?? `${endpointParam}`;\n  const userAgentInfo = `azsdk-js-health-deidentification-rest/1.0.0-beta.1`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://deid.azure.com/.default\"],\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as DeidentificationClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}
+{"version":3,"file":"deidentificationClient.js","sourceRoot":"","sources":["../../src/deidentificationClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAUrC;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,aAAqB,EACrB,WAA4B,EAC5B,EAAE,UAAU,GAAG,oBAAoB,EAAE,GAAG,OAAO,KAAoC,EAAE;IAErF,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,aAAa,EAAE,CAAC;IAC3D,MAAM,aAAa,GAAG,oDAAoD,CAAC;IAC3E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;QAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,aAAa,EAAE;QAChE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC;IACzB,OAAO,GAAG;QACR,GAAG,OAAO;QACV,gBAAgB,EAAE;YAChB,eAAe;SAChB;QACD,cAAc,EAAE;YACd,MAAM,EAAE,OAAO,CAAC,cAAc,EAAE,MAAM,IAAI,MAAM,CAAC,IAAI;SACtD;QACD,WAAW,EAAE;YACX,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,IAAI,CAAC,iCAAiC,CAAC;SAC3E;KACF,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAA2B,CAAC;IAEtF,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3D,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACxB,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,qDAAqD;YACrD,yEAAyE;YACzE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,UAAU,EAAE,CAAC;gBACvD,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAClB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GACzD,eAAe,UAAU,EAAE,CAAC;YAC9B,CAAC;YAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ClientOptions } from \"@azure-rest/core-client\";\nimport { getClient } from \"@azure-rest/core-client\";\nimport { logger } from \"./logger.js\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport type { DeidentificationClient } from \"./clientDefinitions.js\";\n\n/** The optional parameters for the client */\nexport interface DeidentificationClientOptions extends ClientOptions {\n  /** The api version option of the client */\n  apiVersion?: string;\n}\n\n/**\n * Initialize a new instance of `DeidentificationClient`\n * @param endpointParam - Url of your De-identification Service.\n * @param credentials - uniquely identify client credential\n * @param options - the parameter for all optional parameters\n */\nexport default function createClient(\n  endpointParam: string,\n  credentials: TokenCredential,\n  { apiVersion = \"2025-07-15-preview\", ...options }: DeidentificationClientOptions = {},\n): DeidentificationClient {\n  const endpointUrl = options.endpoint ?? `${endpointParam}`;\n  const userAgentInfo = `azsdk-js-health-deidentification-rest/1.0.0-beta.1`;\n  const userAgentPrefix =\n    options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n      ? `${options.userAgentOptions.userAgentPrefix} ${userAgentInfo}`\n      : `${userAgentInfo}`;\n  options = {\n    ...options,\n    userAgentOptions: {\n      userAgentPrefix,\n    },\n    loggingOptions: {\n      logger: options.loggingOptions?.logger ?? logger.info,\n    },\n    credentials: {\n      scopes: options.credentials?.scopes ?? [\"https://deid.azure.com/.default\"],\n    },\n  };\n  const client = getClient(endpointUrl, credentials, options) as DeidentificationClient;\n\n  client.pipeline.removePolicy({ name: \"ApiVersionPolicy\" });\n  client.pipeline.addPolicy({\n    name: \"ClientApiVersionPolicy\",\n    sendRequest: (req, next) => {\n      // Use the apiVersion defined in request url directly\n      // Append one if there is no apiVersion and we have one at client options\n      const url = new URL(req.url);\n      if (!url.searchParams.get(\"api-version\") && apiVersion) {\n        req.url = `${req.url}${\n          Array.from(url.searchParams.keys()).length > 0 ? \"&\" : \"?\"\n        }api-version=${apiVersion}`;\n      }\n\n      return next(req);\n    },\n  });\n\n  return client;\n}\n"]}

package/dist/browser/isUnexpected.js

@@ -11,7 +11,7 @@ const responseMap = {
 };
 export function isUnexpected(response) {
     const lroOriginal = response.headers["x-ms-original-url"];
-    const url = new URL(lroOriginal !== null && lroOriginal !== void 0 ? lroOriginal : response.request.url);
+    const url = new URL(lroOriginal ?? response.request.url);
     const method = response.request.method;
     let pathDetails = responseMap[`${method} ${url.pathname}`];
     if (!pathDetails) {
@@ -20,7 +20,6 @@ export function isUnexpected(response) {
     return !pathDetails.includes(response.status);
 }
 function getParametrizedPathSuccess(method, path) {
-    var _a, _b, _c, _d;
     const pathParts = path.split("/");
     // Traverse list to match the longest candidate
     // matchedLen: the length of candidate path
@@ -39,13 +38,13 @@ function getParametrizedPathSuccess(method, path) {
         // track if we have found a match to return the values found.
         let found = true;
         for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {
-            if (((_a = candidateParts[i]) === null || _a === void 0 ? void 0 : _a.startsWith("{")) && ((_b = candidateParts[i]) === null || _b === void 0 ? void 0 : _b.indexOf("}")) !== -1) {
-                const start = candidateParts[i].indexOf("}") + 1, end = (_c = candidateParts[i]) === null || _c === void 0 ? void 0 : _c.length;
+            if (candidateParts[i]?.startsWith("{") && candidateParts[i]?.indexOf("}") !== -1) {
+                const start = candidateParts[i].indexOf("}") + 1, end = candidateParts[i]?.length;
                 // If the current part of the candidate is a "template" part
                 // Try to use the suffix of pattern to match the path
                 // {guid} ==> $
                 // {guid}:export ==> :export$
-                const isMatched = new RegExp(`${(_d = candidateParts[i]) === null || _d === void 0 ? void 0 : _d.slice(start, end)}`).test(pathParts[j] || "");
+                const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(pathParts[j] || "");
                 if (!isMatched) {
                     found = false;
                     break;

package/dist/browser/isUnexpected.js.map

@@ -1 +1 @@
-{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC,MAAM,WAAW,GAA6B;IAC5C,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,kBAAkB,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IAClC,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,WAAW,EAAE,CAAC,KAAK,CAAC;IACpB,4BAA4B,EAAE,CAAC,KAAK,CAAC;IACrC,0BAA0B,EAAE,CAAC,KAAK,CAAC;IACnC,YAAY,EAAE,CAAC,KAAK,CAAC;CACtB,CAAC;AA2BF,MAAM,UAAU,YAAY,CAC1B,QAgBiC;IASjC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY;;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;IAE9B,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7F,IAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,UAAU,CAAC,GAAG,CAAC,KAAI,CAAA,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,GAAG,CAAC,MAAK,CAAC,CAAC,EAAE,CAAC;gBACjF,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,GAAG,MAAA,cAAc,CAAC,CAAC,CAAC,0CAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  DeidentifyDocuments200Response,\n  DeidentifyDocuments201Response,\n  DeidentifyDocumentsLogicalResponse,\n  DeidentifyDocumentsDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  DeidentifyText200Response,\n  DeidentifyTextDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /jobs/{name}\": [\"200\"],\n  \"PUT /jobs/{name}\": [\"200\", \"201\"],\n  \"DELETE /jobs/{name}\": [\"204\"],\n  \"GET /jobs\": [\"200\"],\n  \"GET /jobs/{name}/documents\": [\"200\"],\n  \"POST /jobs/{name}:cancel\": [\"200\"],\n  \"POST /deid\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: GetJob200Response | GetJobDefaultResponse,\n): response is GetJobDefaultResponse;\nexport function isUnexpected(\n  response:\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse,\n): response is DeidentifyDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: DeleteJob204Response | DeleteJobDefaultResponse,\n): response is DeleteJobDefaultResponse;\nexport function isUnexpected(\n  response: ListJobs200Response | ListJobsDefaultResponse,\n): response is ListJobsDefaultResponse;\nexport function isUnexpected(\n  response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse,\n): response is ListJobDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: CancelJob200Response | CancelJobDefaultResponse,\n): response is CancelJobDefaultResponse;\nexport function isUnexpected(\n  response: DeidentifyText200Response | DeidentifyTextDefaultResponse,\n): response is DeidentifyTextDefaultResponse;\nexport function isUnexpected(\n  response:\n    | GetJob200Response\n    | GetJobDefaultResponse\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse\n    | DeleteJob204Response\n    | DeleteJobDefaultResponse\n    | ListJobs200Response\n    | ListJobsDefaultResponse\n    | ListJobDocuments200Response\n    | ListJobDocumentsDefaultResponse\n    | CancelJob200Response\n    | CancelJobDefaultResponse\n    | DeidentifyText200Response\n    | DeidentifyTextDefaultResponse,\n): response is\n  | GetJobDefaultResponse\n  | DeidentifyDocumentsDefaultResponse\n  | DeleteJobDefaultResponse\n  | ListJobsDefaultResponse\n  | ListJobDocumentsDefaultResponse\n  | CancelJobDefaultResponse\n  | DeidentifyTextDefaultResponse {\n  const lroOriginal = response.headers[\"x-ms-original-url\"];\n  const url = new URL(lroOriginal ?? response.request.url);\n  const method = response.request.method;\n  let pathDetails = responseMap[`${method} ${url.pathname}`];\n  if (!pathDetails) {\n    pathDetails = getParametrizedPathSuccess(method, url.pathname);\n  }\n  return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: string[] = [];\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(responseMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\",\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n"]}
+{"version":3,"file":"isUnexpected.js","sourceRoot":"","sources":["../../src/isUnexpected.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAqBlC,MAAM,WAAW,GAA6B;IAC5C,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,kBAAkB,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;IAClC,qBAAqB,EAAE,CAAC,KAAK,CAAC;IAC9B,WAAW,EAAE,CAAC,KAAK,CAAC;IACpB,4BAA4B,EAAE,CAAC,KAAK,CAAC;IACrC,0BAA0B,EAAE,CAAC,KAAK,CAAC;IACnC,YAAY,EAAE,CAAC,KAAK,CAAC;CACtB,CAAC;AA2BF,MAAM,UAAU,YAAY,CAC1B,QAgBiC;IASjC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;IACvC,IAAI,WAAW,GAAG,WAAW,CAAC,GAAG,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,WAAW,GAAG,0BAA0B,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,0BAA0B,CAAC,MAAc,EAAE,IAAY;IAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAElC,+CAA+C;IAC/C,2CAA2C;IAC3C,8CAA8C;IAC9C,IAAI,UAAU,GAAG,CAAC,CAAC,EACjB,YAAY,GAAa,EAAE,CAAC;IAE9B,0CAA0C;IAC1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QACvD,0DAA0D;QAC1D,gBAAgB;QAChB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,SAAS;QACX,CAAC;QACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7C,gCAAgC;QAChC,MAAM,cAAc,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEhD,6DAA6D;QAC7D,IAAI,KAAK,GAAG,IAAI,CAAC;QACjB,KAAK,IAAI,CAAC,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7F,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACjF,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/C,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC;gBAClC,4DAA4D;gBAC5D,qDAAqD;gBACrD,eAAe;gBACf,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAC1E,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CACnB,CAAC;gBAEF,IAAI,CAAC,SAAS,EAAE,CAAC;oBACf,KAAK,GAAG,KAAK,CAAC;oBACd,MAAM;gBACR,CAAC;gBACD,SAAS;YACX,CAAC;YAED,8CAA8C;YAC9C,wDAAwD;YACxD,2CAA2C;YAC3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvC,KAAK,GAAG,KAAK,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,sEAAsE;QACtE,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC/C,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC;YAClC,YAAY,GAAG,KAAK,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACvC,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  GetJob200Response,\n  GetJobDefaultResponse,\n  DeidentifyDocuments200Response,\n  DeidentifyDocuments201Response,\n  DeidentifyDocumentsLogicalResponse,\n  DeidentifyDocumentsDefaultResponse,\n  DeleteJob204Response,\n  DeleteJobDefaultResponse,\n  ListJobs200Response,\n  ListJobsDefaultResponse,\n  ListJobDocuments200Response,\n  ListJobDocumentsDefaultResponse,\n  CancelJob200Response,\n  CancelJobDefaultResponse,\n  DeidentifyText200Response,\n  DeidentifyTextDefaultResponse,\n} from \"./responses.js\";\n\nconst responseMap: Record<string, string[]> = {\n  \"GET /jobs/{name}\": [\"200\"],\n  \"PUT /jobs/{name}\": [\"200\", \"201\"],\n  \"DELETE /jobs/{name}\": [\"204\"],\n  \"GET /jobs\": [\"200\"],\n  \"GET /jobs/{name}/documents\": [\"200\"],\n  \"POST /jobs/{name}:cancel\": [\"200\"],\n  \"POST /deid\": [\"200\"],\n};\n\nexport function isUnexpected(\n  response: GetJob200Response | GetJobDefaultResponse,\n): response is GetJobDefaultResponse;\nexport function isUnexpected(\n  response:\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse,\n): response is DeidentifyDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: DeleteJob204Response | DeleteJobDefaultResponse,\n): response is DeleteJobDefaultResponse;\nexport function isUnexpected(\n  response: ListJobs200Response | ListJobsDefaultResponse,\n): response is ListJobsDefaultResponse;\nexport function isUnexpected(\n  response: ListJobDocuments200Response | ListJobDocumentsDefaultResponse,\n): response is ListJobDocumentsDefaultResponse;\nexport function isUnexpected(\n  response: CancelJob200Response | CancelJobDefaultResponse,\n): response is CancelJobDefaultResponse;\nexport function isUnexpected(\n  response: DeidentifyText200Response | DeidentifyTextDefaultResponse,\n): response is DeidentifyTextDefaultResponse;\nexport function isUnexpected(\n  response:\n    | GetJob200Response\n    | GetJobDefaultResponse\n    | DeidentifyDocuments200Response\n    | DeidentifyDocuments201Response\n    | DeidentifyDocumentsLogicalResponse\n    | DeidentifyDocumentsDefaultResponse\n    | DeleteJob204Response\n    | DeleteJobDefaultResponse\n    | ListJobs200Response\n    | ListJobsDefaultResponse\n    | ListJobDocuments200Response\n    | ListJobDocumentsDefaultResponse\n    | CancelJob200Response\n    | CancelJobDefaultResponse\n    | DeidentifyText200Response\n    | DeidentifyTextDefaultResponse,\n): response is\n  | GetJobDefaultResponse\n  | DeidentifyDocumentsDefaultResponse\n  | DeleteJobDefaultResponse\n  | ListJobsDefaultResponse\n  | ListJobDocumentsDefaultResponse\n  | CancelJobDefaultResponse\n  | DeidentifyTextDefaultResponse {\n  const lroOriginal = response.headers[\"x-ms-original-url\"];\n  const url = new URL(lroOriginal ?? response.request.url);\n  const method = response.request.method;\n  let pathDetails = responseMap[`${method} ${url.pathname}`];\n  if (!pathDetails) {\n    pathDetails = getParametrizedPathSuccess(method, url.pathname);\n  }\n  return !pathDetails.includes(response.status);\n}\n\nfunction getParametrizedPathSuccess(method: string, path: string): string[] {\n  const pathParts = path.split(\"/\");\n\n  // Traverse list to match the longest candidate\n  // matchedLen: the length of candidate path\n  // matchedValue: the matched status code array\n  let matchedLen = -1,\n    matchedValue: string[] = [];\n\n  // Iterate the responseMap to find a match\n  for (const [key, value] of Object.entries(responseMap)) {\n    // Extracting the path from the map key which is in format\n    // GET /path/foo\n    if (!key.startsWith(method)) {\n      continue;\n    }\n    const candidatePath = getPathFromMapKey(key);\n    // Get each part of the url path\n    const candidateParts = candidatePath.split(\"/\");\n\n    // track if we have found a match to return the values found.\n    let found = true;\n    for (let i = candidateParts.length - 1, j = pathParts.length - 1; i >= 1 && j >= 1; i--, j--) {\n      if (candidateParts[i]?.startsWith(\"{\") && candidateParts[i]?.indexOf(\"}\") !== -1) {\n        const start = candidateParts[i]!.indexOf(\"}\") + 1,\n          end = candidateParts[i]?.length;\n        // If the current part of the candidate is a \"template\" part\n        // Try to use the suffix of pattern to match the path\n        // {guid} ==> $\n        // {guid}:export ==> :export$\n        const isMatched = new RegExp(`${candidateParts[i]?.slice(start, end)}`).test(\n          pathParts[j] || \"\",\n        );\n\n        if (!isMatched) {\n          found = false;\n          break;\n        }\n        continue;\n      }\n\n      // If the candidate part is not a template and\n      // the parts don't match mark the candidate as not found\n      // to move on with the next candidate path.\n      if (candidateParts[i] !== pathParts[j]) {\n        found = false;\n        break;\n      }\n    }\n\n    // We finished evaluating the current candidate parts\n    // Update the matched value if and only if we found the longer pattern\n    if (found && candidatePath.length > matchedLen) {\n      matchedLen = candidatePath.length;\n      matchedValue = value;\n    }\n  }\n\n  return matchedValue;\n}\n\nfunction getPathFromMapKey(mapKey: string): string {\n  const pathStart = mapKey.indexOf(\"/\");\n  return mapKey.slice(pathStart);\n}\n"]}

package/dist/browser/models.d.ts

@@ -3,7 +3,7 @@ export interface DeidentificationJob {
     /**
      * Operation to perform on the input documents.
      *
-     * Possible values: "Redact", "Surrogate", "Tag"
+     * Possible values: "Redact", "Surrogate", "Tag", "SurrogateOnly"
      */
     operation?: DeidentificationOperationType;
     /** Storage location to perform the operation on. */
@@ -44,11 +44,13 @@ export interface TargetStorageLocation {
 export interface DeidentificationJobCustomizationOptions {
     /**
      * Format of the redacted output. Only valid when Operation is Redact.
-     * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.
+     * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.
      */
     redactionFormat?: string;
     /** Locale in which the output surrogates are written. */
     surrogateLocale?: string;
+    /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */
+    inputLocale?: string;
 }
 /** Summary metrics of a job. */
 export interface DeidentificationJobSummary {
@@ -70,24 +72,58 @@ export interface DeidentificationContent {
     /**
      * Operation to perform on the input documents.
      *
-     * Possible values: "Redact", "Surrogate", "Tag"
+     * Possible values: "Redact", "Surrogate", "Tag", "SurrogateOnly"
      */
     operation?: DeidentificationOperationType;
+    /** Grouped PHI entities with single encoding specification for SurrogateOnly operation. */
+    taggedEntities?: TaggedPhiEntities;
     /** Customization parameters to override default service behaviors. */
     customizations?: DeidentificationCustomizationOptions;
 }
+/** Grouped PHI entities with shared encoding specification. */
+export interface TaggedPhiEntities {
+    /**
+     * The encoding type used for all entities in this group.
+     *
+     * Possible values: "Utf8", "Utf16", "CodePoint"
+     */
+    encoding: TextEncodingType;
+    /** List of PHI entities using the specified encoding. */
+    entities: Array<SimplePhiEntity>;
+}
+/** Simple PHI entity with encoding-specific offset and length values. */
+export interface SimplePhiEntity {
+    /**
+     * PHI Category of the entity.
+     *
+     * Possible values: "Unknown", "Account", "Age", "BioID", "City", "CountryOrRegion", "Date", "Device", "Doctor", "Email", "Fax", "HealthPlan", "Hospital", "IDNum", "IPAddress", "License", "LocationOther", "MedicalRecord", "Organization", "Patient", "Phone", "Profession", "SocialSecurity", "State", "Street", "Url", "Username", "Vehicle", "Zip"
+     */
+    category: PhiCategory;
+    /** Starting index of the location from within the input text using the group's encoding. */
+    offset: number;
+    /** Length of the input text using the group's encoding. */
+    length: number;
+    /** Text of the entity (optional). */
+    text?: string;
+}
 /** Customizations options to override default service behaviors for synchronous usage. */
 export interface DeidentificationCustomizationOptions {
     /**
      * Format of the redacted output. Only valid when Operation is Redact.
-     * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.
+     * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.
      */
     redactionFormat?: string;
     /** Locale in which the output surrogates are written. */
     surrogateLocale?: string;
+    /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */
+    inputLocale?: string;
 }
 /** Alias for DeidentificationOperationType */
 export type DeidentificationOperationType = string;
 /** Alias for OperationState */
 export type OperationState = string;
+/** Alias for TextEncodingType */
+export type TextEncodingType = string;
+/** Alias for PhiCategory */
+export type PhiCategory = string;
 //# sourceMappingURL=models.d.ts.map

package/dist/browser/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJob {\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocation;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocation;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptions;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /**\n   * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.\n   *\n   * Example:\n   * File full path: documents/user/note.txt\n   * Input Prefix: \"documents/user/\"\n   * Output Prefix: \"output_docs/\"\n   *\n   * Output file: \"output_docs/note.txt\"\n   */\n  prefix: string;\n  /** When set to true during a job, the service will overwrite the output location if it already exists. */\n  overwrite?: boolean;\n}\n\n/** Customizations options to override default service behaviors for job usage. */\nexport interface DeidentificationJobCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n}\n\n/** Summary metrics of a job. */\nexport interface DeidentificationJobSummary {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Request body for de-identification operation. */\nexport interface DeidentificationContent {\n  /** Input text to de-identify. */\n  inputText: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationCustomizationOptions;\n}\n\n/** Customizations options to override default service behaviors for synchronous usage. */\nexport interface DeidentificationCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n}\n\n/** Alias for DeidentificationOperationType */\nexport type DeidentificationOperationType = string;\n/** Alias for OperationState */\nexport type OperationState = string;\n"]}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJob {\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\", \"SurrogateOnly\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocation;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocation;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptions;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocation {\n  /** URL to storage location. */\n  location: string;\n  /**\n   * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.\n   *\n   * Example:\n   * File full path: documents/user/note.txt\n   * Input Prefix: \"documents/user/\"\n   * Output Prefix: \"output_docs/\"\n   *\n   * Output file: \"output_docs/note.txt\"\n   */\n  prefix: string;\n  /** When set to true during a job, the service will overwrite the output location if it already exists. */\n  overwrite?: boolean;\n}\n\n/** Customizations options to override default service behaviors for job usage. */\nexport interface DeidentificationJobCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n  /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */\n  inputLocale?: string;\n}\n\n/** Summary metrics of a job. */\nexport interface DeidentificationJobSummary {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Request body for de-identification operation. */\nexport interface DeidentificationContent {\n  /** Input text to de-identify. */\n  inputText: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\", \"SurrogateOnly\"\n   */\n  operation?: DeidentificationOperationType;\n  /** Grouped PHI entities with single encoding specification for SurrogateOnly operation. */\n  taggedEntities?: TaggedPhiEntities;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationCustomizationOptions;\n}\n\n/** Grouped PHI entities with shared encoding specification. */\nexport interface TaggedPhiEntities {\n  /**\n   * The encoding type used for all entities in this group.\n   *\n   * Possible values: \"Utf8\", \"Utf16\", \"CodePoint\"\n   */\n  encoding: TextEncodingType;\n  /** List of PHI entities using the specified encoding. */\n  entities: Array<SimplePhiEntity>;\n}\n\n/** Simple PHI entity with encoding-specific offset and length values. */\nexport interface SimplePhiEntity {\n  /**\n   * PHI Category of the entity.\n   *\n   * Possible values: \"Unknown\", \"Account\", \"Age\", \"BioID\", \"City\", \"CountryOrRegion\", \"Date\", \"Device\", \"Doctor\", \"Email\", \"Fax\", \"HealthPlan\", \"Hospital\", \"IDNum\", \"IPAddress\", \"License\", \"LocationOther\", \"MedicalRecord\", \"Organization\", \"Patient\", \"Phone\", \"Profession\", \"SocialSecurity\", \"State\", \"Street\", \"Url\", \"Username\", \"Vehicle\", \"Zip\"\n   */\n  category: PhiCategory;\n  /** Starting index of the location from within the input text using the group's encoding. */\n  offset: number;\n  /** Length of the input text using the group's encoding. */\n  length: number;\n  /** Text of the entity (optional). */\n  text?: string;\n}\n\n/** Customizations options to override default service behaviors for synchronous usage. */\nexport interface DeidentificationCustomizationOptions {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n  /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */\n  inputLocale?: string;\n}\n\n/** Alias for DeidentificationOperationType */\nexport type DeidentificationOperationType = string;\n/** Alias for OperationState */\nexport type OperationState = string;\n/** Alias for TextEncodingType */\nexport type TextEncodingType = string;\n/** Alias for PhiCategory */\nexport type PhiCategory = string;\n"]}

package/dist/browser/outputModels.d.ts

@@ -6,7 +6,7 @@ export interface DeidentificationJobOutput {
     /**
      * Operation to perform on the input documents.
      *
-     * Possible values: "Redact", "Surrogate", "Tag"
+     * Possible values: "Redact", "Surrogate", "Tag", "SurrogateOnly"
      */
     operation?: DeidentificationOperationTypeOutput;
     /** Storage location to perform the operation on. */
@@ -69,11 +69,13 @@ export interface TargetStorageLocationOutput {
 export interface DeidentificationJobCustomizationOptionsOutput {
     /**
      * Format of the redacted output. Only valid when Operation is Redact.
-     * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.
+     * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.
      */
     redactionFormat?: string;
     /** Locale in which the output surrogates are written. */
     surrogateLocale?: string;
+    /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */
+    inputLocale?: string;
 }
 /** Summary metrics of a job. */
 export interface DeidentificationJobSummaryOutput {

package/dist/browser/outputModels.js.map

@@ -1 +1 @@
-{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ErrorModel } from \"@azure-rest/core-client\";\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJobOutput {\n  /** The name of a job. */\n  readonly name: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\"\n   */\n  operation?: DeidentificationOperationTypeOutput;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocationOutput;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocationOutput;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptionsOutput;\n  /**\n   * Current status of a job.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  readonly status: OperationStateOutput;\n  /** Error when job fails in it's entirety. */\n  readonly error?: ErrorModel;\n  /**\n   * Date and time when the job was completed.\n   *\n   * If the job is canceled, this is the time when the job was canceled.\n   *\n   * If the job failed, this is the time when the job failed.\n   */\n  readonly lastUpdatedAt: string;\n  /** Date and time when the job was created. */\n  readonly createdAt: string;\n  /** Date and time when the job was started. */\n  readonly startedAt?: string;\n  /** Summary of a job. Exists only when the job is completed. */\n  readonly summary?: DeidentificationJobSummaryOutput;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocationOutput {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocationOutput {\n  /** URL to storage location. */\n  location: string;\n  /**\n   * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.\n   *\n   * Example:\n   * File full path: documents/user/note.txt\n   * Input Prefix: \"documents/user/\"\n   * Output Prefix: \"output_docs/\"\n   *\n   * Output file: \"output_docs/note.txt\"\n   */\n  prefix: string;\n  /** When set to true during a job, the service will overwrite the output location if it already exists. */\n  overwrite?: boolean;\n}\n\n/** Customizations options to override default service behaviors for job usage. */\nexport interface DeidentificationJobCustomizationOptionsOutput {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/en-us/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n}\n\n/** Summary metrics of a job. */\nexport interface DeidentificationJobSummaryOutput {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Paged collection of DeidentificationJob items */\nexport interface PagedDeidentificationJobOutput {\n  /** The DeidentificationJob items on this page */\n  value: Array<DeidentificationJobOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Paged collection of DeidentificationDocumentDetails items */\nexport interface PagedDeidentificationDocumentDetailsOutput {\n  /** The DeidentificationDocumentDetails items on this page */\n  value: Array<DeidentificationDocumentDetailsOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Details of a single document in a job. */\nexport interface DeidentificationDocumentDetailsOutput {\n  /** Id of the document details. */\n  readonly id: string;\n  /** Location for the input. */\n  input: DeidentificationDocumentLocationOutput;\n  /** Location for the output. */\n  output?: DeidentificationDocumentLocationOutput;\n  /**\n   * Status of the document.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  status: OperationStateOutput;\n  /** Error when document fails. */\n  error?: ErrorModel;\n}\n\n/** Location of a document. */\nexport interface DeidentificationDocumentLocationOutput {\n  /** Location of document in storage. */\n  location: string;\n  /** The entity tag for this resource. */\n  readonly etag: string;\n}\n\n/** Response body for de-identification operation. */\nexport interface DeidentificationResultOutput {\n  /** Output text after de-identification. Not available for \"Tag\" operation. */\n  outputText?: string;\n  /** Result of the \"Tag\" operation. Only available for \"Tag\" Operation. */\n  taggerResult?: PhiTaggerResultOutput;\n}\n\n/** Result of the \"Tag\" operation. */\nexport interface PhiTaggerResultOutput {\n  /** List of entities detected in the input. */\n  entities: Array<PhiEntityOutput>;\n}\n\n/** PHI Entity tag in the input. */\nexport interface PhiEntityOutput {\n  /**\n   * PHI Category of the entity.\n   *\n   * Possible values: \"Unknown\", \"Account\", \"Age\", \"BioID\", \"City\", \"CountryOrRegion\", \"Date\", \"Device\", \"Doctor\", \"Email\", \"Fax\", \"HealthPlan\", \"Hospital\", \"IDNum\", \"IPAddress\", \"License\", \"LocationOther\", \"MedicalRecord\", \"Organization\", \"Patient\", \"Phone\", \"Profession\", \"SocialSecurity\", \"State\", \"Street\", \"Url\", \"Username\", \"Vehicle\", \"Zip\"\n   */\n  category: PhiCategoryOutput;\n  /** Starting index of the location from within the input text. */\n  offset: StringIndexOutput;\n  /** Length of the input text. */\n  length: StringIndexOutput;\n  /** Text of the entity. */\n  text?: string;\n  /** Confidence score of the category match. */\n  confidenceScore?: number;\n}\n\n/** String index encoding model. */\nexport interface StringIndexOutput {\n  /** The offset or length of the substring in UTF-8 encoding */\n  utf8: number;\n  /**\n   * The offset or length of the substring in UTF-16 encoding.\n   *\n   * Primary encoding used by .NET, Java, and JavaScript.\n   */\n  utf16: number;\n  /**\n   * The offset or length of the substring in CodePoint encoding.\n   *\n   * Primary encoding used by Python.\n   */\n  codePoint: number;\n}\n\n/** Alias for DeidentificationOperationTypeOutput */\nexport type DeidentificationOperationTypeOutput = string;\n/** Alias for OperationStateOutput */\nexport type OperationStateOutput = string;\n/** Alias for PhiCategoryOutput */\nexport type PhiCategoryOutput = string;\n"]}
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ErrorModel } from \"@azure-rest/core-client\";\n\n/** A job containing a batch of documents to de-identify. */\nexport interface DeidentificationJobOutput {\n  /** The name of a job. */\n  readonly name: string;\n  /**\n   * Operation to perform on the input documents.\n   *\n   * Possible values: \"Redact\", \"Surrogate\", \"Tag\", \"SurrogateOnly\"\n   */\n  operation?: DeidentificationOperationTypeOutput;\n  /** Storage location to perform the operation on. */\n  sourceLocation: SourceStorageLocationOutput;\n  /** Target location to store output of operation. */\n  targetLocation: TargetStorageLocationOutput;\n  /** Customization parameters to override default service behaviors. */\n  customizations?: DeidentificationJobCustomizationOptionsOutput;\n  /**\n   * Current status of a job.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  readonly status: OperationStateOutput;\n  /** Error when job fails in it's entirety. */\n  readonly error?: ErrorModel;\n  /**\n   * Date and time when the job was completed.\n   *\n   * If the job is canceled, this is the time when the job was canceled.\n   *\n   * If the job failed, this is the time when the job failed.\n   */\n  readonly lastUpdatedAt: string;\n  /** Date and time when the job was created. */\n  readonly createdAt: string;\n  /** Date and time when the job was started. */\n  readonly startedAt?: string;\n  /** Summary of a job. Exists only when the job is completed. */\n  readonly summary?: DeidentificationJobSummaryOutput;\n}\n\n/** Storage location. */\nexport interface SourceStorageLocationOutput {\n  /** URL to storage location. */\n  location: string;\n  /** Prefix to filter path by. */\n  prefix: string;\n  /** List of extensions to filter path by. */\n  extensions?: string[];\n}\n\n/** Storage location. */\nexport interface TargetStorageLocationOutput {\n  /** URL to storage location. */\n  location: string;\n  /**\n   * Replaces the input prefix of a file path with the output prefix, preserving the rest of the path structure.\n   *\n   * Example:\n   * File full path: documents/user/note.txt\n   * Input Prefix: \"documents/user/\"\n   * Output Prefix: \"output_docs/\"\n   *\n   * Output file: \"output_docs/note.txt\"\n   */\n  prefix: string;\n  /** When set to true during a job, the service will overwrite the output location if it already exists. */\n  overwrite?: boolean;\n}\n\n/** Customizations options to override default service behaviors for job usage. */\nexport interface DeidentificationJobCustomizationOptionsOutput {\n  /**\n   * Format of the redacted output. Only valid when Operation is Redact.\n   * Please refer to https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format for more details.\n   */\n  redactionFormat?: string;\n  /** Locale in which the output surrogates are written. */\n  surrogateLocale?: string;\n  /** Locale of the input text. Used for better PHI detection. Defaults to 'en-US'. */\n  inputLocale?: string;\n}\n\n/** Summary metrics of a job. */\nexport interface DeidentificationJobSummaryOutput {\n  /** Number of documents that have completed. */\n  successful: number;\n  /** Number of documents that have failed. */\n  failed: number;\n  /** Number of documents that have been canceled. */\n  canceled: number;\n  /** Number of documents total. */\n  total: number;\n  /** Number of bytes processed. */\n  bytesProcessed: number;\n}\n\n/** Paged collection of DeidentificationJob items */\nexport interface PagedDeidentificationJobOutput {\n  /** The DeidentificationJob items on this page */\n  value: Array<DeidentificationJobOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Paged collection of DeidentificationDocumentDetails items */\nexport interface PagedDeidentificationDocumentDetailsOutput {\n  /** The DeidentificationDocumentDetails items on this page */\n  value: Array<DeidentificationDocumentDetailsOutput>;\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\n/** Details of a single document in a job. */\nexport interface DeidentificationDocumentDetailsOutput {\n  /** Id of the document details. */\n  readonly id: string;\n  /** Location for the input. */\n  input: DeidentificationDocumentLocationOutput;\n  /** Location for the output. */\n  output?: DeidentificationDocumentLocationOutput;\n  /**\n   * Status of the document.\n   *\n   * Possible values: \"NotStarted\", \"Running\", \"Succeeded\", \"Failed\", \"Canceled\"\n   */\n  status: OperationStateOutput;\n  /** Error when document fails. */\n  error?: ErrorModel;\n}\n\n/** Location of a document. */\nexport interface DeidentificationDocumentLocationOutput {\n  /** Location of document in storage. */\n  location: string;\n  /** The entity tag for this resource. */\n  readonly etag: string;\n}\n\n/** Response body for de-identification operation. */\nexport interface DeidentificationResultOutput {\n  /** Output text after de-identification. Not available for \"Tag\" operation. */\n  outputText?: string;\n  /** Result of the \"Tag\" operation. Only available for \"Tag\" Operation. */\n  taggerResult?: PhiTaggerResultOutput;\n}\n\n/** Result of the \"Tag\" operation. */\nexport interface PhiTaggerResultOutput {\n  /** List of entities detected in the input. */\n  entities: Array<PhiEntityOutput>;\n}\n\n/** PHI Entity tag in the input. */\nexport interface PhiEntityOutput {\n  /**\n   * PHI Category of the entity.\n   *\n   * Possible values: \"Unknown\", \"Account\", \"Age\", \"BioID\", \"City\", \"CountryOrRegion\", \"Date\", \"Device\", \"Doctor\", \"Email\", \"Fax\", \"HealthPlan\", \"Hospital\", \"IDNum\", \"IPAddress\", \"License\", \"LocationOther\", \"MedicalRecord\", \"Organization\", \"Patient\", \"Phone\", \"Profession\", \"SocialSecurity\", \"State\", \"Street\", \"Url\", \"Username\", \"Vehicle\", \"Zip\"\n   */\n  category: PhiCategoryOutput;\n  /** Starting index of the location from within the input text. */\n  offset: StringIndexOutput;\n  /** Length of the input text. */\n  length: StringIndexOutput;\n  /** Text of the entity. */\n  text?: string;\n  /** Confidence score of the category match. */\n  confidenceScore?: number;\n}\n\n/** String index encoding model. */\nexport interface StringIndexOutput {\n  /** The offset or length of the substring in UTF-8 encoding */\n  utf8: number;\n  /**\n   * The offset or length of the substring in UTF-16 encoding.\n   *\n   * Primary encoding used by .NET, Java, and JavaScript.\n   */\n  utf16: number;\n  /**\n   * The offset or length of the substring in CodePoint encoding.\n   *\n   * Primary encoding used by Python.\n   */\n  codePoint: number;\n}\n\n/** Alias for DeidentificationOperationTypeOutput */\nexport type DeidentificationOperationTypeOutput = string;\n/** Alias for OperationStateOutput */\nexport type OperationStateOutput = string;\n/** Alias for PhiCategoryOutput */\nexport type PhiCategoryOutput = string;\n"]}