Deid GA Cleanup (Azure#44994)

* Pull in TypeSpec changes, update tests, samples, and changelog

* update tsp

---------

Co-authored-by: Josiah Vinson <jovinson@microsoft.com>

Author: jovinson-ms

sdk/healthdataaiservices/azure-health-deidentification/CHANGELOG.md

@@ -11,15 +11,23 @@
 
 ### Breaking Changes
 
-- Changed the name of model `OperationState` to `OperationStatus`.
-- Changed the property `DeidentificationJob.name` to `DeidentificationJob.jobName`, and corresponding parameters in client methods. 
-- Changed the property `DeidentificationJob.type` to `DeidentificationJob.operationType`.
 - Changed method names in `DeidentificationClient` to match functionality:
-  - Changed the `deidentify` method name to `deidentifyText`.
-  - Changed the `beginCreateJob` method name to `beginDeidentifyDocuments`.
-- Changed `outputPrefix` behavior to no longer include `jobName` by default.
-- Changed `Path` field to `Location` in `SourceStorageLocation` and `TargetStorageLocation`.
+    - Changed the `deidentify` method name to `deidentifyText`.
+    - Changed the `beginCreateJob` method name to `beginDeidentifyDocuments`.
+- Renamed the property `DeidentificationContent.operation` to `operationType`.
 - Deprecated `DocumentDataType`.
+- Changed the model `DeidentificationDocumentDetails`:
+    - Renamed `input` to `inputLocation`.
+    - Renamed `output` to `outputLocation`.
+- Changed the model `DeidentificationJob`
+    - Renamed `name` to `jobName`.
+    - Renamed `operation` to `operationType`.
+- Renamed the model `OperationState` to `OperationStatus`.
+- Changed the model `PhiCategory`:
+  - Renamed `IDNUM` to `ID_NUM`.
+  - Renamed `IPADDRESS` to `IP_ADDRESS`.
+- Changed `Path` field to `Location` in `SourceStorageLocation` and `TargetStorageLocation`.
+- Changed `outputPrefix` behavior to no longer include `jobName` by default.
 - Deprecated `Path` and `Location` from `TaggerResult` model.
 
 ## 1.0.0-beta.1 (2024-08-15)

sdk/healthdataaiservices/azure-health-deidentification/README.md

@@ -64,7 +64,7 @@ You can de-identify text directly using the `DeidentificationClient`:
 String inputText = "Hello, my name is John Smith.";
 
 DeidentificationContent content = new DeidentificationContent(inputText);
-content.setOperation(DeidentificationOperationType.SURROGATE);
+content.setOperationType(DeidentificationOperationType.SURROGATE);
 
 DeidentificationResult result = deidentificationClient.deidentifyText(content);
 System.out.println("De-identified output: " + (result != null ? result.getOutputText() : null));
@@ -122,7 +122,7 @@ DeidentificationClient deidentificationClient = new DeidentificationClientBuilde
 String inputText = "Hello, my name is John Smith.";
 
 DeidentificationContent content = new DeidentificationContent(inputText);
-content.setOperation(DeidentificationOperationType.SURROGATE);
+content.setOperationType(DeidentificationOperationType.SURROGATE);
 
 DeidentificationResult result = deidentificationClient.deidentifyText(content);
 System.out.println("De-identified output: " + (result != null ? result.getOutputText() : null));
@@ -171,7 +171,7 @@ for (DeidentificationJob job : result) {
 String jobName = Configuration.getGlobalConfiguration().get("DEID_JOB_NAME");
 PagedIterable<DeidentificationDocumentDetails> result = deidentificationClient.listJobDocuments(jobName);
 for (DeidentificationDocumentDetails documentDetails : result) {
-    System.out.println(documentDetails.getInput().getLocation() + " - " + documentDetails.getStatus());
+    System.out.println(documentDetails.getInputLocation().getLocation() + " - " + documentDetails.getStatus());
 }
 ```
 

sdk/healthdataaiservices/azure-health-deidentification/customization/pom.xml

@@ -23,12 +23,6 @@ public final class DeidentificationContent implements JsonSerializable<Deidentif
     @Generated
     private final String inputText;
 
-    /*
-     * Operation to perform on the input documents.
-     */
-    @Generated
-    private DeidentificationOperationType operation;
-
     /*
      * Customization parameters to override default service behaviors.
      */
@@ -55,28 +49,6 @@ public String getInputText() {
         return this.inputText;
     }
 
-    /**
-     * Get the operation property: Operation to perform on the input documents.
-     *
-     * @return the operation value.
-     */
-    @Generated
-    public DeidentificationOperationType getOperation() {
-        return this.operation;
-    }
-
-    /**
-     * Set the operation property: Operation to perform on the input documents.
-     *
-     * @param operation the operation value to set.
-     * @return the DeidentificationContent object itself.
-     */
-    @Generated
-    public DeidentificationContent setOperation(DeidentificationOperationType operation) {
-        this.operation = operation;
-        return this;
-    }
-
     /**
      * Get the customizations property: Customization parameters to override default service behaviors.
      *
@@ -107,7 +79,7 @@ public DeidentificationContent setCustomizations(DeidentificationCustomizationOp
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
         jsonWriter.writeStringField("inputText", this.inputText);
-        jsonWriter.writeStringField("operation", this.operation == null ? null : this.operation.toString());
+        jsonWriter.writeStringField("operation", this.operationType == null ? null : this.operationType.toString());
         jsonWriter.writeJsonField("customizations", this.customizations);
         return jsonWriter.writeEndObject();
     }
@@ -125,25 +97,53 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
     public static DeidentificationContent fromJson(JsonReader jsonReader) throws IOException {
         return jsonReader.readObject(reader -> {
             String inputText = null;
-            DeidentificationOperationType operation = null;
+            DeidentificationOperationType operationType = null;
             DeidentificationCustomizationOptions customizations = null;
             while (reader.nextToken() != JsonToken.END_OBJECT) {
                 String fieldName = reader.getFieldName();
                 reader.nextToken();
                 if ("inputText".equals(fieldName)) {
                     inputText = reader.getString();
                 } else if ("operation".equals(fieldName)) {
-                    operation = DeidentificationOperationType.fromString(reader.getString());
+                    operationType = DeidentificationOperationType.fromString(reader.getString());
                 } else if ("customizations".equals(fieldName)) {
                     customizations = DeidentificationCustomizationOptions.fromJson(reader);
                 } else {
                     reader.skipChildren();
                 }
             }
             DeidentificationContent deserializedDeidentificationContent = new DeidentificationContent(inputText);
-            deserializedDeidentificationContent.operation = operation;
+            deserializedDeidentificationContent.operationType = operationType;
             deserializedDeidentificationContent.customizations = customizations;
             return deserializedDeidentificationContent;
         });
     }
+
+    /*
+     * Operation to perform on the input documents.
+     */
+    @Generated
+    private DeidentificationOperationType operationType;
+
+    /**
+     * Get the operationType property: Operation to perform on the input documents.
+     *
+     * @return the operationType value.
+     */
+    @Generated
+    public DeidentificationOperationType getOperationType() {
+        return this.operationType;
+    }
+
+    /**
+     * Set the operationType property: Operation to perform on the input documents.
+     *
+     * @param operationType the operationType value to set.
+     * @return the DeidentificationContent object itself.
+     */
+    @Generated
+    public DeidentificationContent setOperationType(DeidentificationOperationType operationType) {
+        this.operationType = operationType;
+        return this;
+    }
 }

sdk/healthdataaiservices/azure-health-deidentification/customization/src/main/java/ListJobsCustomization.java

@@ -24,18 +24,6 @@ public final class DeidentificationDocumentDetails implements JsonSerializable<D
     @Generated
     private String id;
 
-    /*
-     * Location for the input.
-     */
-    @Generated
-    private final DeidentificationDocumentLocation input;
-
-    /*
-     * Location for the output.
-     */
-    @Generated
-    private DeidentificationDocumentLocation output;
-
     /*
      * Status of the document.
      */
@@ -58,26 +46,6 @@ public String getId() {
         return this.id;
     }
 
-    /**
-     * Get the input property: Location for the input.
-     *
-     * @return the input value.
-     */
-    @Generated
-    public DeidentificationDocumentLocation getInput() {
-        return this.input;
-    }
-
-    /**
-     * Get the output property: Location for the output.
-     *
-     * @return the output value.
-     */
-    @Generated
-    public DeidentificationDocumentLocation getOutput() {
-        return this.output;
-    }
-
     /**
      * Get the status property: Status of the document.
      *
@@ -105,9 +73,9 @@ public ResponseError getError() {
     @Override
     public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeStartObject();
-        jsonWriter.writeJsonField("input", this.input);
+        jsonWriter.writeJsonField("input", this.inputLocation);
         jsonWriter.writeStringField("status", this.status == null ? null : this.status.toString());
-        jsonWriter.writeJsonField("output", this.output);
+        jsonWriter.writeJsonField("output", this.outputLocation);
         jsonWriter.writeJsonField("error", this.error);
         return jsonWriter.writeEndObject();
     }
@@ -125,31 +93,31 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
     public static DeidentificationDocumentDetails fromJson(JsonReader jsonReader) throws IOException {
         return jsonReader.readObject(reader -> {
             String id = null;
-            DeidentificationDocumentLocation input = null;
+            DeidentificationDocumentLocation inputLocation = null;
             OperationStatus status = null;
-            DeidentificationDocumentLocation output = null;
+            DeidentificationDocumentLocation outputLocation = null;
             ResponseError error = null;
             while (reader.nextToken() != JsonToken.END_OBJECT) {
                 String fieldName = reader.getFieldName();
                 reader.nextToken();
                 if ("id".equals(fieldName)) {
                     id = reader.getString();
                 } else if ("input".equals(fieldName)) {
-                    input = DeidentificationDocumentLocation.fromJson(reader);
+                    inputLocation = DeidentificationDocumentLocation.fromJson(reader);
                 } else if ("status".equals(fieldName)) {
                     status = OperationStatus.fromString(reader.getString());
                 } else if ("output".equals(fieldName)) {
-                    output = DeidentificationDocumentLocation.fromJson(reader);
+                    outputLocation = DeidentificationDocumentLocation.fromJson(reader);
                 } else if ("error".equals(fieldName)) {
                     error = ResponseError.fromJson(reader);
                 } else {
                     reader.skipChildren();
                 }
             }
             DeidentificationDocumentDetails deserializedDeidentificationDocumentDetails
-                = new DeidentificationDocumentDetails(input, status);
+                = new DeidentificationDocumentDetails(inputLocation, status);
             deserializedDeidentificationDocumentDetails.id = id;
-            deserializedDeidentificationDocumentDetails.output = output;
+            deserializedDeidentificationDocumentDetails.outputLocation = outputLocation;
             deserializedDeidentificationDocumentDetails.error = error;
             return deserializedDeidentificationDocumentDetails;
         });
@@ -158,12 +126,44 @@ public static DeidentificationDocumentDetails fromJson(JsonReader jsonReader) th
     /**
      * Creates an instance of DeidentificationDocumentDetails class.
      *
-     * @param input the input value to set.
+     * @param inputLocation the inputLocation value to set.
      * @param status the status value to set.
      */
     @Generated
-    private DeidentificationDocumentDetails(DeidentificationDocumentLocation input, OperationStatus status) {
-        this.input = input;
+    private DeidentificationDocumentDetails(DeidentificationDocumentLocation inputLocation, OperationStatus status) {
+        this.inputLocation = inputLocation;
         this.status = status;
     }
+
+    /*
+     * Location for the input.
+     */
+    @Generated
+    private final DeidentificationDocumentLocation inputLocation;
+
+    /*
+     * Location for the output.
+     */
+    @Generated
+    private DeidentificationDocumentLocation outputLocation;
+
+    /**
+     * Get the inputLocation property: Location for the input.
+     *
+     * @return the inputLocation value.
+     */
+    @Generated
+    public DeidentificationDocumentLocation getInputLocation() {
+        return this.inputLocation;
+    }
+
+    /**
+     * Get the outputLocation property: Location for the output.
+     *
+     * @return the outputLocation value.
+     */
+    @Generated
+    public DeidentificationDocumentLocation getOutputLocation() {
+        return this.outputLocation;
+    }
 }

sdk/healthdataaiservices/azure-health-deidentification/src/main/java/com/azure/health/deidentification/models/DeidentificationContent.java

@@ -90,18 +90,6 @@ public final class PhiCategory extends ExpandableStringEnum<PhiCategory> {
     @Generated
     public static final PhiCategory HOSPITAL = fromString("Hospital");
 
-    /**
-     * Id Number, eg. passport number.
-     */
-    @Generated
-    public static final PhiCategory IDNUM = fromString("IDNum");
-
-    /**
-     * IP Address.
-     */
-    @Generated
-    public static final PhiCategory IPADDRESS = fromString("IPAddress");
-
     /**
      * License, eg. Driver's license or medical license.
      */
@@ -216,4 +204,16 @@ public static PhiCategory fromString(String name) {
     public static Collection<PhiCategory> values() {
         return values(PhiCategory.class);
     }
+
+    /**
+     * Id Number, eg. passport number.
+     */
+    @Generated
+    public static final PhiCategory ID_NUM = fromString("IDNum");
+
+    /**
+     * IP Address.
+     */
+    @Generated
+    public static final PhiCategory IP_ADDRESS = fromString("IPAddress");
 }

sdk/healthdataaiservices/azure-health-deidentification/src/main/java/com/azure/health/deidentification/models/DeidentificationDocumentDetails.java

@@ -20,7 +20,7 @@ public static void main(String[] args) {
         String inputText = "Hello, my name is John Smith.";
 
         DeidentificationContent content = new DeidentificationContent(inputText);
-        content.setOperation(DeidentificationOperationType.SURROGATE);
+        content.setOperationType(DeidentificationOperationType.SURROGATE);
 
         DeidentificationResult result = deidentificationClient.deidentifyText(content);
         System.out.println("De-identified output: " + (result != null ? result.getOutputText() : null));