azure-ai-textanalytics 5.3.0b2__py3-none-any.whl → 6.0.0b1__py3-none-any.whl

azure/ai/textanalytics/_generated/_operations_mixin.py

@@ -1,795 +0,0 @@
-# coding=utf-8
-# --------------------------------------------------------------------------
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License. See License.txt in the project root for
-# license information.
-#
-# Code generated by Microsoft (R) AutoRest Code Generator.
-# Changes may cause incorrect behavior and will be lost if the code is
-# regenerated.
-# --------------------------------------------------------------------------
-from ._serialization import Serializer, Deserializer
-from typing import IO, Optional, TYPE_CHECKING, Union
-
-from azure.core.polling import LROPoller
-
-from . import models as _models
-
-if TYPE_CHECKING:
-    # pylint: disable=unused-import,ungrouped-imports
-    from typing import Any, List, Union
-
-    # FIXME: have to manually reconfigure import path for multiapi operation mixin
-    from .._lro import AnalyzeActionsLROPoller, AnalyzeHealthcareEntitiesLROPoller
-
-
-class TextAnalyticsClientOperationsMixin(object):
-
-    def analyze_status(
-        self,
-        job_id,  # type: str
-        show_stats=None,  # type: Optional[bool]
-        top=20,  # type: int
-        skip=0,  # type: int
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.AnalyzeJobState
-        """Get analysis status and results.
-
-        Get the status of an analysis job.  A job may consist of one or more tasks.  Once all tasks are
-        completed, the job will transition to the completed state and results will be available for
-        each task.
-
-        :param job_id: Job ID for Analyze. Required.
-        :type job_id: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param top: (Optional) Set the maximum number of results per task. When both $top and $skip are
-         specified, $skip is applied first. Default value is 20.
-        :type top: int
-        :param skip: (Optional) Set the number of elements to offset in the response. When both $top
-         and $skip are specified, $skip is applied first. Default value is 0.
-        :type skip: int
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: AnalyzeJobState or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.AnalyzeJobState
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('analyze_status')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'analyze_status'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.analyze_status(job_id, show_stats, top, skip, **kwargs)
-
-    def analyze_text(
-        self,
-        body,  # type: Union[_models.AnalyzeTextTask, IO]
-        show_stats=None,  # type: Optional[bool]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.AnalyzeTextTaskResult
-        """Request text analysis over a collection of documents.
-
-        Submit a collection of text documents for analysis.  Specify a single unique task to be
-        executed immediately.
-
-        :param body: Collection of documents to analyze and a single task to execute. Is either a model
-         type or a IO type. Required.
-        :type body: ~azure.ai.textanalytics.v2022_05_01.models.AnalyzeTextTask or IO
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
-         Default value is None.
-        :paramtype content_type: str
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: AnalyzeTextTaskResult or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v2022_05_01.models.AnalyzeTextTaskResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('analyze_text')
-        if api_version == '2022-05-01':
-            from .v2022_05_01.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == '2022-10-01-preview':
-            from .v2022_10_01_preview.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'analyze_text'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.analyze_text(body, show_stats, **kwargs)
-
-    def analyze_text_job_status(
-        self,
-        job_id,  # type: str
-        show_stats=None,  # type: Optional[bool]
-        top=None,  # type: Optional[int]
-        skip=None,  # type: Optional[int]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.AnalyzeTextJobState
-        """Get analysis status and results.
-
-        Get the status of an analysis job.  A job may consist of one or more tasks.  Once all tasks are
-        succeeded, the job will transition to the succeeded state and results will be available for
-        each task.
-
-        :param job_id: Job ID. Required.
-        :type job_id: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param top: The maximum number of resources to return from the collection. Default value is
-         None.
-        :type top: int
-        :param skip: An offset into the collection of the first resource to be returned. Default value
-         is None.
-        :type skip: int
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: AnalyzeTextJobState or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v2022_05_01.models.AnalyzeTextJobState
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('analyze_text_job_status')
-        if api_version == '2022-05-01':
-            from .v2022_05_01.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == '2022-10-01-preview':
-            from .v2022_10_01_preview.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'analyze_text_job_status'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.analyze_text_job_status(job_id, show_stats, top, skip, **kwargs)
-
-    def begin_analyze(
-        self,
-        body=None,  # type: Optional[Union[_models.AnalyzeBatchInput, IO]]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> AnalyzeActionsLROPoller[_models.AnalyzeJobState]
-        """Submit analysis job.
-
-        Submit a collection of text documents for analysis. Specify one or more unique tasks to be
-        executed.
-
-        :param body: Collection of documents to analyze and tasks to execute. Is either a model type or
-         a IO type. Default value is None.
-        :type body: ~azure.ai.textanalytics.v3_1.models.AnalyzeBatchInput or IO
-        :keyword content_type: Body Parameter content-type. Known values are: 'application/json',
-         'text/json'. Default value is None.
-        :paramtype content_type: str
-        :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.
-        :keyword polling: By default, your polling method will be AnalyzeActionsLROPollingMethod. Pass
-         in False for this operation to not poll, or pass in your own initialized polling object for a
-         personal polling strategy.
-        :paramtype polling: bool or ~azure.core.polling.PollingMethod
-        :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
-         Retry-After header is present.
-        :return: An instance of AnalyzeActionsLROPoller that returns either AnalyzeJobState or the
-         result of cls(response)
-        :rtype: ~...._lro.AnalyzeActionsLROPoller[~azure.ai.textanalytics.v3_1.models.AnalyzeJobState]
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('begin_analyze')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'begin_analyze'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.begin_analyze(body, **kwargs)
-
-    def begin_analyze_text_cancel_job(
-        self,
-        job_id,  # type: str
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> LROPoller[None]
-        """Cancel a long-running Text Analysis job.
-
-        Cancel a long-running Text Analysis job.
-
-        :param job_id: Job ID. Required.
-        :type job_id: str
-        :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.
-        :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for
-         this operation to not poll, or pass in your own initialized polling object for a personal
-         polling strategy.
-        :paramtype polling: bool or ~azure.core.polling.PollingMethod
-        :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
-         Retry-After header is present.
-        :return: An instance of LROPoller that returns either None or the result of cls(response)
-        :rtype: ~azure.core.polling.LROPoller[None]
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('begin_analyze_text_cancel_job')
-        if api_version == '2022-05-01':
-            from .v2022_05_01.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == '2022-10-01-preview':
-            from .v2022_10_01_preview.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'begin_analyze_text_cancel_job'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.begin_analyze_text_cancel_job(job_id, **kwargs)
-
-    def begin_analyze_text_submit_job(
-        self,
-        body,  # type: Union[_models.AnalyzeTextJobsInput, IO]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> AnalyzeActionsLROPoller[_models.AnalyzeTextJobState]
-        """Submit text analysis job.
-
-        Submit a collection of text documents for analysis. Specify one or more unique tasks to be
-        executed as a long-running operation.
-
-        :param body: Collection of documents to analyze and one or more tasks to execute. Is either a
-         model type or a IO type. Required.
-        :type body: ~azure.ai.textanalytics.v2022_05_01.models.AnalyzeTextJobsInput or IO
-        :keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
-         Default value is None.
-        :paramtype content_type: str
-        :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.
-        :keyword polling: By default, your polling method will be AnalyzeActionsLROPollingMethod. Pass
-         in False for this operation to not poll, or pass in your own initialized polling object for a
-         personal polling strategy.
-        :paramtype polling: bool or ~azure.core.polling.PollingMethod
-        :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
-         Retry-After header is present.
-        :return: An instance of AnalyzeActionsLROPoller that returns either AnalyzeTextJobState or the
-         result of cls(response)
-        :rtype:
-         ~...._lro.AnalyzeActionsLROPoller[~azure.ai.textanalytics.v2022_05_01.models.AnalyzeTextJobState]
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('begin_analyze_text_submit_job')
-        if api_version == '2022-05-01':
-            from .v2022_05_01.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == '2022-10-01-preview':
-            from .v2022_10_01_preview.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'begin_analyze_text_submit_job'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.begin_analyze_text_submit_job(body, **kwargs)
-
-    def begin_cancel_health_job(
-        self,
-        job_id,  # type: str
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> LROPoller[None]
-        """Cancel healthcare prediction job.
-
-        Cancel healthcare prediction job.
-
-        :param job_id: Job ID. Required.
-        :type job_id: str
-        :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.
-        :keyword polling: By default, your polling method will be LROBasePolling. Pass in False for
-         this operation to not poll, or pass in your own initialized polling object for a personal
-         polling strategy.
-        :paramtype polling: bool or ~azure.core.polling.PollingMethod
-        :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
-         Retry-After header is present.
-        :return: An instance of LROPoller that returns either None or the result of cls(response)
-        :rtype: ~azure.core.polling.LROPoller[None]
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('begin_cancel_health_job')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'begin_cancel_health_job'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.begin_cancel_health_job(job_id, **kwargs)
-
-    def begin_health(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        string_index_type=None,  # type: Optional[Union[str, "_models.StringIndexType"]]
-        logging_opt_out=None,  # type: Optional[bool]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> AnalyzeHealthcareEntitiesLROPoller[_models.HealthcareJobState]
-        """Submit healthcare analysis job.
-
-        Start a healthcare analysis job to recognize healthcare related entities (drugs, conditions,
-        symptoms, etc) and their relations.
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :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
-         see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8",
-         "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None.
-        :type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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.
-        :keyword polling: By default, your polling method will be
-         AnalyzeHealthcareEntitiesLROPollingMethod. Pass in False for this operation to not poll, or
-         pass in your own initialized polling object for a personal polling strategy.
-        :paramtype polling: bool or ~azure.core.polling.PollingMethod
-        :keyword int polling_interval: Default waiting time between two polls for LRO operations if no
-         Retry-After header is present.
-        :return: An instance of AnalyzeHealthcareEntitiesLROPoller that returns either
-         HealthcareJobState or the result of cls(response)
-        :rtype:
-         ~...._lro.AnalyzeHealthcareEntitiesLROPoller[~azure.ai.textanalytics.v3_1.models.HealthcareJobState]
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('begin_health')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'begin_health'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.begin_health(documents, model_version, string_index_type, logging_opt_out, **kwargs)
-
-    def entities_linking(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        string_index_type=None,  # type: Optional[Union[str, "_models.StringIndexType"]]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.EntityLinkingResult
-        """Linked entities from a well known knowledge base.
-
-        The API returns a list of recognized entities with links to a well known knowledge base. See
-        the :code:`<a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a>` for
-        the list of enabled languages.
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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
-         see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8",
-         "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None.
-        :type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: EntityLinkingResult or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.EntityLinkingResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('entities_linking')
-        if api_version == 'v3.0':
-            from .v3_0.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'entities_linking'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        # FIXME: this is handwritten
-        if api_version == 'v3.0':
-            return mixin_instance.entities_linking(documents, model_version, show_stats, **kwargs)
-        elif api_version == 'v3.1':
-            return mixin_instance.entities_linking(documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs)
-
-    def entities_recognition_general(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        string_index_type=None,  # type: Optional[Union[str, "_models.StringIndexType"]]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.EntitiesResult
-        """Named Entity Recognition.
-
-        The API returns a list of general named entities in a given document. For the list of supported
-        entity types, check :code:`<a href="https://aka.ms/taner">Supported Entity Types in Text
-        Analytics API</a>`. See the :code:`<a href="https://aka.ms/talangs">Supported languages in Text
-        Analytics API</a>` for the list of enabled languages.
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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
-         see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8",
-         "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None.
-        :type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: EntitiesResult or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.EntitiesResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('entities_recognition_general')
-        if api_version == 'v3.0':
-            from .v3_0.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'entities_recognition_general'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        # FIXME: this is handwritten
-        if api_version == 'v3.0':
-            return mixin_instance.entities_recognition_general(documents, model_version, show_stats, **kwargs)
-        elif api_version == 'v3.1':
-            return mixin_instance.entities_recognition_general(documents, model_version, show_stats, logging_opt_out, string_index_type, **kwargs)
-
-    def entities_recognition_pii(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        domain=None,  # type: Optional[str]
-        string_index_type=None,  # type: Optional[Union[str, "_models.StringIndexType"]]
-        pii_categories=None,  # type: Optional[List[Union[str, "_models.PiiCategory"]]]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.PiiResult
-        """Entities containing personal information.
-
-        The API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in
-        the document. For the list of supported entity types, check :code:`<a
-        href="https://aka.ms/tanerpii">Supported Entity Types in Text Analytics API</a>`. See the
-        :code:`<a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a>` for the
-        list of enabled languages.
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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.
-        :type domain: str
-        :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
-         see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8",
-         "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None.
-        :type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType
-        :param pii_categories: (Optional) describes the PII categories to return. Default value is
-         None.
-        :type pii_categories: list[str or ~azure.ai.textanalytics.v3_1.models.PiiCategory]
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: PiiResult or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.PiiResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('entities_recognition_pii')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'entities_recognition_pii'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.entities_recognition_pii(documents, model_version, show_stats, logging_opt_out, domain, string_index_type, pii_categories, **kwargs)
-
-    def health_status(
-        self,
-        job_id,  # type: str
-        top=20,  # type: int
-        skip=0,  # type: int
-        show_stats=None,  # type: Optional[bool]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.HealthcareJobState
-        """Get healthcare analysis job status and results.
-
-        Get details of the healthcare prediction job specified by the jobId.
-
-        :param job_id: Job ID. Required.
-        :type job_id: str
-        :param top: (Optional) Set the maximum number of results per task. When both $top and $skip are
-         specified, $skip is applied first. Default value is 20.
-        :type top: int
-        :param skip: (Optional) Set the number of elements to offset in the response. When both $top
-         and $skip are specified, $skip is applied first. Default value is 0.
-        :type skip: int
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: HealthcareJobState or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.HealthcareJobState
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('health_status')
-        if api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'health_status'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        return mixin_instance.health_status(job_id, top, skip, show_stats, **kwargs)
-
-    def key_phrases(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.KeyPhraseResult
-        """Key Phrases.
-
-        The API returns a list of strings denoting the key phrases in the input text. See the :code:`<a
-        href="https://aka.ms/talangs">Supported languages in Text Analytics API</a>` for the list of
-        enabled languages.
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.KeyPhraseResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('key_phrases')
-        if api_version == 'v3.0':
-            from .v3_0.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'key_phrases'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        # FIXME: this is handwritten
-        if api_version == 'v3.0':
-            return mixin_instance.key_phrases(documents, model_version, show_stats, **kwargs)
-        elif api_version == 'v3.1':
-            return mixin_instance.key_phrases(documents, model_version, show_stats, logging_opt_out, **kwargs)
-
-    def languages(
-        self,
-        documents,  # type: List[_models.LanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.LanguageResult
-        """Detect Language.
-
-        The API returns the detected language and a numeric score between 0 and 1. Scores close to 1
-        indicate 100% certainty that the identified language is true. See the :code:`<a
-        href="https://aka.ms/talangs">Supported languages in Text Analytics API</a>` for the list of
-        enabled languages.
-
-        :param documents: Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.LanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.LanguageResult
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('languages')
-        if api_version == 'v3.0':
-            from .v3_0.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'languages'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        # FIXME: this is handwritten
-        if api_version == 'v3.0':
-            return mixin_instance.languages(documents, model_version, show_stats, **kwargs)
-        elif api_version == 'v3.1':
-            return mixin_instance.languages(documents, model_version, show_stats, logging_opt_out, **kwargs)
-
-    def sentiment(
-        self,
-        documents,  # type: List[_models.MultiLanguageInput]
-        model_version=None,  # type: Optional[str]
-        show_stats=None,  # type: Optional[bool]
-        logging_opt_out=None,  # type: Optional[bool]
-        opinion_mining=None,  # type: Optional[bool]
-        string_index_type=None,  # type: Optional[Union[str, "_models.StringIndexType"]]
-        **kwargs  # type: Any
-    ):
-        # type: (...) -> _models.SentimentResponse
-        """Sentiment.
-
-        The API returns a detailed sentiment analysis for the input text. The analysis is done in
-        multiple levels of granularity, start from the a document level, down to sentence and key terms
-        (targets and assessments).
-
-        :param documents: The set of documents to process as part of this batch. Required.
-        :type documents: list[~azure.ai.textanalytics.v3_1.models.MultiLanguageInput]
-        :param model_version: (Optional) This value indicates which model will be used for scoring. If
-         a model-version is not specified, the API should default to the latest, non-preview version.
-         Default value is None.
-        :type model_version: str
-        :param show_stats: (Optional) if set to true, response will contain request and document level
-         statistics. Default value is None.
-        :type show_stats: bool
-        :param logging_opt_out: (Optional) If set to true, you opt-out of having your text input logged
-         for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to
-         allow for troubleshooting issues in providing you with the Text Analytics 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/en-us/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
-         None.
-        :type opinion_mining: 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
-         see https://aka.ms/text-analytics-offsets. Known values are: "TextElement_v8",
-         "UnicodeCodePoint", and "Utf16CodeUnit". Default value is None.
-        :type string_index_type: str or ~azure.ai.textanalytics.v3_1.models.StringIndexType
-        :keyword callable cls: A custom type or function that will be passed the direct response
-        :return: SentimentResponse or the result of cls(response)
-        :rtype: ~azure.ai.textanalytics.v3_1.models.SentimentResponse
-        :raises ~azure.core.exceptions.HttpResponseError:
-        """
-        api_version = self._get_api_version('sentiment')
-        if api_version == 'v3.0':
-            from .v3_0.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        elif api_version == 'v3.1':
-            from .v3_1.operations import TextAnalyticsClientOperationsMixin as OperationClass
-        else:
-            raise ValueError("API version {} does not have operation 'sentiment'".format(api_version))
-        mixin_instance = OperationClass()
-        mixin_instance._client = self._client
-        mixin_instance._config = self._config
-        mixin_instance._serialize = Serializer(self._models_dict(api_version))
-        mixin_instance._serialize.client_side_validation = False
-        mixin_instance._deserialize = Deserializer(self._models_dict(api_version))
-        # FIXME: this is handwritten
-        if api_version == 'v3.0':
-            return mixin_instance.sentiment(documents, model_version, show_stats, **kwargs)
-        elif api_version == 'v3.1':
-            return mixin_instance.sentiment(documents, model_version, show_stats, logging_opt_out, opinion_mining, string_index_type, **kwargs)