[FR] Move to 2.1 GA (#20967)

* oficially move to 2.1 GA

* add 3.1.0 to readme

Author: maririos

sdk/formrecognizer/Azure.AI.FormRecognizer/CHANGELOG.md

@@ -8,10 +8,14 @@
 By default the SDK targets latest supported service version.
 
 ### Breaking changes
+- The client defaults to the latest supported service version, which currently is `2.1`.
 - Renamed `Id` for `Identity` in all the `StartRecognizeIdDocuments` functionalities. For example, the name of the method is now `StartRecognizeIdentityDocuments`.
 - Renamed the model `ReadingOrder` to `FormReadingOrder`.
 - The model `TextAppearance` now includes the properties `StyleName` and `StyleConfidence` that were part of the `TextStyle` object.
 - Removed the model `TextStyle`.
+- Renamed the method `AsCountryCode` to `AsCountryRegion`.
+- Removed type `FieldValueGender`.
+- Removed value `Gender` from the model `FieldValuetype`.
 
 ## 3.0.1 (2021-04-09)
 

sdk/formrecognizer/Azure.AI.FormRecognizer/README.md

@@ -20,14 +20,15 @@ Install the Azure Form Recognizer client library for .NET with [NuGet][nuget]:
 dotnet add package Azure.AI.FormRecognizer
 ``` 
 
-> Note: This version of the client library defaults to the `v2.1-preview.3` version of the service.
+> Note: This version of the client library defaults to the `v2.1` version of the service.
 
 This table shows the relationship between SDK versions and supported API versions of the service:
 
 |SDK version|Supported API version of service
 |-|-
-|3.0.0 - Latest GA release | 2.0
-|3.1.0-beta.4 - Latest release (beta)| 2.0, 2.1-preview.3
+|3.0.0 | 2.0
+|3.0.1 | 2.0
+|3.1.0 | 2.0, 2.1
 
 ### Prerequisites
 * An [Azure subscription][azure_sub].

sdk/formrecognizer/Azure.AI.FormRecognizer/api/Azure.AI.FormRecognizer.netstandard2.0.cs

@@ -48,12 +48,12 @@ public FormRecognizerClient(System.Uri endpoint, Azure.Core.TokenCredential cred
     }
     public partial class FormRecognizerClientOptions : Azure.Core.ClientOptions
     {
-        public FormRecognizerClientOptions(Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion version = Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3) { }
+        public FormRecognizerClientOptions(Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion version = Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1) { }
         public Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion Version { get { throw null; } }
         public enum ServiceVersion
         {
             V2_0 = 1,
-            V2_1_Preview_3 = 2,
+            V2_1 = 2,
         }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
@@ -246,37 +246,17 @@ public readonly partial struct FieldValue
         private readonly object _dummy;
         private readonly int _dummyPrimitive;
         public Azure.AI.FormRecognizer.Models.FieldValueType ValueType { get { throw null; } }
-        public string AsCountryCode() { throw null; }
+        public string AsCountryRegion() { throw null; }
         public System.DateTime AsDate() { throw null; }
         public System.Collections.Generic.IReadOnlyDictionary<string, Azure.AI.FormRecognizer.Models.FormField> AsDictionary() { throw null; }
         public float AsFloat() { throw null; }
-        public Azure.AI.FormRecognizer.Models.FieldValueGender AsGender() { throw null; }
         public long AsInt64() { throw null; }
         public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormField> AsList() { throw null; }
         public string AsPhoneNumber() { throw null; }
         public Azure.AI.FormRecognizer.Models.SelectionMarkState AsSelectionMarkState() { throw null; }
         public string AsString() { throw null; }
         public System.TimeSpan AsTime() { throw null; }
     }
-    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
-    public readonly partial struct FieldValueGender : System.IEquatable<Azure.AI.FormRecognizer.Models.FieldValueGender>
-    {
-        private readonly object _dummy;
-        private readonly int _dummyPrimitive;
-        public FieldValueGender(string value) { throw null; }
-        public static Azure.AI.FormRecognizer.Models.FieldValueGender F { get { throw null; } }
-        public static Azure.AI.FormRecognizer.Models.FieldValueGender M { get { throw null; } }
-        public static Azure.AI.FormRecognizer.Models.FieldValueGender X { get { throw null; } }
-        public bool Equals(Azure.AI.FormRecognizer.Models.FieldValueGender other) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
-        public override bool Equals(object obj) { throw null; }
-        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
-        public override int GetHashCode() { throw null; }
-        public static bool operator ==(Azure.AI.FormRecognizer.Models.FieldValueGender left, Azure.AI.FormRecognizer.Models.FieldValueGender right) { throw null; }
-        public static implicit operator Azure.AI.FormRecognizer.Models.FieldValueGender (string value) { throw null; }
-        public static bool operator !=(Azure.AI.FormRecognizer.Models.FieldValueGender left, Azure.AI.FormRecognizer.Models.FieldValueGender right) { throw null; }
-        public override string ToString() { throw null; }
-    }
     public enum FieldValueType
     {
         String = 0,
@@ -288,8 +268,7 @@ public enum FieldValueType
         List = 6,
         Dictionary = 7,
         SelectionMark = 8,
-        Gender = 9,
-        Country = 10,
+        CountryRegion = 9,
     }
     public abstract partial class FormElement
     {
@@ -368,11 +347,10 @@ public static partial class FormRecognizerModelFactory
         public static Azure.AI.FormRecognizer.Training.CustomFormSubmodel CustomFormSubmodel(string formType, float? accuracy, System.Collections.Generic.IReadOnlyDictionary<string, Azure.AI.FormRecognizer.Training.CustomFormModelField> fields, string modelId) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldBoundingBox FieldBoundingBox(System.Collections.Generic.IReadOnlyList<System.Drawing.PointF> points) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldData FieldData(Azure.AI.FormRecognizer.Models.FieldBoundingBox boundingBox, int pageNumber, string text, System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormElement> fieldElements) { throw null; }
-        public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithCountryCodeValueType(string value) { throw null; }
+        public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithCountryRegionValueType(string value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithDateValueType(System.DateTime value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithDictionaryValueType(System.Collections.Generic.IReadOnlyDictionary<string, Azure.AI.FormRecognizer.Models.FormField> value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithFloatValueType(float value) { throw null; }
-        public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithGenderValueType(Azure.AI.FormRecognizer.Models.FieldValueGender value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithInt64ValueType(long value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithListValueType(System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormField> value) { throw null; }
         public static Azure.AI.FormRecognizer.Models.FieldValue FieldValueWithPhoneNumberValueType(string value) { throw null; }

sdk/formrecognizer/Azure.AI.FormRecognizer/samples/Sample11_RecognizeIdentityDocuments.md

@@ -44,12 +44,12 @@ if (identityDocument.Fields.TryGetValue("Address", out FormField addressField))
     }
 }
 
-if (identityDocument.Fields.TryGetValue("Country", out FormField countryField))
+if (identityDocument.Fields.TryGetValue("CountryRegion", out FormField countryRegionField))
 {
-    if (countryField.Value.ValueType == FieldValueType.Country)
+    if (countryRegionField.Value.ValueType == FieldValueType.CountryRegion)
     {
-        string country = countryField.Value.AsCountryCode();
-        Console.WriteLine($"Country: '{country}', with confidence {countryField.Confidence}");
+        string countryRegion = countryRegionField.Value.AsCountryRegion();
+        Console.WriteLine($"CountryRegion: '{countryRegion}', with confidence {countryRegionField.Confidence}");
     }
 }
 
@@ -106,6 +106,15 @@ if (identityDocument.Fields.TryGetValue("Region", out FormField regionfield))
         Console.WriteLine($"Region: '{region}', with confidence {regionfield.Confidence}");
     }
 }
+
+if (identityDocument.Fields.TryGetValue("Sex", out FormField sexfield))
+{
+    if (sexfield.Value.ValueType == FieldValueType.String)
+    {
+        string sex = sexfield.Value.AsString();
+        Console.WriteLine($"Sex: '{sex}', with confidence {sexfield.Confidence}");
+    }
+}
 ```
 
 ## Recognize identity documents from a given file
@@ -137,12 +146,12 @@ if (identityDocument.Fields.TryGetValue("Address", out FormField addressField))
     }
 }
 
