Skip to content
Merged
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/textanalytics/azure-ai-textanalytics/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down