[Form Recognizer] Add misc properties on models (#34363)

Azure · Apr 7, 2023 · c5ef04f · c5ef04f
1 parent 6bd237c
commit c5ef04f
Show file tree

Hide file tree

Showing 26 changed files with 693 additions and 80 deletions.
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md b/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md
@@ -7,6 +7,15 @@
 - Added support for AzureBlobList source type when building document models
 - Added support for building, getting, listing and deleting classifiers
 - Added support for queryFields premium feature when performing analysis operations
+- Added model `QuotaDetails` and property `customNeuralDocumentModelBuilds` on `ResourceDetails`
+- Added property `expiresOn` to `DocumentModelDetails` and `DocumentModelSummary`
+- Added properties on `DocumentStyle` : `similarFontFamily`, `fontStyle`, `fontWeight`, `color`, `backgroundColor`
+- Added property `commonName` to `DocumentKeyValuePair`.
+- Added support for ParagraphRole `formulaBlock`
+- Added support for `code` property on `CurrencyValue`
+- Added properties `unit`, `cityDistrict`, `stateDistrict`, `suburb`, `house`, and `level` to `AddressValue`
+- Added method `isValueBoolean` to model `DocumentField`
+- Added support for `DocumentFieldType.BOOLEAN`
 
 ### Breaking Changes
 

diff --git a/.../azure/ai/formrecognizer/documentanalysis/administration/models/DocumentModelDetails.java b/.../azure/ai/formrecognizer/documentanalysis/administration/models/DocumentModelDetails.java
@@ -37,6 +37,9 @@ public final class DocumentModelDetails {
      */
     private Map<String, String> tags;
 
+    private OffsetDateTime expiresOn;
+
+
     /**
      * Get the Unique model identifier.
      *
@@ -103,6 +106,19 @@ private void setTags(Map<String, String> tags) {
         this.tags = tags;
     }
 
+    /**
+     * Get the Date and time (UTC) when the analyze operation was submitted.
+     *
+     * @return the expiresOn value.
+     */
+    public OffsetDateTime getExpiresOn() {
+        return expiresOn;
+    }
+
+    private void setExpiresOn(OffsetDateTime expiresOn) {
+        this.expiresOn = expiresOn;
+    }
+
     static {
         DocumentModelDetailsHelper.setAccessor(new DocumentModelDetailsHelper.DocumentModelDetailsAccessor() {
             @Override
@@ -129,6 +145,11 @@ public void setDocTypes(DocumentModelDetails documentModelDetails, Map<String, D
             public void setTags(DocumentModelDetails documentModelDetails, Map<String, String> tags) {
                 documentModelDetails.setTags(tags);
             }
+
+            @Override
+            public void setExpiresOn(DocumentModelDetails documentModelDetails, OffsetDateTime expiresOn) {
+                documentModelDetails.setExpiresOn(expiresOn);
+            }
         });
     }
 }
diff --git a/.../azure/ai/formrecognizer/documentanalysis/administration/models/DocumentModelSummary.java b/.../azure/ai/formrecognizer/documentanalysis/administration/models/DocumentModelSummary.java
@@ -33,6 +33,8 @@ public final class DocumentModelSummary {
      * List of key-value tag attributes associated with the model.
      */
     private Map<String, String> tags;
+    private OffsetDateTime expiresOn;
+
 
     /**
      * Get the unique model identifier.
@@ -104,6 +106,19 @@ void setTags(Map<String, String> tags) {
         this.tags = tags;
     }
 
+    /**
+     * Get the Date and time (UTC) when the document model will expire.
+     *
+     * @return the expiresOn value.
+     */
+    public OffsetDateTime getExpiresOn() {
+        return expiresOn;
+    }
+
+    private void setExpiresOn(OffsetDateTime expiresOn) {
+        this.expiresOn = expiresOn;
+    }
+
     static {
         DocumentModelSummaryHelper.setAccessor(new DocumentModelSummaryHelper.DocumentModelSummaryAccessor() {
             @Override
@@ -125,6 +140,11 @@ public void setCreatedOn(DocumentModelSummary documentModelSummary, OffsetDateTi
             public void setTags(DocumentModelSummary documentModelSummary, Map<String, String> tags) {
                 documentModelSummary.setTags(tags);
             }
+
+            @Override
+            public void setExpiresOn(DocumentModelSummary documentModelSummary, OffsetDateTime expiresOn) {
+                documentModelSummary.setExpiresOn(expiresOn);
+            }
         });
     }
 }
diff --git a/...java/com/azure/ai/formrecognizer/documentanalysis/administration/models/QuotaDetails.java b/...java/com/azure/ai/formrecognizer/documentanalysis/administration/models/QuotaDetails.java
@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+// Code generated by Microsoft (R) AutoRest Code Generator.
+
+package com.azure.ai.formrecognizer.documentanalysis.administration.models;
+
+import com.azure.ai.formrecognizer.documentanalysis.implementation.util.QuotaDetailsHelper;
+import com.azure.core.annotation.Immutable;
+
+import java.time.OffsetDateTime;
+
+/** Quota used, limit, and next reset date/time. */
+@Immutable
+public final class QuotaDetails {
+    /*
+     * Amount of the resource quota used.
+     */
+    private int used;
+
+    /*
+     * Resource quota limit.
+     */
+    private int quota;
+
+    /*
+     * Date/time when the resource quota usage will be reset.
+     */
+    private OffsetDateTime quotaResetDateTime;
+
+
+    /**
+     * Get the used property: Amount of the resource quota used.
+     *
+     * @return the used value.
+     */
+    public int getUsed() {
+        return this.used;
+    }
+
+    /**
+     * Get the quota property: Resource quota limit.
+     *
+     * @return the quota value.
+     */
+    public int getQuota() {
+        return this.quota;
+    }
+
+    /**
+     * Get the quotaResetDateTime property: Date/time when the resource quota usage will be reset.
+     *
+     * @return the quotaResetDateTime value.
+     */
+    public OffsetDateTime getQuotaResetDateTime() {
+        return this.quotaResetDateTime;
+    }
+
+    private void setUsed(int used) {
+        this.used = used;
+    }
+
+    private void setQuota(int quota) {
+        this.quota = quota;
+    }
+
+    private void setQuotaResetDateTime(OffsetDateTime quotaResetDateTime) {
+        this.quotaResetDateTime = quotaResetDateTime;
+    }
+
+    static {
+        QuotaDetailsHelper.setAccessor(new QuotaDetailsHelper.QuotaDetailsAccessor() {
+            @Override
+            public void setUsed(
+                QuotaDetails quotaDetails, int used) {
+                quotaDetails.setUsed(used);
+            }
+
+            @Override
+            public void setQuota(
+                QuotaDetails quotaDetails, int quota) {
+                quotaDetails.setQuota(quota);
+            }
+
+            @Override
+            public void setQuotaResetDateTime(
+                QuotaDetails quotaDetails, OffsetDateTime quotaResetDateTime) {
+                quotaDetails.setQuotaResetDateTime(quotaResetDateTime);
+            }
+        });
+    }
+}
diff --git a/...a/com/azure/ai/formrecognizer/documentanalysis/administration/models/ResourceDetails.java b/...a/com/azure/ai/formrecognizer/documentanalysis/administration/models/ResourceDetails.java
@@ -22,6 +22,8 @@ public final class ResourceDetails {
      */
     private int customDocumentModelLimit;
 
+    private QuotaDetails customNeuralDocumentModelBuilds;
+
     /**
      * Get the current count of built document analysis models
      *
@@ -48,6 +50,20 @@ private void setCustomDocumentModelLimit(int customDocumentModelLimit) {
         this.customDocumentModelLimit = customDocumentModelLimit;
     }
 
+    /**
+     * Get the customNeuralDocumentModelBuilds property: Quota used, limit, and next reset date/time.
+     *
+     * @return the customNeuralDocumentModelBuilds value.
+     */
+    public QuotaDetails getCustomNeuralDocumentModelBuilds() {
+        return customNeuralDocumentModelBuilds;
+    }
+
+    private void setCustomNeuralDocumentModelBuilds(
+        QuotaDetails customNeuralDocumentModelBuilds) {
+        this.customNeuralDocumentModelBuilds = customNeuralDocumentModelBuilds;
+    }
+
     static {
         ResourceDetailsHelper.setAccessor(new ResourceDetailsHelper.ResourceDetailsAccessor() {
             @Override
@@ -61,6 +77,12 @@ public void setDocumentModelLimit(
                 ResourceDetails resourceDetails, int documentModelLimit) {
                 resourceDetails.setCustomDocumentModelLimit(documentModelLimit);
             }
+
+            @Override
+            public void setCustomNeuralDocumentModelBuilds(
+                ResourceDetails resourceDetails, QuotaDetails quotaDetails) {
+                resourceDetails.setCustomNeuralDocumentModelBuilds(quotaDetails);
+            }
         });
     }
 }
diff --git a/...e/ai/formrecognizer/documentanalysis/documentanalysis/models/DocumentAnalysisFeature.java b/...e/ai/formrecognizer/documentanalysis/documentanalysis/models/DocumentAnalysisFeature.java
diff --git a/...va/com/azure/ai/formrecognizer/documentanalysis/documentanalysis/models/package-info.java b/...va/com/azure/ai/formrecognizer/documentanalysis/documentanalysis/models/package-info.java
diff --git a/.../com/azure/ai/formrecognizer/documentanalysis/implementation/util/AddressValueHelper.java b/.../com/azure/ai/formrecognizer/documentanalysis/implementation/util/AddressValueHelper.java
@@ -19,7 +19,7 @@ private AddressValueHelper() {
      *
      * @param addressValueAccessor The accessor.
      */
-    public static void setAccessor(final AddressValueHelper.AddressValueAccessor addressValueAccessor) {
+    public static void setAccessor(final AddressValueAccessor addressValueAccessor) {
         accessor = addressValueAccessor;
     }
 
@@ -35,6 +35,18 @@ public interface AddressValueAccessor {
         void setPostalCode(AddressValue addressValue, String postalCode);
         void setCountryRegion(AddressValue addressValue, String countryRegion);
         void setStreetAddress(AddressValue addressValue, String streetAddress);
+
+        void setUnit(AddressValue addressValue, String unit);
+
+        void setCityDistrict(AddressValue addressValue, String cityDistrict);
+
+        void setStateDistrict(AddressValue addressValue, String stateDistrict);
+
+        void setSuburb(AddressValue addressValue, String suburb);
+
+        void setHouse(AddressValue addressValue, String house);
+
+        void setLevel(AddressValue addressValue, String level);
     }
     static void setPoBox(AddressValue addressValue, String poBox) {
         accessor.setPoBox(addressValue, poBox);

diff --git a/...com/azure/ai/formrecognizer/documentanalysis/implementation/util/CurrencyValueHelper.java b/...com/azure/ai/formrecognizer/documentanalysis/implementation/util/CurrencyValueHelper.java
@@ -20,6 +20,8 @@ private CurrencyValueHelper() {
     public interface CurrencyValueAccessor {
         void setAmount(CurrencyValue currencyValue, double amount);
         void setSymbol(CurrencyValue currencyValue, String currencySymbol);
+
+        void setCode(CurrencyValue currencyValue, String code);
     }
 
     /**
@@ -38,4 +40,7 @@ static void setAmount(CurrencyValue currencyValue, double amount) {
     static void setCurrencySymbol(CurrencyValue currencyValue, String currencySymbol) {
         accessor.setSymbol(currencyValue, currencySymbol);
     }
+    static void setCode(CurrencyValue currencyValue, String code) {
+        accessor.setCode(currencyValue, code);
+    }
 }
diff --git a/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentKeyValuePairHelper.java b/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentKeyValuePairHelper.java
@@ -26,7 +26,7 @@ private DocumentKeyValuePairHelper() {
      * @param documentKeyValueElementAccessor The accessor.
      */
     public static void setAccessor(
-        final DocumentKeyValuePairHelper.DocumentKeyValuePairAccessor documentKeyValueElementAccessor) {
+        final DocumentKeyValuePairAccessor documentKeyValueElementAccessor) {
         accessor = documentKeyValueElementAccessor;
     }
 
@@ -37,6 +37,8 @@ public interface DocumentKeyValuePairAccessor {
         void setKey(DocumentKeyValuePair documentKeyValuePair, DocumentKeyValueElement key);
         void setValue(DocumentKeyValuePair documentKeyValuePair, DocumentKeyValueElement value);
         void setConfidence(DocumentKeyValuePair documentKeyValuePair, float confidence);
+
+        void setCommonName(DocumentKeyValuePair documentKeyValuePair, String commonName);
     }
 
     static void setConfidence(DocumentKeyValuePair documentKeyValuePair, float confidence) {

diff --git a/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentModelDetailsHelper.java b/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentModelDetailsHelper.java
@@ -32,6 +32,8 @@ public interface DocumentModelDetailsAccessor {
         void setDocTypes(DocumentModelDetails documentModelDetails, Map<String, DocumentTypeDetails> docTypes);
 
         void setTags(DocumentModelDetails documentModelDetails, Map<String, String> tags);
+
+        void setExpiresOn(DocumentModelDetails documentModelDetails, OffsetDateTime expiresOn);
     }
 
     /**
@@ -62,4 +64,8 @@ static void setDocTypes(DocumentModelDetails documentModelDetails, Map<String, D
     static void setTags(DocumentModelDetails documentModelDetails, Map<String, String> tags) {
         accessor.setTags(documentModelDetails, tags);
     }
+
+    static void setExpiresOn(DocumentModelDetails documentModelDetails, OffsetDateTime expirationDateTime) {
+        accessor.setExpiresOn(documentModelDetails, expirationDateTime);
+    }
 }
diff --git a/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentModelSummaryHelper.java b/...re/ai/formrecognizer/documentanalysis/implementation/util/DocumentModelSummaryHelper.java
@@ -25,6 +25,8 @@ public interface DocumentModelSummaryAccessor {
         void setDescription(DocumentModelSummary documentModelSummary, String description);
         void setCreatedOn(DocumentModelSummary documentModelSummary, OffsetDateTime createdDateTime);
         void setTags(DocumentModelSummary documentModelSummary, Map<String, String> tags);
+
+        void setExpiresOn(DocumentModelSummary documentModelSummary, OffsetDateTime expiresOn);
     }
 
     /**
@@ -51,4 +53,8 @@ static void setCreatedOn(DocumentModelSummary documentModelSummary, OffsetDateTi
     static void setTags(DocumentModelSummary documentModelSummary, Map<String, String> tags) {
         accessor.setTags(documentModelSummary, tags);
     }
+
+    static void setExpiresOn(DocumentModelSummary documentModelSummary, OffsetDateTime expirationDateTime) {
+        accessor.setExpiresOn(documentModelSummary, expirationDateTime);
+    }
 }