[text analytics] default to v3.1-preview.2, have it listed under enum V3_1_PREVIEW #13708
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -305,7 +305,7 @@ and [supported types][linked_entities_categories]. | |
|
|
||
| ### Recognize PII entities | ||
| [recognize_pii_entities][recognize_pii_entities] recognizes and categorizes Personally Identifiable Information (PII) entities in its input text, such as | ||
| Social Security Numbers, bank account information, credit card numbers, and more. This endpoint is only available for v3.1-preview and up. | ||
|
|
||
| ```python | ||
| from azure.core.credentials import AzureKeyCredential | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,7 @@ class TextAnalyticsApiVersion(str, Enum): | |
| """Text Analytics API versions supported by this package""" | ||
|
|
||
| #: this is the default version | ||
| V3_1_PREVIEW = "v3.1-preview.2" | ||
| V3_0 = "v3.0" | ||
|
|
||
| def _authentication_policy(credential): | ||
|
|
@@ -40,7 +36,7 @@ def __init__(self, endpoint, credential, **kwargs): | |
| self._client = _TextAnalyticsClient( | ||
| endpoint=endpoint, | ||
| credential=credential, | ||
| api_version=kwargs.pop("api_version", TextAnalyticsApiVersion.V3_1_PREVIEW), | ||
| sdk_moniker=USER_AGENT, | ||
| authentication_policy=_authentication_policy(credential), | ||
| custom_hook_policy=TextAnalyticsResponseHookPolicy(**kwargs), | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,5 @@ | |
| # Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
| # -------------------------------------------------------------------------- | ||
|
|
||
| from ._text_analytics_client import TextAnalyticsClient | ||
| __all__ = ['TextAnalyticsClient'] | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,11 +47,11 @@ async def entities_linking( | |
| """ | ||
| api_version = self._get_api_version('entities_linking') | ||
| if api_version == 'v3.0': | ||
| from ..v3_0.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
@@ -90,11 +90,11 @@ async def entities_recognition_general( | |
| """ | ||
| api_version = self._get_api_version('entities_recognition_general') | ||
| if api_version == 'v3.0': | ||
| from ..v3_0.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
@@ -142,9 +142,9 @@ async def entities_recognition_pii( | |
| """ | ||
| api_version = self._get_api_version('entities_recognition_pii') | ||
| if api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
@@ -182,11 +182,11 @@ async def key_phrases( | |
| """ | ||
| api_version = self._get_api_version('key_phrases') | ||
| if api_version == 'v3.0': | ||
| from ..v3_0.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
@@ -225,11 +225,11 @@ async def languages( | |
| """ | ||
| api_version = self._get_api_version('languages') | ||
| if api_version == 'v3.0': | ||
| from ..v3_0.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
@@ -268,11 +268,11 @@ async def sentiment( | |
| """ | ||
| api_version = self._get_api_version('sentiment') | ||
| if api_version == 'v3.0': | ||
| from ..v3_0.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.1': | ||
| from ..v3_1_preview_1.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| elif api_version == 'v3.1-preview.2': | ||
| from ..v3_1_preview_2.aio.operations import TextAnalyticsClientOperationsMixin as OperationClass | ||
| else: | ||
| raise NotImplementedError("APIVersion {} is not available".format(api_version)) | ||
| mixin_instance = OperationClass() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,8 +14,8 @@ | |
|
|
||
| from azure.profiles import KnownProfiles, ProfileDefinition | ||
| from azure.profiles.multiapiclient import MultiApiClientMixin | ||
| from ._configuration import TextAnalyticsClientConfiguration | ||
| from ._operations_mixin import TextAnalyticsClientOperationsMixin | ||
| class _SDKClient(object): | ||
| def __init__(self, *args, **kwargs): | ||
| """This is a fake class to support current implemetation of MultiApiClientMixin." | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,5 @@ | |
| # Changes may cause incorrect behavior and will be lost if the code is regenerated. | ||
| # -------------------------------------------------------------------------- | ||
|
|
||
| from ._text_analytics_client import TextAnalyticsClient | ||
| __all__ = ['TextAnalyticsClient'] | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,8 +15,8 @@ | |
| # pylint: disable=unused-import,ungrouped-imports | ||
| from azure.core.credentials_async import AsyncTokenCredential | ||
|
|
||
| from ._configuration import TextAnalyticsClientConfiguration | ||
| from .operations import TextAnalyticsClientOperationsMixin | ||
| from .. import models | ||
|
|
||
|
|
||
|
|
||
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this could be confusing to the user, especially that you referred to the concrete preview version before in older changelog notes here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's fair, but I think with these two new versions, it's unnecessary to support both, and once the service GAs, we're also only going to support v3.0 and v3.1, so I'm comfortable squashing v3.1-preview.1 and v3.1-preview.2 into one api version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my comment is not about supporting both but rather about being consistent with the service naming of the endpoints. Otherwise the user would wonder what is v3.1-preview because no such version exist in the service docs.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see your point, @kristapratico and I had discussed this, and I think we both overall prefer exposing it as v3.0 and v3.1-preview instead of v3.1-preivew.2. Since we've never actually done a release on our side targeting the v3.1-preview.1 API, I think it would be weird to come out directly with a v3.1-preview.2, and I think it overall reduces some overhead for the user exposing it as v3.1-preview version instead of specifically v3.1-preview.2 in all of the docstrings. How strongly do you feel about this @deyaaeldeen ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@deyaaeldeen what I meant by overhead was having to explicitly now that this was the second preview version. Since there's no reason for a user to discern between 3.1-preview.1 and 3.1-preview.2, I think it would be cleaner to just combine them as 3.1-preview