add version info on models

Azure · May 12, 2021 · 3883ee9 · 3883ee9
1 parent da2f2e4
commit 3883ee9
Showing 1 changed file with 46 additions and 10 deletions.
diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py
@@ -132,6 +132,9 @@ class Point(namedtuple("Point", "x y")):
 
     :ivar float x: x-coordinate
     :ivar float y: y-coordinate
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     __slots__ = ()
@@ -152,6 +155,9 @@ class FormPageRange(namedtuple("FormPageRange", "first_page_number last_page_num
 
     :ivar int first_page_number: The first page number of the form.
     :ivar int last_page_number: The last page number of the form.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     __slots__ = ()
@@ -190,6 +196,9 @@ class FormElement(object):
         The kind of form element. Possible kinds are "word", "line", or "selectionMark" which
         correspond to a :class:`~azure.ai.formrecognizer.FormWord` :class:`~azure.ai.formrecognizer.FormLine`,
         or :class:`~azure.ai.formrecognizer.FormSelectionMark`, respectively.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -244,7 +253,8 @@ class RecognizedForm(object):
         words, selection marks, tables and page metadata.
 
     .. versionadded:: v2.1
-        The *form_type_confidence* and *model_id* properties
+        The *form_type_confidence* and *model_id* properties, support for
+        *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -318,6 +328,9 @@ class FormField(object):
         dict[str, :class:`~azure.ai.formrecognizer.FormField`], or list[:class:`~azure.ai.formrecognizer.FormField`]
     :ivar float confidence:
         Measures the degree of certainty of the recognition result. Value is between [0.0, 1.0].
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -424,7 +437,8 @@ class FieldData(object):
         ~azure.ai.formrecognizer.FormLine,  ~azure.ai.formrecognizer.FormSelectionMark]]
 
     .. versionadded:: v2.1
-        *FormSelectionMark* is added to the types returned in the list of field_elements
+        *FormSelectionMark* is added to the types returned in the list of field_elements, support for
+        *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -532,7 +546,7 @@ class FormPage(object):
     :vartype selection_marks: list[~azure.ai.formrecognizer.FormSelectionMark]
 
     .. versionadded:: v2.1
-        *selection_marks* property
+        *selection_marks* property, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -612,7 +626,7 @@ class FormLine(FormElement):
     :vartype appearance: ~azure.ai.formrecognizer.Appearance
 
     .. versionadded:: v2.1
-        *appearance* property
+        *appearance* property, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -690,6 +704,9 @@ class FormWord(FormElement):
     :ivar int page_number:
         The 1-based number of the page in which this content is present.
     :ivar str kind: For FormWord, this is "word".
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -749,6 +766,9 @@ class FormSelectionMark(FormElement):
     :ivar int page_number:
         The 1-based number of the page in which this content is present.
     :ivar str kind: For FormSelectionMark, this is "selectionMark".
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -813,7 +833,7 @@ class FormTable(object):
         Units are in pixels for images and inches for PDF.
 
     .. versionadded:: v2.1
-        The *bounding_box* property.
+        The *bounding_box* property, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -886,7 +906,8 @@ class FormTableCell(object):  # pylint:disable=too-many-instance-attributes
         ~azure.ai.formrecognizer.FormLine, ~azure.ai.formrecognizer.FormSelectionMark]]
 
     .. versionadded:: v2.1
-        *FormSelectionMark* is added to the types returned in the list of field_elements
+        *FormSelectionMark* is added to the types returned in the list of field_elements, support for
+        *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1012,7 +1033,7 @@ class CustomFormModel(object):
     :vartype properties: ~azure.ai.formrecognizer.CustomFormModelProperties
 
     .. versionadded:: v2.1
-        The *model_name* and *properties* properties.
+        The *model_name* and *properties* properties, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1141,7 +1162,7 @@ class CustomFormSubmodel(object):
     :ivar str form_type: Type of form this submodel recognizes.
 
     .. versionadded:: v2.1
-        The *model_id* property
+        The *model_id* property, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1245,6 +1266,9 @@ class CustomFormModelField(object):
     :ivar str label: The form fields label on the form.
     :ivar str name: Canonical name; uniquely identifies a field within the form.
     :ivar float accuracy: The estimated recognition accuracy for this field.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1305,7 +1329,7 @@ class TrainingDocumentInfo(object):
         The model ID that used the document to train.
 
     .. versionadded:: v2.1
-        The *model_id* property
+        The *model_id* property, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1384,6 +1408,9 @@ class FormRecognizerError(object):
 
     :ivar str code: Error code.
     :ivar str message: Error message.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1434,7 +1461,7 @@ class CustomFormModelInfo(object):
     :vartype properties: ~azure.ai.formrecognizer.CustomFormModelProperties
 
     .. versionadded:: v2.1
-        The *model_name* and *properties* properties
+        The *model_name* and *properties* properties, support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1510,6 +1537,9 @@ class AccountProperties(object):
 
     :ivar int custom_model_count: Current count of trained custom models.
     :ivar int custom_model_limit: Max number of models that can be trained for this account.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1546,6 +1576,9 @@ class CustomFormModelProperties(object):
     """Optional model properties.
 
     :ivar bool is_composed_model: Is this model composed? (default: false).
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):
@@ -1580,6 +1613,9 @@ class TextAppearance(object):
     :ivar str style_name: The text line style name.
         Possible values include: "other", "handwriting".
     :ivar float style_confidence: The confidence of text line style.
+
+    .. versionadded:: v2.1
+        Support for *to_dict* and *from_dict* methods
     """
 
     def __init__(self, **kwargs):