[FormRecognizer] Updated docs for 4.1.0 + final architect feedback (#38092)

Author: kinelski

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

@@ -1,11 +1,11 @@
 # Release History
 
-## 4.1.0-beta.2 (Unreleased)
+## 4.1.0 (2023-08-10)
 
 ### Features Added
 - In struct `DocumentAnalysisFeature`, added properties `Barcodes`, `KeyValuePairs`, and `Languages` as add-on capabilities.
-- Added class `ContentSource` as a base class to `AzureBlobContentSource` (currently named `BlobContentSource`) and `AzureBlobFileListSource` (currently named `BlobFileListContentSource`).
-- In `DocumentModelAdministrationClient`, added a new overload to `BuildDocumentModel` that takes a `ContentSource` object. It can be used to build a document model from alternative content sources.
+- Added class `DocumentContentSource` as a base class to `AzureBlobContentSource` (renamed to `BlobContentSource` in this SDK version) and `AzureBlobFileListSource` (renamed to `BlobFileListContentSource` in this SDK version).
+- In `DocumentModelAdministrationClient`, added a new overload to `BuildDocumentModel` that takes a `DocumentContentSource` object. It can be used to build a document model from alternative content sources.
 - Added property `ServiceVersion` to classes `AnalyzeResult`, `DocumentModelDetails`, `DocumentModelSummary`, `OperationDetails`, and `OperationSummary`.
 
 ### Breaking Changes
@@ -19,8 +19,8 @@
 - In `DocumentBarcodeKind`, renamed members `QRCode`, `PDF417`, `EAN8`, `EAN13`, `ITF`, and `MicroQRCode` to `QrCode`, `Pdf417`, `Ean8`, `Ean13`, `Itf`, and `MicroQrCode`, respectively.
 - Renamed class `AzureBlobContentSource` to `BlobContentSource`.
 - Renamed class `AzureBlobFileListSource` to `BlobFileListContentSource`.
-- In class `ClassifierDocumentTypeDetails`, properties `AzureBlobFileListSource` and `AzureBlobSource` have been replaced by a single polymorphic property `TrainingDataContentSource`.
-- In class `ClassifierDocumentTypeDetails`, all constructors have been replaced by a single constructor that takes a polymorphic parameter `trainingDataContentSource`.
+- In class `ClassifierDocumentTypeDetails`, properties `AzureBlobFileListSource` and `AzureBlobSource` have been replaced by a single polymorphic property `TrainingDataSource`.
+- In class `ClassifierDocumentTypeDetails`, all constructors have been replaced by a single constructor that takes a polymorphic parameter `trainingDataSource`.
 - In class `ResourceDetails`, renamed property `CustomNeuralDocumentModelBuilds` to `NeuralDocumentModelQuota`.
 - In class `DocumentClassifierDetails`, renamed property `ApiVersion` to `ServiceVersion`.
 - Renamed struct `FontStyle` to `DocumentFontStyle`.
@@ -30,8 +30,6 @@
 ### Bugs Fixed
 - Fixed a bug where calling the `GetResourceDetails` API while targeting service version `2022-08-31` would throw an `ArgumentNullException`.
 
-### Other Changes
-
 ## 4.1.0-beta.1 (2023-04-13)
 
 ### Features Added

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

@@ -308,13 +308,13 @@ internal AnalyzeResult() { }
         public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentStyle> Styles { get { throw null; } }
         public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentTable> Tables { get { throw null; } }
     }
-    public partial class BlobContentSource : Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource
+    public partial class BlobContentSource : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource
     {
         public BlobContentSource(System.Uri containerUri) { }
         public System.Uri ContainerUri { get { throw null; } }
         public string Prefix { get { throw null; } set { } }
     }
