[FR] flatten TextStyle's properties in TextAppearance (Azure#21197)

* flatten TextStyle's properties in TextAppearance

Author: mssfang

sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md

@@ -5,6 +5,14 @@
 - Renamed `ReadingOrder` model to `FormReadingOrder`.
 - Renamed the method names and the method parameters, using `identity` to replace `id` keyword in the identity documents recognition API.
   For example, renamed `beginRecognizeIdDocuments` to `beginRecognizeIdentityDocuments`.
+- The model `TextAppearance` now includes the properties `styleName` and `styleConfidence` that were part of the `TextStyle` object.
+- Removed the model `TextStyle`.
+- Removed `V2_1_PREVIEW_1` and `V2_1_PREVIEW_2` but only support latest service beta API version `V2_1_PREVIEW_3`.
+
+### New features
+- Added `clientOptions` method to the `FormRecognizerClientBuilder` and `FormTrainingClientBuilder`.
+- Added `getDefaultLogOptions` method to the `FormRecognizerClientBuilder`.
+- We are able to support multiple service API versions now: `V2_0` and `V2_1_PREVIEW_3`.
 
 ## 3.0.7 (2021-04-07)
 ### Dependency updates

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/Transforms.java

@@ -3,13 +3,12 @@
 
 package com.azure.ai.formrecognizer;
 
-import com.azure.ai.formrecognizer.implementation.TextAppearanceHelper;
 import com.azure.ai.formrecognizer.implementation.FormLineHelper;
 import com.azure.ai.formrecognizer.implementation.FormPageHelper;
 import com.azure.ai.formrecognizer.implementation.FormSelectionMarkHelper;
 import com.azure.ai.formrecognizer.implementation.FormTableHelper;
 import com.azure.ai.formrecognizer.implementation.RecognizedFormHelper;
-import com.azure.ai.formrecognizer.implementation.TextStyleHelper;
+import com.azure.ai.formrecognizer.implementation.TextAppearanceHelper;
 import com.azure.ai.formrecognizer.implementation.models.AnalyzeResult;
 import com.azure.ai.formrecognizer.implementation.models.DocumentResult;
 import com.azure.ai.formrecognizer.implementation.models.FieldValue;
@@ -20,7 +19,6 @@
 import com.azure.ai.formrecognizer.implementation.models.SelectionMarkState;
 import com.azure.ai.formrecognizer.implementation.models.TextLine;
 import com.azure.ai.formrecognizer.implementation.models.TextWord;
-import com.azure.ai.formrecognizer.models.TextAppearance;
 import com.azure.ai.formrecognizer.models.FieldBoundingBox;
 import com.azure.ai.formrecognizer.models.FieldData;
 import com.azure.ai.formrecognizer.models.FieldValueType;
@@ -36,7 +34,7 @@
 import com.azure.ai.formrecognizer.models.LengthUnit;
 import com.azure.ai.formrecognizer.models.Point;
 import com.azure.ai.formrecognizer.models.RecognizedForm;
-import com.azure.ai.formrecognizer.models.TextStyle;
+import com.azure.ai.formrecognizer.models.TextAppearance;
 import com.azure.ai.formrecognizer.models.TextStyleName;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
@@ -54,7 +52,6 @@
 
 import static com.azure.ai.formrecognizer.implementation.Utility.forEachWithIndex;
 import static com.azure.ai.formrecognizer.implementation.models.FieldValueType.ARRAY;
