Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/formrecognizer/azure-ai-formrecognizer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This table shows the relationship between SDK versions and supported API version
|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.0b5 - Latest release (beta)| 2.0, 2.1-preview.3, 2.1


#### Create a Form Recognizer resource
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ class FormRecognizerApiVersion(str, Enum):

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


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"locale": locale})
else:
raise ValueError(
Expand All @@ -136,7 +136,7 @@ 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 pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
Expand Down Expand Up @@ -198,7 +198,7 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"locale": locale})
else:
raise ValueError(
Expand All @@ -207,7 +207,7 @@ 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 pages:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
Expand Down Expand Up @@ -644,23 +644,23 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
)

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

if language:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"language": language})
else:
raise ValueError(
Expand Down Expand Up @@ -714,23 +714,23 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
"'pages' is only available for API version V2_1_PREVIEW and up"
)

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

if language:
if self._api_version == FormRecognizerApiVersion.V2_1_PREVIEW:
if self._api_version in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"language": language})
else:
raise ValueError(
Expand Down Expand Up @@ -817,7 +817,7 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
Expand Down Expand Up @@ -886,7 +886,7 @@ 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 in [FormRecognizerApiVersion.V2_1, FormRecognizerApiVersion.V2_1_PREVIEW]:
kwargs.update({"pages": pages})
else:
raise ValueError(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ def __init__(
):
if api_version == '2.0':
base_url = '{endpoint}/formrecognizer/v2.0'
elif api_version == '2.1':
base_url = '{endpoint}/formrecognizer/v2.1'
elif api_version == '2.1-preview.3':
base_url = '{endpoint}/formrecognizer/v2.1-preview.3'
else:
Expand All @@ -94,11 +96,15 @@ def models(cls, api_version=DEFAULT_API_VERSION):
"""Module depends on the API version:

* 2.0: :mod:`v2_0.models<azure.ai.formrecognizer.v2_0.models>`
* 2.1: :mod:`v2_1.models<azure.ai.formrecognizer.v2_1.models>`
* 2.1-preview.3: :mod:`v2_1_preview_3.models<azure.ai.formrecognizer.v2_1_preview_3.models>`
"""
if api_version == '2.0':
from .v2_0 import models
return models
elif api_version == '2.1':
from .v2_1 import models
return models
elif api_version == '2.1-preview.3':
from .v2_1_preview_3 import models
return models
Expand Down
Loading