Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[formrecognizer] regenerates on v2.1 #18551

Merged
merged 14 commits into from
May 11, 2021
Merged

[formrecognizer] regenerates on v2.1 #18551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
5d4e9fe
add v2.1 generation
kristapratico Apr 22, 2021
e661446
some fixes for v2.1
kristapratico May 6, 2021
355011c
add note about 3.5 deprecation
kristapratico May 7, 2021
3625a09
ingest new changes
kristapratico May 8, 2021
6185d84
adjust code for new field value types and remove the old
kristapratico May 8, 2021
1d82f8b
adjustments to tests for changes in models
kristapratico May 8, 2021
a4274b0
update changelog and samples for CountryRegion
kristapratico May 8, 2021
62ca67f
api version compatibility
kristapratico May 9, 2021
50da70f
add recordings for v2.1
kristapratico May 11, 2021
254aa53
merge master
kristapratico May 11, 2021
7ef62ba
Exclude recordings from spellcheck
danieljurek May 11, 2021
b9971e9
Merge branch 'master' into fr2.1
kristapratico May 11, 2021
9fb4110
skip tests for regression in tables bounding box
kristapratico May 11, 2021
d077fb5
review feedback + skip AAD tests since not deployed
kristapratico May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .vscode/cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"powershell"
],
"ignorePaths": [
"**/tests/recordings/**",
".vscode/cspell.json"
],
"words": ["azsdk", "conda", "tenvparallel"],
Expand Down
11 changes: 8 additions & 3 deletions sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Release History

## 3.1.0b5 (Unreleased)
## 3.1.0 (Unreleased)

Note: this version will be the last to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+

**Breaking Changes**

- `begin_recognize_id_documents` renamed to `begin_recognize_identity_documents`
- `begin_recognize_id_documents_from_url` renamed to `begin_recognize_identity_documents_from_url`
- `begin_recognize_id_documents` renamed to `begin_recognize_identity_documents`.
- `begin_recognize_id_documents_from_url` renamed to `begin_recognize_identity_documents_from_url`.
- The model `TextAppearance` now includes the properties `style_name` and `style_confidence` that were part of the `TextStyle` object.
- Removed the model `TextStyle`.
- Removed field value types "gender" and "country" from the `FieldValueType` enum.
- Added field value type "countryRegion" to the `FieldValueType` enum.
- Renamed field name for identity documents from "Country" to "CountryRegion".

**New features**

Expand Down
7 changes: 3 additions & 4 deletions sdk/formrecognizer/azure-ai-formrecognizer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,16 @@ from form documents. It includes the following main functionalities:
Install the Azure Form Recognizer client library for Python with [pip][pip]:

```bash
pip install azure-ai-formrecognizer --pre
pip install azure-ai-formrecognizer
```

> Note: This version of the client library defaults to the v2.1-preview.3 version of the service
> Note: This version of the client library defaults to the v2.1 version of the service
This table shows the relationship between SDK versions and supported API versions of the service

|SDK version|Supported API version of service
|-|-
|3.0.0 - Latest GA release (can be installed by removing the `--pre` flag)| 2.0
|3.1.0b4 - Latest release (beta)| 2.0, 2.1-preview.3
|3.1.0 - Latest GA release| 2.0, 2.1 (default)


#### Create a Form Recognizer resource
Expand Down
2 changes: 1 addition & 1 deletion sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_api_versions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class FormRecognizerApiVersion(str, Enum):
"""Form Recognizer API versions supported by this package"""

#: This is the default version
V2_1_PREVIEW = "2.1-preview.3"
V2_1 = "2.1"
V2_0 = "2.0"


Expand Down
4 changes: 3 additions & 1 deletion sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_base_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ def __init__(self, endpoint, credential, **kwargs):
self._endpoint = endpoint
self._credential = credential
self._api_version = kwargs.pop(
"api_version", FormRecognizerApiVersion.V2_1_PREVIEW
"api_version", FormRecognizerApiVersion.V2_1
)
if self._api_version.startswith("v"): # v2.0 released with this option
self._api_version = self._api_version[1:]
validate_api_version(self._api_version)

