# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
# pylint: disable=too-many-lines
from typing import (
Union,
Any,
List,
Dict,
TYPE_CHECKING
)
from functools import partial
from azure.core.paging import ItemPaged
from azure.core.tracing.decorator import distributed_trace
from azure.core.exceptions import HttpResponseError
from azure.core.credentials import AzureKeyCredential
from ._base_client import TextAnalyticsClientBase
from ._lro import AnalyzeActionsLROPoller, AnalyzeHealthcareEntitiesLROPoller
from ._request_handlers import (
_validate_input,
_determine_action_type,
)
from ._validate import validate_multiapi_args, check_for_unsupported_actions_types
from ._version import DEFAULT_API_VERSION
from ._response_handlers import (
process_http_response_error,
entities_result,
linked_entities_result,
key_phrases_result,
sentiment_result,
language_result,
pii_entities_result,
healthcare_paged_result,
analyze_paged_result,
)
from ._lro import (
TextAnalyticsOperationResourcePolling,
AnalyzeActionsLROPollingMethod,
AnalyzeHealthcareEntitiesLROPollingMethod,
)
from ._models import (
DetectLanguageInput,
TextDocumentInput,
DetectLanguageResult,
RecognizeEntitiesResult,
RecognizeLinkedEntitiesResult,
ExtractKeyPhrasesResult,
AnalyzeSentimentResult,
DocumentError,
RecognizePiiEntitiesResult,
RecognizeEntitiesAction,
RecognizePiiEntitiesAction,
RecognizeLinkedEntitiesAction,
ExtractKeyPhrasesAction,
AnalyzeSentimentAction,
AnalyzeHealthcareEntitiesResult,
ExtractSummaryAction,
ExtractSummaryResult,
RecognizeCustomEntitiesAction,
RecognizeCustomEntitiesResult,
SingleCategoryClassifyAction,
SingleCategoryClassifyResult,
MultiCategoryClassifyAction,
MultiCategoryClassifyResult,
AnalyzeHealthcareEntitiesAction,
_AnalyzeActionsType,
)
from ._check import is_language_api, string_index_type_compatibility
if TYPE_CHECKING:
from azure.core.credentials import TokenCredential
[docs]class TextAnalyticsClient(TextAnalyticsClientBase):
"""The Language service API is a suite of natural language processing (NLP) skills built with the 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, entities recognition,
and language detection, and more.
Further documentation can be found in
https://docs.microsoft.com/azure/cognitive-services/language-service/overview
:param str endpoint: Supported Cognitive Services or Language resource
endpoints (protocol and hostname, for example: 'https://<resource-name>.cognitiveservices.azure.com').
:param credential: Credentials needed for the client to connect to Azure.
This can be the an instance of AzureKeyCredential if using a Cognitive Services/Language API key
or a token credential from :mod:`azure.identity`.
:type credential: ~azure.core.credentials.AzureKeyCredential or ~azure.core.credentials.TokenCredential
:keyword str default_country_hint: Sets the default country_hint to use for all operations.
Defaults to "US". If you don't want to use a country hint, pass the string "none".
:keyword str default_language: Sets the default language to use for all operations.
Defaults to "en".
:keyword api_version: The API version of the service to use for requests. It defaults to the
latest service version. Setting to an older version may result in reduced feature compatibility.
:paramtype api_version: str or ~azure.ai.textanalytics.TextAnalyticsApiVersion
.. admonition:: Example:
.. literalinclude:: ../samples/sample_authentication.py
:start-after: [START create_ta_client_with_key]
:end-before: [END create_ta_client_with_key]
:language: python
:dedent: 4
:caption: Creating the TextAnalyticsClient with endpoint and API key.
.. literalinclude:: ../samples/sample_authentication.py
:start-after: [START create_ta_client_with_aad]
:end-before: [END create_ta_client_with_aad]
:language: python
:dedent: 4
:caption: Creating the TextAnalyticsClient with endpoint and token credential from Azure Active Directory.
"""
def __init__(
self,
endpoint: str,
credential: Union[AzureKeyCredential, "TokenCredential"],
**kwargs: Any
) -> None:
super().__init__(
endpoint=endpoint, credential=credential, **kwargs
)
self._api_version = kwargs.get("api_version", DEFAULT_API_VERSION)
self._default_language = kwargs.pop("default_language", "en")
self._default_country_hint = kwargs.pop("default_country_hint", "US")
self._string_index_type_default = (
None if kwargs.get("api_version") == "v3.0" else "UnicodeCodePoint"
)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.0",
args_mapping={"v3.1": ["disable_service_logs"]}
)
def detect_language(
self,
documents: Union[List[str], List[DetectLanguageInput], List[Dict[str, str]]],
**kwargs: Any,
) -> List[Union[DetectLanguageResult, DocumentError]]:
"""Detect language for a batch of documents.
Returns the detected language and a numeric score between zero and
one. Scores close to one indicate 100% certainty that the identified
language is true. See https://aka.ms/talangs for the list of enabled languages.
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and country_hint on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.DetectLanguageInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.DetectLanguageInput`, like
`{"id": "1", "country_hint": "us", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.DetectLanguageInput] or list[dict[str, str]]
:keyword str country_hint: Country of origin hint for the entire batch. Accepts two
letter country codes specified by ISO 3166-1 alpha-2. Per-document
country hints will take precedence over whole batch hints. Defaults to
"US". If you don't want to use a country hint, pass the string "none".
:keyword str model_version: Version of the model used on the service side for scoring,
e.g. "latest", "2019-10-01". If a model version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document
level statistics in the `statistics` field of the document-level response.
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language 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/ai/responsible-ai.
:return: The combined list of :class:`~azure.ai.textanalytics.DetectLanguageResult` and
:class:`~azure.ai.textanalytics.DocumentError` in the order the original documents were
passed in.
:rtype: list[~azure.ai.textanalytics.DetectLanguageResult or ~azure.ai.textanalytics.DocumentError]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *disable_service_logs* keyword argument.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_detect_language.py
:start-after: [START detect_language]
:end-before: [END detect_language]
:language: python
:dedent: 4
:caption: Detecting language in a batch of documents.
"""
country_hint_arg = kwargs.pop("country_hint", None)
country_hint = (
country_hint_arg
if country_hint_arg is not None
else self._default_country_hint
)
docs = _validate_input(documents, "country_hint", country_hint)
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
disable_service_logs = kwargs.pop("disable_service_logs", None)
try:
if is_language_api(self._api_version):
models = self._client.models(api_version=self._api_version)
return self._client.analyze_text(
body=models.AnalyzeTextLanguageDetectionInput(
analysis_input={"documents": docs},
parameters=models.LanguageDetectionTaskParameters(
logging_opt_out=disable_service_logs,
model_version=model_version
)
),
show_stats=show_stats,
cls=kwargs.pop("cls", language_result),
**kwargs
)
# api_versions 3.0, 3.1
return self._client.languages(
documents=docs,
model_version=model_version,
show_stats=show_stats,
logging_opt_out=disable_service_logs,
cls=kwargs.pop("cls", language_result),
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.0",
args_mapping={"v3.1": ["string_index_type", "disable_service_logs"]}
)
def recognize_entities(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
**kwargs: Any,
) -> List[Union[RecognizeEntitiesResult, DocumentError]]:
"""Recognize entities for a batch of documents.
Identifies and categorizes entities in your text as people, places,
organizations, date/time, quantities, percentages, currencies, and more.
For the list of supported entity types, check: https://aka.ms/taner
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list
of dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`,
like `{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword str model_version: This value indicates which model will
be used for scoring, e.g. "latest", "2019-10-01". If a model-version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document
level statistics in the `statistics` field of the document-level response.
:keyword str string_index_type: Specifies the method used to interpret string offsets.
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
see https://aka.ms/text-analytics-offsets
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language 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/ai/responsible-ai.
:return: The combined list of :class:`~azure.ai.textanalytics.RecognizeEntitiesResult` and
:class:`~azure.ai.textanalytics.DocumentError` in the order the original documents
were passed in.
:rtype: list[~azure.ai.textanalytics.RecognizeEntitiesResult or ~azure.ai.textanalytics.DocumentError]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *disable_service_logs* and *string_index_type* keyword arguments.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_recognize_entities.py
:start-after: [START recognize_entities]
:end-before: [END recognize_entities]
:language: python
:dedent: 4
:caption: Recognize entities in a batch of documents.
"""
language_arg = kwargs.pop("language", None)
language = language_arg if language_arg is not None else self._default_language
docs = _validate_input(documents, "language", language)
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
string_index_type = kwargs.pop("string_index_type", self._string_index_type_default)
disable_service_logs = kwargs.pop("disable_service_logs", None)
try:
if is_language_api(self._api_version):
models = self._client.models(api_version=self._api_version)
return self._client.analyze_text(
body=models.AnalyzeTextEntityRecognitionInput(
analysis_input={"documents": docs},
parameters=models.EntitiesTaskParameters(
logging_opt_out=disable_service_logs,
model_version=model_version,
string_index_type=string_index_type_compatibility(string_index_type)
)
),
show_stats=show_stats,
cls=kwargs.pop("cls", entities_result),
**kwargs
)
# api_versions 3.0, 3.1
return self._client.entities_recognition_general(
documents=docs,
model_version=model_version,
show_stats=show_stats,
string_index_type=string_index_type,
logging_opt_out=disable_service_logs,
cls=kwargs.pop("cls", entities_result),
**kwargs,
)
except HttpResponseError as error:
return process_http_response_error(error)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.1"
)
def recognize_pii_entities(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
**kwargs: Any,
) -> List[Union[RecognizePiiEntitiesResult, DocumentError]]:
"""Recognize entities containing personal information for a batch of documents.
Returns a list of personal information entities ("SSN",
"Bank Account", etc) in the document. For the list of supported entity types,
check https://aka.ms/tanerpii
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`, like
`{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword str model_version: This value indicates which model will
be used for scoring, e.g. "latest", "2019-10-01". If a model-version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document
level statistics in the `statistics` field of the document-level response.
:keyword domain_filter: Filters the response entities to ones only included in the specified domain.
I.e., if set to 'phi', will only return entities in the Protected Healthcare Information domain.
See https://aka.ms/tanerpii for more information.
:paramtype domain_filter: str or ~azure.ai.textanalytics.PiiEntityDomain
:keyword categories_filter: Instead of filtering over all PII entity categories, you can pass in a list of
the specific PII entity categories you want to filter out. For example, if you only want to filter out
U.S. social security numbers in a document, you can pass in
`[PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER]` for this kwarg.
:paramtype categories_filter: list[str or ~azure.ai.textanalytics.PiiEntityCategory]
:keyword str string_index_type: Specifies the method used to interpret string offsets.
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
see https://aka.ms/text-analytics-offsets
:keyword bool disable_service_logs: Defaults to true, meaning that the Language service will not log your
input text on the service side for troubleshooting. If set to False, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language processing functions. 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/ai/responsible-ai.
:return: The combined list of :class:`~azure.ai.textanalytics.RecognizePiiEntitiesResult`
and :class:`~azure.ai.textanalytics.DocumentError` in the order the original documents
were passed in.
:rtype: list[~azure.ai.textanalytics.RecognizePiiEntitiesResult or ~azure.ai.textanalytics.DocumentError]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *recognize_pii_entities* client method.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_recognize_pii_entities.py
:start-after: [START recognize_pii_entities]
:end-before: [END recognize_pii_entities]
:language: python
:dedent: 4
:caption: Recognize personally identifiable information entities in a batch of documents.
"""
language_arg = kwargs.pop("language", None)
language = language_arg if language_arg is not None else self._default_language
docs = _validate_input(documents, "language", language)
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
domain_filter = kwargs.pop("domain_filter", None)
categories_filter = kwargs.pop("categories_filter", None)
string_index_type = kwargs.pop("string_index_type", self._string_index_type_default)
disable_service_logs = kwargs.pop("disable_service_logs", None)
try:
if is_language_api(self._api_version):
models = self._client.models(api_version=self._api_version)
return self._client.analyze_text(
body=models.AnalyzeTextPiiEntitiesRecognitionInput(
analysis_input={"documents": docs},
parameters=models.PiiTaskParameters(
logging_opt_out=disable_service_logs,
model_version=model_version,
domain=domain_filter,
pii_categories=categories_filter,
string_index_type=string_index_type_compatibility(string_index_type)
)
),
show_stats=show_stats,
cls=kwargs.pop("cls", pii_entities_result),
**kwargs
)
# api_versions 3.0, 3.1
return self._client.entities_recognition_pii(
documents=docs,
model_version=model_version,
show_stats=show_stats,
domain=domain_filter,
pii_categories=categories_filter,
logging_opt_out=disable_service_logs,
string_index_type=string_index_type,
cls=kwargs.pop("cls", pii_entities_result),
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.0",
args_mapping={"v3.1": ["string_index_type", "disable_service_logs"]}
)
def recognize_linked_entities(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
**kwargs: Any,
) -> List[Union[RecognizeLinkedEntitiesResult, DocumentError]]:
"""Recognize linked entities from a well-known knowledge base for a batch of documents.
Identifies and disambiguates the identity of each entity found in text (for example,
determining whether an occurrence of the word Mars refers to the planet, or to the
Roman god of war). Recognized entities are associated with URLs to a well-known
knowledge base, like Wikipedia.
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`, like
`{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword str model_version: This value indicates which model will
be used for scoring, e.g. "latest", "2019-10-01". If a model-version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document
level statistics in the `statistics` field of the document-level response.
:keyword str string_index_type: Specifies the method used to interpret string offsets.
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
see https://aka.ms/text-analytics-offsets
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language 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/ai/responsible-ai.
:return: The combined list of :class:`~azure.ai.textanalytics.RecognizeLinkedEntitiesResult`
and :class:`~azure.ai.textanalytics.DocumentError` in the order the original documents
were passed in.
:rtype: list[~azure.ai.textanalytics.RecognizeLinkedEntitiesResult or ~azure.ai.textanalytics.DocumentError]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *disable_service_logs* and *string_index_type* keyword arguments.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_recognize_linked_entities.py
:start-after: [START recognize_linked_entities]
:end-before: [END recognize_linked_entities]
:language: python
:dedent: 4
:caption: Recognize linked entities in a batch of documents.
"""
language_arg = kwargs.pop("language", None)
language = language_arg if language_arg is not None else self._default_language
docs = _validate_input(documents, "language", language)
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
disable_service_logs = kwargs.pop("disable_service_logs", None)
string_index_type = kwargs.pop("string_index_type", self._string_index_type_default)
try:
if is_language_api(self._api_version):
models = self._client.models(api_version=self._api_version)
return self._client.analyze_text(
body=models.AnalyzeTextEntityLinkingInput(
analysis_input={"documents": docs},
parameters=models.EntityLinkingTaskParameters(
logging_opt_out=disable_service_logs,
model_version=model_version,
string_index_type=string_index_type_compatibility(string_index_type)
)
),
show_stats=show_stats,
cls=kwargs.pop("cls", linked_entities_result),
**kwargs
)
# api_versions 3.0, 3.1
return self._client.entities_linking(
documents=docs,
logging_opt_out=disable_service_logs,
model_version=model_version,
string_index_type=string_index_type,
show_stats=show_stats,
cls=kwargs.pop("cls", linked_entities_result),
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)
def _healthcare_result_callback(
self, doc_id_order, raw_response, deserialized, headers, show_stats=False
):
if deserialized is None:
models = self._client.models(api_version=self._api_version)
response_cls = \
models.AnalyzeTextJobState if is_language_api(self._api_version) else models.HealthcareJobState
deserialized = response_cls.deserialize(raw_response)
return healthcare_paged_result(
doc_id_order,
self._client.analyze_text_job_status if is_language_api(self._api_version) else self._client.health_status,
raw_response,
deserialized,
headers,
show_stats=show_stats,
)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.1",
args_mapping={"2022-04-01-preview": ["display_name", "fhir_version"]}
)
def begin_analyze_healthcare_entities(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
**kwargs: Any,
) -> AnalyzeHealthcareEntitiesLROPoller[ItemPaged[Union[AnalyzeHealthcareEntitiesResult, DocumentError]]]:
"""Analyze healthcare entities and identify relationships between these entities in a batch of documents.
Entities are associated with references that can be found in existing knowledge bases,
such as UMLS, CHV, MSH, etc.
We also extract the relations found between entities, for example in "The subject took 100 mg of ibuprofen",
we would extract the relationship between the "100 mg" dosage and the "ibuprofen" medication.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`, like
`{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:keyword str model_version: This value indicates which model will
be used for scoring, e.g. "latest", "2019-10-01". If a model-version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document level statistics.
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword str display_name: An optional display name to set for the requested analysis.
:keyword str fhir_version: The FHIR Spec version that the result will use to format the fhir_bundle
on the result object. For additional information see https://www.hl7.org/fhir/overview.html.
The only acceptable values to pass in are None and "4.0.1". The default value is None.
:keyword str string_index_type: Specifies the method used to interpret string offsets.
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
see https://aka.ms/text-analytics-offsets
:keyword int polling_interval: Waiting time between two polls for LRO operations
if no Retry-After header is present. Defaults to 5 seconds.
:keyword str continuation_token:
Call `continuation_token()` on the poller object to save the long-running operation (LRO)
state into an opaque token. Pass the value as the `continuation_token` keyword argument
to restart the LRO from a saved state.
:keyword bool disable_service_logs: Defaults to true, meaning that the Language service will not log your
input text on the service side for troubleshooting. If set to False, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language processing functions. 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/ai/responsible-ai.
:return: An instance of an AnalyzeHealthcareEntitiesLROPoller. Call `result()` on the this
object to return a heterogeneous pageable of
:class:`~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult` and
:class:`~azure.ai.textanalytics.DocumentError`.
:rtype:
~azure.ai.textanalytics.AnalyzeHealthcareEntitiesLROPoller[~azure.core.paging.ItemPaged[
~azure.ai.textanalytics.AnalyzeHealthcareEntitiesResult or ~azure.ai.textanalytics.DocumentError]]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *begin_analyze_healthcare_entities* client method.
.. versionadded:: 2022-04-01-preview
The *display_name* and *fhir_version* keyword arguments.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_analyze_healthcare_entities.py
:start-after: [START analyze_healthcare_entities]
:end-before: [END analyze_healthcare_entities]
:language: python
:dedent: 4
:caption: Recognize healthcare entities in a batch of documents.
"""
language_arg = kwargs.pop("language", None)
language = language_arg if language_arg is not None else self._default_language
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
polling_interval = kwargs.pop("polling_interval", 5)
continuation_token = kwargs.pop("continuation_token", None)
string_index_type = kwargs.pop("string_index_type", self._string_index_type_default)
disable_service_logs = kwargs.pop("disable_service_logs", None)
display_name = kwargs.pop("display_name", None)
fhir_version = kwargs.pop("fhir_version", None)
if continuation_token:
def get_result_from_cont_token(initial_response, pipeline_response):
doc_id_order = initial_response.context.options["doc_id_order"]
show_stats = initial_response.context.options["show_stats"]
return self._healthcare_result_callback(
doc_id_order, pipeline_response, None, {}, show_stats=show_stats
)
return AnalyzeHealthcareEntitiesLROPoller.from_continuation_token(
polling_method=AnalyzeHealthcareEntitiesLROPollingMethod(
text_analytics_client=self._client,
timeout=polling_interval,
**kwargs
),
client=self._client._client, # pylint: disable=protected-access
deserialization_callback=get_result_from_cont_token,
continuation_token=continuation_token
)
docs = _validate_input(documents, "language", language)
doc_id_order = [doc.get("id") for doc in docs]
my_cls = kwargs.pop(
"cls",
partial(
self._healthcare_result_callback, doc_id_order, show_stats=show_stats
),
)
models = self._client.models(api_version=self._api_version)
try:
if is_language_api(self._api_version):
docs = models.MultiLanguageAnalysisInput(
documents=_validate_input(documents, "language", language)
)
return self._client.begin_analyze_text_submit_job( # type: ignore
body=models.AnalyzeTextJobsInput(
analysis_input=docs,
display_name=display_name,
tasks=[
models.HealthcareLROTask(
task_name="0",
parameters=models.HealthcareTaskParameters(
model_version=model_version,
logging_opt_out=disable_service_logs,
string_index_type=string_index_type_compatibility(string_index_type),
fhir_version=fhir_version,
)
)
]
),
cls=my_cls,
polling=AnalyzeHealthcareEntitiesLROPollingMethod(
text_analytics_client=self._client,
timeout=polling_interval,
show_stats=show_stats,
doc_id_order=doc_id_order,
lro_algorithms=[
TextAnalyticsOperationResourcePolling(
show_stats=show_stats,
)
],
**kwargs
),
continuation_token=continuation_token,
poller_cls=AnalyzeHealthcareEntitiesLROPoller,
**kwargs
)
# v3.1
return self._client.begin_health(
docs,
model_version=model_version,
string_index_type=string_index_type,
logging_opt_out=disable_service_logs,
cls=my_cls,
polling=AnalyzeHealthcareEntitiesLROPollingMethod(
text_analytics_client=self._client,
timeout=polling_interval,
doc_id_order=doc_id_order,
show_stats=show_stats,
lro_algorithms=[
TextAnalyticsOperationResourcePolling(
show_stats=show_stats,
)
],
**kwargs
),
continuation_token=continuation_token,
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.0",
args_mapping={"v3.1": ["show_opinion_mining", "disable_service_logs", "string_index_type"]}
)
def analyze_sentiment(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
**kwargs: Any,
) -> List[Union[AnalyzeSentimentResult, DocumentError]]:
"""Analyze sentiment for a batch of documents. Turn on opinion mining with `show_opinion_mining`.
Returns a sentiment prediction, as well as sentiment scores for
each sentiment class (Positive, Negative, and Neutral) for the document
and each sentence within it.
See https://aka.ms/azsdk/textanalytics/data-limits for service data limits.
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`, like
`{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:keyword bool show_opinion_mining: Whether to mine the opinions of a sentence and conduct more
granular analysis around the aspects of a product or service (also known as
aspect-based sentiment analysis). If set to true, the returned
:class:`~azure.ai.textanalytics.SentenceSentiment` objects
will have property `mined_opinions` containing the result of this analysis. Only available for
API version v3.1 and up.
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword str model_version: This value indicates which model will
be used for scoring, e.g. "latest", "2019-10-01". If a model-version
is not specified, the API will default to the latest, non-preview version.
See here for more info: https://aka.ms/text-analytics-model-versioning
:keyword bool show_stats: If set to true, response will contain document
level statistics in the `statistics` field of the document-level response.
:keyword str string_index_type: Specifies the method used to interpret string offsets.
`UnicodeCodePoint`, the Python encoding, is the default. To override the Python default,
you can also pass in `Utf16CodeUnit` or `TextElement_v8`. For additional information
see https://aka.ms/text-analytics-offsets
:keyword bool disable_service_logs: If set to true, you opt-out of having your text input
logged on the service side for troubleshooting. By default, the Language service logs your
input text for 48 hours, solely to allow for troubleshooting issues in providing you with
the service's natural language 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/ai/responsible-ai.
:return: The combined list of :class:`~azure.ai.textanalytics.AnalyzeSentimentResult` and
:class:`~azure.ai.textanalytics.DocumentError` in the order the original documents were
passed in.
:rtype: list[~azure.ai.textanalytics.AnalyzeSentimentResult or ~azure.ai.textanalytics.DocumentError]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *show_opinion_mining*, *disable_service_logs*, and *string_index_type* keyword arguments.
.. admonition:: Example:
.. literalinclude:: ../samples/sample_analyze_sentiment.py
:start-after: [START analyze_sentiment]
:end-before: [END analyze_sentiment]
:language: python
:dedent: 4
:caption: Analyze sentiment in a batch of documents.
"""
language_arg = kwargs.pop("language", None)
language = language_arg if language_arg is not None else self._default_language
docs = _validate_input(documents, "language", language)
model_version = kwargs.pop("model_version", None)
show_stats = kwargs.pop("show_stats", None)
show_opinion_mining = kwargs.pop("show_opinion_mining", None)
disable_service_logs = kwargs.pop("disable_service_logs", None)
string_index_type = kwargs.pop("string_index_type", self._string_index_type_default)
try:
if is_language_api(self._api_version):
models = self._client.models(api_version=self._api_version)
return self._client.analyze_text(
body=models.AnalyzeTextSentimentAnalysisInput(
analysis_input={"documents": docs},
parameters=models.SentimentAnalysisTaskParameters(
logging_opt_out=disable_service_logs,
model_version=model_version,
string_index_type=string_index_type_compatibility(string_index_type),
opinion_mining=show_opinion_mining,
)
),
show_stats=show_stats,
cls=kwargs.pop("cls", sentiment_result),
**kwargs
)
# api_versions 3.0, 3.1
return self._client.sentiment(
documents=docs,
logging_opt_out=disable_service_logs,
model_version=model_version,
string_index_type=string_index_type,
opinion_mining=show_opinion_mining,
show_stats=show_stats,
cls=kwargs.pop("cls", sentiment_result),
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)
def _analyze_result_callback(
self, doc_id_order, task_order, raw_response, deserialized, headers, show_stats=False
):
if deserialized is None:
models = self._client.models(api_version=self._api_version)
response_cls = models.AnalyzeTextJobState if is_language_api(self._api_version) else models.AnalyzeJobState
deserialized = response_cls.deserialize(raw_response)
return analyze_paged_result(
doc_id_order,
task_order,
self._client.analyze_text_job_status if is_language_api(self._api_version) else self._client.analyze_status,
raw_response,
deserialized,
headers,
show_stats=show_stats,
)
[docs] @distributed_trace
@validate_multiapi_args(
version_method_added="v3.1",
custom_wrapper=check_for_unsupported_actions_types
)
def begin_analyze_actions(
self,
documents: Union[List[str], List[TextDocumentInput], List[Dict[str, str]]],
actions: List[
Union[
RecognizeEntitiesAction,
RecognizeLinkedEntitiesAction,
RecognizePiiEntitiesAction,
ExtractKeyPhrasesAction,
AnalyzeSentimentAction,
ExtractSummaryAction,
RecognizeCustomEntitiesAction,
SingleCategoryClassifyAction,
MultiCategoryClassifyAction,
AnalyzeHealthcareEntitiesAction,
]
],
**kwargs: Any,
) -> AnalyzeActionsLROPoller[
ItemPaged[
List[
Union[
RecognizeEntitiesResult,
RecognizeLinkedEntitiesResult,
RecognizePiiEntitiesResult,
ExtractKeyPhrasesResult,
AnalyzeSentimentResult,
ExtractSummaryResult,
RecognizeCustomEntitiesResult,
SingleCategoryClassifyResult,
MultiCategoryClassifyResult,
AnalyzeHealthcareEntitiesResult,
DocumentError,
]
]
]
]:
"""Start a long-running operation to perform a variety of text analysis actions over a batch of documents.
We recommend you use this function if you're looking to analyze larger documents, and / or
combine multiple text analysis actions into one call. Otherwise, we recommend you use
the action specific endpoints, for example :func:`analyze_sentiment`.
.. note:: See the service documentation for regional support of custom action features:
https://aka.ms/azsdk/textanalytics/customfunctionalities
:param documents: The set of documents to process as part of this batch.
If you wish to specify the ID and language on a per-item basis you must
use as input a list[:class:`~azure.ai.textanalytics.TextDocumentInput`] or a list of
dict representations of :class:`~azure.ai.textanalytics.TextDocumentInput`, like
`{"id": "1", "language": "en", "text": "hello world"}`.
:type documents:
list[str] or list[~azure.ai.textanalytics.TextDocumentInput] or list[dict[str, str]]
:param actions: A heterogeneous list of actions to perform on the input documents.
Each action object encapsulates the parameters used for the particular action type.
The action results will be in the same order of the input actions.
:type actions:
list[RecognizeEntitiesAction or RecognizePiiEntitiesAction or ExtractKeyPhrasesAction or
RecognizeLinkedEntitiesAction or AnalyzeSentimentAction or ExtractSummaryAction or
RecognizeCustomEntitiesAction or SingleCategoryClassifyAction or
MultiCategoryClassifyAction or AnalyzeHealthcareEntitiesAction]
:keyword str display_name: An optional display name to set for the requested analysis.
:keyword str language: The 2 letter ISO 639-1 representation of language for the
entire batch. For example, use "en" for English; "es" for Spanish etc.
If not set, uses "en" for English as default. Per-document language will
take precedence over whole batch language. See https://aka.ms/talangs for
supported languages in Language API.
:keyword bool show_stats: If set to true, response will contain document level statistics.
:keyword int polling_interval: Waiting time between two polls for LRO operations
if no Retry-After header is present. Defaults to 5 seconds.
:keyword str continuation_token:
Call `continuation_token()` on the poller object to save the long-running operation (LRO)
state into an opaque token. Pass the value as the `continuation_token` keyword argument
to restart the LRO from a saved state.
:return: An instance of an AnalyzeActionsLROPoller. Call `result()` on the poller
object to return a pageable heterogeneous list of lists. This list of lists is first ordered
by the documents you input, then ordered by the actions you input. For example,
if you have documents input ["Hello", "world"], and actions
:class:`~azure.ai.textanalytics.RecognizeEntitiesAction` and
:class:`~azure.ai.textanalytics.AnalyzeSentimentAction`, when iterating over the list of lists,
you will first iterate over the action results for the "Hello" document, getting the
:class:`~azure.ai.textanalytics.RecognizeEntitiesResult` of "Hello",
then the :class:`~azure.ai.textanalytics.AnalyzeSentimentResult` of "Hello".
Then, you will get the :class:`~azure.ai.textanalytics.RecognizeEntitiesResult` and
:class:`~azure.ai.textanalytics.AnalyzeSentimentResult` of "world".
:rtype:
~azure.ai.textanalytics.AnalyzeActionsLROPoller[~azure.core.paging.ItemPaged[
list[RecognizeEntitiesResult or RecognizeLinkedEntitiesResult or RecognizePiiEntitiesResult or
ExtractKeyPhrasesResult or AnalyzeSentimentResult or ExtractSummaryAction or RecognizeCustomEntitiesResult
or SingleCategoryClassifyResult or MultiCategoryClassifyResult or AnalyzeHealthcareEntitiesResult or
DocumentError]]]
:raises ~azure.core.exceptions.HttpResponseError or TypeError or ValueError:
.. versionadded:: v3.1
The *begin_analyze_actions* client method.
.. versionadded:: 2022-04-01-preview
The *ExtractSummaryAction*, *RecognizeCustomEntitiesAction*, *SingleCategoryClassifyAction*,
*MultiCategoryClassifyAction*, and *AnalyzeHealthcareEntitiesAction* input options and the
corresponding *ExtractSummaryResult*, *RecognizeCustomEntitiesResult*, *SingleCategoryClassifyResult*,
*MultiCategoryClassifyResult*, and *AnalyzeHealthcareEntitiesResult* result objects
.. admonition:: Example:
.. literalinclude:: ../samples/sample_analyze_actions.py
:start-after: [START analyze]
:end-before: [END analyze]
:language: python
:dedent: 4
:caption: Start a long-running operation to perform a variety of text analysis
actions over a batch of documents.
"""
continuation_token = kwargs.pop("continuation_token", None)
display_name = kwargs.pop("display_name", None)
language_arg = kwargs.pop("language", None)
show_stats = kwargs.pop("show_stats", None)
polling_interval = kwargs.pop("polling_interval", 5)
language = language_arg if language_arg is not None else self._default_language
if continuation_token:
def get_result_from_cont_token(initial_response, pipeline_response):
doc_id_order = initial_response.context.options["doc_id_order"]
task_id_order = initial_response.context.options["task_id_order"]
show_stats = initial_response.context.options["show_stats"]
return self._analyze_result_callback(
doc_id_order, task_id_order, pipeline_response, None, {}, show_stats=show_stats
)
return AnalyzeActionsLROPoller.from_continuation_token(
polling_method=AnalyzeActionsLROPollingMethod(
timeout=polling_interval,
**kwargs
),
client=self._client._client, # pylint: disable=protected-access
deserialization_callback=get_result_from_cont_token,
continuation_token=continuation_token
)
models = self._client.models(api_version=self._api_version)
input_model_cls = \
models.MultiLanguageAnalysisInput if is_language_api(self._api_version) else models.MultiLanguageBatchInput
docs = input_model_cls(
documents=_validate_input(documents, "language", language)
)
doc_id_order = [doc.get("id") for doc in docs.documents]
try:
generated_tasks = [
action._to_generated(self._api_version, str(idx)) # pylint: disable=protected-access
for idx, action in enumerate(actions)
]
except AttributeError as e:
raise TypeError("Unsupported action type in list.") from e
task_order = [(_determine_action_type(a), a.task_name) for a in generated_tasks]
try:
if is_language_api(self._api_version):
return self._client.begin_analyze_text_submit_job(
body=models.AnalyzeTextJobsInput(
analysis_input=docs,
display_name=display_name,
tasks=generated_tasks
),
cls=kwargs.pop(
"cls",
partial(
self._analyze_result_callback,
doc_id_order,
task_order,
show_stats=show_stats,
),
),
polling=AnalyzeActionsLROPollingMethod(
timeout=polling_interval,
show_stats=show_stats,
doc_id_order=doc_id_order,
task_id_order=task_order,
lro_algorithms=[
TextAnalyticsOperationResourcePolling(
show_stats=show_stats,
)
],
**kwargs
),
continuation_token=continuation_token,
**kwargs
)
# v3.1
analyze_tasks = models.JobManifestTasks(
entity_recognition_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.RECOGNIZE_ENTITIES
],
entity_recognition_pii_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.RECOGNIZE_PII_ENTITIES
],
key_phrase_extraction_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.EXTRACT_KEY_PHRASES
],
entity_linking_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.RECOGNIZE_LINKED_ENTITIES
],
sentiment_analysis_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.ANALYZE_SENTIMENT
],
extractive_summarization_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.EXTRACT_SUMMARY
],
custom_entity_recognition_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.RECOGNIZE_CUSTOM_ENTITIES
],
custom_single_classification_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.SINGLE_CATEGORY_CLASSIFY
],
custom_multi_classification_tasks=[
a for a in generated_tasks
if _determine_action_type(a) == _AnalyzeActionsType.MULTI_CATEGORY_CLASSIFY
],
)
analyze_body = models.AnalyzeBatchInput(
display_name=display_name, tasks=analyze_tasks, analysis_input=docs
)
return self._client.begin_analyze(
body=analyze_body,
cls=kwargs.pop(
"cls",
partial(
self._analyze_result_callback,
doc_id_order,
task_order,
show_stats=show_stats,
),
),
polling=AnalyzeActionsLROPollingMethod(
timeout=polling_interval,
show_stats=show_stats,
doc_id_order=doc_id_order,
task_id_order=task_order,
lro_algorithms=[
TextAnalyticsOperationResourcePolling(
show_stats=show_stats,
)
],
**kwargs
),
continuation_token=continuation_token,
**kwargs
)
except HttpResponseError as error:
return process_http_response_error(error)