-import static com.azure.ai.formrecognizer.implementation.models.FieldValueType.OBJECT;
 
 /**
  * Helper class to convert service level models to SDK exposed models.
@@ -275,21 +272,20 @@ static List<FormLine> getReadResultFormLines(ReadResult readResultItem) {
 
     /**
      * Private method to get the appearance from the service side text line object.
+     *
      * @param textLine The service side text line object.
-     * @return the custom type Appearance model.
+     * @return the custom type TextAppearance model.
      */
     private static TextAppearance getTextAppearance(TextLine textLine) {
-        TextStyle textStyle = new TextStyle();
+        TextAppearance textAppearance = new TextAppearance();
         if (textLine.getAppearance() != null && textLine.getAppearance().getStyle() != null) {
             if (textLine.getAppearance().getStyle().getName() != null) {
-                TextStyleHelper.setName(textStyle,
+                TextAppearanceHelper.setStyleName(textAppearance,
                     TextStyleName.fromString(textLine.getAppearance().getStyle().getName().toString()));
             }
-            TextStyleHelper.setConfidence(textStyle, textLine.getAppearance().getStyle().getConfidence());
+            TextAppearanceHelper.setStyleConfidence(textAppearance,
+                textLine.getAppearance().getStyle().getConfidence());
         }
-
-        TextAppearance textAppearance = new TextAppearance();
-        TextAppearanceHelper.setStyle(textAppearance, textStyle);
         return textAppearance;
     }
 

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/TextAppearanceHelper.java

@@ -4,7 +4,7 @@
 package com.azure.ai.formrecognizer.implementation;
 
 import com.azure.ai.formrecognizer.models.TextAppearance;
-import com.azure.ai.formrecognizer.models.TextStyle;
+import com.azure.ai.formrecognizer.models.TextStyleName;
 
 /**
  * The helper class to set the non-public properties of an {@link TextAppearance} instance.
@@ -18,19 +18,24 @@ private TextAppearanceHelper() { }
      * Type defining the methods to set the non-public properties of an {@link TextAppearance} instance.
      */
     public interface TextAppearanceAccessor {
-        void setStyle(TextAppearance textAppearance, TextStyle textStyle);
+        void setStyleName(TextAppearance textAppearance, TextStyleName styleName);
+        void setStyleConfidence(TextAppearance textAppearance, float styleConfidence);
     }
 
     /**
      * The method called from {@link TextAppearance} to set it's accessor.
      *
-     * @param styleAccessor The accessor.
+     * @param textAppearanceAccessor The accessor.
      */
-    public static void setAccessor(final TextAppearanceAccessor styleAccessor) {
-        accessor = styleAccessor;
+    public static void setAccessor(final TextAppearanceAccessor textAppearanceAccessor) {
+        accessor = textAppearanceAccessor;
     }
 
-    public static void setStyle(TextAppearance textAppearance, TextStyle textStyle) {
-        accessor.setStyle(textAppearance, textStyle);
+    public static void setStyleName(TextAppearance textAppearance, TextStyleName styleName) {
+        accessor.setStyleName(textAppearance, styleName);
+    }
+
+    public static void setStyleConfidence(TextAppearance textAppearance, float styleConfidence) {
+        accessor.setStyleConfidence(textAppearance, styleConfidence);
     }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/TextStyleHelper.java

@@ -8,36 +8,66 @@
 /** The TextAppearance model representing the appearance of the text line. */
 public final class TextAppearance {
     /*
-     * An object representing the style of the text line.
+     * The text line style name, including handwriting and other.
      */
-    private TextStyle style;
+    private TextStyleName styleName;
+
+    /*
+     * The confidence of text line style.
+     */
+    private float styleConfidence;
 
     static {
         TextAppearanceHelper.setAccessor(new TextAppearanceHelper.TextAppearanceAccessor() {
             @Override
-            public void setStyle(TextAppearance textAppearance, TextStyle textStyle) {
-                textAppearance.setStyle(textStyle);
+            public void setStyleConfidence(TextAppearance textAppearance, float styleConfidence) {
+                textAppearance.setStyleConfidence(styleConfidence);
+            }
+
+            @Override
+            public void setStyleName(TextAppearance textAppearance, TextStyleName styleName) {
+                textAppearance.setStyleName(styleName);
             }
         });
     }
 
     /**
-     * Get the style of the text line.
+     * Get the text line style name. Possible values include handwriting and other.
+     *
+     * @return the style name value.
+     */
+    public TextStyleName getStyleName() {
+        return this.styleName;
+    }
+
+    /**
+     * Private setter to set the text line style name, including handwriting and other.
+     *
+     * @param styleName the style name value to set.
+     * @return the TextAppearance object itself.
+     */
+    private TextAppearance setStyleName(TextStyleName styleName) {
+        this.styleName = styleName;
+        return this;
+    }
+
+    /**
+     * Get the confidence of the recognized text line style.
      *
-     * @return the style value.
+     * @return the confidence value.
      */
-    public TextStyle getStyle() {
-        return this.style;
+    public float getStyleConfidence() {
+        return this.styleConfidence;
     }
 
     /**
-     * Private setter to set an object representing the style of the text line.
+     * Private setter to set the confidence of text line style.
      *
-     * @param style the style value to set.
-     * @return the Appearance object itself.
+     * @param styleConfidence the style confidence value to set.
+     * @return the TextAppearance object itself.
      */
-    private TextAppearance setStyle(TextStyle style) {
-        this.style = style;
+    private TextAppearance setStyleConfidence(float styleConfidence) {
+        this.styleConfidence = styleConfidence;
         return this;
     }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/TextAppearance.java

@@ -71,8 +71,8 @@ public static void main(final String[] args) throws IOException {
                     System.out.printf(
                         "Line %s consists of %d words and has a text style %s with a confidence score of %.2f.%n",
                         formLine.getText(), formLine.getWords().size(),
-                        formLine.getAppearance().getStyle().getName(),
-                        formLine.getAppearance().getStyle().getConfidence());
+                        formLine.getAppearance().getStyleName(),
+                        formLine.getAppearance().getStyleConfidence());
                 }
             });
         }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/TextStyle.java

@@ -73,8 +73,8 @@ public static void main(final String[] args) {
                         System.out.printf(
                             "Line %s consists of %d words and has a text style %s with a confidence score of %.2f.%n",
                             formLine.getText(), formLine.getWords().size(),
-                            formLine.getAppearance().getStyle().getName(),
-                            formLine.getAppearance().getStyle().getConfidence());
+                            formLine.getAppearance().getStyleName(),
+                            formLine.getAppearance().getStyleConfidence());
                     }
                 });
             }

sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContent.java

@@ -79,8 +79,8 @@ public static void main(final String[] args) throws IOException {
                     System.out.printf(
                         "Line %s consists of %d words and has a text style %s with a confidence score of %.2f.%n",
                         formLine.getText(), formLine.getWords().size(),
-                        formLine.getAppearance().getStyle().getName(),
-                        formLine.getAppearance().getStyle().getConfidence());
+                        formLine.getAppearance().getStyleName(),
+                        formLine.getAppearance().getStyleConfidence());
                 }
             });
         }

sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContentFromUrlAsync.java

@@ -515,7 +515,7 @@ public void recognizeContentAppearance(HttpClient httpClient, FormRecognizerServ
             List<FormPage> formPages = syncPoller.getFinalResult();
             validateContentResultData(formPages, false);
             assertEquals(TextStyleName.OTHER,
-                formPages.get(0).getLines().get(0).getAppearance().getStyle().getName());
+                formPages.get(0).getLines().get(0).getAppearance().getStyleName());
         }, FORM_JPG);
     }