[Text Analytics] Remove options parameter from DynamicClassify and DynamicClassifyAsync methods (Azure#33915)

The `DynamicClassify` and `DynamicClassifyAsync` methods of the `TextAnalyticsClient` class should not receive a `DynamicClassifyOptions` parameter. This is to align with the other convenience methods that receive a single document as a string parameter (e.g., `RecognizeEntities`, `ExtractKeyPhrases`, etc.)

The `ClassificationType` property is also being "moved out" of the `DynamicClassifyOptions` class and turned into a standalone parameter that can be passed into all the dynamic classification methods. This means that customers can still choose the classification type (multi vs. single) when calling `DynamicClassify` or `DynamicClassifyAsync` without the options parameter. Additionally, we no longer need the `DynamicClassifyOptions` sub-class, since `ClassificationType` was the only property that it added on top of the `TextAnalyticsRequestOptions` base class.

Author: joseharriaga

sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs

@@ -454,11 +454,6 @@ internal DynamicClassifyDocumentResultCollection() : base (default(System.Collec
         public string ModelVersion { get { throw null; } }
         public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } }
     }
-    public partial class DynamicClassifyOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions
-    {
-        public DynamicClassifyOptions() { }
-        public Azure.AI.TextAnalytics.ClassificationType? ClassificationType { get { throw null; } set { } }
-    }
     public enum EntityAssociation
     {
         Subject = 0,
@@ -1593,12 +1588,12 @@ public TextAnalyticsClient(System.Uri endpoint, Azure.Core.TokenCredential crede
         public virtual Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection> DetectLanguageBatch(System.Collections.Generic.IEnumerable<string> documents, string countryHint = null, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync(System.Collections.Generic.IEnumerable<string> documents, string countryHint = null, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Response<Azure.AI.TextAnalytics.ClassificationCategoryCollection> DynamicClassify(string document, System.Collections.Generic.IEnumerable<string> categories, string language = null, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ClassificationCategoryCollection>> DynamicClassifyAsync(string document, System.Collections.Generic.IEnumerable<string> categories, string language = null, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(System.Collections.Generic.IEnumerable<string> documents, System.Collections.Generic.IEnumerable<string> categories, string language = null, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(System.Collections.Generic.IEnumerable<string> documents, System.Collections.Generic.IEnumerable<string> categories, string language = null, Azure.AI.TextAnalytics.DynamicClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.AI.TextAnalytics.ClassificationCategoryCollection> DynamicClassify(string document, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), string language = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ClassificationCategoryCollection>> DynamicClassifyAsync(string document, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), string language = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(System.Collections.Generic.IEnumerable<string> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), string language = null, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(System.Collections.Generic.IEnumerable<string> documents, System.Collections.Generic.IEnumerable<string> categories, Azure.AI.TextAnalytics.ClassificationType? classificationType = default(Azure.AI.TextAnalytics.ClassificationType?), string language = null, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override bool Equals(object obj) { throw null; }
         public virtual Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection> ExtractKeyPhrases(string document, string language = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

sdk/textanalytics/Azure.AI.TextAnalytics/src/DynamicClassifyOptions.cs

@@ -2094,15 +2094,13 @@ private async Task<ClassifyDocumentOperation> StartMultiLabelClassifyAsync(Multi
         public override Response<ClassificationCategoryCollection> DynamicClassify(
             string document,
             IEnumerable<string> categories,
+            ClassificationType? classificationType = default,
             string language = default,
-            DynamicClassifyOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(document, nameof(document));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
 
-            options ??= new DynamicClassifyOptions();
-
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(DynamicClassify)}");
             scope.AddAttribute("document", document);
             scope.Start();
@@ -2115,16 +2113,11 @@ public override Response<ClassificationCategoryCollection> DynamicClassify(
                 AnalyzeTextDynamicClassificationInput input = new()
                 {
                     AnalysisInput = multiLanguageInput,
-                    Parameters = new DynamicClassificationTaskParameters(
-                        options.DisableServiceLogs,
-                        options.ModelVersion,
-                        options.ClassificationType,
-                        categories.ToList())
+                    Parameters = new DynamicClassificationTaskParameters(categories.ToList()) { ClassificationType = classificationType }
                 };
 
                 Response<AnalyzeTextTaskResult> result = _languageRestClient.Analyze(
                     input,
-                    options.IncludeStatistics,
                     cancellationToken: cancellationToken);
 
                 DynamicClassificationTaskResult taskResult = (DynamicClassificationTaskResult)result.Value;
@@ -2147,42 +2140,42 @@ public override Response<ClassificationCategoryCollection> DynamicClassify(
         public override Response<DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(
             IEnumerable<string> documents,
             IEnumerable<string> categories,
+            ClassificationType? classificationType = default,
             string language = default,
-            DynamicClassifyOptions options = default,
+            TextAnalyticsRequestOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(documents, nameof(documents));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
             MultiLanguageAnalysisInput documentInputs = ConvertToMultiLanguageInputs(documents, language);
 
-            return DynamicClassifyBatch(documentInputs, categories, options, cancellationToken);
+            return DynamicClassifyBatch(documentInputs, categories, classificationType, options, cancellationToken);
         }
 
         public override Response<DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(
             IEnumerable<TextDocumentInput> documents,
             IEnumerable<string> categories,
-            DynamicClassifyOptions options = default,
+            ClassificationType? classificationType = default,
+            TextAnalyticsRequestOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(documents, nameof(documents));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
             MultiLanguageAnalysisInput documentInputs = ConvertToMultiLanguageInputs(documents);
 
-            return DynamicClassifyBatch(documentInputs, categories, options, cancellationToken);
+            return DynamicClassifyBatch(documentInputs, categories, classificationType, options, cancellationToken);
         }
 
         public override async Task<Response<ClassificationCategoryCollection>> DynamicClassifyAsync(
             string document,
             IEnumerable<string> categories,
+            ClassificationType? classificationType = default,
             string language = default,
-            DynamicClassifyOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(document, nameof(document));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
 
-            options ??= new DynamicClassifyOptions();
-
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(DynamicClassify)}");
             scope.AddAttribute("document", document);
             scope.Start();
@@ -2195,16 +2188,11 @@ public override async Task<Response<ClassificationCategoryCollection>> DynamicCl
                 AnalyzeTextDynamicClassificationInput input = new()
                 {
                     AnalysisInput = multiLanguageInput,
-                    Parameters = new DynamicClassificationTaskParameters(
-                        options.DisableServiceLogs,
-                        options.ModelVersion,
-                        options.ClassificationType,
-                        categories.ToList())
+                    Parameters = new DynamicClassificationTaskParameters(categories.ToList()) { ClassificationType = classificationType }
                 };
 
                 Response<AnalyzeTextTaskResult> result = await _languageRestClient.AnalyzeAsync(
                     input,
-                    options.IncludeStatistics,
                     cancellationToken: cancellationToken).ConfigureAwait(false);
 
                 DynamicClassificationTaskResult taskResult = (DynamicClassificationTaskResult)result.Value;
@@ -2227,37 +2215,40 @@ public override async Task<Response<ClassificationCategoryCollection>> DynamicCl
         public override async Task<Response<DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(
             IEnumerable<string> documents,
             IEnumerable<string> categories,
+            ClassificationType? classificationType = default,
             string language = default,
-            DynamicClassifyOptions options = default,
+            TextAnalyticsRequestOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(documents, nameof(documents));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
             MultiLanguageAnalysisInput documentInputs = ConvertToMultiLanguageInputs(documents, language);
 
-            return await DynamicClassifyBatchAsync(documentInputs, categories, options, cancellationToken).ConfigureAwait(false);
+            return await DynamicClassifyBatchAsync(documentInputs, categories, classificationType, options, cancellationToken).ConfigureAwait(false);
         }
 
         public override async Task<Response<DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(
             IEnumerable<TextDocumentInput> documents,
             IEnumerable<string> categories,
-            DynamicClassifyOptions options = default,
+            ClassificationType? classificationType = default,
+            TextAnalyticsRequestOptions options = default,
             CancellationToken cancellationToken = default)
         {
             Argument.AssertNotNullOrEmpty(documents, nameof(documents));
             Argument.AssertNotNullOrEmpty(categories, nameof(categories));
             MultiLanguageAnalysisInput documentInputs = ConvertToMultiLanguageInputs(documents);
 
-            return await DynamicClassifyBatchAsync(documentInputs, categories, options, cancellationToken).ConfigureAwait(false);
+            return await DynamicClassifyBatchAsync(documentInputs, categories, classificationType, options, cancellationToken).ConfigureAwait(false);
         }
 
         private Response<DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(
             MultiLanguageAnalysisInput multiLanguageInput,
             IEnumerable<string> categories,
-            DynamicClassifyOptions options,
+            ClassificationType? classificationType,
+            TextAnalyticsRequestOptions options,
             CancellationToken cancellationToken)
         {
-            options ??= new DynamicClassifyOptions();
+            options ??= new TextAnalyticsRequestOptions();
 
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(DynamicClassifyBatch)}");
             scope.Start();
@@ -2270,7 +2261,7 @@ private Response<DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(
                     Parameters = new DynamicClassificationTaskParameters(
                         options.DisableServiceLogs,
                         options.ModelVersion,
-                        options.ClassificationType,
+                        classificationType,
                         categories.ToList())
                 };
 
@@ -2296,10 +2287,11 @@ private Response<DynamicClassifyDocumentResultCollection> DynamicClassifyBatch(
         private async Task<Response<DynamicClassifyDocumentResultCollection>> DynamicClassifyBatchAsync(
             MultiLanguageAnalysisInput multiLanguageInput,
             IEnumerable<string> categories,
-            DynamicClassifyOptions options,
+            ClassificationType? classificationType,
+            TextAnalyticsRequestOptions options,
             CancellationToken cancellationToken)
         {
-            options ??= new DynamicClassifyOptions();
+            options ??= new TextAnalyticsRequestOptions();
 
             using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(DynamicClassifyBatch)}");
             scope.Start();
@@ -2312,7 +2304,7 @@ private async Task<Response<DynamicClassifyDocumentResultCollection>> DynamicCla
                     Parameters = new DynamicClassificationTaskParameters(
                         options.DisableServiceLogs,
                         options.ModelVersion,
-                        options.ClassificationType,
+                        classificationType,
                         categories.ToList())
                 };