authentication_policy = get_authentication_policy(credential)
Expand Down
80 changes: 40 additions & 40 deletions ...formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def begin_recognize_receipts(self, receipt, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *locale* and *pages* keyword arguments and support for image/bmp content
.. admonition:: Example:
Expand All @@ -127,20 +127,20 @@ def begin_recognize_receipts(self, receipt, **kwargs):
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if locale:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"locale": locale})
else:
raise ValueError(
"'locale' is only available for API version V2_1_PREVIEW and up"
"'locale' is only available for API version V2_1 and up"
)
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)
return self._client.begin_analyze_receipt_async( # type: ignore
file_stream=receipt,
Expand Down Expand Up @@ -178,7 +178,7 @@ def begin_recognize_receipts_from_url(self, receipt_url, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *locale* and *pages* keyword arguments and support for image/bmp content
.. admonition:: Example:
Expand All @@ -198,20 +198,20 @@ def begin_recognize_receipts_from_url(self, receipt_url, **kwargs):
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if locale:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"locale": locale})
else:
raise ValueError(
"'locale' is only available for API version V2_1_PREVIEW and up"
"'locale' is only available for API version V2_1 and up"
)
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)
return self._client.begin_analyze_receipt_async( # type: ignore
file_stream={"source": receipt_url},
Expand Down Expand Up @@ -253,7 +253,7 @@ def begin_recognize_business_cards(self, business_card, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_business_cards* client method
.. admonition:: Example:
Expand Down Expand Up @@ -288,7 +288,7 @@ def begin_recognize_business_cards(self, business_card, **kwargs):
except ValueError as e:
if "begin_analyze_business_card_async" in str(e):
raise ValueError(
"Method 'begin_recognize_business_cards' is only available for API version V2_1_PREVIEW and up"
"Method 'begin_recognize_business_cards' is only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -319,7 +319,7 @@ def begin_recognize_business_cards_from_url(self, business_card_url, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_business_cards_from_url* client method
"""
Expand All @@ -338,7 +338,7 @@ def begin_recognize_business_cards_from_url(self, business_card_url, **kwargs):
if "begin_analyze_business_card_async" in str(e):
raise ValueError(
"Method 'begin_recognize_business_cards_from_url' is "
"only available for API version V2_1_PREVIEW and up"
"only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -372,7 +372,7 @@ def begin_recognize_identity_documents(self, identity_document, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_identity_documents* client method
.. admonition:: Example:
Expand Down Expand Up @@ -406,7 +406,7 @@ def begin_recognize_identity_documents(self, identity_document, **kwargs):
except ValueError as e:
if "begin_analyze_id_document_async" in str(e):
raise ValueError(
"Method 'begin_recognize_identity_documents' is only available for API version V2_1_PREVIEW and up"
"Method 'begin_recognize_identity_documents' is only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -435,7 +435,7 @@ def begin_recognize_identity_documents_from_url(self, identity_document_url, **k
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_identity_documents_from_url* client method
"""

Expand All @@ -453,7 +453,7 @@ def begin_recognize_identity_documents_from_url(self, identity_document_url, **k
if "begin_analyze_id_document_async" in str(e):
raise ValueError(
"Method 'begin_recognize_identity_documents_from_url' is "
"only available for API version V2_1_PREVIEW and up"
"only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -488,7 +488,7 @@ def begin_recognize_invoices(self, invoice, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_invoices* client method
.. admonition:: Example:
Expand Down Expand Up @@ -523,7 +523,7 @@ def begin_recognize_invoices(self, invoice, **kwargs):
except ValueError as e:
if "begin_analyze_invoice_async" in str(e):
raise ValueError(
"Method 'begin_recognize_invoices' is only available for API version V2_1_PREVIEW and up"
"Method 'begin_recognize_invoices' is only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -553,7 +553,7 @@ def begin_recognize_invoices_from_url(self, invoice_url, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.RecognizedForm]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_recognize_invoices_from_url* client method
"""

Expand All @@ -571,7 +571,7 @@ def begin_recognize_invoices_from_url(self, invoice_url, **kwargs):
if "begin_analyze_invoice_async" in str(e):
raise ValueError(
"Method 'begin_recognize_invoices_from_url' is "
"only available for API version V2_1_PREVIEW and up"
"only available for API version V2_1 and up"
)
raise e

Expand Down Expand Up @@ -617,7 +617,7 @@ def begin_recognize_content(self, form, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.FormPage]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *pages*, *language* and *reading_order* keyword arguments and support for image/bmp content
.. admonition:: Example:
Expand All @@ -644,27 +644,27 @@ def begin_recognize_content(self, form, **kwargs):
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)

if reading_order:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"reading_order": reading_order})
else:
raise ValueError(
"'reading_order' is only available for API version V2_1_PREVIEW and up"
"'reading_order' is only available for API version V2_1 and up"
)

if language:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"language": language})
else:
raise ValueError(
"'language' is only available for API version V2_1_PREVIEW and up"
"'language' is only available for API version V2_1 and up"
)

return self._client.begin_analyze_layout_async( # type: ignore
Expand Down Expand Up @@ -704,7 +704,7 @@ def begin_recognize_content_from_url(self, form_url, **kwargs):
:rtype: ~azure.core.polling.LROPoller[list[~azure.ai.formrecognizer.FormPage]]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *pages*, *language* and *reading_order* keyword arguments and support for image/bmp content
"""
pages = kwargs.pop("pages", None)
Expand All @@ -714,27 +714,27 @@ def begin_recognize_content_from_url(self, form_url, **kwargs):
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)

if reading_order:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"reading_order": reading_order})
else:
raise ValueError(
"'reading_order' is only available for API version V2_1_PREVIEW and up"
"'reading_order' is only available for API version V2_1 and up"
)

if language:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"language": language})
else:
raise ValueError(
"'language' is only available for API version V2_1_PREVIEW and up"
"'language' is only available for API version V2_1 and up"
)

return self._client.begin_analyze_layout_async( # type: ignore
Expand Down Expand Up @@ -817,11 +817,11 @@ def analyze_callback(
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)

return self._client.begin_analyze_with_custom_model( # type: ignore
Expand Down Expand Up @@ -886,11 +886,11 @@ def analyze_callback(
# FIXME: part of this code will be removed once autorest can handle diff mixin
# signatures across API versions
if pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version == FormRecognizerApiVersion.V2_1:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
"'pages' is only available for API version V2_1 and up"
)

return self._client.begin_analyze_with_custom_model( # type: ignore
Expand Down
8 changes: 4 additions & 4 deletions sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_training_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ def begin_training(self, training_files_url, use_training_labels, **kwargs):
Note that if the training fails, the exception is raised, but a model with an
"invalid" status is still created. You can delete this model by calling :func:`~delete_model()`
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *model_name* keyword argument
.. admonition:: Example:
Expand All @@ -135,7 +135,7 @@ def callback_v2_1(raw_response, _, headers): # pylint: disable=unused-argument
model_name = kwargs.pop("model_name", None)
if model_name and self._api_version == "2.0":
raise ValueError(
"'model_name' is only available for API version V2_1_PREVIEW and up"
"'model_name' is only available for API version V2_1 and up"
)
continuation_token = kwargs.pop("continuation_token", None)
polling_interval = kwargs.pop(
Expand Down Expand Up @@ -454,7 +454,7 @@ def begin_create_composed_model(self, model_ids, **kwargs):
:rtype: ~azure.core.polling.LROPoller[~azure.ai.formrecognizer.CustomFormModel]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1-preview
.. versionadded:: v2.1
The *begin_create_composed_model* client method
.. admonition:: Example:
Expand Down Expand Up @@ -492,7 +492,7 @@ def _compose_callback(
)
except ValueError:
raise ValueError(
"Method 'begin_create_composed_model' is only available for API version V2_1_PREVIEW and up"
"Method 'begin_create_composed_model' is only available for API version V2_1 and up"
)

def get_form_recognizer_client(self, **kwargs):
Expand Down
Loading