Skip to content

Commit 79ffc05

Browse files
update release date and fix some docstrings (Azure#24473)
1 parent 5ffb488 commit 79ffc05

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release History
22

3-
## 5.2.0b4 (Unreleased)
3+
## 5.2.0b4 (2022-05-18)
44

55
Note that this is the first version of the client library that targets the Azure Cognitive Service for Language APIs which includes the existing text analysis and natural language processing features found in the Text Analytics client library.
66
In addition, the service API has changed from semantic to date-based versioning. This version of the client library defaults to the latest supported API version, which currently is `2022-04-01-preview`. Support for `v3.2-preview.2` is removed, however, all functionalities are included in the latest version.

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1793,7 +1793,7 @@ class RecognizeEntitiesAction(DictMixin):
17931793
:keyword str model_version: The model version to use for the analysis.
17941794
:keyword str string_index_type: Specifies the method used to interpret string offsets.
17951795
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1796-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1796+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
17971797
see https://aka.ms/text-analytics-offsets
17981798
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
17991799
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -1806,7 +1806,7 @@ class RecognizeEntitiesAction(DictMixin):
18061806
:ivar str model_version: The model version to use for the analysis.
18071807
:ivar str string_index_type: Specifies the method used to interpret string offsets.
18081808
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1809-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1809+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
18101810
see https://aka.ms/text-analytics-offsets
18111811
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
18121812
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -1867,7 +1867,7 @@ class AnalyzeSentimentAction(DictMixin):
18671867
will have property `mined_opinions` containing the result of this analysis.
18681868
:keyword str string_index_type: Specifies the method used to interpret string offsets.
18691869
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1870-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1870+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
18711871
see https://aka.ms/text-analytics-offsets
18721872
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
18731873
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -1885,7 +1885,7 @@ class AnalyzeSentimentAction(DictMixin):
18851885
will have property `mined_opinions` containing the result of this analysis.
18861886
:ivar str string_index_type: Specifies the method used to interpret string offsets.
18871887
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1888-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1888+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
18891889
see https://aka.ms/text-analytics-offsets
18901890
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
18911891
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -1954,7 +1954,7 @@ class RecognizePiiEntitiesAction(DictMixin):
19541954
:paramtype categories_filter: list[str or ~azure.ai.textanalytics.PiiEntityCategory]
19551955
:keyword str string_index_type: Specifies the method used to interpret string offsets.
19561956
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1957-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1957+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
19581958
see https://aka.ms/text-analytics-offsets
19591959
:keyword bool disable_service_logs: Defaults to true, meaning that the Language service will not log your
19601960
input text on the service side for troubleshooting. If set to False, the Language service logs your
@@ -1973,7 +1973,7 @@ class RecognizePiiEntitiesAction(DictMixin):
19731973
:vartype categories_filter: list[str or ~azure.ai.textanalytics.PiiEntityCategory]
19741974
:ivar str string_index_type: Specifies the method used to interpret string offsets.
19751975
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
1976-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
1976+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
19771977
see https://aka.ms/text-analytics-offsets
19781978
:ivar bool disable_service_logs: Defaults to true, meaning that the Language service will not log your
19791979
input text on the service side for troubleshooting. If set to False, the Language service logs your
@@ -2097,7 +2097,7 @@ class RecognizeLinkedEntitiesAction(DictMixin):
20972097
:keyword str model_version: The model version to use for the analysis.
20982098
:keyword str string_index_type: Specifies the method used to interpret string offsets.
20992099
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2100-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2100+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
21012101
see https://aka.ms/text-analytics-offsets
21022102
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
21032103
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2110,7 +2110,7 @@ class RecognizeLinkedEntitiesAction(DictMixin):
21102110
:ivar str model_version: The model version to use for the analysis.
21112111
:ivar str string_index_type: Specifies the method used to interpret string offsets.
21122112
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2113-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2113+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
21142114
see https://aka.ms/text-analytics-offsets
21152115
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
21162116
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2164,7 +2164,7 @@ class ExtractSummaryAction(DictMixin):
21642164
:keyword str model_version: The model version to use for the analysis.
21652165
:keyword str string_index_type: Specifies the method used to interpret string offsets.
21662166
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2167-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2167+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
21682168
see https://aka.ms/text-analytics-offsets
21692169
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
21702170
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2179,7 +2179,7 @@ class ExtractSummaryAction(DictMixin):
21792179
:ivar str model_version: The model version to use for the analysis.
21802180
:ivar str string_index_type: Specifies the method used to interpret string offsets.
21812181
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2182-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2182+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
21832183
see https://aka.ms/text-analytics-offsets
21842184
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
21852185
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2328,7 +2328,7 @@ class RecognizeCustomEntitiesAction(DictMixin):
23282328
:param str deployment_name: This field indicates the deployment name for the model.
23292329
:keyword str string_index_type: Specifies the method used to interpret string offsets.
23302330
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2331-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2331+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
23322332
see https://aka.ms/text-analytics-offsets
23332333
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
23342334
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2342,7 +2342,7 @@ class RecognizeCustomEntitiesAction(DictMixin):
23422342
:ivar str deployment_name: This field indicates the deployment name for the model.
23432343
:ivar str string_index_type: Specifies the method used to interpret string offsets.
23442344
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2345-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2345+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
23462346
see https://aka.ms/text-analytics-offsets
23472347
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
23482348
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2708,7 +2708,7 @@ class AnalyzeHealthcareEntitiesAction(DictMixin):
27082708
:keyword str model_version: The model version to use for the analysis.
27092709
:keyword str string_index_type: Specifies the method used to interpret string offsets.
27102710
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2711-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2711+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
27122712
see https://aka.ms/text-analytics-offsets
27132713
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
27142714
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -2724,7 +2724,7 @@ class AnalyzeHealthcareEntitiesAction(DictMixin):
27242724
:ivar str model_version: The model version to use for the analysis.
27252725
:ivar str string_index_type: Specifies the method used to interpret string offsets.
27262726
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
2727-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
2727+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
27282728
see https://aka.ms/text-analytics-offsets
27292729
:ivar bool disable_service_logs: If set to true, you opt-out of having your text input
27302730
logged on the service side for troubleshooting. By default, the Language service logs your

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ def recognize_entities(
268268
level statistics in the `statistics` field of the document-level response.
269269
:keyword str string_index_type: Specifies the method used to interpret string offsets.
270270
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
271-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
271+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
272272
see https://aka.ms/text-analytics-offsets
273273
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
274274
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -636,7 +636,7 @@ def begin_analyze_healthcare_entities(
636636
:rtype:
637637
~azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller[~azure.core.paging.ItemPaged[
638638
~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult or ~azure.ai.textanalytics.DocumentError]]
639-
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError:
639+
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
640640
641641
.. versionadded:: v3.1
642642
The *begin_analyze_healthcare_entities* client method.
@@ -1081,7 +1081,7 @@ def begin_analyze_actions(
10811081
ExtractKeyPhrasesResult or AnalyzeSentimentResult or ExtractSummaryAction or RecognizeCustomEntitiesResult
10821082
or SingleCategoryClassifyResult or MultiCategoryClassifyResult or AnalyzeHealthcareEntitiesResult or
10831083
DocumentError]]]
1084-
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError:
1084+
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
10851085
10861086
.. versionadded:: v3.1
10871087
The *begin_analyze_actions* client method.

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ async def recognize_entities(
262262
level statistics in the `statistics` field of the document-level response.
263263
:keyword str string_index_type: Specifies the method used to interpret string offsets.
264264
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
265-
you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information
265+
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
266266
see https://aka.ms/text-analytics-offsets
267267
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
268268
logged on the service side for troubleshooting. By default, the Language service logs your
@@ -842,7 +842,7 @@ async def begin_analyze_healthcare_entities(
842842
:rtype:
843843
~azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller[~azure.core.async_paging.AsyncItemPaged[
844844
~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult or ~azure.ai.textanalytics.DocumentError]]
845-
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError:
845+
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
846846
847847
.. versionadded:: v3.1
848848
The *begin_analyze_healthcare_entities* client method.
@@ -1076,7 +1076,7 @@ async def begin_analyze_actions(
10761076
ExtractKeyPhrasesResult or AnalyzeSentimentResult or ExtractSummaryAction or RecognizeCustomEntitiesResult
10771077
or SingleCategoryClassifyResult or MultiCategoryClassifyResult or AnalyzeHealthcareEntitiesResult or
10781078
DocumentError]]]
1079-
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError:
1079+
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
10801080
10811081
.. versionadded:: v3.1
10821082
The *begin_analyze_actions* client method.

0 commit comments

Comments
 (0)