@azure-rest/health-deidentification 1.0.0-alpha.20250702.3 → 1.0.0-alpha.20250715.2

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
@@ -12,6 +13,7 @@ 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
@@ -64,32 +66,45 @@ 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`.
 
+### 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 +113,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 +133,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 +143,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 +157,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 +177,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";
 
@@ -206,12 +228,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-rest/health-deidentification",
-  "version": "1.0.0-alpha.20250702.3",
+  "version": "1.0.0-alpha.20250715.2",
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/healthdataaiservices/health-deidentification-rest",
   "description": "Azure Health Data Services de-identification service",
   "engines": {
@@ -94,7 +94,7 @@
   },
   "scripts": {
     "build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
-    "build:samples": "echo Obsolete.",
+    "build:samples": "dev-tool samples publish",
     "build:test": "npm run clean && dev-tool run build-package && dev-tool run build-test",
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\" \"samples-dev/**/*.ts\"",
     "clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
@@ -102,19 +102,13 @@
     "extract-api": "dev-tool run build-package && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\" \"samples-dev/**/*.ts\"",
     "generate:client": "autorest --typescript ./swagger/README.md",
-    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "integration-test:browser": "dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
-    "integration-test:node": "dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest",
     "lint": "eslint package.json api-extractor.json src test",
     "lint:fix": "eslint package.json api-extractor.json src test --fix --fix-type [problem,suggestion]",
     "pack": "npm pack 2>&1",
-    "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run bundle && npm run unit-test:browser",
-    "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
-    "test:node": "npm run clean && dev-tool run build-package && npm run unit-test:node",
+    "test": "npm run test:node && npm run test:browser",
+    "test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
+    "test:node": "dev-tool run test:vitest",
     "test:node:esm": "dev-tool run test:vitest --esm",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "unit-test:browser": "npm run integration-test:browser",
-    "unit-test:node": "npm run integration-test:node",
     "update-snippets": "dev-tool run update-snippets"
   },
   "exports": {