diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md index 5dc7299fcf55..42e3664f4dbf 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md +++ b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md @@ -1,6 +1,6 @@ # Release History -## 5.2.0b4 (Unreleased) +## 5.2.0b4 (2022-05-18) 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. 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. diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py index 303fd136c649..0e324e5328ea 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_models.py @@ -1793,7 +1793,7 @@ class RecognizeEntitiesAction(DictMixin): :keyword str model_version: The model version to use for the analysis. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -1806,7 +1806,7 @@ class RecognizeEntitiesAction(DictMixin): :ivar str model_version: The model version to use for the analysis. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -1867,7 +1867,7 @@ class AnalyzeSentimentAction(DictMixin): will have property `mined_opinions` containing the result of this analysis. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -1885,7 +1885,7 @@ class AnalyzeSentimentAction(DictMixin): will have property `mined_opinions` containing the result of this analysis. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -1954,7 +1954,7 @@ class RecognizePiiEntitiesAction(DictMixin): :paramtype categories_filter: list[str or ~azure.ai.textanalytics.PiiEntityCategory] :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: Defaults to true, meaning that the Language service will not log your input text on the service side for troubleshooting. If set to False, the Language service logs your @@ -1973,7 +1973,7 @@ class RecognizePiiEntitiesAction(DictMixin): :vartype categories_filter: list[str or ~azure.ai.textanalytics.PiiEntityCategory] :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: Defaults to true, meaning that the Language service will not log your input text on the service side for troubleshooting. If set to False, the Language service logs your @@ -2097,7 +2097,7 @@ class RecognizeLinkedEntitiesAction(DictMixin): :keyword str model_version: The model version to use for the analysis. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2110,7 +2110,7 @@ class RecognizeLinkedEntitiesAction(DictMixin): :ivar str model_version: The model version to use for the analysis. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2164,7 +2164,7 @@ class ExtractSummaryAction(DictMixin): :keyword str model_version: The model version to use for the analysis. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2179,7 +2179,7 @@ class ExtractSummaryAction(DictMixin): :ivar str model_version: The model version to use for the analysis. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2328,7 +2328,7 @@ class RecognizeCustomEntitiesAction(DictMixin): :param str deployment_name: This field indicates the deployment name for the model. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2342,7 +2342,7 @@ class RecognizeCustomEntitiesAction(DictMixin): :ivar str deployment_name: This field indicates the deployment name for the model. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2708,7 +2708,7 @@ class AnalyzeHealthcareEntitiesAction(DictMixin): :keyword str model_version: The model version to use for the analysis. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -2724,7 +2724,7 @@ class AnalyzeHealthcareEntitiesAction(DictMixin): :ivar str model_version: The model version to use for the analysis. :ivar str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :ivar bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py index 7f779722e019..16d8a3ce5fb7 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py @@ -268,7 +268,7 @@ def recognize_entities( level statistics in the `statistics` field of the document-level response. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -636,7 +636,7 @@ def begin_analyze_healthcare_entities( :rtype: ~azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller[~azure.core.paging.ItemPaged[ ~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult or ~azure.ai.textanalytics.DocumentError]] - :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError: + :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError: .. versionadded:: v3.1 The *begin_analyze_healthcare_entities* client method. @@ -1081,7 +1081,7 @@ def begin_analyze_actions( ExtractKeyPhrasesResult or AnalyzeSentimentResult or ExtractSummaryAction or RecognizeCustomEntitiesResult or SingleCategoryClassifyResult or MultiCategoryClassifyResult or AnalyzeHealthcareEntitiesResult or DocumentError]]] - :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError: + :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError: .. versionadded:: v3.1 The *begin_analyze_actions* client method. diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py index 8e9daf0d4e90..eab2f569025c 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py +++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py @@ -262,7 +262,7 @@ async def recognize_entities( level statistics in the `statistics` field of the document-level response. :keyword str string_index_type: Specifies the method used to interpret string offsets. `UnicodeCodePoint`, the Python encoding, is the default. To override the Python default, - you can also pass in `Utf16CodeUnit` or TextElement_v8`. For additional information + you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets :keyword bool disable_service_logs: If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your @@ -842,7 +842,7 @@ async def begin_analyze_healthcare_entities( :rtype: ~azure.ai.textanalytics.aio.AsyncAnalyzeHealthcareEntitiesLROPoller[~azure.core.async_paging.AsyncItemPaged[ ~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult or ~azure.ai.textanalytics.DocumentError]] - :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError: + :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError: .. versionadded:: v3.1 The *begin_analyze_healthcare_entities* client method. @@ -1076,7 +1076,7 @@ async def begin_analyze_actions( ExtractKeyPhrasesResult or AnalyzeSentimentResult or ExtractSummaryAction or RecognizeCustomEntitiesResult or SingleCategoryClassifyResult or MultiCategoryClassifyResult or AnalyzeHealthcareEntitiesResult or DocumentError]]] - :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError or NotImplementedError: + :raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError: .. versionadded:: v3.1 The *begin_analyze_actions* client method.