Form Recognizer API consistency updates (Azure#27753)

Author: samvaity

sdk/formrecognizer/azure-ai-formrecognizer-perf/src/main/java/com/azure/ai/formrecognizer/perf/core/ServiceTest.java

@@ -81,7 +81,6 @@ public Mono<Void> globalSetupAsync() {
                 syncPoller = documentModelAdministrationAsyncClient
                 .beginBuildModel(trainingDocumentsUrl,
                     DocumentBuildMode.TEMPLATE,
-                    null,
                     new BuildModelOptions().setDescription("perf-model"))
                 .getSyncPoller();
             modelId = syncPoller.getFinalResult().getModelId();

sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md

@@ -7,6 +7,8 @@
 ### Breaking Changes
 - Renamed `modelIDs` in method `beginCreateComposedModel` to `componentModelIds`
 - Renamed method `beginCopyModel` to `beginCopyModelTo`
+- Removed `modelId` as a required parameter from `beginBuildModel`, `beginCreateComposedModel` and `getCopyAuthorization`
+and moved to `BuildModelOptions`, `CreateComposedModelOptions` and `CopyAuthorizationOptions` respectively
 
 ### Bugs Fixed
 

sdk/formrecognizer/azure-ai-formrecognizer/README.md

@@ -390,7 +390,7 @@ String trainingFilesUrl = "{SAS_URL_of_your_container_in_blob_storage}";
 // The shared access signature (SAS) Url of your Azure Blob Storage container with your forms.
 SyncPoller<DocumentOperationResult, DocumentModel> buildOperationPoller =
     documentModelAdminClient.beginBuildModel(trainingFilesUrl,
-        DocumentBuildMode.TEMPLATE, "my-build-model",
+        DocumentBuildMode.TEMPLATE,
         new BuildModelOptions().setDescription("model desc"), Context.NONE);
 
 DocumentModel documentModel = buildOperationPoller.getFinalResult();
@@ -608,7 +608,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
 [product_documentation]: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/overview
 [register_AAD_application]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
 [fr-studio]: https://aka.ms/azsdk/formrecognizer/formrecognizerstudio
-[fr_build_training_set]: https://aka.ms/azsdk/formrecognizer/buildtrainingset
+[fr_build_training_set]: https://aka.ms/azsdk/formrecognizer/buildcustommodel
 [sample_examples]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples#examples
 [sample_readme]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/src/samples#readme
 [migration_guide]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md

sdk/formrecognizer/azure-ai-formrecognizer/migration-guide.md

@@ -532,7 +532,7 @@ String trainingFilesUrl = "{SAS_URL_of_your_container_in_blob_storage}";
 // The shared access signature (SAS) Url of your Azure Blob Storage container with your forms.
 SyncPoller<DocumentOperationResult, DocumentModel> buildOperationPoller =
     documentModelAdminClient.beginBuildModel(trainingFilesUrl,
-        DocumentBuildMode.TEMPLATE, "my-build-model",
+        DocumentBuildMode.TEMPLATE,
         new BuildModelOptions().setDescription("model desc"), Context.NONE);
 
 DocumentModel documentModel = buildOperationPoller.getFinalResult();

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationAsyncClient.java

@@ -22,6 +22,8 @@ public final class BuildModelOptions {
 
     private Map<String, String> tags;
 
+    private String modelId;
+
     /**
      * Get the model description.
      *
@@ -35,7 +37,7 @@ public String getDescription() {
      * Set the model description.
      *
      * @param description the model description value to set.
-     * @return the BuildDocumentModelOptions object itself.
+     * @return the BuildModelOptions object itself.
      */
     public BuildModelOptions setDescription(String description) {
         this.description = description;
@@ -56,7 +58,7 @@ public String getPrefix() {
      * Set the case-sensitive prefix string to filter documents in the source path for training.
      *
      * @param prefix the prefix value to set.
-     * @return the BuildDocumentModelOptions object itself.
+     * @return the BuildModelOptions object itself.
      */
     public BuildModelOptions setPrefix(String prefix) {
         this.prefix = prefix;
@@ -76,10 +78,30 @@ public Map<String, String> getTags() {
      * Set the user defined attributes associated with the model.
      *
      * @param tags the tags value to set.
-     * @return the BuildDocumentModelOptions object itself.
+     * @return the BuildModelOptions object itself.
      */
     public BuildModelOptions setTags(Map<String, String> tags) {
         this.tags = tags;
         return this;
     }
+
+    /**
+     * Get the unique model identifier for the model.
+     *
+     * @return the modelId
+     */
+    public String getModelId() {
+        return modelId;
+    }
+
+    /**
+     * Set the unique model identifier for the model. If not specified, a model ID will be created for you.
+     *
+     * @param modelId a unique model identifier
+     * @return the BuildModelOptions object itself.
+     */
+    public BuildModelOptions setModelId(String modelId) {
+        this.modelId = modelId;
+        return this;
+    }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/DocumentModelAdministrationClient.java

@@ -14,6 +14,7 @@
 public final class CopyAuthorizationOptions {
     private String description;
     private Map<String, String> tags;
+    private String modelId;
 
     /**
      * Get the model description.
@@ -54,4 +55,24 @@ public CopyAuthorizationOptions setTags(Map<String, String> tags) {
         this.tags = tags;
         return this;
     }
+
+    /**
+     * Get the unique model identifier for the model.
+     *
+     * @return the modelId
+     */
+    public String getModelId() {
+        return modelId;
+    }
+
+    /**
+     * Set the unique model identifier for the model. If not specified, a model ID will be created for you.
+     *
+     * @param modelId a unique model identifier
+     * @return the CopyAuthorizationOptions object itself.
+     */
+    public CopyAuthorizationOptions setModelId(String modelId) {
+        this.modelId = modelId;
+        return this;
+    }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/models/BuildModelOptions.java

@@ -14,6 +14,7 @@
 public final class CreateComposedModelOptions {
     private String description;
     private Map<String, String> tags;
+    private String modelId;
 
     /**
      * Get the optional model description defined by the user.
@@ -55,4 +56,24 @@ public CreateComposedModelOptions setTags(Map<String, String> tags) {
         this.tags = tags;
         return this;
     }
+
+    /**
+     * Get the unique model identifier for the model.
+     *
+     * @return the modelId
+     */
+    public String getModelId() {
+        return modelId;
+    }
+
+    /**
+     * Set the unique model identifier for the model. If not specified, a model ID will be created for you.
+     *
+     * @param modelId a unique model identifier
+     * @return the CreateComposedModelOptions object itself.
+     */
+    public CreateComposedModelOptions setModelId(String modelId) {
+        this.modelId = modelId;
+        return this;
+    }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/administration/models/CopyAuthorizationOptions.java

@@ -217,7 +217,7 @@ public void buildModel() {
         // The shared access signature (SAS) Url of your Azure Blob Storage container with your forms.
         SyncPoller<DocumentOperationResult, DocumentModel> buildOperationPoller =
             documentModelAdminClient.beginBuildModel(trainingFilesUrl,
-                DocumentBuildMode.TEMPLATE, "my-build-model",
+                DocumentBuildMode.TEMPLATE,
                 new BuildModelOptions().setDescription("model desc"), Context.NONE);
 
         DocumentModel documentModel = buildOperationPoller.getFinalResult();