Azure · maririos · May 3, 2021 · Apr 30, 2021
diff --git a/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CreateComposedModelOperation.cs b/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CreateComposedModelOperation.cs
@@ -11,7 +11,8 @@ namespace Azure.AI.FormRecognizer.Training
     /// </summary>
     public class CreateComposedModelOperation : CreateCustomFormModelOperation
     {
-        internal CreateComposedModelOperation(string location, FormRecognizerRestClient allOperations, ClientDiagnostics diagnostics) : base(location, allOperations, diagnostics) { }
+        internal CreateComposedModelOperation(string location, FormRecognizerRestClient allOperations, ClientDiagnostics diagnostics, FormRecognizerClientOptions.ServiceVersion serviceVersion)
+            : base(location, allOperations, diagnostics, serviceVersion) { }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="CreateComposedModelOperation"/> class which

diff --git a/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CreateCustomFormModelOperation.cs b/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CreateCustomFormModelOperation.cs
@@ -22,6 +22,9 @@ public class CreateCustomFormModelOperation : Operation<CustomFormModel>
         /// <summary>Provides tools for exception creation in case of failure.</summary>
         private readonly ClientDiagnostics _diagnostics;
 
+        /// <summary>Service version used in this client.</summary>
+        private readonly FormRecognizerClientOptions.ServiceVersion _serviceVersion;
+
         private RequestFailedException _requestFailedException;
 
         /// <summary>The last HTTP response received from the server. <c>null</c> until the first response is received.</summary>
@@ -105,10 +108,15 @@ public override ValueTask<Response<CustomFormModel>> WaitForCompletionAsync(Canc
         public override ValueTask<Response<CustomFormModel>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) =>
             this.DefaultWaitForCompletionAsync(pollingInterval, cancellationToken);
 
-        internal CreateCustomFormModelOperation(string location, FormRecognizerRestClient allOperations, ClientDiagnostics diagnostics)
+        internal CreateCustomFormModelOperation(
+            string location,
+            FormRecognizerRestClient allOperations,
+            ClientDiagnostics diagnostics,
+            FormRecognizerClientOptions.ServiceVersion serviceVersion)
         {
             _serviceClient = allOperations;
             _diagnostics = diagnostics;
+            _serviceVersion = serviceVersion;
 
             // TODO: validate this
             // https://github.com/Azure/azure-sdk-for-net/issues/10385
@@ -128,6 +136,7 @@ public CreateCustomFormModelOperation(string operationId, FormTrainingClient cli
             Id = operationId;
             _diagnostics = client.Diagnostics;
             _serviceClient = client.ServiceClient;
+            _serviceVersion = client.ServiceVersion;
         }
 
         /// <summary>
@@ -185,7 +194,7 @@ private async ValueTask<Response> UpdateStatusAsync(bool async, CancellationToke
                     if (update.Value.ModelInfo.Status == CustomFormModelStatus.Ready)
                     {
                         // We need to first assign a value and then mark the operation as completed to avoid a race condition with the getter in Value
-                        _value = new CustomFormModel(update.Value);
+                        _value = new CustomFormModel(update.Value, _serviceVersion);
                         _hasCompleted = true;
                     }
                     else if (update.Value.ModelInfo.Status == CustomFormModelStatus.Invalid)

diff --git a/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CustomFormModel.cs b/sdk/formrecognizer/Azure.AI.FormRecognizer/src/CustomFormModel.cs
@@ -13,14 +13,14 @@ namespace Azure.AI.FormRecognizer.Training
     /// </summary>
     public class CustomFormModel
     {
-        internal CustomFormModel(Model model)
+        internal CustomFormModel(Model model, FormRecognizerClientOptions.ServiceVersion serviceVersion)
         {
             ModelId = model.ModelInfo.ModelId;
             ModelName = model.ModelInfo.ModelName;
             Status = model.ModelInfo.Status;
             TrainingStartedOn = model.ModelInfo.TrainingStartedOn;
             TrainingCompletedOn = model.ModelInfo.TrainingCompletedOn;
-            Submodels = ConvertToSubmodels(model);
+            Submodels = ConvertToSubmodels(model, serviceVersion);
             TrainingDocuments = ConvertToTrainingDocuments(model);
             Errors = model.TrainResult?.Errors ?? new List<FormRecognizerError>();
             Properties = model.ModelInfo.Properties ?? new CustomFormModelProperties();
@@ -106,13 +106,13 @@ internal CustomFormModel(
         /// </summary>
         public IReadOnlyList<FormRecognizerError> Errors { get; }
 
-        private static IReadOnlyList<CustomFormSubmodel> ConvertToSubmodels(Model model)
+        private static IReadOnlyList<CustomFormSubmodel> ConvertToSubmodels(Model model, FormRecognizerClientOptions.ServiceVersion serviceVersion = default)
         {
             if (model.Keys != null)
                 return ConvertFromUnlabeled(model);
 
             if (model.TrainResult != null)
-                return ConvertFromLabeled(model);
+                return ConvertFromLabeled(model, serviceVersion);
 
             if (model.ComposedTrainResults != null)
                 return ConvertFromLabeledComposedModel(model);
@@ -142,13 +142,20 @@ private static IReadOnlyList<CustomFormSubmodel> ConvertFromUnlabeled(Model mode
             return subModels;
         }
 
-        private static IReadOnlyList<CustomFormSubmodel> ConvertFromLabeled(Model model)
+        private static IReadOnlyList<CustomFormSubmodel> ConvertFromLabeled(Model model, FormRecognizerClientOptions.ServiceVersion serviceVersion = default)
         {
-            string formType = string.Empty;
-            if (string.IsNullOrEmpty(model.ModelInfo.ModelName))
-                formType = $"custom:{model.ModelInfo.ModelId}";
+            string formType;
+            if (serviceVersion == FormRecognizerClientOptions.ServiceVersion.V2_0)
+            {
+                formType = $"form-{model.ModelInfo.ModelId}";
+            }
             else
-                formType = $"custom:{model.ModelInfo.ModelName}";
+            {
+                if (string.IsNullOrEmpty(model.ModelInfo.ModelName))
+                    formType = $"custom:{model.ModelInfo.ModelId}";
+                else
+                    formType = $"custom:{model.ModelInfo.ModelName}";
+            }
 
             return new List<CustomFormSubmodel> {
                 new CustomFormSubmodel(

diff --git a/sdk/formrecognizer/Azure.AI.FormRecognizer/src/FormTrainingClient.cs b/sdk/formrecognizer/Azure.AI.FormRecognizer/src/FormTrainingClient.cs
@@ -25,6 +25,9 @@ public class FormTrainingClient
         /// <summary>Provides tools for exception creation in case of failure.</summary>
         internal readonly ClientDiagnostics Diagnostics;
 
+        /// <summary>Service version used in this client.</summary>
+        internal readonly FormRecognizerClientOptions.ServiceVersion ServiceVersion = FormRecognizerClientOptions.LatestVersion;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="FormTrainingClient"/> class.
         /// </summary>
@@ -65,8 +68,9 @@ public FormTrainingClient(Uri endpoint, AzureKeyCredential credential, FormRecog
             Argument.AssertNotNull(options, nameof(options));
 
             Diagnostics = new ClientDiagnostics(options);
+            ServiceVersion = options.Version;
             HttpPipeline pipeline = HttpPipelineBuilder.Build(options, new AzureKeyCredentialPolicy(credential, Constants.AuthorizationHeader));
-            ServiceClient = new FormRecognizerRestClient(Diagnostics, pipeline, endpoint.AbsoluteUri, FormRecognizerClientOptions.GetVersionString(options.Version));
+            ServiceClient = new FormRecognizerRestClient(Diagnostics, pipeline, endpoint.AbsoluteUri, FormRecognizerClientOptions.GetVersionString(ServiceVersion));
         }
 
         /// <summary>
@@ -100,8 +104,9 @@ public FormTrainingClient(Uri endpoint, TokenCredential credential, FormRecogniz
             Argument.AssertNotNull(options, nameof(options));
 
             Diagnostics = new ClientDiagnostics(options);
+            ServiceVersion = options.Version;
             var pipeline = HttpPipelineBuilder.Build(options, new BearerTokenAuthenticationPolicy(credential, Constants.DefaultCognitiveScope));
-            ServiceClient = new FormRecognizerRestClient(Diagnostics, pipeline, endpoint.AbsoluteUri, FormRecognizerClientOptions.GetVersionString(options.Version));
+            ServiceClient = new FormRecognizerRestClient(Diagnostics, pipeline, endpoint.AbsoluteUri, FormRecognizerClientOptions.GetVersionString(ServiceVersion));
         }
 
         #region Training
@@ -139,7 +144,7 @@ public virtual TrainingOperation StartTraining(Uri trainingFilesUri, bool useTra
                 };
 
                 ResponseWithHeaders<FormRecognizerTrainCustomModelAsyncHeaders> response = ServiceClient.TrainCustomModelAsync(trainRequest, cancellationToken);
-                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -182,7 +187,7 @@ public virtual async Task<TrainingOperation> StartTrainingAsync(Uri trainingFile
                 };
 
                 ResponseWithHeaders<FormRecognizerTrainCustomModelAsyncHeaders> response = await ServiceClient.TrainCustomModelAsyncAsync(trainRequest, cancellationToken).ConfigureAwait(false);
-                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -223,7 +228,7 @@ public virtual TrainingOperation StartTraining(Uri trainingFilesUri, bool useTra
                 };
 
                 ResponseWithHeaders<FormRecognizerTrainCustomModelAsyncHeaders> response = ServiceClient.TrainCustomModelAsync(trainRequest, cancellationToken);
-                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -264,7 +269,7 @@ public virtual async Task<TrainingOperation> StartTrainingAsync(Uri trainingFile
                 };
 
                 ResponseWithHeaders<FormRecognizerTrainCustomModelAsyncHeaders> response = await ServiceClient.TrainCustomModelAsyncAsync(trainRequest, cancellationToken).ConfigureAwait(false);
-                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new TrainingOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -306,7 +311,7 @@ public virtual CreateComposedModelOperation StartCreateComposedModel(IEnumerable
                 composeRequest.ModelName = modelName;
 
                 ResponseWithHeaders<FormRecognizerComposeCustomModelsAsyncHeaders> response = ServiceClient.ComposeCustomModelsAsync(composeRequest, cancellationToken);
-                return new CreateComposedModelOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new CreateComposedModelOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -344,7 +349,7 @@ public virtual async Task<CreateComposedModelOperation> StartCreateComposedModel
                 composeRequest.ModelName = modelName;
 
                 ResponseWithHeaders<FormRecognizerComposeCustomModelsAsyncHeaders> response = await ServiceClient.ComposeCustomModelsAsyncAsync(composeRequest, cancellationToken).ConfigureAwait(false);
-                return new CreateComposedModelOperation(response.Headers.Location, ServiceClient, Diagnostics);
+                return new CreateComposedModelOperation(response.Headers.Location, ServiceClient, Diagnostics, ServiceVersion);
             }
             catch (Exception e)
             {
@@ -376,7 +381,7 @@ public virtual Response<CustomFormModel> GetCustomModel(string modelId, Cancella
                 Guid guid = ClientCommon.ValidateModelId(modelId, nameof(modelId));
 
                 Response<Model> response = ServiceClient.GetCustomModel(guid, includeKeys: true, cancellationToken);
-                return Response.FromValue(new CustomFormModel(response.Value), response.GetRawResponse());
+                return Response.FromValue(new CustomFormModel(response.Value, ServiceVersion), response.GetRawResponse());
             }
             catch (Exception e)
             {
@@ -404,7 +409,7 @@ public virtual async Task<Response<CustomFormModel>> GetCustomModelAsync(string
                 Guid guid = ClientCommon.ValidateModelId(modelId, nameof(modelId));
 
                 Response<Model> response = await ServiceClient.GetCustomModelAsync(guid, includeKeys: true, cancellationToken).ConfigureAwait(false);
-                return Response.FromValue(new CustomFormModel(response.Value), response.GetRawResponse());
+                return Response.FromValue(new CustomFormModel(response.Value, ServiceVersion), response.GetRawResponse());
             }
             catch (Exception e)
             {

diff --git a/sdk/formrecognizer/Azure.AI.FormRecognizer/src/TrainingOperation.cs b/sdk/formrecognizer/Azure.AI.FormRecognizer/src/TrainingOperation.cs
@@ -10,7 +10,8 @@ namespace Azure.AI.FormRecognizer.Training
     /// </summary>
     public class TrainingOperation : CreateCustomFormModelOperation
     {
-        internal TrainingOperation(string location, FormRecognizerRestClient allOperations, ClientDiagnostics diagnostics) : base(location, allOperations, diagnostics) { }
+        internal TrainingOperation(string location, FormRecognizerRestClient allOperations, ClientDiagnostics diagnostics, FormRecognizerClientOptions.ServiceVersion serviceVersion)
+            : base(location, allOperations, diagnostics, serviceVersion) { }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="TrainingOperation"/> class which