diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
index eaf125765577..d10a311b9fa8 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
+++ b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
@@ -251,7 +251,7 @@ is this diagnosis conditional on a symptom?
**Known Issues**
-- `begin_analyze_healthcare_entities` is currently in gated preview and can not be used with AAD credentials. For more information, see [the Text Analytics for Health documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
+- `begin_analyze_healthcare_entities` is currently in gated preview and can not be used with AAD credentials. For more information, see [the Text Analytics for Health documentation](https://learn.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
- At time of this SDK release, the service is not respecting the value passed through `model_version` to `begin_analyze_healthcare_entities`, it only uses the latest model.
## 5.1.0b5 (2021-02-10)
@@ -289,7 +289,7 @@ the service client to the poller object returned from `begin_analyze_healthcare_
**New Features**
- We have added method `begin_analyze`, which supports long-running batch process of Named Entity Recognition, Personally identifiable Information, and Key Phrase Extraction. To use, you must specify `api_version=TextAnalyticsApiVersion.V3_1_PREVIEW_3` when creating your client.
-- We have added method `begin_analyze_healthcare`, which supports the service's Health API. Since the Health API is currently only available in a gated preview, you need to have your subscription on the service's allow list, and you must specify `api_version=TextAnalyticsApiVersion.V3_1_PREVIEW_3` when creating your client. Note that since this is a gated preview, AAD is not supported. More information [here](https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
+- We have added method `begin_analyze_healthcare`, which supports the service's Health API. Since the Health API is currently only available in a gated preview, you need to have your subscription on the service's allow list, and you must specify `api_version=TextAnalyticsApiVersion.V3_1_PREVIEW_3` when creating your client. Note that since this is a gated preview, AAD is not supported. More information [here](https://learn.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
## 5.1.0b2 (2020-10-06)
diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md
index c489a594e6cf..382444e8eff7 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/README.md
+++ b/sdk/textanalytics/azure-ai-textanalytics/README.md
@@ -827,7 +827,7 @@ Advanced scenarios
### Additional documentation
-For more extensive documentation on Azure Cognitive Service for Language, see the [Language Service documentation][language_product_documentation] on docs.microsoft.com.
+For more extensive documentation on Azure Cognitive Service for Language, see the [Language Service documentation][language_product_documentation] on learn.microsoft.com.
## Contributing
@@ -843,24 +843,24 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[ta_pypi]: https://pypi.org/project/azure-ai-textanalytics/
[ta_ref_docs]: https://aka.ms/azsdk-python-textanalytics-ref-docs
[ta_samples]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples
-[language_product_documentation]: https://docs.microsoft.com/azure/cognitive-services/language-service
+[language_product_documentation]: https://learn.microsoft.com/azure/cognitive-services/language-service
[azure_subscription]: https://azure.microsoft.com/free/
-[ta_or_cs_resource]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
+[ta_or_cs_resource]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
[pip]: https://pypi.org/project/pip/
[azure_portal_create_ta_resource]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextAnalytics
-[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_cli_create_ta_resource]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli
-[multi_and_single_service]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
-[azure_cli_endpoint_lookup]: https://docs.microsoft.com/cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show
-[azure_portal_get_endpoint]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource
-[cognitive_authentication]: https://docs.microsoft.com/azure/cognitive-services/authentication
-[cognitive_authentication_api_key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource
+[multi_and_single_service]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows
+[azure_cli_endpoint_lookup]: https://learn.microsoft.com/cli/azure/cognitiveservices/account?view=azure-cli-latest#az-cognitiveservices-account-show
+[azure_portal_get_endpoint]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource
+[cognitive_authentication]: https://learn.microsoft.com/azure/cognitive-services/authentication
+[cognitive_authentication_api_key]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource
[install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#install-the-package
-[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
-[grant_role_access]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
-[cognitive_custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-custom-subdomains
-[custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain
-[cognitive_authentication_aad]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory
+[register_aad_app]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
+[grant_role_access]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
+[cognitive_custom_subdomain]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-custom-subdomains
+[custom_subdomain]: https://learn.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain
+[cognitive_authentication_aad]: https://learn.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
[service_limits]: https://aka.ms/azsdk/textanalytics/data-limits
@@ -883,14 +883,14 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[recognize_linked_entities]: https://aka.ms/azsdk-python-textanalytics-recognizelinkedentities
[extract_key_phrases]: https://aka.ms/azsdk-python-textanalytics-extractkeyphrases
[detect_language]: https://aka.ms/azsdk-python-textanalytics-detectlanguage
-[language_detection]: https://docs.microsoft.com/azure/cognitive-services/language-service/language-detection/overview
-[language_and_regional_support]: https://docs.microsoft.com/azure/cognitive-services/language-service/language-detection/language-support
-[sentiment_analysis]: https://docs.microsoft.com/azure/cognitive-services/language-service/sentiment-opinion-mining/overview
-[key_phrase_extraction]: https://docs.microsoft.com/azure/cognitive-services/language-service/key-phrase-extraction/overview
+[language_detection]: https://learn.microsoft.com/azure/cognitive-services/language-service/language-detection/overview
+[language_and_regional_support]: https://learn.microsoft.com/azure/cognitive-services/language-service/language-detection/language-support
+[sentiment_analysis]: https://learn.microsoft.com/azure/cognitive-services/language-service/sentiment-opinion-mining/overview
+[key_phrase_extraction]: https://learn.microsoft.com/azure/cognitive-services/language-service/key-phrase-extraction/overview
[linked_entities_categories]: https://aka.ms/taner
-[linked_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/language-service/entity-linking/overview
+[linked_entity_recognition]: https://learn.microsoft.com/azure/cognitive-services/language-service/entity-linking/overview
[pii_entity_categories]: https://aka.ms/azsdk/language/pii
-[named_entity_recognition]: https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/overview
+[named_entity_recognition]: https://learn.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/overview
[named_entity_categories]: https://aka.ms/taner
[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_operations_mixin.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_operations_mixin.py
index 14b72f196cc6..117637458e8e 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_operations_mixin.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_operations_mixin.py
@@ -352,7 +352,7 @@ def begin_health(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -412,7 +412,7 @@ def entities_linking(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -475,7 +475,7 @@ def entities_recognition_general(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -541,7 +541,7 @@ def entities_recognition_pii(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param domain: (Optional) if specified, will set the PII domain to include only a subset of the
entity categories. Possible values include: 'PHI', 'none'. Default value is None.
@@ -644,7 +644,7 @@ def key_phrases(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: KeyPhraseResult or the result of cls(response)
@@ -701,7 +701,7 @@ def languages(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: LanguageResult or the result of cls(response)
@@ -759,7 +759,7 @@ def sentiment(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param opinion_mining: (Optional) if set to true, response will contain not only sentiment
prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_text_analytics_client.py
index ff7503e8cafb..416ee76529f0 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_text_analytics_client.py
@@ -33,7 +33,7 @@ def __init__(self, *args, **kwargs):
pass
class TextAnalyticsClient(TextAnalyticsClientOperationsMixin, MultiApiClientMixin, _SDKClient):
- """The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview`.
+ """The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview`.
This ready contains multiple API versions, to help you deal with all of the Azure clouds
(Azure Stack, Azure Government, Azure China, etc.).
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_operations_mixin.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_operations_mixin.py
index 36be136c8c09..e4bacc1a9035 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_operations_mixin.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_operations_mixin.py
@@ -340,7 +340,7 @@ async def begin_health(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -399,7 +399,7 @@ async def entities_linking(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -461,7 +461,7 @@ async def entities_recognition_general(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -526,7 +526,7 @@ async def entities_recognition_pii(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param domain: (Optional) if specified, will set the PII domain to include only a subset of the
entity categories. Possible values include: 'PHI', 'none'. Default value is None.
@@ -627,7 +627,7 @@ async def key_phrases(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: KeyPhraseResult or the result of cls(response)
@@ -683,7 +683,7 @@ async def languages(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: LanguageResult or the result of cls(response)
@@ -740,7 +740,7 @@ async def sentiment(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param opinion_mining: (Optional) if set to true, response will contain not only sentiment
prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_text_analytics_client.py
index 23cb051ecb47..a83528c1fe41 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_text_analytics_client.py
@@ -31,7 +31,7 @@ def __init__(self, *args, **kwargs):
pass
class TextAnalyticsClient(TextAnalyticsClientOperationsMixin, MultiApiClientMixin, _SDKClient):
- """The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview`.
+ """The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview`.
This ready contains multiple API versions, to help you deal with all of the Azure clouds
(Azure Stack, Azure Government, Azure China, etc.).
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_metadata.json b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_metadata.json
index c6a24c103c9f..d89734a03244 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_metadata.json
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_metadata.json
@@ -4,7 +4,7 @@
"client": {
"name": "TextAnalyticsClient",
"filename": "_text_analytics_client",
- "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in :code:`\u003ca href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\"\u003ehttps://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\u003c/a\u003e`.0.",
+ "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in :code:`\u003ca href=\"https://learn.microsoft.com/azure/cognitive-services/language-service/overview\"\u003ehttps://learn.microsoft.com/azure/cognitive-services/language-service/overview\u003c/a\u003e`.0.",
"host_value": null,
"parameterized_host_template": "\u0027{Endpoint}/language\u0027",
"azure_arm": false,
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_text_analytics_client.py
index 31ee8e4bae5d..9cee0c4fc6a5 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/_text_analytics_client.py
@@ -26,7 +26,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
best-in-class Microsoft machine learning algorithms. The API can be used to analyze
unstructured text for tasks such as sentiment analysis, key phrase extraction, language
detection and question answering. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview`.0.
+ href="https://learn.microsoft.com/azure/cognitive-services/language-service/overview">https://learn.microsoft.com/azure/cognitive-services/language-service/overview`.0.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/aio/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/aio/_text_analytics_client.py
index 3a920009380e..ae543cf596d1 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/aio/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2022_05_01/aio/_text_analytics_client.py
@@ -26,7 +26,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
best-in-class Microsoft machine learning algorithms. The API can be used to analyze
unstructured text for tasks such as sentiment analysis, key phrase extraction, language
detection and question answering. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview`.0.
+ href="https://learn.microsoft.com/azure/cognitive-services/language-service/overview">https://learn.microsoft.com/azure/cognitive-services/language-service/overview`.0.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_metadata.json b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_metadata.json
index 3956eb69bb9a..e6968970dbad 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_metadata.json
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_metadata.json
@@ -4,7 +4,7 @@
"client": {
"name": "TextAnalyticsClient",
"filename": "_text_analytics_client",
- "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in :code:`\u003ca href=\"https://docs.microsoft.com/azure/cognitive-services/language-service/overview\"\u003ehttps://docs.microsoft.com/azure/cognitive-services/language-service/overview\u003c/a\u003e`.",
+ "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in :code:`\u003ca href=\"https://learn.microsoft.com/azure/cognitive-services/language-service/overview\"\u003ehttps://learn.microsoft.com/azure/cognitive-services/language-service/overview\u003c/a\u003e`.",
"host_value": null,
"parameterized_host_template": "\u0027{Endpoint}/language\u0027",
"azure_arm": false,
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_text_analytics_client.py
index 5bc6800546bb..8491d9c9bbcb 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/_text_analytics_client.py
@@ -26,7 +26,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
best-in-class Microsoft machine learning algorithms. The API can be used to analyze
unstructured text for tasks such as sentiment analysis, key phrase extraction, language
detection and question answering. Further documentation can be found in :code:`https://docs.microsoft.com/azure/cognitive-services/language-service/overview`.
+ href="https://learn.microsoft.com/azure/cognitive-services/language-service/overview">https://learn.microsoft.com/azure/cognitive-services/language-service/overview`.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/aio/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/aio/_text_analytics_client.py
index d823dfec72e0..6c69d553a7b5 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/aio/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v2023_04_01/aio/_text_analytics_client.py
@@ -26,7 +26,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
best-in-class Microsoft machine learning algorithms. The API can be used to analyze
unstructured text for tasks such as sentiment analysis, key phrase extraction, language
detection and question answering. Further documentation can be found in :code:`https://docs.microsoft.com/azure/cognitive-services/language-service/overview`.
+ href="https://learn.microsoft.com/azure/cognitive-services/language-service/overview">https://learn.microsoft.com/azure/cognitive-services/language-service/overview`.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_metadata.json b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_metadata.json
index 2cc308368a46..cc8f5136f92d 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_metadata.json
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_metadata.json
@@ -4,7 +4,7 @@
"client": {
"name": "TextAnalyticsClient",
"filename": "_text_analytics_client",
- "description": "The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.",
+ "description": "The Text Analytics API is a suite of text analytics web services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview.",
"host_value": null,
"parameterized_host_template": "\u0027{Endpoint}/text/analytics/v3.0\u0027",
"azure_arm": false,
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_text_analytics_client.py
index 6fe9fa5c4e06..2918a2e04805 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/_text_analytics_client.py
@@ -27,7 +27,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
tasks such as sentiment analysis, key phrase extraction and language detection. No training
data is needed to use this API; just bring your text data. This API uses advanced natural
language processing techniques to deliver best in class predictions. Further documentation can
- be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.
+ be found in https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/aio/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/aio/_text_analytics_client.py
index 49f1eabdaef9..b6b6ad82146f 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/aio/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_0/aio/_text_analytics_client.py
@@ -27,7 +27,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
tasks such as sentiment analysis, key phrase extraction and language detection. No training
data is needed to use this API; just bring your text data. This API uses advanced natural
language processing techniques to deliver best in class predictions. Further documentation can
- be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.
+ be found in https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_metadata.json b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_metadata.json
index c0e19557d1b3..649e7a5c26c6 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_metadata.json
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_metadata.json
@@ -4,7 +4,7 @@
"client": {
"name": "TextAnalyticsClient",
"filename": "_text_analytics_client",
- "description": "The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`\u003ca href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview\"\u003ehttps://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview\u003c/a\u003e`.",
+ "description": "The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in :code:`\u003ca href=\"https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview\"\u003ehttps://learn.microsoft.com/azure/cognitive-services/text-analytics/overview\u003c/a\u003e`.",
"host_value": null,
"parameterized_host_template": "\u0027{Endpoint}/text/analytics/v3.1\u0027",
"azure_arm": false,
@@ -171,104 +171,104 @@
"_health_initial" : {
"sync": {
"signature": "def _health_initial(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n logging_opt_out=None, # type: Optional[bool]\n **kwargs # type: Any\n):\n # type: (...) -\u003e Optional[_models.HealthcareJobState]\n",
- "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: HealthcareJobState or None or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.HealthcareJobState or None\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: HealthcareJobState or None or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.HealthcareJobState or None\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, string_index_type, logging_opt_out, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def _health_initial(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n logging_opt_out: Optional[bool] = None,\n **kwargs: Any\n) -\u003e Optional[_models.HealthcareJobState]:\n",
- "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: HealthcareJobState or None or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.HealthcareJobState or None\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: HealthcareJobState or None or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.HealthcareJobState or None\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, string_index_type, logging_opt_out, **kwargs"
}
},
"begin_health" : {
"sync": {
"signature": "def begin_health(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n logging_opt_out=None, # type: Optional[bool]\n **kwargs # type: Any\n):\n # type: (...) -\u003e AnalyzeHealthcareEntitiesLROPoller[_models.HealthcareJobState]\n",
- "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:keyword str continuation_token: A continuation token to restart a poller from a saved state.\n:keyword polling: By default, your polling method will be\n AnalyzeHealthcareEntitiesLROPollingMethod. Pass in False for this operation to not poll, or\n pass in your own initialized polling object for a personal polling strategy.\n:paramtype polling: bool or ~azure.core.polling.PollingMethod\n:keyword int polling_interval: Default waiting time between two polls for LRO operations if no\n Retry-After header is present.\n:return: An instance of AnalyzeHealthcareEntitiesLROPoller that returns either\n HealthcareJobState or the result of cls(response)\n:rtype:\n ~...._lro.AnalyzeHealthcareEntitiesLROPoller[~azure.ai.textanalytics.v3_1.models.HealthcareJobState]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:keyword str continuation_token: A continuation token to restart a poller from a saved state.\n:keyword polling: By default, your polling method will be\n AnalyzeHealthcareEntitiesLROPollingMethod. Pass in False for this operation to not poll, or\n pass in your own initialized polling object for a personal polling strategy.\n:paramtype polling: bool or ~azure.core.polling.PollingMethod\n:keyword int polling_interval: Default waiting time between two polls for LRO operations if no\n Retry-After header is present.\n:return: An instance of AnalyzeHealthcareEntitiesLROPoller that returns either\n HealthcareJobState or the result of cls(response)\n:rtype:\n ~...._lro.AnalyzeHealthcareEntitiesLROPoller[~azure.ai.textanalytics.v3_1.models.HealthcareJobState]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, string_index_type, logging_opt_out, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def begin_health(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n logging_opt_out: Optional[bool] = None,\n **kwargs: Any\n) -\u003e AsyncAnalyzeHealthcareEntitiesLROPoller[_models.HealthcareJobState]:\n",
- "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:keyword str continuation_token: A continuation token to restart a poller from a saved state.\n:keyword polling: By default, your polling method will be\n AsyncAnalyzeHealthcareEntitiesLROPollingMethod. Pass in False for this operation to not poll,\n or pass in your own initialized polling object for a personal polling strategy.\n:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n:keyword int polling_interval: Default waiting time between two polls for LRO operations if no\n Retry-After header is present.\n:return: An instance of AsyncAnalyzeHealthcareEntitiesLROPoller that returns either\n HealthcareJobState or the result of cls(response)\n:rtype:\n ~.....aio._lro_async.AsyncAnalyzeHealthcareEntitiesLROPoller[~azure.ai.textanalytics.v3_1.models.HealthcareJobState]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Submit healthcare analysis job.\n\nStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions,\nsymptoms, etc) and their relations.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:keyword str continuation_token: A continuation token to restart a poller from a saved state.\n:keyword polling: By default, your polling method will be\n AsyncAnalyzeHealthcareEntitiesLROPollingMethod. Pass in False for this operation to not poll,\n or pass in your own initialized polling object for a personal polling strategy.\n:paramtype polling: bool or ~azure.core.polling.AsyncPollingMethod\n:keyword int polling_interval: Default waiting time between two polls for LRO operations if no\n Retry-After header is present.\n:return: An instance of AsyncAnalyzeHealthcareEntitiesLROPoller that returns either\n HealthcareJobState or the result of cls(response)\n:rtype:\n ~.....aio._lro_async.AsyncAnalyzeHealthcareEntitiesLROPoller[~azure.ai.textanalytics.v3_1.models.HealthcareJobState]\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, string_index_type, logging_opt_out, **kwargs"
}
},
"entities_recognition_general" : {
"sync": {
"signature": "def entities_recognition_general(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.EntitiesResult\n",
- "doc": "\"\"\"Named Entity Recognition.\n\nThe API returns a list of general named entities in a given document. For the list of supported\nentity types, check :code:`\u003ca href=\"https://aka.ms/taner\"\u003eSupported Entity Types in Text\nAnalytics API\u003c/a\u003e`. See the :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text\nAnalytics API\u003c/a\u003e` for the list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntitiesResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntitiesResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Named Entity Recognition.\n\nThe API returns a list of general named entities in a given document. For the list of supported\nentity types, check :code:`\u003ca href=\"https://aka.ms/taner\"\u003eSupported Entity Types in Text\nAnalytics API\u003c/a\u003e`. See the :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text\nAnalytics API\u003c/a\u003e` for the list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntitiesResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntitiesResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def entities_recognition_general(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n **kwargs: Any\n) -\u003e _models.EntitiesResult:\n",
- "doc": "\"\"\"Named Entity Recognition.\n\nThe API returns a list of general named entities in a given document. For the list of supported\nentity types, check :code:`\u003ca href=\"https://aka.ms/taner\"\u003eSupported Entity Types in Text\nAnalytics API\u003c/a\u003e`. See the :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text\nAnalytics API\u003c/a\u003e` for the list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntitiesResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntitiesResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Named Entity Recognition.\n\nThe API returns a list of general named entities in a given document. For the list of supported\nentity types, check :code:`\u003ca href=\"https://aka.ms/taner\"\u003eSupported Entity Types in Text\nAnalytics API\u003c/a\u003e`. See the :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text\nAnalytics API\u003c/a\u003e` for the list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntitiesResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntitiesResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs"
}
},
"entities_recognition_pii" : {
"sync": {
"signature": "def entities_recognition_pii(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n domain=None, # type: Optional[str]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n pii_categories=None, # type: Optional[List[Union[str, \"_models.PiiCategory\"]]]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.PiiResult\n",
- "doc": "\"\"\"Entities containing personal information.\n\nThe API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in\nthe document. For the list of supported entity types, check :code:`\u003ca\nhref=\"https://aka.ms/tanerpii\"\u003eSupported Entity Types in Text Analytics API\u003c/a\u003e`. See the\n:code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the\nlist of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param domain: (Optional) if specified, will set the PII domain to include only a subset of the\n entity categories. Possible values include: \u0027PHI\u0027, \u0027none\u0027. Default value is None.\n:type domain: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param pii_categories: (Optional) describes the PII categories to return. Default value is\n None.\n:type pii_categories: list[str or ~azure.ai.textanalytics.v3_1.models.PiiCategory]\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: PiiResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.PiiResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Entities containing personal information.\n\nThe API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in\nthe document. For the list of supported entity types, check :code:`\u003ca\nhref=\"https://aka.ms/tanerpii\"\u003eSupported Entity Types in Text Analytics API\u003c/a\u003e`. See the\n:code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the\nlist of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param domain: (Optional) if specified, will set the PII domain to include only a subset of the\n entity categories. Possible values include: \u0027PHI\u0027, \u0027none\u0027. Default value is None.\n:type domain: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param pii_categories: (Optional) describes the PII categories to return. Default value is\n None.\n:type pii_categories: list[str or ~azure.ai.textanalytics.v3_1.models.PiiCategory]\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: PiiResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.PiiResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, domain, string_index_type, pii_categories, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def entities_recognition_pii(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n domain: Optional[str] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n pii_categories: Optional[List[Union[str, \"_models.PiiCategory\"]]] = None,\n **kwargs: Any\n) -\u003e _models.PiiResult:\n",
- "doc": "\"\"\"Entities containing personal information.\n\nThe API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in\nthe document. For the list of supported entity types, check :code:`\u003ca\nhref=\"https://aka.ms/tanerpii\"\u003eSupported Entity Types in Text Analytics API\u003c/a\u003e`. See the\n:code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the\nlist of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param domain: (Optional) if specified, will set the PII domain to include only a subset of the\n entity categories. Possible values include: \u0027PHI\u0027, \u0027none\u0027. Default value is None.\n:type domain: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param pii_categories: (Optional) describes the PII categories to return. Default value is\n None.\n:type pii_categories: list[str or ~azure.ai.textanalytics.v3_1.models.PiiCategory]\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: PiiResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.PiiResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Entities containing personal information.\n\nThe API returns a list of entities with personal information (\\\"SSN\\\", \\\"Bank Account\\\" etc) in\nthe document. For the list of supported entity types, check :code:`\u003ca\nhref=\"https://aka.ms/tanerpii\"\u003eSupported Entity Types in Text Analytics API\u003c/a\u003e`. See the\n:code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the\nlist of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param domain: (Optional) if specified, will set the PII domain to include only a subset of the\n entity categories. Possible values include: \u0027PHI\u0027, \u0027none\u0027. Default value is None.\n:type domain: str\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:param pii_categories: (Optional) describes the PII categories to return. Default value is\n None.\n:type pii_categories: list[str or ~azure.ai.textanalytics.v3_1.models.PiiCategory]\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: PiiResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.PiiResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, domain, string_index_type, pii_categories, **kwargs"
}
},
"entities_linking" : {
"sync": {
"signature": "def entities_linking(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.EntityLinkingResult\n",
- "doc": "\"\"\"Linked entities from a well known knowledge base.\n\nThe API returns a list of recognized entities with links to a well known knowledge base. See\nthe :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for\nthe list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntityLinkingResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntityLinkingResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Linked entities from a well known knowledge base.\n\nThe API returns a list of recognized entities with links to a well known knowledge base. See\nthe :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for\nthe list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntityLinkingResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntityLinkingResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def entities_linking(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n **kwargs: Any\n) -\u003e _models.EntityLinkingResult:\n",
- "doc": "\"\"\"Linked entities from a well known knowledge base.\n\nThe API returns a list of recognized entities with links to a well known knowledge base. See\nthe :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for\nthe list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntityLinkingResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntityLinkingResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Linked entities from a well known knowledge base.\n\nThe API returns a list of recognized entities with links to a well known knowledge base. See\nthe :code:`\u003ca href=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for\nthe list of enabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: EntityLinkingResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.EntityLinkingResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs"
}
},
"key_phrases" : {
"sync": {
"signature": "def key_phrases(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.KeyPhraseResult\n",
- "doc": "\"\"\"Key Phrases.\n\nThe API returns a list of strings denoting the key phrases in the input text. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: KeyPhraseResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.KeyPhraseResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Key Phrases.\n\nThe API returns a list of strings denoting the key phrases in the input text. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: KeyPhraseResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.KeyPhraseResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def key_phrases(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n **kwargs: Any\n) -\u003e _models.KeyPhraseResult:\n",
- "doc": "\"\"\"Key Phrases.\n\nThe API returns a list of strings denoting the key phrases in the input text. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: KeyPhraseResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.KeyPhraseResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Key Phrases.\n\nThe API returns a list of strings denoting the key phrases in the input text. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: KeyPhraseResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.KeyPhraseResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, **kwargs"
}
},
"languages" : {
"sync": {
"signature": "def languages(\n self,\n documents, # type: List[_models.LanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.LanguageResult\n",
- "doc": "\"\"\"Detect Language.\n\nThe API returns the detected language and a numeric score between 0 and 1. Scores close to 1\nindicate 100% certainty that the identified language is true. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.LanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: LanguageResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.LanguageResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Detect Language.\n\nThe API returns the detected language and a numeric score between 0 and 1. Scores close to 1\nindicate 100% certainty that the identified language is true. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.LanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: LanguageResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.LanguageResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def languages(\n self,\n documents: List[_models.LanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n **kwargs: Any\n) -\u003e _models.LanguageResult:\n",
- "doc": "\"\"\"Detect Language.\n\nThe API returns the detected language and a numeric score between 0 and 1. Scores close to 1\nindicate 100% certainty that the identified language is true. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.LanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: LanguageResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.LanguageResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Detect Language.\n\nThe API returns the detected language and a numeric score between 0 and 1. Scores close to 1\nindicate 100% certainty that the identified language is true. See the :code:`\u003ca\nhref=\"https://aka.ms/talangs\"\u003eSupported languages in Text Analytics API\u003c/a\u003e` for the list of\nenabled languages.\n\n:param documents: Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.LanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: LanguageResult or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.LanguageResult\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, **kwargs"
}
},
"sentiment" : {
"sync": {
"signature": "def sentiment(\n self,\n documents, # type: List[_models.MultiLanguageInput]\n model_version=None, # type: Optional[str]\n show_stats=None, # type: Optional[bool]\n logging_opt_out=None, # type: Optional[bool]\n opinion_mining=None, # type: Optional[bool]\n string_index_type=None, # type: Optional[Union[str, \"_models.StringIndexType\"]]\n **kwargs # type: Any\n):\n # type: (...) -\u003e _models.SentimentResponse\n",
- "doc": "\"\"\"Sentiment.\n\nThe API returns a detailed sentiment analysis for the input text. The analysis is done in\nmultiple levels of granularity, start from the a document level, down to sentence and key terms\n(targets and assessments).\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param opinion_mining: (Optional) if set to true, response will contain not only sentiment\n prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is\n None.\n:type opinion_mining: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: SentimentResponse or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.SentimentResponse\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Sentiment.\n\nThe API returns a detailed sentiment analysis for the input text. The analysis is done in\nmultiple levels of granularity, start from the a document level, down to sentence and key terms\n(targets and assessments).\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param opinion_mining: (Optional) if set to true, response will contain not only sentiment\n prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is\n None.\n:type opinion_mining: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: SentimentResponse or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.SentimentResponse\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, opinion_mining, string_index_type, **kwargs"
},
"async": {
"coroutine": true,
"signature": "async def sentiment(\n self,\n documents: List[_models.MultiLanguageInput],\n model_version: Optional[str] = None,\n show_stats: Optional[bool] = None,\n logging_opt_out: Optional[bool] = None,\n opinion_mining: Optional[bool] = None,\n string_index_type: Optional[Union[str, \"_models.StringIndexType\"]] = None,\n **kwargs: Any\n) -\u003e _models.SentimentResponse:\n",
- "doc": "\"\"\"Sentiment.\n\nThe API returns a detailed sentiment analysis for the input text. The analysis is done in\nmultiple levels of granularity, start from the a document level, down to sentence and key terms\n(targets and assessments).\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param opinion_mining: (Optional) if set to true, response will contain not only sentiment\n prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is\n None.\n:type opinion_mining: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: SentimentResponse or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.SentimentResponse\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
+ "doc": "\"\"\"Sentiment.\n\nThe API returns a detailed sentiment analysis for the input text. The analysis is done in\nmultiple levels of granularity, start from the a document level, down to sentence and key terms\n(targets and assessments).\n\n:param documents: The set of documents to process as part of this batch. Required.\n:type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]\n:param model_version: (Optional) This value indicates which model will be used for scoring. If\n a model-version is not specified, the API should default to the latest, non-preview version.\n Default value is None.\n:type model_version: str\n:param show_stats: (Optional) if set to true, response will contain request and document level\n statistics. Default value is None.\n:type show_stats: bool\n:param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged\n for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to\n allow for troubleshooting issues in providing you with the Text Analytics natural language\n processing functions. Setting this parameter to true, disables input logging and may limit our\n ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy\n notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI\n principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.\n:type logging_opt_out: bool\n:param opinion_mining: (Optional) if set to true, response will contain not only sentiment\n prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is\n None.\n:type opinion_mining: bool\n:param string_index_type: (Optional) Specifies the method used to interpret string offsets.\n Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information\n see https://aka.ms/text-analytics-offsets. Known values are: \"TextElement_v8\",\n \"UnicodeCodePoint\", and \"Utf16CodeUnit\". Default value is None.\n:type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType\n:keyword callable cls: A custom type or function that will be passed the direct response\n:return: SentimentResponse or the result of cls(response)\n:rtype: ~azure.ai.textanalytics.v3_1.models.SentimentResponse\n:raises ~azure.core.exceptions.HttpResponseError:\n\"\"\"",
"call": "documents, model_version, show_stats, logging_opt_out, opinion_mining, string_index_type, **kwargs"
}
}
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_text_analytics_client.py
index f10d51f600e4..822bc7e6f576 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/_text_analytics_client.py
@@ -27,7 +27,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
unstructured text for tasks such as sentiment analysis, key phrase extraction and language
detection. Functionality for analysis of text specific to the healthcare domain and personal
information are also available in the API. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview`.
+ href="https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview">https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview`.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials.TokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/_text_analytics_client.py
index 2a598d90d050..7fc798038898 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/_text_analytics_client.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/_text_analytics_client.py
@@ -27,7 +27,7 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin): # pylint: disabl
unstructured text for tasks such as sentiment analysis, key phrase extraction and language
detection. Functionality for analysis of text specific to the healthcare domain and personal
information are also available in the API. Further documentation can be found in :code:`https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview`.
+ href="https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview">https://learn.microsoft.com/azure/cognitive-services/text-analytics/overview`.
:param credential: Credential needed for the client to connect to Azure. Required.
:type credential: ~azure.core.credentials_async.AsyncTokenCredential
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/operations/_text_analytics_client_operations.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/operations/_text_analytics_client_operations.py
index b4f3e2cd89b2..efd62e9d2b4b 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/operations/_text_analytics_client_operations.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/aio/operations/_text_analytics_client_operations.py
@@ -630,7 +630,7 @@ async def begin_health(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -734,7 +734,7 @@ async def entities_recognition_general(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -835,7 +835,7 @@ async def entities_recognition_pii(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param domain: (Optional) if specified, will set the PII domain to include only a subset of the
entity categories. Possible values include: 'PHI', 'none'. Default value is None.
@@ -940,7 +940,7 @@ async def entities_linking(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -1036,7 +1036,7 @@ async def key_phrases(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: KeyPhraseResult or the result of cls(response)
@@ -1127,7 +1127,7 @@ async def languages(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: LanguageResult or the result of cls(response)
@@ -1219,7 +1219,7 @@ async def sentiment(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param opinion_mining: (Optional) if set to true, response will contain not only sentiment
prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is
diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/operations/_text_analytics_client_operations.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/operations/_text_analytics_client_operations.py
index 27401c6ee9a8..ccd3cc62e001 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/operations/_text_analytics_client_operations.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/v3_1/operations/_text_analytics_client_operations.py
@@ -1048,7 +1048,7 @@ def begin_health(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -1152,7 +1152,7 @@ def entities_recognition_general(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -1253,7 +1253,7 @@ def entities_recognition_pii(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param domain: (Optional) if specified, will set the PII domain to include only a subset of the
entity categories. Possible values include: 'PHI', 'none'. Default value is None.
@@ -1358,7 +1358,7 @@ def entities_linking(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param string_index_type: (Optional) Specifies the method used to interpret string offsets.
Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information
@@ -1454,7 +1454,7 @@ def key_phrases(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: KeyPhraseResult or the result of cls(response)
@@ -1545,7 +1545,7 @@ def languages(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:keyword callable cls: A custom type or function that will be passed the direct response
:return: LanguageResult or the result of cls(response)
@@ -1637,7 +1637,7 @@ def sentiment(
processing functions. Setting this parameter to true, disables input logging and may limit our
ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy
notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI
- principles at https://www.microsoft.com/en-us/ai/responsible-ai. Default value is None.
+ principles at https://www.microsoft.com/ai/responsible-ai. Default value is None.
:type logging_opt_out: bool
:param opinion_mining: (Optional) if set to true, response will contain not only sentiment
prediction but also opinion mining (aspect-based sentiment analysis) results. Default value is
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 fdbef7b1ccb8..8b56d4f08bc0 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
@@ -104,7 +104,7 @@ class TextAnalyticsClient(TextAnalyticsClientBase):
and language detection, and more.
Further documentation can be found in
- https://docs.microsoft.com/azure/cognitive-services/language-service/overview
+ https://learn.microsoft.com/azure/cognitive-services/language-service/overview
:param str endpoint: Supported Cognitive Services or Language resource
endpoints (protocol and hostname, for example: 'https://.cognitiveservices.azure.com').
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 0f199d5a75f8..00d10713f611 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
@@ -98,7 +98,7 @@ class TextAnalyticsClient(AsyncTextAnalyticsClientBase):
and language detection, and more.
Further documentation can be found in
- https://docs.microsoft.com/azure/cognitive-services/language-service/overview
+ https://learn.microsoft.com/azure/cognitive-services/language-service/overview
:param str endpoint: Supported Cognitive Services or Language resource
endpoints (protocol and hostname, for example: 'https://.cognitiveservices.azure.com').
diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/README.md b/sdk/textanalytics/azure-ai-textanalytics/samples/README.md
index 1097a7d5dffa..f33960029cd8 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/samples/README.md
+++ b/sdk/textanalytics/azure-ai-textanalytics/samples/README.md
@@ -120,6 +120,6 @@ what you can do with the Azure Text Analytics client library.
[abstract_summary_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_abstract_summary_async.py
[pip]: https://pypi.org/project/pip/
[azure_subscription]: https://azure.microsoft.com/free/
-[azure_language_account]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=singleservice%2Cwindows
+[azure_language_account]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=singleservice%2Cwindows
[azure_identity_pip]: https://pypi.org/project/azure-identity/
[api_reference_documentation]: https://aka.ms/azsdk-python-textanalytics-ref-docs
diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_authentication_async.py b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_authentication_async.py
index 5fd0a7252b2d..384c608acdce 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_authentication_async.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_authentication_async.py
@@ -15,7 +15,7 @@
2) Use a token credential from azure-identity to authenticate with Azure Active Directory
See more details about authentication here:
- https://docs.microsoft.com/azure/cognitive-services/authentication
+ https://learn.microsoft.com/azure/cognitive-services/authentication
USAGE:
python sample_authentication_async.py
diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_authentication.py b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_authentication.py
index 7f91c8106fc9..82da01a6ad45 100644
--- a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_authentication.py
+++ b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_authentication.py
@@ -15,7 +15,7 @@
2) Use a token credential from azure-identity to authenticate with Azure Active Directory
See more details about authentication here:
- https://docs.microsoft.com/azure/cognitive-services/authentication
+ https://learn.microsoft.com/azure/cognitive-services/authentication
USAGE:
python sample_authentication.py