Updates HealthDataAiService.Deid with feedback from SDK Review Team

cSpell.json

@@ -859,6 +859,7 @@
                 "psqldb"
             ]
         },
+
         {
             "filename": "**/specification/maps/data-plane/Weather/stable/1.1/weather.json",
             "words": [
@@ -1133,6 +1134,12 @@
                 "throughputpool"
             ]
         },
+        {
+            "filename": "**/specification/purview/data-plane/Azure.Analytics.Purview.DataMap/**/*.json",
+            "words": [
+                "timerange"
+            ]
+        },
         {
             "filename": "**/specification/healthdataaiservices/**/*.json",
             "words": [

specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-31-preview/Jobs_Cancel.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_CancelJob.json

@@ -1,8 +1,8 @@
 {
-  "title": "Cancel a DeID Job",
-  "operationId": "Jobs_Cancel",
+  "title": "Cancel a De-Identify Job",
+  "operationId": "Deidentification_CancelJob",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "name": "documents_smith_1",
     "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
   },

specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-31-preview/Jobs_Create.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_CreateJob.json

@@ -1,8 +1,8 @@
 {
-  "title": "Create a DeID Job",
-  "operationId": "Jobs_Create",
+  "title": "Create a De-Identify Job",
+  "operationId": "Deidentification_CreateJob",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "name": "documents_smith_1",
     "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
     "resource": {

specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-31-preview/RealtimeOperations_Deid.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_Deidentify.json

@@ -1,8 +1,8 @@
 {
   "title": "Realtime Synchronous Deidentification.",
-  "operationId": "RealtimeOperations_Deid",
+  "operationId": "Deidentification_Deidentify",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "body": {
       "inputText": "Hello my name is John Smith.",
       "dataType": "PlainText",

specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/preview/2024-01-31-preview/examples/Jobs_Delete.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_DeleteJob.json

@@ -1,8 +1,8 @@
 {
-  "title": "Delete a DeID Job",
-  "operationId": "Jobs_Delete",
+  "title": "Delete a De-Identify Job",
+  "operationId": "Deidentification_DeleteJob",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "name": "documents_smith_1",
     "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
   },

specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/preview/2024-01-31-preview/examples/Jobs_Get.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_GetJob.json

@@ -1,8 +1,8 @@
 {
-  "title": "Get a DeID Job",
-  "operationId": "Jobs_Get",
+  "title": "Get a De-Identify Job",
+  "operationId": "Deidentification_GetJob",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "name": "documents_smith_1",
     "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
   },

specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-31-preview/Jobs_ListFiles.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_ListJobFiles.json

@@ -1,8 +1,8 @@
 {
   "title": "List processed files within a Job",
-  "operationId": "Jobs_ListFiles",
+  "operationId": "Deidentification_ListJobFiles",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "name": "documents_smith_1",
     "maxpagesize": 10,
     "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==",

specification/healthdataaiservices/data-plane/HealthDataAIServices.Deidentification/preview/2024-01-31-preview/examples/Jobs_List.json → specification/healthdataaiservices/HealthDataAIServices.Deidentification/examples/2024-01-16-preview/Deidentification_ListJobs.json

@@ -1,8 +1,8 @@
 {
-  "title": "List DeID Jobs",
-  "operationId": "Jobs_List",
+  "title": "List De-Identify Jobs",
+  "operationId": "Deidentification_ListJobs",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "maxpagesize": 10,
     "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==",
     "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"

specification/healthdataaiservices/HealthDataAIServices.Deidentification/main.tsp

@@ -15,11 +15,11 @@ using Azure.Core.Traits;
   title: "HealthDataAIServices.Deidentification Service",
 })
 @server(
-  "https://{deid-service-uri}",
+  "https://{endpoint}",
   "Azure Health Deidentification Service",
   {
-    @doc("Uri of your Deid Service.")
-    `deid-service-uri`: string,
+    @doc("Url of your Deid Service.")
+    endpoint: string,
   }
 )
 @versioned(HealthDataAIServices.Deidentification.Versions)
@@ -40,5 +40,5 @@ model AadToken
 @doc("The HealthDataAIServices.Deidentification service versions.")
 enum Versions {
   @useDependency(Azure.Core.Versions.v1_0_Preview_2)
-  v2024_01_31_preview: "2024-01-31-preview",
+  v2024_01_16_preview: "2024-01-16-preview",
 }

specification/healthdataaiservices/HealthDataAIServices.Deidentification/models.tsp

@@ -9,7 +9,7 @@ namespace HealthDataAIServices.Deidentification;
 
 @doc("A job containing a batch of documents to deidentify.")
 @resource("jobs")
-model Job {
+model DeidentifyJob {
   @key("name")
   @doc("The name of a job.")
   @visibility("read")
@@ -71,8 +71,8 @@ model Job {
 
 @doc("File report once job has completed.")
 @resource("files")
-@parentResource(Job)
-model File {
+@parentResource(DeidentifyJob)
+model HealthFileDetails {
   @key
   @doc("Id of the file report.")
   @visibility("read")
@@ -189,8 +189,9 @@ enum StringIndexType {
   Utf16CodeUnit,
 }
 
-@doc("Request for synchronous DeID operation.")
-model DeidRequest {
+@doc("Request for synchronous De-Identify operation.")
+@projectedName("csharp", "DeidentifyConfig")
+model DeidentifyOptions {
   @doc("Input text to deidentify.")
   @maxLength(100000) // 100KB
   inputText: string;
@@ -209,9 +210,9 @@ model DeidRequest {
   redactionFormat?: string;
 }
 
-@doc("Response for synchronous DeID operation.")
-model DeidResponse {
-  @doc("Output text after deidentification. Not available for Tag Operation.")
+@doc("Response for synchronous De-Identify operation.")
+model DeidentifyResult {
+  @doc("Output text after de-identifying. Not available for Tag Operation.")
   outputText?: string;
 
   @doc("Result of the tag operation. Only available for Tag Operation.")
@@ -245,6 +246,7 @@ enum PhiCategory {
   Age,
 
   @doc("Biological Identifier, such as a fingerprint or retinal scan")
+  @projectedName("python", "BIO_ID")
   BioID,
 
   @doc("City.")
@@ -275,9 +277,11 @@ enum PhiCategory {
   Hospital,
 
   @doc("Id Numbers. Such as a passport number.")
+  @projectedName("python", "ID_NUM")
   IDNum,
 
   @doc("IP Address.")
+  @projectedName("python", "IP_ADDRESS")
   IPAddress,
 
   @doc("License. Such as a driver's license or medical license")

specification/healthdataaiservices/HealthDataAIServices.Deidentification/routes.tsp

@@ -15,59 +15,57 @@ alias ServiceTraits = NoRepeatableRequests &
   NoConditionalRequests &
   SupportsClientRequestId;
 
-alias DeidOperations = ResourceOperations<
+alias DeidentifyOperations = ResourceOperations<
   ServiceTraits,
   Azure.Core.Foundations.ErrorResponse
 >;
 
-interface Jobs {
-  @summary("Create a DeID Job")
-  @pollingOperation(Jobs.get)
-  create is DeidOperations.LongRunningResourceCreateOrReplace<Job>;
+interface Deidentification {
+  @summary("Create a De-Identify Job")
+  createJob is DeidentifyOperations.LongRunningResourceCreateOrReplace<DeidentifyJob>;
 
-  @summary("Get a DeID Job")
-  get is DeidOperations.ResourceRead<Job>;
+  @summary("Get a De-Identify Job")
+  getJob is DeidentifyOperations.ResourceRead<DeidentifyJob>;
 
-  @summary("List DeID Jobs")
-  list is DeidOperations.ResourceList<
-    Job,
+  @summary("List De-Identify Jobs")
+  listJobs is DeidentifyOperations.ResourceList<
+    DeidentifyJob,
     ListQueryParametersTrait<PaginationByTokenQueryParameters>
   >;
 
   @summary("List processed files within a Job")
-  listFiles is DeidOperations.ResourceList<
-    File,
+  listJobFiles is DeidentifyOperations.ResourceList<
+    HealthFileDetails,
     ListQueryParametersTrait<PaginationByTokenQueryParameters>
   >;
 
-  @summary("Cancel a DeID Job")
+  @summary("Cancel a De-Identify Job")
   @doc("""
   Cancels a job that is in progress. 
 
   The job will be marked as canceled and the service will stop processing the job. The service will not delete any files that have already been processed.
 
   If the job is already complete, this will have no effect. 
   """)
-  cancel is DeidOperations.ResourceAction<Job, {}, Job>;
+  cancelJob is DeidentifyOperations.ResourceAction<
+    DeidentifyJob,
+    {},
+    DeidentifyJob
+  >;
 
-  @summary("Delete a DeID Job")
+  @summary("Delete a De-Identify Job")
   @doc("Removes the record of the job from the service. Does not delete any files.")
-  delete is DeidOperations.ResourceDelete<Job>;
-}
+  deleteJob is DeidentifyOperations.ResourceDelete<DeidentifyJob>;
 
-interface RealtimeOperations {
   @summary("Realtime Synchronous Deidentification.")
   @route("/deid")
   @post
-  deid is Azure.Core.RpcOperation<
+  deidentify is Azure.Core.RpcOperation<
     {
       @doc("The request body for realtime deidentification.")
       @body
-      @projectedName("csharp", "options")
-      @projectedName("python", "options")
-      @projectedName("java", "options")
-      body: DeidRequest;
+      body: DeidentifyOptions;
     },
-    DeidResponse
+    DeidentifyResult
   >;
 }

specification/healthdataaiservices/HealthDataAIServices.Deidentification/tspconfig.yaml

@@ -1,6 +1,6 @@
 parameters:
   "service-dir":
-    default: "sdk/deid"
+    default: "sdk/healthdataaiservices"
   "dependencies":
     "additionalDirectories": []
     default: ""
@@ -14,24 +14,24 @@ options:
     output-file: "{project-root}/../data-plane/{service-name}/{version-status}/{version}/{service-name}.json"
     omit-unreachable-types: true
   "@azure-tools/typespec-python":
-    package-dir: "azure-healthdataaiservices-deid"
+    package-dir: "azure-health-deidentification"
     package-name: "{package-dir}"
     package-mode: dataplane
   "@azure-tools/typespec-csharp":
-    package-dir: "Azure.HealthDataAIServices.Deid"
+    package-dir: "Azure.Health.Deidentification"
     namespace: "{package-dir}"
     clear-output-folder: true
     model-namespace: false
   "@azure-tools/typespec-ts":
-    package-dir: "azure-healthdataaiservices-deid-rest"
+    package-dir: "azure-health-deidentification"
     generateMetadata: true
     generateTest: true
     packageDetails:
-      name: "@azure-rest/azure-healthdataaiservices-deid-rest"
-      description: "Azure.HealthDataAIServices.Deid Service"
+      name: "@azure-rest/azure-health-deidentification"
+      description: "Health Deidentification Service"
   "@azure-tools/typespec-java":
-    package-dir: "azure-healthdataaiservices-deid"
-    namespace: com.azure.healthdataaiservices.deid
+    package-dir: "azure-health-deidentification"
+    namespace: "com.azure.health.deidentification"
 linter:
   extends:
     - "@azure-tools/typespec-azure-core/all"