-if (identityDocument.Fields.TryGetValue("Country", out FormField countryField))
+if (identityDocument.Fields.TryGetValue("CountryRegion", out FormField countryRegionField))
 {
-    if (countryField.Value.ValueType == FieldValueType.Country)
+    if (countryRegionField.Value.ValueType == FieldValueType.CountryRegion)
     {
-        string country = countryField.Value.AsCountryCode();
-        Console.WriteLine($"Country: '{country}', with confidence {countryField.Confidence}");
+        string countryRegion = countryRegionField.Value.AsCountryRegion();
+        Console.WriteLine($"CountryRegion: '{countryRegion}', with confidence {countryRegionField.Confidence}");
     }
 }
 
@@ -199,6 +208,15 @@ if (identityDocument.Fields.TryGetValue("Region", out FormField regionfield))
         Console.WriteLine($"Region: '{region}', with confidence {regionfield.Confidence}");
     }
 }
+
+if (identityDocument.Fields.TryGetValue("Sex", out FormField sexfield))
+{
+    if (sexfield.Value.ValueType == FieldValueType.String)
+    {
+        string sex = sexfield.Value.AsString();
+        Console.WriteLine($"Sex: '{sex}', with confidence {sexfield.Confidence}");
+    }
+}
 ```
 
 To see the full example source files, see:

sdk/formrecognizer/Azure.AI.FormRecognizer/src/CustomFormModel.cs

@@ -69,15 +69,15 @@ internal CustomFormModel(
         /// An optional, user-defined name to associate with your model.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         public string ModelName { get; }
 
         /// <summary>
         /// Properties of a model, such as whether the model is a composed model or not.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         [CodeGenMember("Attributes")]
         public CustomFormModelProperties Properties { get; }

sdk/formrecognizer/Azure.AI.FormRecognizer/src/CustomFormModelInfo.cs

@@ -38,15 +38,15 @@ internal CustomFormModelInfo(string modelId, CustomFormModelStatus status, DateT
         /// An optional, user-defined name to associate with your model.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         public string ModelName { get; }
 
         /// <summary>
         /// Properties of a model, such as whether the model is a composed model or not.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         [CodeGenMember("Attributes")]
         public CustomFormModelProperties Properties { get; }

sdk/formrecognizer/Azure.AI.FormRecognizer/src/CustomFormSubmodel.cs

@@ -29,7 +29,7 @@ internal CustomFormSubmodel(string formType, float? accuracy, IReadOnlyDictionar
         /// The unique identifier of the submodel.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         public string ModelId { get; }
 

sdk/formrecognizer/Azure.AI.FormRecognizer/src/FieldValue.cs

@@ -44,7 +44,7 @@ internal FieldValue(FieldValueType type)
         internal FieldValue(string value, FieldValueType type)
             : this()
         {
-            if (type != FieldValueType.String && type != FieldValueType.PhoneNumber && type != FieldValueType.Country)
+            if (type != FieldValueType.String && type != FieldValueType.PhoneNumber && type != FieldValueType.CountryRegion)
             {
                 throw new ArgumentException($"Specified {nameof(type)} does not support string value ({type}).");
             }
@@ -137,18 +137,6 @@ internal FieldValue(SelectionMarkState value)
             ValueSelectionMark = value;
         }
 
-        /// <summary>
-        /// Initializes a new instance of the <see cref="FieldValue"/> structure. This constructor
-        /// is intended to be used for mocking only.
-        /// </summary>
-        /// <param name="value">The actual field value.</param>
-        internal FieldValue(FieldValueGender value)
-            : this()
-        {
-            ValueType = FieldValueType.Gender;
-            ValueGender = value;
-        }
-
         /// <summary>
         /// The data type of the field value.
         /// </summary>
@@ -204,12 +192,6 @@ internal FieldValue(FieldValueGender value)
         /// </summary>
         private SelectionMarkState ValueSelectionMark { get; }
 
-        /// <summary>
-        /// The <see cref="FieldValueGender"/> value of this instance. Values are usually extracted from
-        /// <see cref="_fieldValue"/>, so this property is exclusively used for mocking.
-        /// </summary>
-        private FieldValueGender ValueGender { get; }
-
         /// <summary>
         /// Gets the value of the field as a <see cref="string"/>.
         /// </summary>
@@ -432,7 +414,7 @@ public IReadOnlyDictionary<string, FormField> AsDictionary()
         /// <returns>The value of the field converted to <see cref="SelectionMarkState"/>.</returns>
         /// <exception cref="InvalidOperationException">Thrown when <see cref="ValueType"/> is not <see cref="FieldValueType.SelectionMark"/>.</exception>
         /// <remarks>
-        /// This method is only available for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This method is only available for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         public SelectionMarkState AsSelectionMarkState()
         {
@@ -459,13 +441,10 @@ public SelectionMarkState AsSelectionMarkState()
         /// Gets the value of the field as an ISO 3166-1 alpha-3 country code <see cref="string"/>.
         /// </summary>
         /// <returns>The value of the field converted to an ISO 3166-1 alpha-3 country code <see cref="string"/>.</returns>
-        /// <exception cref="InvalidOperationException">Thrown when <see cref="ValueType"/> is not <see cref="FieldValueType.Country"/>.</exception>
-        /// <remarks>
-        /// This method is only available for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
-        /// </remarks>
-        public string AsCountryCode()
+        /// <exception cref="InvalidOperationException">Thrown when <see cref="ValueType"/> is not <see cref="FieldValueType.CountryRegion"/>.</exception>
+        public string AsCountryRegion()
         {
-            if (ValueType != FieldValueType.Country)
+            if (ValueType != FieldValueType.CountryRegion)
             {
                 throw new InvalidOperationException($"Cannot get field as country code.  Field value's type is {ValueType}.");
             }
@@ -476,33 +455,7 @@ public string AsCountryCode()
                 return ValueString;
             }
 
-            return _fieldValue.ValueCountry;
-        }
-
-        /// <summary>
-        /// Gets the value of the field as a <see cref="FieldValueGender"/>.
-        /// </summary>
-        /// <returns>The value of the field converted to a <see cref="FieldValueGender"/>.</returns>
-        /// <exception cref="InvalidOperationException">Thrown when <see cref="ValueType"/> is not <see cref="FieldValueType.Gender"/>.</exception>
-        public FieldValueGender AsGender()
-        {
-            if (ValueType != FieldValueType.Gender)
-            {
-                throw new InvalidOperationException($"Cannot get field as gender.  Field value's type is {ValueType}.");
-            }
-
-            // Use when mocking
-            if (_fieldValue == null)
-            {
-                return ValueGender;
-            }
-
-            if (!_fieldValue.ValueGender.HasValue)
-            {
-                throw new InvalidOperationException($"Value was extracted from the form, but cannot be normalized to {nameof(FieldValueType.Gender)} type. Consider accessing the `ValueData.text` property for a textual representation of the value.");
-            }
-
-            return _fieldValue.ValueGender.Value;
+            return _fieldValue.ValueCountryRegion;
         }
     }
 }

sdk/formrecognizer/Azure.AI.FormRecognizer/src/FieldValueType.cs

@@ -61,24 +61,13 @@ public enum FieldValueType
         /// Used for <see cref="SelectionMarkState"/> type.
         /// </summary>
         /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
+        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1"/> and up.
         /// </remarks>
         SelectionMark,
 
-        /// <summary>
-        /// Used for <see cref="FieldValueGender"/> type.
-        /// </summary>
-        /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
-        /// </remarks>
-        Gender,
-
         /// <summary>
         /// Used for <see cref="string"/> type with an ISO 3166-1 alpha-3 country code.
         /// </summary>
-        /// <remarks>
-        /// This property only has value for <see cref="FormRecognizerClientOptions.ServiceVersion.V2_1_Preview_3"/> and up.
-        /// </remarks>
-        Country
+        CountryRegion
     }
 }