Rename to completed_on and requested_on in the CustomFormModel (#11592)

* Rename to completed_on and requested_on

* comments

* Apply suggestions from code review

Co-authored-by: Krista Pratico <[email protected]>

* Update sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py

Co-authored-by: Krista Pratico <[email protected]>

Co-authored-by: Krista Pratico <[email protected]>

Author: Rakshith Bhyravabhotla

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

@@ -16,7 +16,9 @@
 - `USReceiptType` is renamed to `ReceiptType`
 - `use_training_labels` is now a required positional param in the `begin_training` APIs.
 - `stream` and `url` parameters found on methods for `FormRecognizerClient` have been renamed to `form` and `form_url`, respectively.
-For recognize receipt methods, parameters have been renamed to `receipt` and `receipt_url`.
+- For recognize receipt methods, parameters have been renamed to `receipt` and `receipt_url`.
+- `created_on` and `last_modified` are renamed to `requested_on` and `completed_on` in the
+`CustomFormModel`  and `CustomFormModelInfo` models.
 
 **New features**
 

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

@@ -265,8 +265,8 @@ model = poller.result()
 # Custom model information
 print("Model ID: {}".format(model.model_id))
 print("Status: {}".format(model.status))
-print("Created on: {}".format(model.created_on))
-print("Last modified: {}".format(model.last_modified))
+print("Requested on: {}".format(model.requested_on))
+print("Completed on: {}".format(model.completed_on))
 
 print("Recognized fields:")
 # looping through the submodels, which contains the fields they were trained on
@@ -314,8 +314,8 @@ model_id = "<model id from the Train a Model sample>"
 custom_model = form_training_client.get_custom_model(model_id=model_id)
 print("Model ID: {}".format(custom_model.model_id))
 print("Status: {}".format(custom_model.status))
-print("Created on: {}".format(custom_model.created_on))
-print("Last modified: {}".format(custom_model.last_modified))
+print("Requested on: {}".format(custom_model.requested_on))
+print("Completed on: {}".format(custom_model.completed_on))
 
 # Finally, we will delete this model by ID
 form_training_client.delete_model(model_id=custom_model.model_id)

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py

@@ -672,9 +672,9 @@ class CustomFormModel(object):
         Status indicating the model's readiness for use,
         :class:`~azure.ai.formrecognizer.CustomFormModelStatus`.
         Possible values include: 'creating', 'ready', 'invalid'.
-    :ivar ~datetime.datetime created_on:
-        The date and time (UTC) when model training was started.
-    :ivar ~datetime.datetime last_modified:
+    :ivar ~datetime.datetime requested_on:
+        The date and time (UTC) when model training was requested.
+    :ivar ~datetime.datetime completed_on:
         Date and time (UTC) when model training completed.
     :ivar list[~azure.ai.formrecognizer.CustomFormSubModel] models:
         A list of submodels that are part of this model, each of
@@ -688,8 +688,8 @@ class CustomFormModel(object):
     def __init__(self, **kwargs):
         self.model_id = kwargs.get("model_id", None)
         self.status = kwargs.get("status", None)
-        self.created_on = kwargs.get("created_on", None)
-        self.last_modified = kwargs.get("last_modified", None)
+        self.requested_on = kwargs.get("requested_on", None)
+        self.completed_on = kwargs.get("completed_on", None)
         self.models = kwargs.get("models", None)
         self.errors = kwargs.get("errors", None)
         self.training_documents = kwargs.get("training_documents", [])
@@ -699,8 +699,8 @@ def _from_generated(cls, model):
         return cls(
             model_id=model.model_info.model_id,
             status=model.model_info.status,
-            created_on=model.model_info.created_date_time,
-            last_modified=model.model_info.last_updated_date_time,
+            requested_on=model.model_info.created_date_time,
+            completed_on=model.model_info.last_updated_date_time,
             models=CustomFormSubModel._from_generated_unlabeled(model)
             if model.keys else CustomFormSubModel._from_generated_labeled(model),
             errors=FormRecognizerError._from_generated(model.train_result.errors) if model.train_result else None,
@@ -709,9 +709,9 @@ def _from_generated(cls, model):
         )
 
     def __repr__(self):
-        return "CustomFormModel(model_id={}, status={}, created_on={}, last_modified={}, models={}, " \
+        return "CustomFormModel(model_id={}, status={}, requested_on={}, completed_on={}, models={}, " \
                 "errors={}, training_documents={})".format(
-                    self.model_id, self.status, self.created_on, self.last_modified, repr(self.models),
+                    self.model_id, self.status, self.requested_on, self.completed_on, repr(self.models),
                     repr(self.errors), repr(self.training_documents)
                 )[:1024]
 
@@ -853,30 +853,30 @@ class CustomFormModelInfo(object):
     :ivar str status:
         The status of the model, :class:`~azure.ai.formrecognizer.CustomFormModelStatus`.
         Possible values include: 'creating', 'ready', 'invalid'.
-    :ivar ~datetime.datetime created_on:
-        Date and time (UTC) when model training was started.
-    :ivar ~datetime.datetime last_modified:
+    :ivar ~datetime.datetime requested_on:
+        Date and time (UTC) when model training was requested.
+    :ivar ~datetime.datetime completed_on:
         Date and time (UTC) when model training completed.
     """
 
     def __init__(self, **kwargs):
         self.model_id = kwargs.get("model_id", None)
         self.status = kwargs.get("status", None)
-        self.created_on = kwargs.get("created_on", None)
-        self.last_modified = kwargs.get("last_modified", None)
+        self.requested_on = kwargs.get("requested_on", None)
+        self.completed_on = kwargs.get("completed_on", None)
 
     @classmethod
     def _from_generated(cls, model, model_id=None):
         return cls(
             model_id=model_id if model_id else model.model_id,
             status=model.status,
-            created_on=model.created_date_time,
-            last_modified=model.last_updated_date_time
+            requested_on=model.created_date_time,
+            completed_on=model.last_updated_date_time
         )
 
     def __repr__(self):
-        return "CustomFormModelInfo(model_id={}, status={}, created_on={}, last_modified={})".format(
-            self.model_id, self.status, self.created_on, self.last_modified
+        return "CustomFormModelInfo(model_id={}, status={}, requested_on={}, completed_on={})".format(
+            self.model_id, self.status, self.requested_on, self.completed_on
         )[:1024]
 
 

sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_manage_custom_models_async.py

@@ -65,8 +65,8 @@ async def manage_custom_models(self):
             custom_model = await form_training_client.get_custom_model(model_id=first_model.model_id)
             print("Model ID: {}".format(custom_model.model_id))
             print("Status: {}".format(custom_model.status))
-            print("Created on: {}".format(custom_model.created_on))
-            print("Last modified: {}".format(custom_model.last_modified))
+            print("Requested on: {}".format(custom_model.requested_on))
+            print("Completed on: {}".format(custom_model.completed_on))
             # [END get_custom_model_async]
 
             # Finally, we will delete this model by ID

sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_train_model_with_labels_async.py

@@ -49,8 +49,8 @@ async def train_model_with_labels(self):
             # Custom model information
             print("Model ID: {}".format(model.model_id))
             print("Status: {}".format(model.status))
-            print("Created on: {}".format(model.created_on))
-            print("Last modified: {}".format(model.last_modified))
+            print("Requested on: {}".format(model.requested_on))
+            print("Completed on: {}".format(model.completed_on))
 
             print("Recognized fields:")
             # looping through the submodels, which contains the fields they were trained on

sdk/formrecognizer/azure-ai-formrecognizer/samples/async_samples/sample_train_model_without_labels_async.py

@@ -48,8 +48,8 @@ async def train_model_without_labels(self):
             # Custom model information
             print("Model ID: {}".format(model.model_id))
             print("Status: {}".format(model.status))
-            print("Created on: {}".format(model.created_on))
-            print("Last modified: {}".format(model.last_modified))
+            print("Requested on: {}".format(model.requested_on))
+            print("Completed on: {}".format(model.completed_on))
 
             print("Recognized fields:")
             # Looping through the submodels, which contains the fields they were trained on

sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_manage_custom_models.py

@@ -61,8 +61,8 @@ def manage_custom_models(self):
         custom_model = form_training_client.get_custom_model(model_id=first_model.model_id)
         print("Model ID: {}".format(custom_model.model_id))
         print("Status: {}".format(custom_model.status))
-        print("Created on: {}".format(custom_model.created_on))
-        print("Last modified: {}".format(custom_model.last_modified))
+        print("Requested on: {}".format(custom_model.requested_on))
+        print("Completed on: {}".format(custom_model.completed_on))
         # [END get_custom_model]
 
         # Finally, we will delete this model by ID

sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_train_model_with_labels.py

@@ -46,8 +46,8 @@ def train_model_with_labels(self):
         # Custom model information
         print("Model ID: {}".format(model.model_id))
         print("Status: {}".format(model.status))
-        print("Created on: {}".format(model.created_on))
-        print("Last modified: {}".format(model.last_modified))
+        print("Requested on: {}".format(model.requested_on))
+        print("Completed on: {}".format(model.completed_on))
 
         print("Recognized fields:")
         # looping through the submodels, which contains the fields they were trained on

sdk/formrecognizer/azure-ai-formrecognizer/samples/sample_train_model_without_labels.py

@@ -46,8 +46,8 @@ def train_model_without_labels(self):
         # Custom model information
         print("Model ID: {}".format(model.model_id))
         print("Status: {}".format(model.status))
-        print("Created on: {}".format(model.created_on))
-        print("Last modified: {}".format(model.last_modified))
+        print("Requested on: {}".format(model.requested_on))
+        print("Completed on: {}".format(model.completed_on))
 
         print("Recognized fields:")
         # Looping through the submodels, which contains the fields they were trained on

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_copy_model.py

@@ -44,8 +44,8 @@ def test_copy_model_successful(self, client, container_sas_url, location, resour
         copied_model = client.get_custom_model(copy.model_id)
 
         self.assertEqual(copy.status, "succeeded")
-        self.assertIsNotNone(copy.created_on)
-        self.assertIsNotNone(copy.last_modified)
+        self.assertIsNotNone(copy.requested_on)
+        self.assertIsNotNone(copy.completed_on)
         self.assertEqual(target["modelId"], copy.model_id)
         self.assertNotEqual(target["modelId"], model.model_id)
         self.assertIsNotNone(copied_model)
@@ -86,9 +86,9 @@ def callback(response, _, headers):
 
         actual = raw_response[0]
         copy = raw_response[1]
-        self.assertEqual(copy.created_on, actual.created_date_time)
+        self.assertEqual(copy.requested_on, actual.created_date_time)
         self.assertEqual(copy.status, actual.status)
-        self.assertEqual(copy.last_modified, actual.last_updated_date_time)
+        self.assertEqual(copy.completed_on, actual.last_updated_date_time)
         self.assertEqual(copy.model_id, target["modelId"])
 
     @GlobalFormRecognizerAccountPreparer()

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_copy_model_async.py

@@ -43,8 +43,8 @@ async def test_copy_model_successful(self, client, container_sas_url, location,
         copied_model = await client.get_custom_model(copy.model_id)
 
         self.assertEqual(copy.status, "succeeded")
-        self.assertIsNotNone(copy.created_on)
-        self.assertIsNotNone(copy.last_modified)
+        self.assertIsNotNone(copy.requested_on)
+        self.assertIsNotNone(copy.completed_on)
         self.assertEqual(target["modelId"], copy.model_id)
         self.assertNotEqual(target["modelId"], model.model_id)
         self.assertIsNotNone(copied_model)
@@ -81,9 +81,9 @@ def callback(response, _, headers):
 
         actual = raw_response[0]
         copy = raw_response[1]
-        self.assertEqual(copy.created_on, actual.created_date_time)
+        self.assertEqual(copy.requested_on, actual.created_date_time)
         self.assertEqual(copy.status, actual.status)
-        self.assertEqual(copy.last_modified, actual.last_updated_date_time)
+        self.assertEqual(copy.completed_on, actual.last_updated_date_time)
         self.assertEqual(copy.model_id, target["modelId"])
 
     @GlobalFormRecognizerAccountPreparer()

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_mgmt.py

@@ -87,8 +87,8 @@ def test_mgmt_model_labeled(self, client, container_sas_url):
 
         self.assertEqual(labeled_model_from_train.model_id, labeled_model_from_get.model_id)
         self.assertEqual(labeled_model_from_train.status, labeled_model_from_get.status)
-        self.assertEqual(labeled_model_from_train.created_on, labeled_model_from_get.created_on)
-        self.assertEqual(labeled_model_from_train.last_modified, labeled_model_from_get.last_modified)
+        self.assertEqual(labeled_model_from_train.requested_on, labeled_model_from_get.requested_on)
+        self.assertEqual(labeled_model_from_train.completed_on, labeled_model_from_get.completed_on)
         self.assertEqual(labeled_model_from_train.errors, labeled_model_from_get.errors)
         for a, b in zip(labeled_model_from_train.training_documents, labeled_model_from_get.training_documents):
             self.assertEqual(a.document_name, b.document_name)
@@ -104,8 +104,8 @@ def test_mgmt_model_labeled(self, client, container_sas_url):
         for model in models_list:
             self.assertIsNotNone(model.model_id)
             self.assertIsNotNone(model.status)
-            self.assertIsNotNone(model.created_on)
-            self.assertIsNotNone(model.last_modified)
+            self.assertIsNotNone(model.requested_on)
+            self.assertIsNotNone(model.completed_on)
 
         client.delete_model(labeled_model_from_train.model_id)
 
@@ -123,8 +123,8 @@ def test_mgmt_model_unlabeled(self, client, container_sas_url):
 
         self.assertEqual(unlabeled_model_from_train.model_id, unlabeled_model_from_get.model_id)
         self.assertEqual(unlabeled_model_from_train.status, unlabeled_model_from_get.status)
-        self.assertEqual(unlabeled_model_from_train.created_on, unlabeled_model_from_get.created_on)
-        self.assertEqual(unlabeled_model_from_train.last_modified, unlabeled_model_from_get.last_modified)
+        self.assertEqual(unlabeled_model_from_train.requested_on, unlabeled_model_from_get.requested_on)
+        self.assertEqual(unlabeled_model_from_train.completed_on, unlabeled_model_from_get.completed_on)
         self.assertEqual(unlabeled_model_from_train.errors, unlabeled_model_from_get.errors)
         for a, b in zip(unlabeled_model_from_train.training_documents, unlabeled_model_from_get.training_documents):
             self.assertEqual(a.document_name, b.document_name)
@@ -139,8 +139,8 @@ def test_mgmt_model_unlabeled(self, client, container_sas_url):
         for model in models_list:
             self.assertIsNotNone(model.model_id)
             self.assertIsNotNone(model.status)
-            self.assertIsNotNone(model.created_on)
-            self.assertIsNotNone(model.last_modified)
+            self.assertIsNotNone(model.requested_on)
+            self.assertIsNotNone(model.completed_on)
 
         client.delete_model(unlabeled_model_from_train.model_id)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_mgmt_async.py

@@ -87,8 +87,8 @@ async def test_mgmt_model_labeled(self, client, container_sas_url):
 
         self.assertEqual(labeled_model_from_train.model_id, labeled_model_from_get.model_id)
         self.assertEqual(labeled_model_from_train.status, labeled_model_from_get.status)
-        self.assertEqual(labeled_model_from_train.created_on, labeled_model_from_get.created_on)
-        self.assertEqual(labeled_model_from_train.last_modified, labeled_model_from_get.last_modified)
+        self.assertEqual(labeled_model_from_train.requested_on, labeled_model_from_get.requested_on)
+        self.assertEqual(labeled_model_from_train.completed_on, labeled_model_from_get.completed_on)
         self.assertEqual(labeled_model_from_train.errors, labeled_model_from_get.errors)
         for a, b in zip(labeled_model_from_train.training_documents, labeled_model_from_get.training_documents):
             self.assertEqual(a.document_name, b.document_name)
@@ -104,8 +104,8 @@ async def test_mgmt_model_labeled(self, client, container_sas_url):
         async for model in models_list:
             self.assertIsNotNone(model.model_id)
             self.assertIsNotNone(model.status)
-            self.assertIsNotNone(model.created_on)
-            self.assertIsNotNone(model.last_modified)
+            self.assertIsNotNone(model.requested_on)
+            self.assertIsNotNone(model.completed_on)
 
         await client.delete_model(labeled_model_from_train.model_id)
 
@@ -121,8 +121,8 @@ async def test_mgmt_model_unlabeled(self, client, container_sas_url):
 
         self.assertEqual(unlabeled_model_from_train.model_id, unlabeled_model_from_get.model_id)
         self.assertEqual(unlabeled_model_from_train.status, unlabeled_model_from_get.status)
-        self.assertEqual(unlabeled_model_from_train.created_on, unlabeled_model_from_get.created_on)
-        self.assertEqual(unlabeled_model_from_train.last_modified, unlabeled_model_from_get.last_modified)
+        self.assertEqual(unlabeled_model_from_train.requested_on, unlabeled_model_from_get.requested_on)
+        self.assertEqual(unlabeled_model_from_train.completed_on, unlabeled_model_from_get.completed_on)
         self.assertEqual(unlabeled_model_from_train.errors, unlabeled_model_from_get.errors)
         for a, b in zip(unlabeled_model_from_train.training_documents, unlabeled_model_from_get.training_documents):
             self.assertEqual(a.document_name, b.document_name)
@@ -137,8 +137,8 @@ async def test_mgmt_model_unlabeled(self, client, container_sas_url):
         async for model in models_list:
             self.assertIsNotNone(model.model_id)
             self.assertIsNotNone(model.status)
-            self.assertIsNotNone(model.created_on)
-            self.assertIsNotNone(model.last_modified)
+            self.assertIsNotNone(model.requested_on)
+            self.assertIsNotNone(model.completed_on)
 
         await client.delete_model(unlabeled_model_from_train.model_id)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_repr.py

@@ -205,25 +205,25 @@ def test_custom_form_model(self, custom_form_sub_model, form_recognizer_error, t
         model = _models.CustomFormModel(
             model_id=1,
             status=_models.CustomFormModelStatus.creating,
-            created_on=datetime.datetime(1, 1, 1),
-            last_modified=datetime.datetime(1, 1, 1),
+            requested_on=datetime.datetime(1, 1, 1),
+            completed_on=datetime.datetime(1, 1, 1),
             models=[custom_form_sub_model[0], custom_form_sub_model[0]],
             errors=[form_recognizer_error[0]],
             training_documents=[training_document_info[0], training_document_info[0]]
         )
 
-        model_repr = "CustomFormModel(model_id=1, status=creating, created_on=0001-01-01 00:00:00, " \
-            "last_modified=0001-01-01 00:00:00, models=[{}, {}], errors=[{}], training_documents=[{}, {}])".format(
+        model_repr = "CustomFormModel(model_id=1, status=creating, requested_on=0001-01-01 00:00:00, " \
+            "completed_on=0001-01-01 00:00:00, models=[{}, {}], errors=[{}], training_documents=[{}, {}])".format(
                 custom_form_sub_model[1], custom_form_sub_model[1], form_recognizer_error[1], training_document_info[1], training_document_info[1]
             )[:1024]
 
         assert repr(model) == model_repr
 
     def test_custom_form_model_info(self):
         model = _models.CustomFormModelInfo(
-            model_id=1, status=_models.CustomFormModelStatus.ready, created_on=datetime.datetime(1, 1, 1), last_modified=datetime.datetime(1, 1, 1)
+            model_id=1, status=_models.CustomFormModelStatus.ready, requested_on=datetime.datetime(1, 1, 1), completed_on=datetime.datetime(1, 1, 1)
         )
-        model_repr = "CustomFormModelInfo(model_id=1, status=ready, created_on=0001-01-01 00:00:00, last_modified=0001-01-01 00:00:00)"[:1024]
+        model_repr = "CustomFormModelInfo(model_id=1, status=ready, requested_on=0001-01-01 00:00:00, completed_on=0001-01-01 00:00:00)"[:1024]
         assert repr(model) == model_repr
 
     def test_account_properties(self):