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/client.tsp

@@ -3,3 +3,11 @@
  * Add readme and sample
  */
 import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+
+// // This model is input only
+// @@usage(HealthDataAIServices.Deidentification.DeidentifyOptions, Usage.input);
+// // This models is input/output
+// @@usage(HealthDataAIServices.Deidentification.DeidentifyJob, Usage.output);

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

@@ -1,8 +1,8 @@
 {
-  "title": "Cancel a DeID Job",
-  "operationId": "Jobs_Cancel",
+  "title": "Cancel a De-Identify Job",
+  "operationId": "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"
   },
@@ -18,11 +18,10 @@
           ]
         },
         "targetLocation": {
-          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
           "prefix": "/documents"
         },
-        "dataType": "PlainText",
         "operation": "Redact",
+        "dataType": "Plaintext",
         "redactionFormat": "[{type}]",
         "status": "Canceled",
         "createdAt": "2024-01-25T23:27:43.009Z",

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

@@ -1,8 +1,8 @@
 {
-  "title": "Create a DeID Job",
-  "operationId": "Jobs_Create",
+  "title": "Create a De-Identify Job",
+  "operationId": "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": {
@@ -17,9 +17,10 @@
         "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
         "prefix": "/documents"
       },
-      "dataType": "PlainText",
       "operation": "Redact",
-      "redactionFormat": "[{type}]"
+      "dataType": "Plaintext",
+      "redactionFormat": "[{type}]",
+      "status": "NotStarted"
     }
   },
   "responses": {
@@ -34,11 +35,10 @@
           ]
         },
         "targetLocation": {
-          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
           "prefix": "/documents"
         },
-        "dataType": "PlainText",
         "operation": "Redact",
+        "dataType": "Plaintext",
         "redactionFormat": "[{type}]",
         "status": "NotStarted",
         "createdAt": "2024-01-25T23:27:43.009Z",
@@ -59,11 +59,10 @@
           ]
         },
         "targetLocation": {
-          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
           "prefix": "/documents"
         },
-        "dataType": "PlainText",
         "operation": "Redact",
+        "dataType": "Plaintext",
         "redactionFormat": "[{type}]",
         "status": "NotStarted",
         "createdAt": "2024-01-25T23:27:43.009Z",

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

@@ -1,12 +1,12 @@
 {
   "title": "Realtime Synchronous Deidentification.",
-  "operationId": "RealtimeOperations_Deid",
+  "operationId": "Deidentify",
   "parameters": {
-    "api-version": "2024-01-31-preview",
+    "api-version": "2024-01-16-preview",
     "body": {
       "inputText": "Hello my name is John Smith.",
-      "dataType": "PlainText",
       "operation": "Redact",
+      "dataType": "Plaintext",
       "stringIndexType": "TextElement_v8",
       "redactionFormat": "[{type}]"
     }

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

@@ -1,8 +1,8 @@
 {
-  "title": "Delete a DeID Job",
-  "operationId": "Jobs_Delete",
+  "title": "Delete a De-Identify Job",
+  "operationId": "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/GetJob.json

@@ -1,8 +1,8 @@
 {
-  "title": "Get a DeID Job",
-  "operationId": "Jobs_Get",
+  "title": "Get a De-Identify Job",
+  "operationId": "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"
   },
@@ -18,11 +18,10 @@
           ]
         },
         "targetLocation": {
-          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
           "prefix": "/documents"
         },
-        "dataType": "PlainText",
         "operation": "Redact",
+        "dataType": "Plaintext",
         "redactionFormat": "[{type}]",
         "status": "Succeeded",
         "createdAt": "2024-01-25T23:27:43.009Z",

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

@@ -1,8 +1,8 @@
 {
   "title": "List processed files within a Job",
-  "operationId": "Jobs_ListFiles",
+  "operationId": "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/ListJobs.json

@@ -1,8 +1,8 @@
 {
-  "title": "List DeID Jobs",
-  "operationId": "Jobs_List",
+  "title": "List De-Identify Jobs",
+  "operationId": "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"
@@ -21,11 +21,10 @@
               ]
             },
             "targetLocation": {
-              "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
               "prefix": "/documents"
             },
-            "dataType": "PlainText",
             "operation": "Redact",
+            "dataType": "Plaintext",
             "redactionFormat": "[{type}]",
             "status": "Succeeded",
             "createdAt": "2024-01-25T23:27:43.009Z",

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",
 }