-    public partial class BlobFileListContentSource : Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource
+    public partial class BlobFileListContentSource : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource
     {
         public BlobFileListContentSource(System.Uri containerUri, string fileList) { }
         public System.Uri ContainerUri { get { throw null; } }
@@ -372,8 +372,8 @@ public BuildDocumentModelOptions() { }
     }
     public partial class ClassifierDocumentTypeDetails
     {
-        public ClassifierDocumentTypeDetails(Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource trainingDataContentSource) { }
-        public Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource TrainingDataContentSource { get { throw null; } }
+        public ClassifierDocumentTypeDetails(Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource trainingDataSource) { }
+        public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource TrainingDataSource { get { throw null; } }
     }
     public partial class ClassifyDocumentOperation : Azure.Operation<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeResult>
     {
@@ -404,29 +404,6 @@ public ComposeDocumentModelOperation(string operationId, Azure.AI.FormRecognizer
         public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
     }
-    public abstract partial class ContentSource
-    {
-        internal ContentSource() { }
-        public Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind Kind { get { throw null; } }
-    }
-    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
-    public readonly partial struct ContentSourceKind : System.IEquatable<Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind>
-    {
-        private readonly object _dummy;
-        private readonly int _dummyPrimitive;
-        public ContentSourceKind(string value) { throw null; }
-        public static Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind Blob { get { throw null; } }
-        public static Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind BlobFileList { get { throw null; } }
-        public bool Equals(Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind 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.DocumentAnalysis.ContentSourceKind left, Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind right) { throw null; }
-        public static implicit operator Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind (string value) { throw null; }
-        public static bool operator !=(Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind left, Azure.AI.FormRecognizer.DocumentAnalysis.ContentSourceKind right) { throw null; }
-        public override string ToString() { throw null; }
-    }
     public partial class CopyDocumentModelToOperation : Azure.Operation<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>
     {
         protected CopyDocumentModelToOperation() { }
@@ -671,6 +648,29 @@ internal DocumentClassifierDetails() { }
         public System.DateTimeOffset? ExpiresOn { get { throw null; } }
         public string ServiceVersion { get { throw null; } }
     }
+    public abstract partial class DocumentContentSource
+    {
+        internal DocumentContentSource() { }
+        public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind Kind { get { throw null; } }
+    }
+    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
+    public readonly partial struct DocumentContentSourceKind : System.IEquatable<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind>
+    {
+        private readonly object _dummy;
+        private readonly int _dummyPrimitive;
+        public DocumentContentSourceKind(string value) { throw null; }
+        public static Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind Blob { get { throw null; } }
+        public static Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind BlobFileList { get { throw null; } }
+        public bool Equals(Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind 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.DocumentAnalysis.DocumentContentSourceKind left, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind right) { throw null; }
+        public static implicit operator Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind (string value) { throw null; }
+        public static bool operator !=(Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind left, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSourceKind right) { throw null; }
+        public override string ToString() { throw null; }
+    }
     public partial class DocumentField
     {
         internal DocumentField() { }
@@ -829,9 +829,9 @@ public DocumentModelAdministrationClient(System.Uri endpoint, Azure.Core.TokenCr
         public DocumentModelAdministrationClient(System.Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions options) { }
         public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentClassifierOperation BuildDocumentClassifier(Azure.WaitUntil waitUntil, System.Collections.Generic.IDictionary<string, Azure.AI.FormRecognizer.DocumentAnalysis.ClassifierDocumentTypeDetails> documentTypes, string classifierId = null, string description = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentClassifierOperation> BuildDocumentClassifierAsync(Azure.WaitUntil waitUntil, System.Collections.Generic.IDictionary<string, Azure.AI.FormRecognizer.DocumentAnalysis.ClassifierDocumentTypeDetails> documentTypes, string classifierId = null, string description = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation BuildDocumentModel(Azure.WaitUntil waitUntil, Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource trainingDataContentSource, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation BuildDocumentModel(Azure.WaitUntil waitUntil, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource trainingDataSource, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation BuildDocumentModel(Azure.WaitUntil waitUntil, System.Uri blobContainerUri, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, string prefix = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation> BuildDocumentModelAsync(Azure.WaitUntil waitUntil, Azure.AI.FormRecognizer.DocumentAnalysis.ContentSource trainingDataContentSource, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation> BuildDocumentModelAsync(Azure.WaitUntil waitUntil, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentContentSource trainingDataSource, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOperation> BuildDocumentModelAsync(Azure.WaitUntil waitUntil, System.Uri blobContainerUri, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentBuildMode buildMode, string modelId = null, string prefix = null, Azure.AI.FormRecognizer.DocumentAnalysis.BuildDocumentModelOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation ComposeDocumentModel(Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> componentModelIds, string modelId = null, string description = null, System.Collections.Generic.IDictionary<string, string> tags = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation> ComposeDocumentModelAsync(Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> componentModelIds, string modelId = null, string description = null, System.Collections.Generic.IDictionary<string, string> tags = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }