From a50b9d97ef7d5663dba0452d8accc5a01ffda768 Mon Sep 17 00:00:00 2001 From: azure-sdk Date: Mon, 20 Apr 2026 06:37:42 +0000 Subject: [PATCH 01/37] Configurations: 'specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments/tspconfig.yaml', API Version: 2026-05-15-preview, SDK Release Type: beta, and CommitSHA: '0295acbed05cf1cb9f92f7307e2a049e8d7058cd' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6179116 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. --- .../azure-ai-language-documents/CHANGELOG.md | 7 + .../azure-ai-language-documents/LICENSE | 21 + .../azure-ai-language-documents/MANIFEST.in | 8 + .../azure-ai-language-documents/README.md | 43 + .../_metadata.json | 10 + .../apiview-properties.json | 59 + .../azure/__init__.py | 1 + .../azure/ai/__init__.py | 1 + .../azure/ai/language/__init__.py | 1 + .../azure/ai/language/documents/__init__.py | 32 + .../azure/ai/language/documents/_client.py | 111 + .../ai/language/documents/_configuration.py | 73 + .../documents/_operations/__init__.py | 23 + .../documents/_operations/_operations.py | 492 ++++ .../language/documents/_operations/_patch.py | 21 + .../azure/ai/language/documents/_patch.py | 21 + .../ai/language/documents/_utils/__init__.py | 6 + .../language/documents/_utils/model_base.py | 1459 ++++++++++++ .../documents/_utils/serialization.py | 2041 +++++++++++++++++ .../ai/language/documents/_utils/utils.py | 25 + .../azure/ai/language/documents/_version.py | 9 + .../ai/language/documents/aio/__init__.py | 29 + .../ai/language/documents/aio/_client.py | 115 + .../language/documents/aio/_configuration.py | 75 + .../documents/aio/_operations/__init__.py | 23 + .../documents/aio/_operations/_operations.py | 418 ++++ .../documents/aio/_operations/_patch.py | 21 + .../azure/ai/language/documents/aio/_patch.py | 21 + .../ai/language/documents/models/__init__.py | 124 + .../ai/language/documents/models/_enums.py | 920 ++++++++ .../ai/language/documents/models/_models.py | 1885 +++++++++++++++ .../ai/language/documents/models/_patch.py | 21 + .../azure/ai/language/documents/py.typed | 1 + .../dev_requirements.txt | 3 + ...ocuments_job_status_task_status_request.py | 33 + ...l_analyze_documents_jobs_cancel_request.py | 32 + ...lyze_documents_jobs_task_submit_request.py | 57 + .../generated_tests/conftest.py | 39 + .../generated_tests/test_analyze_documents.py | 55 + .../test_analyze_documents_async.py | 65 + .../generated_tests/testpreparer.py | 26 + .../generated_tests/testpreparer_async.py | 20 + .../pyproject.toml | 62 + .../tsp-location.yaml | 4 + sdk/cognitivelanguage/ci.yml | 2 + 45 files changed, 8515 insertions(+) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/CHANGELOG.md create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/LICENSE create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/MANIFEST.in create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/README.md create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_configuration.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_patch.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/serialization.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/utils.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_version.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_configuration.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_patch.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_patch.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/py.typed create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/pyproject.toml create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/CHANGELOG.md b/sdk/cognitivelanguage/azure-ai-language-documents/CHANGELOG.md new file mode 100644 index 000000000000..d49354593592 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/CHANGELOG.md @@ -0,0 +1,7 @@ +# Release History + +## 1.0.0b1 (2026-04-20) + +### Other Changes + + - Initial version \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/LICENSE b/sdk/cognitivelanguage/azure-ai-language-documents/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/MANIFEST.in b/sdk/cognitivelanguage/azure-ai-language-documents/MANIFEST.in new file mode 100644 index 000000000000..9a724f719a17 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/MANIFEST.in @@ -0,0 +1,8 @@ +include *.md +include LICENSE +include azure/ai/language/documents/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/ai/__init__.py +include azure/ai/language/__init__.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md new file mode 100644 index 000000000000..c9383e996078 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -0,0 +1,43 @@ +# Azure Ai Language Documents client library for Python + + +## Getting started + +### Install the package + +```bash +python -m pip install azure-ai-language-documents +``` + +#### Prequisites + +- Python 3.9 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Ai Language Documents instance. + + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json b/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json new file mode 100644 index 000000000000..329287a6a0cc --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json @@ -0,0 +1,10 @@ +{ + "apiVersion": "2026-05-15-preview", + "apiVersions": { + "Language.AnalyzeDocuments": "2026-05-15-preview" + }, + "commit": "0295acbed05cf1cb9f92f7307e2a049e8d7058cd", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments", + "emitterVersion": "0.61.3" +} \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json new file mode 100644 index 000000000000..ae72cbfb8e46 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json @@ -0,0 +1,59 @@ +{ + "CrossLanguagePackageId": "Language.AnalyzeDocuments", + "CrossLanguageDefinitionId": { + "azure.ai.language.documents.models.AnalyzeDocumentsLROResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", + "azure.ai.language.documents.models.AbstractiveSummarizationLROResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", + "azure.ai.language.documents.models.AnalyzeDocumentJobsInput": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", + "azure.ai.language.documents.models.AnalyzeDocumentsDocumentError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", + "azure.ai.language.documents.models.AnalyzeDocumentsJobState": "Language.AnalyzeDocuments.AnalyzeDocumentsJobState", + "azure.ai.language.documents.models.AnalyzeDocumentsLROTask": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTask", + "azure.ai.language.documents.models.AnalyzeDocumentsResult": "Language.AnalyzeDocuments.AnalyzeDocumentsResult", + "azure.ai.language.documents.models.DocumentLocation": "Language.AnalyzeDocuments.DocumentLocation", + "azure.ai.language.documents.models.AzureBlobDocumentLocation": "Language.AnalyzeDocuments.AzureBlobDocumentLocation", + "azure.ai.language.documents.models.AzureContainerDocumentLocation": "Language.AnalyzeDocuments.AzureContainerDocumentLocation", + "azure.ai.language.documents.models.AzureContainerFolderDocumentLocation": "Language.AnalyzeDocuments.AzureContainerFolderDocumentLocation", + "azure.ai.language.documents.models.BaseRedactionPolicy": "Language.AnalyzeDocuments.BaseRedactionPolicy", + "azure.ai.language.documents.models.CharacterMaskPolicy": "Language.AnalyzeDocuments.CharacterMaskPolicy", + "azure.ai.language.documents.models.ConfidenceScoreThreshold": "Language.AnalyzeDocuments.ConfidenceScoreThreshold", + "azure.ai.language.documents.models.ConfidenceScoreThresholdOverride": "Language.AnalyzeDocuments.ConfidenceScoreThresholdOverride", + "azure.ai.language.documents.models.DocumentAnalysisDocumentResult": "Language.AnalyzeDocuments.DocumentAnalysisDocumentResult", + "azure.ai.language.documents.models.DocumentStatistics": "Language.AnalyzeDocuments.DocumentStatistics", + "azure.ai.language.documents.models.DocumentWarning": "Language.AnalyzeDocuments.DocumentWarning", + "azure.ai.language.documents.models.EntityMaskPolicy": "Language.AnalyzeDocuments.EntityMaskPolicy", + "azure.ai.language.documents.models.EntitySynonym": "Language.AnalyzeDocuments.EntitySynonym", + "azure.ai.language.documents.models.EntitySynonyms": "Language.AnalyzeDocuments.EntitySynonyms", + "azure.ai.language.documents.models.Error": "Language.AnalyzeDocuments.Error", + "azure.ai.language.documents.models.ErrorResponse": "Language.AnalyzeDocuments.ErrorResponse", + "azure.ai.language.documents.models.InnerErrorModel": "Language.AnalyzeDocuments.InnerErrorModel", + "azure.ai.language.documents.models.MarkerMaskPolicy": "Language.AnalyzeDocuments.MarkerMaskPolicy", + "azure.ai.language.documents.models.MultiLanguageAnalysisInput": "Language.AnalyzeDocuments.MultiLanguageAnalysisInput", + "azure.ai.language.documents.models.MultiLanguageInput": "Language.AnalyzeDocuments.MultiLanguageInput", + "azure.ai.language.documents.models.NoMaskPolicy": "Language.AnalyzeDocuments.NoMaskPolicy", + "azure.ai.language.documents.models.PiiEntityRecognitionLROResult": "Language.AnalyzeDocuments.PiiEntityRecognitionLROResult", + "azure.ai.language.documents.models.PiiLROTask": "Language.AnalyzeDocuments.PiiLROTask", + "azure.ai.language.documents.models.PiiTaskParameters": "Language.AnalyzeDocuments.PiiTaskParameters", + "azure.ai.language.documents.models.RequestStatistics": "Language.AnalyzeDocuments.RequestStatistics", + "azure.ai.language.documents.models.SyntheticReplacementPolicyType": "Language.AnalyzeDocuments.SyntheticReplacementPolicyType", + "azure.ai.language.documents.models.Tasks": "Language.AnalyzeDocuments.Tasks", + "azure.ai.language.documents.models.ValueExclusionPolicy": "Language.AnalyzeDocuments.ValueExclusionPolicy", + "azure.ai.language.documents.models.State": "Language.AnalyzeDocuments.State", + "azure.ai.language.documents.models.ErrorCode": "Language.AnalyzeDocuments.ErrorCode", + "azure.ai.language.documents.models.InnerErrorCode": "Language.AnalyzeDocuments.InnerErrorCode", + "azure.ai.language.documents.models.AnalyzeDocumentsLROResultsKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResultsKind", + "azure.ai.language.documents.models.WarningCodeValue": "Language.AnalyzeDocuments.WarningCodeValue", + "azure.ai.language.documents.models.DocumentLocationKind": "Language.AnalyzeDocuments.DocumentLocationKind", + "azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTaskKind", + "azure.ai.language.documents.models.PiiDomain": "Language.AnalyzeDocuments.PiiDomain", + "azure.ai.language.documents.models.PiiCategoriesExtended": "Language.AnalyzeDocuments.PiiCategoriesExtended", + "azure.ai.language.documents.models.StringIndexType": "Language.AnalyzeDocuments.StringIndexType", + "azure.ai.language.documents.models.PiiCategories": "Language.AnalyzeDocuments.PiiCategories", + "azure.ai.language.documents.models.RedactionPolicyKind": "Language.AnalyzeDocuments.RedactionPolicyKind", + "azure.ai.language.documents.models.RedactionCharacter": "Language.AnalyzeDocuments.redactionCharacter", + "azure.ai.language.documents.AnalyzeDocumentsClient.analyze_documents_job_status": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.analyze_documents_job_status": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", + "azure.ai.language.documents.AnalyzeDocumentsClient.begin_analyze_documents_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_analyze_documents_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", + "azure.ai.language.documents.AnalyzeDocumentsClient.begin_analyze_documents_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_analyze_documents_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob" + } +} \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/__init__.py new file mode 100644 index 000000000000..7aa46ff83b3a --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/__init__.py @@ -0,0 +1,32 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import AnalyzeDocumentsClient # type: ignore +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AnalyzeDocumentsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py new file mode 100644 index 000000000000..ab31168f0799 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py @@ -0,0 +1,111 @@ +# pylint: disable=line-too-long,useless-suppression +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, TYPE_CHECKING, Union +from typing_extensions import Self + +from azure.core import PipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import HttpRequest, HttpResponse + +from ._configuration import AnalyzeDocumentsClientConfiguration +from ._operations import _AnalyzeDocumentsClientOperationsMixin +from ._utils.serialization import Deserializer, Serializer + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): + """The language service API is a suite of natural language processing (NLP) skills built with + best-in-class Microsoft machine learning algorithms. The API can be used to analyze + unstructured text for tasks such as sentiment analysis, key phrase extraction, language + detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview + https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + + :param endpoint: Supported Cognitive Services endpoint (e.g., + https://.api.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-05-15-preview". Default value is "2026-05-15-preview". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + _endpoint = "{Endpoint}/language" + self._config = AnalyzeDocumentsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() + + def __enter__(self) -> Self: + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_configuration.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_configuration.py new file mode 100644 index 000000000000..f16202edda6e --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_configuration.py @@ -0,0 +1,73 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials import TokenCredential + + +class AnalyzeDocumentsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for AnalyzeDocumentsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoint (e.g., + https://.api.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-05-15-preview". Default value is "2026-05-15-preview". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2026-05-15-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-language-documents/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/__init__.py new file mode 100644 index 000000000000..05ba78260df3 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/__init__.py @@ -0,0 +1,23 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _AnalyzeDocumentsClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py new file mode 100644 index 000000000000..0567d40f4d7c --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py @@ -0,0 +1,492 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, Callable, IO, Iterator, Optional, TypeVar, Union, cast, overload + +from azure.core import PipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.polling.base_polling import LROBasePolling +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._configuration import AnalyzeDocumentsClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_analyze_documents_analyze_documents_job_status_request( # pylint: disable=name-too-long + job_id: str, + *, + show_stats: Optional[bool] = None, + top: Optional[int] = None, + skip: Optional[int] = None, + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-05-15-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/analyze-documents/jobs/{jobId}" + path_format_arguments = { + "jobId": _SERIALIZER.url("job_id", job_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if show_stats is not None: + _params["showStats"] = _SERIALIZER.query("show_stats", show_stats, "bool") + if top is not None: + _params["top"] = _SERIALIZER.query("top", top, "int") + if skip is not None: + _params["skip"] = _SERIALIZER.query("skip", skip, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_analyze_documents_analyze_documents_submit_job_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-05-15-preview")) + # Construct URL + _url = "/analyze-documents/jobs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_analyze_documents_analyze_documents_cancel_job_request( # pylint: disable=name-too-long + job_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2026-05-15-preview")) + # Construct URL + _url = "/analyze-documents/jobs/{jobId}:cancel" + path_format_arguments = { + "jobId": _SERIALIZER.url("job_id", job_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="POST", url=_url, params=_params, **kwargs) + + +class _AnalyzeDocumentsClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], AnalyzeDocumentsClientConfiguration] +): + + @distributed_trace + def analyze_documents_job_status( + self, + job_id: str, + *, + show_stats: Optional[bool] = None, + top: Optional[int] = None, + skip: Optional[int] = None, + **kwargs: Any, + ) -> _models.AnalyzeDocumentsJobState: + """Get analysis status and results. + + Get the status of a document analysis job. A job can consist of one or more tasks. After all + tasks succeed, the job transitions to the succeeded state and results are available for each + task. + + :param job_id: job ID. Required. + :type job_id: str + :keyword show_stats: (Optional) if set to true, response will contain request and document + level statistics. Default value is None. + :paramtype show_stats: bool + :keyword top: The maximum number of resources to return from the collection. Default value is + None. + :paramtype top: int + :keyword skip: An offset into the collection of the first resource to be returned. Default + value is None. + :paramtype skip: int + :return: AnalyzeDocumentsJobState. The AnalyzeDocumentsJobState is compatible with + MutableMapping + :rtype: ~azure.ai.language.documents.models.AnalyzeDocumentsJobState + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AnalyzeDocumentsJobState] = kwargs.pop("cls", None) + + _request = build_analyze_documents_analyze_documents_job_status_request( + job_id=job_id, + show_stats=show_stats, + top=top, + skip=skip, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AnalyzeDocumentsJobState, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + def _analyze_documents_submit_job_initial( + self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + ) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_analyze_documents_analyze_documents_submit_job_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + def begin_analyze_documents_submit_job( + self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_analyze_documents_submit_job( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def begin_analyze_documents_submit_job( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> LROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def begin_analyze_documents_submit_job( + self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + ) -> LROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Is one of the following types: + AnalyzeDocumentJobsInput, JSON, IO[bytes] Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput or JSON or IO[bytes] + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._analyze_documents_submit_job_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> Iterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + + _request = build_analyze_documents_analyze_documents_cancel_job_request( + job_id=job_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: + """Cancel a long-running Text Analysis job. + + Cancel a long-running Text Analysis job. + + :param job_id: The job ID to cancel. Required. + :type job_id: str + :return: An instance of LROPoller that returns None + :rtype: ~azure.core.polling.LROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = self._analyze_documents_cancel_job_initial( + job_id=job_id, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + if polling is True: + polling_method: PollingMethod = cast( + PollingMethod, LROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs) + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py new file mode 100644 index 000000000000..eef4e52ed1a0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py @@ -0,0 +1,1459 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null +from azure.core.rest import HttpResponse + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") +_NONE_TYPE = type(None) + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + +_ARRAY_ENCODE_MAPPING = { + "pipeDelimited": "|", + "spaceDelimited": " ", + "commaDelimited": ",", + "newlineDelimited": "\n", +} + + +def _deserialize_array_encoded(delimit: str, attr): + if isinstance(attr, str): + if attr == "": + return [] + return attr.split(delimit) + return attr + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj # type: ignore[no-any-return] + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) # type: ignore[no-any-return] + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: + return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + # If this key has been deserialized (for mutable types), we need to handle serialization + if hasattr(self, "_attr_to_rest_field"): + cache_attr = f"_deserialized_{key}" + if hasattr(self, cache_attr): + rf = _get_rest_field(getattr(self, "_attr_to_rest_field"), key) + if rf: + value = self._data.get(key) + if isinstance(value, (dict, list, set)): + # For mutable types, serialize and return + # But also update _data with serialized form and clear flag + # so mutations via this returned value affect _data + serialized = _serialize(value, rf._format) + # If serialized form is same type (no transformation needed), + # return _data directly so mutations work + if isinstance(serialized, type(value)) and serialized == value: + return self._data.get(key) + # Otherwise return serialized copy and clear flag + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + # Store serialized form back + self._data[key] = serialized + return serialized + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + # Clear any cached deserialized value when setting through dictionary access + cache_attr = f"_deserialized_{key}" + try: + object.__delattr__(self, cache_attr) + except AttributeError: + pass + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + if isinstance(other, _MyMutableMapping): + return self._data == other._data + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + if format in _ARRAY_ENCODE_MAPPING and all(isinstance(x, str) for x in o): + return _ARRAY_ENCODE_MAPPING[format].join(o) + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + if isinstance(args[0], ET.Element): + dict_to_pass.update(self._init_from_xml(args[0])) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def _init_from_xml(self, element: ET.Element) -> dict[str, typing.Any]: + """Deserialize an XML element into a dict mapping rest field names to values. + + :param ET.Element element: The XML element to deserialize from. + :returns: A dictionary of rest_name to deserialized value pairs. + :rtype: dict + """ + result: dict[str, typing.Any] = {} + model_meta = getattr(self, "_xml", {}) + existed_attr_keys: list[str] = [] + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and element.get(xml_name) is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, element.get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + _items_name = prop_meta.get("itemsName") + if _items_name: + xml_name = _items_name + _items_ns = prop_meta.get("itemsNs") + if _items_ns is not None: + xml_ns = _items_ns + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = element.findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, items) + elif not rf._is_optional: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = [] + continue + + # text element is primitive type + if prop_meta.get("text", False): + if element.text is not None: + result[rf._rest_name] = _deserialize(rf._type, element.text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = element.find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + result[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in element: + if e.tag not in existed_attr_keys: + result[e.tag] = _convert_element(e) + + return result + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._backcompat_attr_to_rest_field: dict[str, _RestField] = { + Model._get_backcompat_attribute_name(cls._attr_to_rest_field, attr): rf + for attr, rf in cls._attr_to_rest_field.items() + } + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_backcompat_attribute_name(cls, attr_to_rest_field: dict[str, "_RestField"], attr_name: str) -> str: + rest_field_obj = attr_to_rest_field.get(attr_name) # pylint: disable=protected-access + if rest_field_obj is None: + return attr_name + original_tsp_name = getattr(rest_field_obj, "_original_tsp_name", None) # pylint: disable=protected-access + if original_tsp_name: + return original_tsp_name + return attr_name + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = _resolve_xml_ns(prop_meta, model_meta) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _is_array_encoded_deserializer(deserializer: functools.partial) -> bool: + return ( + isinstance(deserializer, functools.partial) + and isinstance(deserializer.args[0], functools.partial) + and deserializer.args[0].func == _deserialize_array_encoded # pylint: disable=comparison-with-callable + ) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + + # encoded string may be deserialized to sequence + if isinstance(obj, str) and isinstance(deserializer, functools.partial): + # for list[str] + if _is_array_encoded_deserializer(deserializer): + return deserializer(obj) + + # for list[Union[...]] + if isinstance(deserializer.args[0], list): + for sub_deserializer in deserializer.args[0]: + if _is_array_encoded_deserializer(sub_deserializer): + return sub_deserializer(obj) + + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a is _NONE_TYPE for a in annotation.__args__): # pyright: ignore + if rf: + rf._is_optional = True + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a is not _NONE_TYPE), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a is not _NONE_TYPE] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING.values(): + return deserializer(value.text) if value.text else None + if deserializer and deserializer in _DESERIALIZE_MAPPING_WITHFORMAT.values(): + return deserializer(value.text) if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value.text if isinstance(value, ET.Element) else value) + except ValueError: + # for unknown value, return raw value + return value.text if isinstance(value, ET.Element) else value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except Exception: # pylint: disable=broad-except + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +# pylint: disable=too-many-instance-attributes +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + original_tsp_name: typing.Optional[str] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._is_optional = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + self._original_tsp_name = original_tsp_name + + @property + def _class_type(self) -> typing.Any: + result = getattr(self._type, "args", [None])[0] + # type may be wrapped by nested functools.partial so we need to check for that + if isinstance(result, functools.partial): + return getattr(result, "args", [None])[0] + return result + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + # Use _data.get() directly to avoid triggering __getitem__ which clears the cache + item = obj._data.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + + # For mutable types, we want mutations to directly affect _data + # Check if we've already deserialized this value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + # Return the value from _data directly (it's been deserialized in place) + return obj._data.get(self._rest_name) + + deserialized = _deserialize(self._type, _serialize(item, self._format), rf=self) + + # For mutable types, store the deserialized value back in _data + # so mutations directly affect _data + if isinstance(deserialized, (dict, list, set)): + obj._data[self._rest_name] = deserialized + object.__setattr__(obj, cache_attr, True) # Mark as deserialized + return deserialized + + return deserialized + + def __set__(self, obj: Model, value) -> None: + # Clear the cached deserialized object when setting a new value + cache_attr = f"_deserialized_{self._rest_name}" + if hasattr(obj, cache_attr): + object.__delattr__(obj, cache_attr) + + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + original_tsp_name: typing.Optional[str] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + original_tsp_name=original_tsp_name, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_xml_ns(meta: dict[str, typing.Any]) -> typing.Optional[str]: + """Return the XML namespace from a metadata dict, checking both 'ns' (old-style) and 'namespace' (DPG) keys. + + :param dict meta: The metadata dictionary to extract namespace from. + :returns: The namespace string if 'ns' or 'namespace' key is present, None otherwise. + :rtype: str or None + """ + ns = meta.get("ns") + if ns is None: + ns = meta.get("namespace") + return ns + + +def _resolve_xml_ns( + prop_meta: dict[str, typing.Any], model_meta: typing.Optional[dict[str, typing.Any]] = None +) -> typing.Optional[str]: + """Resolve XML namespace for a property, falling back to model namespace when appropriate. + + Checks the property metadata first; if no namespace is found and the model does not declare + an explicit prefix, falls back to the model-level namespace. + + :param dict prop_meta: The property metadata dictionary. + :param dict model_meta: The model metadata dictionary, used as fallback. + :returns: The resolved namespace string, or None. + :rtype: str or None + """ + ns = _get_xml_ns(prop_meta) + if ns is None and model_meta is not None and not model_meta.get("prefix"): + ns = _get_xml_ns(model_meta) + return ns + + +def _set_xml_attribute(element: ET.Element, name: str, value: typing.Any, prop_meta: dict[str, typing.Any]) -> None: + """Set an XML attribute on an element, handling namespace prefix registration. + + :param ET.Element element: The element to set the attribute on. + :param str name: The default attribute name (wire name). + :param any value: The attribute value. + :param dict prop_meta: The property metadata dictionary. + """ + xml_name = prop_meta.get("name", name) + _attr_ns = _get_xml_ns(prop_meta) + if _attr_ns: + _attr_prefix = prop_meta.get("prefix") + if _attr_prefix: + _safe_register_namespace(_attr_prefix, _attr_ns) + xml_name = "{" + _attr_ns + "}" + xml_name + element.set(xml_name, _get_primitive_type_value(value)) + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + # When serializing as an array item (parent_meta is set), check if the parent has an + # explicit itemsName. This ensures correct element names for unwrapped arrays (where + # the element tag is the property/items name, not the model type name). + _items_name = parent_meta.get("itemsName") if parent_meta is not None else None + element_name = _items_name if _items_name else (model_meta.get("name") or o.__class__.__name__) + _model_ns = _get_xml_ns(model_meta) + wrapped_element = _create_xml_element( + element_name, + model_meta.get("prefix"), + _model_ns, + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # Propagate model namespace to properties only for old-style "ns"-keyed models. + # DPG-generated models use the "namespace" key and explicitly declare namespace on + # each property that needs it, so propagation is intentionally skipped for them. + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + _set_xml_attribute(wrapped_element, k, v, prop_meta) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + _dict_ns = _get_xml_ns(parent_meta) if parent_meta else None + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": _dict_ns, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + _items_ns = parent_meta.get("itemsNs") + if _items_ns is None: + _items_ns = _get_xml_ns(parent_meta) + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": _items_ns, + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + _meta_ns = _get_xml_ns(meta) if meta else None + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, _meta_ns + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element # type: ignore[no-any-return] + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _safe_register_namespace(prefix: str, ns: str) -> None: + """Register an XML namespace prefix, handling reserved prefix patterns. + + Some prefixes (e.g. 'ns2') match Python's reserved 'ns\\d+' pattern used for + auto-generated prefixes, causing register_namespace to raise ValueError. + Falls back to directly registering in the internal namespace map. + + :param str prefix: The namespace prefix to register. + :param str ns: The namespace URI. + """ + try: + ET.register_namespace(prefix, ns) + except ValueError: + _ns_map = getattr(ET, "_namespace_map", None) + if _ns_map is not None: + _ns_map[ns] = prefix + + +def _create_xml_element( + tag: typing.Any, prefix: typing.Optional[str] = None, ns: typing.Optional[str] = None +) -> ET.Element: + if prefix and ns: + _safe_register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/serialization.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/serialization.py new file mode 100644 index 000000000000..81ec1de5922b --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/serialization.py @@ -0,0 +1,2041 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized |= target_obj.additional_properties + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + :raises TypeError: raise if data_type is not one of str, int, float, bool. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + if data_type == "int": + return int(data) + if data_type == "float": + return float(data) + if data_type == "bool": + return bool(data) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(list[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid or data_type is not one of str, int, float, bool. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + if data_type == "int": + return int(attr) + if data_type == "float": + return float(attr) + raise TypeError("Unknown basic data type: {}".format(data_type)) + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/utils.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/utils.py new file mode 100644 index 000000000000..35c9c836f85f --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/utils.py @@ -0,0 +1,25 @@ +# -------------------------------------------------------------------------- +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import Generic, TYPE_CHECKING, TypeVar + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_version.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_version.py new file mode 100644 index 000000000000..be71c81bd282 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_version.py @@ -0,0 +1,9 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/__init__.py new file mode 100644 index 000000000000..76b9fc96acbc --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/__init__.py @@ -0,0 +1,29 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import AnalyzeDocumentsClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AnalyzeDocumentsClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore + +_patch_sdk() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py new file mode 100644 index 000000000000..513cccb77baf --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py @@ -0,0 +1,115 @@ +# pylint: disable=line-too-long,useless-suppression +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from copy import deepcopy +from typing import Any, Awaitable, TYPE_CHECKING, Union +from typing_extensions import Self + +from azure.core import AsyncPipelineClient +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._utils.serialization import Deserializer, Serializer +from ._configuration import AnalyzeDocumentsClientConfiguration +from ._operations import _AnalyzeDocumentsClientOperationsMixin + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): + """The language service API is a suite of natural language processing (NLP) skills built with + best-in-class Microsoft machine learning algorithms. The API can be used to analyze + unstructured text for tasks such as sentiment analysis, key phrase extraction, language + detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview + https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + + :param endpoint: Supported Cognitive Services endpoint (e.g., + https://.api.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-05-15-preview". Default value is "2026-05-15-preview". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + :keyword int polling_interval: Default waiting time between two polls for LRO operations if no + Retry-After header is present. + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + _endpoint = "{Endpoint}/language" + self._config = AnalyzeDocumentsClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> Self: + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_configuration.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_configuration.py new file mode 100644 index 000000000000..6c71ec0fa7ec --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_configuration.py @@ -0,0 +1,75 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING, Union + +from azure.core.credentials import AzureKeyCredential +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + from azure.core.credentials_async import AsyncTokenCredential + + +class AnalyzeDocumentsClientConfiguration: # pylint: disable=too-many-instance-attributes + """Configuration for AnalyzeDocumentsClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Supported Cognitive Services endpoint (e.g., + https://.api.cognitiveservices.azure.com). Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Is either a key + credential type or a token credential type. Required. + :type credential: ~azure.core.credentials.AzureKeyCredential or + ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Known values are + "2026-05-15-preview". Default value is "2026-05-15-preview". Note that overriding this default + value may result in unsupported behavior. + :paramtype api_version: str + """ + + def __init__( + self, endpoint: str, credential: Union[AzureKeyCredential, "AsyncTokenCredential"], **kwargs: Any + ) -> None: + api_version: str = kwargs.pop("api_version", "2026-05-15-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cognitiveservices.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "ai-language-documents/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _infer_policy(self, **kwargs): + if isinstance(self.credential, AzureKeyCredential): + return policies.AzureKeyCredentialPolicy(self.credential, "Ocp-Apim-Subscription-Key", **kwargs) + if hasattr(self.credential, "get_token"): + return policies.AsyncBearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs) + raise TypeError(f"Unsupported credential: {self.credential}") + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = self._infer_policy(**kwargs) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/__init__.py new file mode 100644 index 000000000000..05ba78260df3 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/__init__.py @@ -0,0 +1,23 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import _AnalyzeDocumentsClientOperationsMixin # type: ignore # pylint: disable=unused-import + +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py new file mode 100644 index 000000000000..264e6db877f6 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py @@ -0,0 +1,418 @@ +# pylint: disable=line-too-long,useless-suppression +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from collections.abc import MutableMapping +from io import IOBase +import json +from typing import Any, AsyncIterator, Callable, IO, Optional, TypeVar, Union, cast, overload + +from azure.core import AsyncPipelineClient +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.polling.async_base_polling import AsyncLROBasePolling +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._operations._operations import ( + build_analyze_documents_analyze_documents_cancel_job_request, + build_analyze_documents_analyze_documents_job_status_request, + build_analyze_documents_analyze_documents_submit_job_request, +) +from ..._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from ..._utils.utils import ClientMixinABC +from .._configuration import AnalyzeDocumentsClientConfiguration + +JSON = MutableMapping[str, Any] +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] + + +class _AnalyzeDocumentsClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], AnalyzeDocumentsClientConfiguration] +): + + @distributed_trace_async + async def analyze_documents_job_status( + self, + job_id: str, + *, + show_stats: Optional[bool] = None, + top: Optional[int] = None, + skip: Optional[int] = None, + **kwargs: Any + ) -> _models.AnalyzeDocumentsJobState: + """Get analysis status and results. + + Get the status of a document analysis job. A job can consist of one or more tasks. After all + tasks succeed, the job transitions to the succeeded state and results are available for each + task. + + :param job_id: job ID. Required. + :type job_id: str + :keyword show_stats: (Optional) if set to true, response will contain request and document + level statistics. Default value is None. + :paramtype show_stats: bool + :keyword top: The maximum number of resources to return from the collection. Default value is + None. + :paramtype top: int + :keyword skip: An offset into the collection of the first resource to be returned. Default + value is None. + :paramtype skip: int + :return: AnalyzeDocumentsJobState. The AnalyzeDocumentsJobState is compatible with + MutableMapping + :rtype: ~azure.ai.language.documents.models.AnalyzeDocumentsJobState + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AnalyzeDocumentsJobState] = kwargs.pop("cls", None) + + _request = build_analyze_documents_analyze_documents_job_status_request( + job_id=job_id, + show_stats=show_stats, + top=top, + skip=skip, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + if _stream: + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + else: + deserialized = _deserialize(_models.AnalyzeDocumentsJobState, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + async def _analyze_documents_submit_job_initial( + self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_analyze_documents_analyze_documents_submit_job_request( + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @overload + async def begin_analyze_documents_submit_job( + self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_analyze_documents_submit_job( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def begin_analyze_documents_submit_job( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def begin_analyze_documents_submit_job( + self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + ) -> AsyncLROPoller[None]: + """Submit a collection of text documents for analysis. Specify one or more unique tasks to be + executed as a long-running operation. + + :param body: The input for the analyze documents operation. Is one of the following types: + AnalyzeDocumentJobsInput, JSON, IO[bytes] Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput or JSON or IO[bytes] + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._analyze_documents_submit_job_initial( + body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore + + async def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> AsyncIterator[bytes]: + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + + _request = build_analyze_documents_analyze_documents_cancel_job_request( + job_id=job_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _decompress = kwargs.pop("decompress", True) + _stream = True + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [202]: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) + raise HttpResponseError(response=response, model=error) + + response_headers = {} + response_headers["Operation-Location"] = self._deserialize("str", response.headers.get("Operation-Location")) + + deserialized = response.iter_bytes() if _decompress else response.iter_raw() + + if cls: + return cls(pipeline_response, deserialized, response_headers) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[None]: + """Cancel a long-running Text Analysis job. + + Cancel a long-running Text Analysis job. + + :param job_id: The job ID to cancel. Required. + :type job_id: str + :return: An instance of AsyncLROPoller that returns None + :rtype: ~azure.core.polling.AsyncLROPoller[None] + :raises ~azure.core.exceptions.HttpResponseError: + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token: Optional[str] = kwargs.pop("continuation_token", None) + if cont_token is None: + raw_result = await self._analyze_documents_cancel_job_initial( + job_id=job_id, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs + ) + await raw_result.http_response.read() # type: ignore + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): # pylint: disable=inconsistent-return-statements + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + } + + if polling is True: + polling_method: AsyncPollingMethod = cast( + AsyncPollingMethod, + AsyncLROBasePolling(lro_delay, path_format_arguments=path_format_arguments, **kwargs), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py new file mode 100644 index 000000000000..6c46f0c471bb --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py @@ -0,0 +1,124 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position + +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + AbstractiveSummarizationLROResult, + AnalyzeDocumentJobsInput, + AnalyzeDocumentsDocumentError, + AnalyzeDocumentsJobState, + AnalyzeDocumentsLROResult, + AnalyzeDocumentsLROTask, + AnalyzeDocumentsResult, + AzureBlobDocumentLocation, + AzureContainerDocumentLocation, + AzureContainerFolderDocumentLocation, + BaseRedactionPolicy, + CharacterMaskPolicy, + ConfidenceScoreThreshold, + ConfidenceScoreThresholdOverride, + DocumentAnalysisDocumentResult, + DocumentLocation, + DocumentStatistics, + DocumentWarning, + EntityMaskPolicy, + EntitySynonym, + EntitySynonyms, + Error, + ErrorResponse, + InnerErrorModel, + MarkerMaskPolicy, + MultiLanguageAnalysisInput, + MultiLanguageInput, + NoMaskPolicy, + PiiEntityRecognitionLROResult, + PiiLROTask, + PiiTaskParameters, + RequestStatistics, + SyntheticReplacementPolicyType, + Tasks, + ValueExclusionPolicy, +) + +from ._enums import ( # type: ignore + AnalyzeDocumentsLROResultsKind, + AnalyzeDocumentsLROTaskKind, + DocumentLocationKind, + ErrorCode, + InnerErrorCode, + PiiCategories, + PiiCategoriesExtended, + PiiDomain, + RedactionCharacter, + RedactionPolicyKind, + State, + StringIndexType, + WarningCodeValue, +) +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AbstractiveSummarizationLROResult", + "AnalyzeDocumentJobsInput", + "AnalyzeDocumentsDocumentError", + "AnalyzeDocumentsJobState", + "AnalyzeDocumentsLROResult", + "AnalyzeDocumentsLROTask", + "AnalyzeDocumentsResult", + "AzureBlobDocumentLocation", + "AzureContainerDocumentLocation", + "AzureContainerFolderDocumentLocation", + "BaseRedactionPolicy", + "CharacterMaskPolicy", + "ConfidenceScoreThreshold", + "ConfidenceScoreThresholdOverride", + "DocumentAnalysisDocumentResult", + "DocumentLocation", + "DocumentStatistics", + "DocumentWarning", + "EntityMaskPolicy", + "EntitySynonym", + "EntitySynonyms", + "Error", + "ErrorResponse", + "InnerErrorModel", + "MarkerMaskPolicy", + "MultiLanguageAnalysisInput", + "MultiLanguageInput", + "NoMaskPolicy", + "PiiEntityRecognitionLROResult", + "PiiLROTask", + "PiiTaskParameters", + "RequestStatistics", + "SyntheticReplacementPolicyType", + "Tasks", + "ValueExclusionPolicy", + "AnalyzeDocumentsLROResultsKind", + "AnalyzeDocumentsLROTaskKind", + "DocumentLocationKind", + "ErrorCode", + "InnerErrorCode", + "PiiCategories", + "PiiCategoriesExtended", + "PiiDomain", + "RedactionCharacter", + "RedactionPolicyKind", + "State", + "StringIndexType", + "WarningCodeValue", +] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore +_patch_sdk() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py new file mode 100644 index 000000000000..0c81181aff54 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py @@ -0,0 +1,920 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AnalyzeDocumentsLROResultsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The kind of the response object returned by the analyze-documents long running task.""" + + PII_ENTITY_RECOGNITION_LRO_RESULTS = "PiiEntityRecognitionLROResults" + """PII entity recognition LRO results.""" + EXTRACTIVE_SUMMARIZATION_LRO_RESULTS = "ExtractiveSummarizationLROResults" + """Extractive summarization LRO results.""" + ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS = "AbstractiveSummarizationLROResults" + """Abstractive summarization LRO results.""" + + +class AnalyzeDocumentsLROTaskKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The kind of the long running analyze documents tasks supported.""" + + PII_ENTITY_RECOGNITION = "PiiEntityRecognition" + """PII entity recognition task.""" + EXTRACTIVE_SUMMARIZATION = "ExtractiveSummarization" + """Extractive summarization task.""" + ABSTRACTIVE_SUMMARIZATION = "AbstractiveSummarization" + """Abstractive summarization task.""" + + +class DocumentLocationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Enumeration of supported document locations.""" + + AZURE_BLOB = "AzureBlob" + """The document is a URL.""" + AZURE_CONTAINER = "AzureContainer" + """The document location is an Azure Blob Storage container.""" + AZURE_CONTAINER_FOLDER = "AzureContainerFolder" + """The document location is a folder within an Azure Blob Storage container.""" + + +class ErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Human-readable error code.""" + + INVALID_REQUEST = "InvalidRequest" + """Invalid request error.""" + INVALID_ARGUMENT = "InvalidArgument" + """Invalid argument error.""" + UNAUTHORIZED = "Unauthorized" + """Unauthorized access error.""" + FORBIDDEN = "Forbidden" + """Forbidden access error.""" + NOT_FOUND = "NotFound" + """Not found error.""" + PROJECT_NOT_FOUND = "ProjectNotFound" + """Project not found error.""" + OPERATION_NOT_FOUND = "OperationNotFound" + """Operation not found error.""" + AZURE_COGNITIVE_SEARCH_NOT_FOUND = "AzureCognitiveSearchNotFound" + """Azure Cognitive Search not found error.""" + AZURE_COGNITIVE_SEARCH_INDEX_NOT_FOUND = "AzureCognitiveSearchIndexNotFound" + """Azure Cognitive Search index not found error.""" + TOO_MANY_REQUESTS = "TooManyRequests" + """Too many requests error.""" + AZURE_COGNITIVE_SEARCH_THROTTLING = "AzureCognitiveSearchThrottling" + """Azure Cognitive Search throttling error.""" + AZURE_COGNITIVE_SEARCH_INDEX_LIMIT_REACHED = "AzureCognitiveSearchIndexLimitReached" + """Azure Cognitive Search index limit reached error.""" + INTERNAL_SERVER_ERROR = "InternalServerError" + """Internal server error.""" + SERVICE_UNAVAILABLE = "ServiceUnavailable" + """Service unavailable error.""" + TIMEOUT = "Timeout" + """Timeout error.""" + QUOTA_EXCEEDED = "QuotaExceeded" + """Quota exceeded error.""" + CONFLICT = "Conflict" + """Conflict error.""" + WARNING = "Warning" + """Warning error.""" + + +class InnerErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Human-readable error code.""" + + INVALID_REQUEST = "InvalidRequest" + """Invalid request error.""" + INVALID_PARAMETER_VALUE = "InvalidParameterValue" + """Invalid parameter value error.""" + KNOWLEDGE_BASE_NOT_FOUND = "KnowledgeBaseNotFound" + """Knowledge base not found error.""" + AZURE_COGNITIVE_SEARCH_NOT_FOUND = "AzureCognitiveSearchNotFound" + """Azure Cognitive Search not found error.""" + AZURE_COGNITIVE_SEARCH_THROTTLING = "AzureCognitiveSearchThrottling" + """Azure Cognitive Search throttling error.""" + EXTRACTION_FAILURE = "ExtractionFailure" + """Extraction failure error.""" + INVALID_REQUEST_BODY_FORMAT = "InvalidRequestBodyFormat" + """Invalid request body format error.""" + EMPTY_REQUEST = "EmptyRequest" + """Empty request error.""" + MISSING_INPUT_DOCUMENTS = "MissingInputDocuments" + """Missing input documents error.""" + INVALID_DOCUMENT = "InvalidDocument" + """Invalid document error.""" + MODEL_VERSION_INCORRECT = "ModelVersionIncorrect" + """Model version incorrect error.""" + INVALID_DOCUMENT_BATCH = "InvalidDocumentBatch" + """Invalid document batch error.""" + UNSUPPORTED_LANGUAGE_CODE = "UnsupportedLanguageCode" + """Unsupported language code error.""" + INVALID_COUNTRY_HINT = "InvalidCountryHint" + """Invalid country hint error.""" + + +class PiiCategories(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """(Optional) describes the PII categories to return.""" + + ABA_ROUTING_NUMBER = "ABARoutingNumber" + """ABA Routing number.""" + AR_NATIONAL_IDENTITY_NUMBER = "ARNationalIdentityNumber" + """AR National Identity Number.""" + AU_BANK_ACCOUNT_NUMBER = "AUBankAccountNumber" + """AT Identity Card.""" + AU_DRIVERS_LICENSE_NUMBER = "AUDriversLicenseNumber" + """AU Driver's License Number.""" + AU_MEDICAL_ACCOUNT_NUMBER = "AUMedicalAccountNumber" + """AU Medical Account Number.""" + AU_PASSPORT_NUMBER = "AUPassportNumber" + """AU Passport Number.""" + AU_TAX_FILE_NUMBER = "AUTaxFileNumber" + """AU Tax File Number.""" + AU_BUSINESS_NUMBER = "AUBusinessNumber" + """AU Business Number.""" + AU_COMPANY_NUMBER = "AUCompanyNumber" + """AU Company Number.""" + AT_IDENTITY_CARD = "ATIdentityCard" + """AT Identity Card.""" + AT_TAX_IDENTIFICATION_NUMBER = "ATTaxIdentificationNumber" + """AT Tax Identification Number.""" + AT_VALUE_ADDED_TAX_NUMBER = "ATValueAddedTaxNumber" + """AT Value Added Tax Number.""" + AZURE_DOCUMENT_DB_AUTH_KEY = "AzureDocumentDBAuthKey" + """Azure Document DB Auth Key.""" + AZURE_IAAS_DATABASE_CONNECTION_AND_SQL_STRING = "AzureIAASDatabaseConnectionAndSQLString" + """Azure IAAS Database Connection And SQL String.""" + AZURE_IO_T_CONNECTION_STRING = "AzureIoTConnectionString" + """Azure IoT Connection String.""" + AZURE_PUBLISH_SETTING_PASSWORD = "AzurePublishSettingPassword" + """Azure Publish Setting Password.""" + AZURE_REDIS_CACHE_STRING = "AzureRedisCacheString" + """Azure Redis Cache String.""" + AZURE_SAS = "AzureSAS" + """Azure SAS.""" + AZURE_SERVICE_BUS_STRING = "AzureServiceBusString" + """Azure Service Bus String.""" + AZURE_STORAGE_ACCOUNT_KEY = "AzureStorageAccountKey" + """Azure Storage Account Key.""" + AZURE_STORAGE_ACCOUNT_GENERIC = "AzureStorageAccountGeneric" + """Azure Storage Account Generic.""" + BE_NATIONAL_NUMBER = "BENationalNumber" + """BE National Number.""" + BE_NATIONAL_NUMBER_V2 = "BENationalNumberV2" + """BE National Number V2.""" + BE_VALUE_ADDED_TAX_NUMBER = "BEValueAddedTaxNumber" + """BE Value Added Tax Number.""" + BRCPF_NUMBER = "BRCPFNumber" + """BR CPF Number.""" + BR_LEGAL_ENTITY_NUMBER = "BRLegalEntityNumber" + """BR Legal Entity Number.""" + BR_NATIONAL_IDRG = "BRNationalIDRG" + """BR National ID RG.""" + BG_UNIFORM_CIVIL_NUMBER = "BGUniformCivilNumber" + """BG Uniform Civil Number.""" + CA_BANK_ACCOUNT_NUMBER = "CABankAccountNumber" + """CA Bank Account Number.""" + CA_DRIVERS_LICENSE_NUMBER = "CADriversLicenseNumber" + """CA Driver's License Number.""" + CA_HEALTH_SERVICE_NUMBER = "CAHealthServiceNumber" + """CA Health Service Number.""" + CA_PASSPORT_NUMBER = "CAPassportNumber" + """CA Passport Number.""" + CA_PERSONAL_HEALTH_IDENTIFICATION = "CAPersonalHealthIdentification" + """CA Personal Health Identification.""" + CA_SOCIAL_INSURANCE_NUMBER = "CASocialInsuranceNumber" + """CA Social Insurance Number.""" + CL_IDENTITY_CARD_NUMBER = "CLIdentityCardNumber" + """CL Identity Card Number.""" + CN_RESIDENT_IDENTITY_CARD_NUMBER = "CNResidentIdentityCardNumber" + """CN Resident Identity Card Number.""" + CREDIT_CARD_NUMBER = "CreditCardNumber" + """Credit Card Number.""" + HR_IDENTITY_CARD_NUMBER = "HRIdentityCardNumber" + """HR Identity Card Number.""" + HR_NATIONAL_ID_NUMBER = "HRNationalIDNumber" + """HR National ID Number.""" + HR_PERSONAL_IDENTIFICATION_NUMBER = "HRPersonalIdentificationNumber" + """HR Personal Identification Number.""" + HR_PERSONAL_IDENTIFICATION_OIB_NUMBER_V2 = "HRPersonalIdentificationOIBNumberV2" + """HR Personal Identification OIB Number V2.""" + CY_IDENTITY_CARD = "CYIdentityCard" + """CY Identity Card.""" + CY_TAX_IDENTIFICATION_NUMBER = "CYTaxIdentificationNumber" + """CY Tax Identification Number.""" + CZ_PERSONAL_IDENTITY_NUMBER = "CZPersonalIdentityNumber" + """CZ Personal Identity Number.""" + CZ_PERSONAL_IDENTITY_V2 = "CZPersonalIdentityV2" + """CZ Personal Identity V2.""" + DK_PERSONAL_IDENTIFICATION_NUMBER = "DKPersonalIdentificationNumber" + """DK Personal Identification Number.""" + DK_PERSONAL_IDENTIFICATION_V2 = "DKPersonalIdentificationV2" + """DK Personal Identification V2.""" + DRUG_ENFORCEMENT_AGENCY_NUMBER = "DrugEnforcementAgencyNumber" + """Drug Enforcement Agency Number.""" + EE_PERSONAL_IDENTIFICATION_CODE = "EEPersonalIdentificationCode" + """EE Personal Identification Code.""" + EU_DEBIT_CARD_NUMBER = "EUDebitCardNumber" + """EU Debit Card Number.""" + EU_DRIVERS_LICENSE_NUMBER = "EUDriversLicenseNumber" + """EU Driver's License Number.""" + EUGPS_COORDINATES = "EUGPSCoordinates" + """EU GPS Coordinates.""" + EU_NATIONAL_IDENTIFICATION_NUMBER = "EUNationalIdentificationNumber" + """EU National Identification Number.""" + EU_PASSPORT_NUMBER = "EUPassportNumber" + """EU Passport Number.""" + EU_SOCIAL_SECURITY_NUMBER = "EUSocialSecurityNumber" + """EU Social Security Number.""" + EU_TAX_IDENTIFICATION_NUMBER = "EUTaxIdentificationNumber" + """EU Tax Identification Number.""" + FI_EUROPEAN_HEALTH_NUMBER = "FIEuropeanHealthNumber" + """FI European Health Number.""" + FI_NATIONAL_ID = "FINationalID" + """FI National ID.""" + FI_NATIONAL_IDV2 = "FINationalIDV2" + """FI National ID V2.""" + FI_PASSPORT_NUMBER = "FIPassportNumber" + """FI Passport Number.""" + FR_DRIVERS_LICENSE_NUMBER = "FRDriversLicenseNumber" + """FR Driver's License Number.""" + FR_HEALTH_INSURANCE_NUMBER = "FRHealthInsuranceNumber" + """FR Health Insurance Number.""" + FR_NATIONAL_ID = "FRNationalID" + """FR National ID.""" + FR_PASSPORT_NUMBER = "FRPassportNumber" + """FR Passport Number.""" + FR_SOCIAL_SECURITY_NUMBER = "FRSocialSecurityNumber" + """FR Social Security Number.""" + FR_TAX_IDENTIFICATION_NUMBER = "FRTaxIdentificationNumber" + """FR Tax Identification Number.""" + FR_VALUE_ADDED_TAX_NUMBER = "FRValueAddedTaxNumber" + """FR Value Added Tax Number.""" + DE_DRIVERS_LICENSE_NUMBER = "DEDriversLicenseNumber" + """DE Driver's License Number.""" + DE_PASSPORT_NUMBER = "DEPassportNumber" + """DE Passport Number.""" + DE_IDENTITY_CARD_NUMBER = "DEIdentityCardNumber" + """DE Identity Card Number.""" + DE_TAX_IDENTIFICATION_NUMBER = "DETaxIdentificationNumber" + """DE Tax Identification Number.""" + DE_VALUE_ADDED_NUMBER = "DEValueAddedNumber" + """DE Value Added Number.""" + GR_NATIONAL_ID_CARD = "GRNationalIDCard" + """GR National ID Card.""" + GR_NATIONAL_IDV2 = "GRNationalIDV2" + """GR National ID V2.""" + GR_TAX_IDENTIFICATION_NUMBER = "GRTaxIdentificationNumber" + """GR Tax Identification Number.""" + HK_IDENTITY_CARD_NUMBER = "HKIdentityCardNumber" + """HK Identity Card Number.""" + HU_VALUE_ADDED_NUMBER = "HUValueAddedNumber" + """HU Value Added Number.""" + HU_PERSONAL_IDENTIFICATION_NUMBER = "HUPersonalIdentificationNumber" + """HU Personal Identification Number.""" + HU_TAX_IDENTIFICATION_NUMBER = "HUTaxIdentificationNumber" + """HU Tax Identification Number.""" + IN_PERMANENT_ACCOUNT = "INPermanentAccount" + """IN Permanent Account.""" + IN_UNIQUE_IDENTIFICATION_NUMBER = "INUniqueIdentificationNumber" + """IN Unique Identification Number.""" + ID_IDENTITY_CARD_NUMBER = "IDIdentityCardNumber" + """ID Identity Card Number.""" + INTERNATIONAL_BANKING_ACCOUNT_NUMBER = "InternationalBankingAccountNumber" + """International Banking Account Number.""" + IE_PERSONAL_PUBLIC_SERVICE_NUMBER = "IEPersonalPublicServiceNumber" + """IE Personal Public Service Number.""" + IE_PERSONAL_PUBLIC_SERVICE_NUMBER_V2 = "IEPersonalPublicServiceNumberV2" + """IE Personal Public Service Number V2.""" + IL_BANK_ACCOUNT_NUMBER = "ILBankAccountNumber" + """IL Bank Account Number.""" + IL_NATIONAL_ID = "ILNationalID" + """IL National ID.""" + IT_DRIVERS_LICENSE_NUMBER = "ITDriversLicenseNumber" + """IT Driver's License Number.""" + IT_FISCAL_CODE = "ITFiscalCode" + """IT Fiscal Code.""" + IT_VALUE_ADDED_TAX_NUMBER = "ITValueAddedTaxNumber" + """IT Value Added Tax Number.""" + JP_BANK_ACCOUNT_NUMBER = "JPBankAccountNumber" + """JP Bank Account Number.""" + JP_DRIVERS_LICENSE_NUMBER = "JPDriversLicenseNumber" + """JP Driver's License Number.""" + JP_PASSPORT_NUMBER = "JPPassportNumber" + """JP Passport Number.""" + JP_RESIDENT_REGISTRATION_NUMBER = "JPResidentRegistrationNumber" + """JP Resident Registration Number.""" + JP_SOCIAL_INSURANCE_NUMBER = "JPSocialInsuranceNumber" + """JP Social Insurance Number.""" + JP_MY_NUMBER_CORPORATE = "JPMyNumberCorporate" + """JP My Number Corporate.""" + JP_MY_NUMBER_PERSONAL = "JPMyNumberPersonal" + """JP My Number Personal.""" + JP_RESIDENCE_CARD_NUMBER = "JPResidenceCardNumber" + """JP Residence Card Number.""" + LV_PERSONAL_CODE = "LVPersonalCode" + """LV Personal Code.""" + LT_PERSONAL_CODE = "LTPersonalCode" + """LT Personal Code.""" + LU_NATIONAL_IDENTIFICATION_NUMBER_NATURAL = "LUNationalIdentificationNumberNatural" + """LU National Identification Number Natural.""" + LU_NATIONAL_IDENTIFICATION_NUMBER_NON_NATURAL = "LUNationalIdentificationNumberNonNatural" + """LU National Identification Number Non Natural.""" + MY_IDENTITY_CARD_NUMBER = "MYIdentityCardNumber" + """MY Identity Card Number.""" + MT_IDENTITY_CARD_NUMBER = "MTIdentityCardNumber" + """MT Identity Card Number.""" + MT_TAX_ID_NUMBER = "MTTaxIDNumber" + """MT Tax ID Number.""" + NL_CITIZENS_SERVICE_NUMBER = "NLCitizensServiceNumber" + """NL Citizens Service Number.""" + NL_CITIZENS_SERVICE_NUMBER_V2 = "NLCitizensServiceNumberV2" + """NL Citizens Service Number V2.""" + NL_TAX_IDENTIFICATION_NUMBER = "NLTaxIdentificationNumber" + """NL Tax Identification Number.""" + NL_VALUE_ADDED_TAX_NUMBER = "NLValueAddedTaxNumber" + """NL Value Added Tax Number.""" + NZ_BANK_ACCOUNT_NUMBER = "NZBankAccountNumber" + """NZ Bank Account Number.""" + NZ_DRIVERS_LICENSE_NUMBER = "NZDriversLicenseNumber" + """NZ Driver's License Number.""" + NZ_INLAND_REVENUE_NUMBER = "NZInlandRevenueNumber" + """NZ Inland Revenue Number.""" + NZ_MINISTRY_OF_HEALTH_NUMBER = "NZMinistryOfHealthNumber" + """NZ Ministry Of Health Number.""" + NZ_SOCIAL_WELFARE_NUMBER = "NZSocialWelfareNumber" + """NZ Social Welfare Number.""" + NO_IDENTITY_NUMBER = "NOIdentityNumber" + """NO Identity Number.""" + PH_UNIFIED_MULTI_PURPOSE_ID_NUMBER = "PHUnifiedMultiPurposeIDNumber" + """PH Unified Multi Purpose ID Number.""" + PL_IDENTITY_CARD = "PLIdentityCard" + """PL Identity Card.""" + PL_NATIONAL_ID = "PLNationalID" + """PL National ID.""" + PL_NATIONAL_IDV2 = "PLNationalIDV2" + """PL National ID V2.""" + PL_PASSPORT_NUMBER = "PLPassportNumber" + """PL Passport Number.""" + PL_TAX_IDENTIFICATION_NUMBER = "PLTaxIdentificationNumber" + """PL Tax Identification Number.""" + PLREGON_NUMBER = "PLREGONNumber" + """PL REGON Number.""" + PT_CITIZEN_CARD_NUMBER = "PTCitizenCardNumber" + """PT Citizen Card Number.""" + PT_CITIZEN_CARD_NUMBER_V2 = "PTCitizenCardNumberV2" + """PT Citizen Card Number V2.""" + PT_TAX_IDENTIFICATION_NUMBER = "PTTaxIdentificationNumber" + """PT Tax Identification Number.""" + RO_PERSONAL_NUMERICAL_CODE = "ROPersonalNumericalCode" + """RO Personal Numerical Code.""" + RU_PASSPORT_NUMBER_DOMESTIC = "RUPassportNumberDomestic" + """RU Passport Number Domestic.""" + RU_PASSPORT_NUMBER_INTERNATIONAL = "RUPassportNumberInternational" + """RU Passport Number International.""" + SA_NATIONAL_ID = "SANationalID" + """SA National ID.""" + SG_NATIONAL_REGISTRATION_IDENTITY_CARD_NUMBER = "SGNationalRegistrationIdentityCardNumber" + """SG National Registration Identity Card Number.""" + SK_PERSONAL_NUMBER = "SKPersonalNumber" + """SK Personal Number.""" + SI_TAX_IDENTIFICATION_NUMBER = "SITaxIdentificationNumber" + """SI Tax Identification Number.""" + SI_UNIQUE_MASTER_CITIZEN_NUMBER = "SIUniqueMasterCitizenNumber" + """SI Unique Master Citizen Number.""" + ZA_IDENTIFICATION_NUMBER = "ZAIdentificationNumber" + """ZA Identification Number.""" + KR_RESIDENT_REGISTRATION_NUMBER = "KRResidentRegistrationNumber" + """KR Resident Registration Number.""" + ESDNI = "ESDNI" + """ES DNI.""" + ES_SOCIAL_SECURITY_NUMBER = "ESSocialSecurityNumber" + """ES Social Security Number.""" + ES_TAX_IDENTIFICATION_NUMBER = "ESTaxIdentificationNumber" + """ES Tax Identification Number.""" + SQL_SERVER_CONNECTION_STRING = "SQLServerConnectionString" + """SQL Server Connection String.""" + SE_NATIONAL_ID = "SENationalID" + """SE National ID.""" + SE_NATIONAL_IDV2 = "SENationalIDV2" + """SE National ID V2.""" + SE_PASSPORT_NUMBER = "SEPassportNumber" + """SE Passport Number.""" + SE_TAX_IDENTIFICATION_NUMBER = "SETaxIdentificationNumber" + """SE Tax Identification Number.""" + SWIFT_CODE = "SWIFTCode" + """SWIFT Code.""" + CH_SOCIAL_SECURITY_NUMBER = "CHSocialSecurityNumber" + """CH Social Security Number.""" + TW_NATIONAL_ID = "TWNationalID" + """TW National ID.""" + TW_PASSPORT_NUMBER = "TWPassportNumber" + """TW Passport Number.""" + TW_RESIDENT_CERTIFICATE = "TWResidentCertificate" + """TW Resident Certificate.""" + TH_POPULATION_IDENTIFICATION_CODE = "THPopulationIdentificationCode" + """TH Population Identification Code.""" + TR_NATIONAL_IDENTIFICATION_NUMBER = "TRNationalIdentificationNumber" + """TR National Identification Number.""" + UK_DRIVERS_LICENSE_NUMBER = "UKDriversLicenseNumber" + """UK Driver's License Number.""" + UK_ELECTORAL_ROLL_NUMBER = "UKElectoralRollNumber" + """UK Electoral Roll Number.""" + UK_NATIONAL_HEALTH_NUMBER = "UKNationalHealthNumber" + """UK National Health Number.""" + UK_NATIONAL_INSURANCE_NUMBER = "UKNationalInsuranceNumber" + """UK National Insurance Number.""" + UK_UNIQUE_TAXPAYER_NUMBER = "UKUniqueTaxpayerNumber" + """UK Unique Taxpayer Number.""" + USUK_PASSPORT_NUMBER = "USUKPassportNumber" + """US UK Passport Number.""" + US_BANK_ACCOUNT_NUMBER = "USBankAccountNumber" + """US Bank Account Number.""" + US_DRIVERS_LICENSE_NUMBER = "USDriversLicenseNumber" + """US Driver's License Number.""" + US_INDIVIDUAL_TAXPAYER_IDENTIFICATION = "USIndividualTaxpayerIdentification" + """US Individual Taxpayer Identification.""" + US_SOCIAL_SECURITY_NUMBER = "USSocialSecurityNumber" + """US Social Security Number.""" + UA_PASSPORT_NUMBER_DOMESTIC = "UAPassportNumberDomestic" + """UA Passport Number Domestic.""" + UA_PASSPORT_NUMBER_INTERNATIONAL = "UAPassportNumberInternational" + """UA Passport Number International.""" + ORGANIZATION = "Organization" + """Organization.""" + EMAIL = "Email" + """Email.""" + URL = "URL" + """URL.""" + AGE = "Age" + """Age.""" + PHONE_NUMBER = "PhoneNumber" + """Phone Number.""" + IP_ADDRESS = "IPAddress" + """IP Address.""" + DATE = "Date" + """Date.""" + PERSON = "Person" + """Person.""" + ADDRESS = "Address" + """Address.""" + + +class PiiCategoriesExtended(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """(Optional) describes the PII categories to return.""" + + ABA_ROUTING_NUMBER = "ABARoutingNumber" + """ABA Routing number.""" + AR_NATIONAL_IDENTITY_NUMBER = "ARNationalIdentityNumber" + """AR National Identity Number.""" + AU_BANK_ACCOUNT_NUMBER = "AUBankAccountNumber" + """AT Identity Card.""" + AU_DRIVERS_LICENSE_NUMBER = "AUDriversLicenseNumber" + """AU Driver's License Number.""" + AU_MEDICAL_ACCOUNT_NUMBER = "AUMedicalAccountNumber" + """AU Medical Account Number.""" + AU_PASSPORT_NUMBER = "AUPassportNumber" + """AU Passport Number.""" + AU_TAX_FILE_NUMBER = "AUTaxFileNumber" + """AU Tax File Number.""" + AU_BUSINESS_NUMBER = "AUBusinessNumber" + """AU Business Number.""" + AU_COMPANY_NUMBER = "AUCompanyNumber" + """AU Company Number.""" + AT_IDENTITY_CARD = "ATIdentityCard" + """AT Identity Card.""" + AT_TAX_IDENTIFICATION_NUMBER = "ATTaxIdentificationNumber" + """AT Tax Identification Number.""" + AT_VALUE_ADDED_TAX_NUMBER = "ATValueAddedTaxNumber" + """AT Value Added Tax Number.""" + AZURE_DOCUMENT_DB_AUTH_KEY = "AzureDocumentDBAuthKey" + """Azure Document DB Auth Key.""" + AZURE_IAAS_DATABASE_CONNECTION_AND_SQL_STRING = "AzureIAASDatabaseConnectionAndSQLString" + """Azure IAAS Database Connection And SQL String.""" + AZURE_IO_T_CONNECTION_STRING = "AzureIoTConnectionString" + """Azure IoT Connection String.""" + AZURE_PUBLISH_SETTING_PASSWORD = "AzurePublishSettingPassword" + """Azure Publish Setting Password.""" + AZURE_REDIS_CACHE_STRING = "AzureRedisCacheString" + """Azure Redis Cache String.""" + AZURE_SAS = "AzureSAS" + """Azure SAS.""" + AZURE_SERVICE_BUS_STRING = "AzureServiceBusString" + """Azure Service Bus String.""" + AZURE_STORAGE_ACCOUNT_KEY = "AzureStorageAccountKey" + """Azure Storage Account Key.""" + AZURE_STORAGE_ACCOUNT_GENERIC = "AzureStorageAccountGeneric" + """Azure Storage Account Generic.""" + BE_NATIONAL_NUMBER = "BENationalNumber" + """BE National Number.""" + BE_NATIONAL_NUMBER_V2 = "BENationalNumberV2" + """BE National Number V2.""" + BE_VALUE_ADDED_TAX_NUMBER = "BEValueAddedTaxNumber" + """BE Value Added Tax Number.""" + BRCPF_NUMBER = "BRCPFNumber" + """BR CPF Number.""" + BR_LEGAL_ENTITY_NUMBER = "BRLegalEntityNumber" + """BR Legal Entity Number.""" + BR_NATIONAL_IDRG = "BRNationalIDRG" + """BR National ID RG.""" + BG_UNIFORM_CIVIL_NUMBER = "BGUniformCivilNumber" + """BG Uniform Civil Number.""" + CA_BANK_ACCOUNT_NUMBER = "CABankAccountNumber" + """CA Bank Account Number.""" + CA_DRIVERS_LICENSE_NUMBER = "CADriversLicenseNumber" + """CA Driver's License Number.""" + CA_HEALTH_SERVICE_NUMBER = "CAHealthServiceNumber" + """CA Health Service Number.""" + CA_PASSPORT_NUMBER = "CAPassportNumber" + """CA Passport Number.""" + CA_PERSONAL_HEALTH_IDENTIFICATION = "CAPersonalHealthIdentification" + """CA Personal Health Identification.""" + CA_SOCIAL_INSURANCE_NUMBER = "CASocialInsuranceNumber" + """CA Social Insurance Number.""" + CL_IDENTITY_CARD_NUMBER = "CLIdentityCardNumber" + """CL Identity Card Number.""" + CN_RESIDENT_IDENTITY_CARD_NUMBER = "CNResidentIdentityCardNumber" + """CN Resident Identity Card Number.""" + CREDIT_CARD_NUMBER = "CreditCardNumber" + """Credit Card Number.""" + HR_IDENTITY_CARD_NUMBER = "HRIdentityCardNumber" + """HR Identity Card Number.""" + HR_NATIONAL_ID_NUMBER = "HRNationalIDNumber" + """HR National ID Number.""" + HR_PERSONAL_IDENTIFICATION_NUMBER = "HRPersonalIdentificationNumber" + """HR Personal Identification Number.""" + HR_PERSONAL_IDENTIFICATION_OIB_NUMBER_V2 = "HRPersonalIdentificationOIBNumberV2" + """HR Personal Identification OIB Number V2.""" + CY_IDENTITY_CARD = "CYIdentityCard" + """CY Identity Card.""" + CY_TAX_IDENTIFICATION_NUMBER = "CYTaxIdentificationNumber" + """CY Tax Identification Number.""" + CZ_PERSONAL_IDENTITY_NUMBER = "CZPersonalIdentityNumber" + """CZ Personal Identity Number.""" + CZ_PERSONAL_IDENTITY_V2 = "CZPersonalIdentityV2" + """CZ Personal Identity V2.""" + DK_PERSONAL_IDENTIFICATION_NUMBER = "DKPersonalIdentificationNumber" + """DK Personal Identification Number.""" + DK_PERSONAL_IDENTIFICATION_V2 = "DKPersonalIdentificationV2" + """DK Personal Identification V2.""" + DRUG_ENFORCEMENT_AGENCY_NUMBER = "DrugEnforcementAgencyNumber" + """Drug Enforcement Agency Number.""" + EE_PERSONAL_IDENTIFICATION_CODE = "EEPersonalIdentificationCode" + """EE Personal Identification Code.""" + EU_DEBIT_CARD_NUMBER = "EUDebitCardNumber" + """EU Debit Card Number.""" + EU_DRIVERS_LICENSE_NUMBER = "EUDriversLicenseNumber" + """EU Driver's License Number.""" + EUGPS_COORDINATES = "EUGPSCoordinates" + """EU GPS Coordinates.""" + EU_NATIONAL_IDENTIFICATION_NUMBER = "EUNationalIdentificationNumber" + """EU National Identification Number.""" + EU_PASSPORT_NUMBER = "EUPassportNumber" + """EU Passport Number.""" + EU_SOCIAL_SECURITY_NUMBER = "EUSocialSecurityNumber" + """EU Social Security Number.""" + EU_TAX_IDENTIFICATION_NUMBER = "EUTaxIdentificationNumber" + """EU Tax Identification Number.""" + FI_EUROPEAN_HEALTH_NUMBER = "FIEuropeanHealthNumber" + """FI European Health Number.""" + FI_NATIONAL_ID = "FINationalID" + """FI National ID.""" + FI_NATIONAL_IDV2 = "FINationalIDV2" + """FI National ID V2.""" + FI_PASSPORT_NUMBER = "FIPassportNumber" + """FI Passport Number.""" + FR_DRIVERS_LICENSE_NUMBER = "FRDriversLicenseNumber" + """FR Driver's License Number.""" + FR_HEALTH_INSURANCE_NUMBER = "FRHealthInsuranceNumber" + """FR Health Insurance Number.""" + FR_NATIONAL_ID = "FRNationalID" + """FR National ID.""" + FR_PASSPORT_NUMBER = "FRPassportNumber" + """FR Passport Number.""" + FR_SOCIAL_SECURITY_NUMBER = "FRSocialSecurityNumber" + """FR Social Security Number.""" + FR_TAX_IDENTIFICATION_NUMBER = "FRTaxIdentificationNumber" + """FR Tax Identification Number.""" + FR_VALUE_ADDED_TAX_NUMBER = "FRValueAddedTaxNumber" + """FR Value Added Tax Number.""" + DE_DRIVERS_LICENSE_NUMBER = "DEDriversLicenseNumber" + """DE Driver's License Number.""" + DE_PASSPORT_NUMBER = "DEPassportNumber" + """DE Passport Number.""" + DE_IDENTITY_CARD_NUMBER = "DEIdentityCardNumber" + """DE Identity Card Number.""" + DE_TAX_IDENTIFICATION_NUMBER = "DETaxIdentificationNumber" + """DE Tax Identification Number.""" + DE_VALUE_ADDED_NUMBER = "DEValueAddedNumber" + """DE Value Added Number.""" + GR_NATIONAL_ID_CARD = "GRNationalIDCard" + """GR National ID Card.""" + GR_NATIONAL_IDV2 = "GRNationalIDV2" + """GR National ID V2.""" + GR_TAX_IDENTIFICATION_NUMBER = "GRTaxIdentificationNumber" + """GR Tax Identification Number.""" + HK_IDENTITY_CARD_NUMBER = "HKIdentityCardNumber" + """HK Identity Card Number.""" + HU_VALUE_ADDED_NUMBER = "HUValueAddedNumber" + """HU Value Added Number.""" + HU_PERSONAL_IDENTIFICATION_NUMBER = "HUPersonalIdentificationNumber" + """HU Personal Identification Number.""" + HU_TAX_IDENTIFICATION_NUMBER = "HUTaxIdentificationNumber" + """HU Tax Identification Number.""" + IN_PERMANENT_ACCOUNT = "INPermanentAccount" + """IN Permanent Account.""" + IN_UNIQUE_IDENTIFICATION_NUMBER = "INUniqueIdentificationNumber" + """IN Unique Identification Number.""" + ID_IDENTITY_CARD_NUMBER = "IDIdentityCardNumber" + """ID Identity Card Number.""" + INTERNATIONAL_BANKING_ACCOUNT_NUMBER = "InternationalBankingAccountNumber" + """International Banking Account Number.""" + IE_PERSONAL_PUBLIC_SERVICE_NUMBER = "IEPersonalPublicServiceNumber" + """IE Personal Public Service Number.""" + IE_PERSONAL_PUBLIC_SERVICE_NUMBER_V2 = "IEPersonalPublicServiceNumberV2" + """IE Personal Public Service Number V2.""" + IL_BANK_ACCOUNT_NUMBER = "ILBankAccountNumber" + """IL Bank Account Number.""" + IL_NATIONAL_ID = "ILNationalID" + """IL National ID.""" + IT_DRIVERS_LICENSE_NUMBER = "ITDriversLicenseNumber" + """IT Driver's License Number.""" + IT_FISCAL_CODE = "ITFiscalCode" + """IT Fiscal Code.""" + IT_VALUE_ADDED_TAX_NUMBER = "ITValueAddedTaxNumber" + """IT Value Added Tax Number.""" + JP_BANK_ACCOUNT_NUMBER = "JPBankAccountNumber" + """JP Bank Account Number.""" + JP_DRIVERS_LICENSE_NUMBER = "JPDriversLicenseNumber" + """JP Driver's License Number.""" + JP_PASSPORT_NUMBER = "JPPassportNumber" + """JP Passport Number.""" + JP_RESIDENT_REGISTRATION_NUMBER = "JPResidentRegistrationNumber" + """JP Resident Registration Number.""" + JP_SOCIAL_INSURANCE_NUMBER = "JPSocialInsuranceNumber" + """JP Social Insurance Number.""" + JP_MY_NUMBER_CORPORATE = "JPMyNumberCorporate" + """JP My Number Corporate.""" + JP_MY_NUMBER_PERSONAL = "JPMyNumberPersonal" + """JP My Number Personal.""" + JP_RESIDENCE_CARD_NUMBER = "JPResidenceCardNumber" + """JP Residence Card Number.""" + LV_PERSONAL_CODE = "LVPersonalCode" + """LV Personal Code.""" + LT_PERSONAL_CODE = "LTPersonalCode" + """LT Personal Code.""" + LU_NATIONAL_IDENTIFICATION_NUMBER_NATURAL = "LUNationalIdentificationNumberNatural" + """LU National Identification Number Natural.""" + LU_NATIONAL_IDENTIFICATION_NUMBER_NON_NATURAL = "LUNationalIdentificationNumberNonNatural" + """LU National Identification Number Non Natural.""" + MY_IDENTITY_CARD_NUMBER = "MYIdentityCardNumber" + """MY Identity Card Number.""" + MT_IDENTITY_CARD_NUMBER = "MTIdentityCardNumber" + """MT Identity Card Number.""" + MT_TAX_ID_NUMBER = "MTTaxIDNumber" + """MT Tax ID Number.""" + NL_CITIZENS_SERVICE_NUMBER = "NLCitizensServiceNumber" + """NL Citizens Service Number.""" + NL_CITIZENS_SERVICE_NUMBER_V2 = "NLCitizensServiceNumberV2" + """NL Citizens Service Number V2.""" + NL_TAX_IDENTIFICATION_NUMBER = "NLTaxIdentificationNumber" + """NL Tax Identification Number.""" + NL_VALUE_ADDED_TAX_NUMBER = "NLValueAddedTaxNumber" + """NL Value Added Tax Number.""" + NZ_BANK_ACCOUNT_NUMBER = "NZBankAccountNumber" + """NZ Bank Account Number.""" + NZ_DRIVERS_LICENSE_NUMBER = "NZDriversLicenseNumber" + """NZ Driver's License Number.""" + NZ_INLAND_REVENUE_NUMBER = "NZInlandRevenueNumber" + """NZ Inland Revenue Number.""" + NZ_MINISTRY_OF_HEALTH_NUMBER = "NZMinistryOfHealthNumber" + """NZ Ministry Of Health Number.""" + NZ_SOCIAL_WELFARE_NUMBER = "NZSocialWelfareNumber" + """NZ Social Welfare Number.""" + NO_IDENTITY_NUMBER = "NOIdentityNumber" + """NO Identity Number.""" + PH_UNIFIED_MULTI_PURPOSE_ID_NUMBER = "PHUnifiedMultiPurposeIDNumber" + """PH Unified Multi Purpose ID Number.""" + PL_IDENTITY_CARD = "PLIdentityCard" + """PL Identity Card.""" + PL_NATIONAL_ID = "PLNationalID" + """PL National ID.""" + PL_NATIONAL_IDV2 = "PLNationalIDV2" + """PL National ID V2.""" + PL_PASSPORT_NUMBER = "PLPassportNumber" + """PL Passport Number.""" + PL_TAX_IDENTIFICATION_NUMBER = "PLTaxIdentificationNumber" + """PL Tax Identification Number.""" + PLREGON_NUMBER = "PLREGONNumber" + """PL REGON Number.""" + PT_CITIZEN_CARD_NUMBER = "PTCitizenCardNumber" + """PT Citizen Card Number.""" + PT_CITIZEN_CARD_NUMBER_V2 = "PTCitizenCardNumberV2" + """PT Citizen Card Number V2.""" + PT_TAX_IDENTIFICATION_NUMBER = "PTTaxIdentificationNumber" + """PT Tax Identification Number.""" + RO_PERSONAL_NUMERICAL_CODE = "ROPersonalNumericalCode" + """RO Personal Numerical Code.""" + RU_PASSPORT_NUMBER_DOMESTIC = "RUPassportNumberDomestic" + """RU Passport Number Domestic.""" + RU_PASSPORT_NUMBER_INTERNATIONAL = "RUPassportNumberInternational" + """RU Passport Number International.""" + SA_NATIONAL_ID = "SANationalID" + """SA National ID.""" + SG_NATIONAL_REGISTRATION_IDENTITY_CARD_NUMBER = "SGNationalRegistrationIdentityCardNumber" + """SG National Registration Identity Card Number.""" + SK_PERSONAL_NUMBER = "SKPersonalNumber" + """SK Personal Number.""" + SI_TAX_IDENTIFICATION_NUMBER = "SITaxIdentificationNumber" + """SI Tax Identification Number.""" + SI_UNIQUE_MASTER_CITIZEN_NUMBER = "SIUniqueMasterCitizenNumber" + """SI Unique Master Citizen Number.""" + ZA_IDENTIFICATION_NUMBER = "ZAIdentificationNumber" + """ZA Identification Number.""" + KR_RESIDENT_REGISTRATION_NUMBER = "KRResidentRegistrationNumber" + """KR Resident Registration Number.""" + ESDNI = "ESDNI" + """ES DNI.""" + ES_SOCIAL_SECURITY_NUMBER = "ESSocialSecurityNumber" + """ES Social Security Number.""" + ES_TAX_IDENTIFICATION_NUMBER = "ESTaxIdentificationNumber" + """ES Tax Identification Number.""" + SQL_SERVER_CONNECTION_STRING = "SQLServerConnectionString" + """SQL Server Connection String.""" + SE_NATIONAL_ID = "SENationalID" + """SE National ID.""" + SE_NATIONAL_IDV2 = "SENationalIDV2" + """SE National ID V2.""" + SE_PASSPORT_NUMBER = "SEPassportNumber" + """SE Passport Number.""" + SE_TAX_IDENTIFICATION_NUMBER = "SETaxIdentificationNumber" + """SE Tax Identification Number.""" + SWIFT_CODE = "SWIFTCode" + """SWIFT Code.""" + CH_SOCIAL_SECURITY_NUMBER = "CHSocialSecurityNumber" + """CH Social Security Number.""" + TW_NATIONAL_ID = "TWNationalID" + """TW National ID.""" + TW_PASSPORT_NUMBER = "TWPassportNumber" + """TW Passport Number.""" + TW_RESIDENT_CERTIFICATE = "TWResidentCertificate" + """TW Resident Certificate.""" + TH_POPULATION_IDENTIFICATION_CODE = "THPopulationIdentificationCode" + """TH Population Identification Code.""" + TR_NATIONAL_IDENTIFICATION_NUMBER = "TRNationalIdentificationNumber" + """TR National Identification Number.""" + UK_DRIVERS_LICENSE_NUMBER = "UKDriversLicenseNumber" + """UK Driver's License Number.""" + UK_ELECTORAL_ROLL_NUMBER = "UKElectoralRollNumber" + """UK Electoral Roll Number.""" + UK_NATIONAL_HEALTH_NUMBER = "UKNationalHealthNumber" + """UK National Health Number.""" + UK_NATIONAL_INSURANCE_NUMBER = "UKNationalInsuranceNumber" + """UK National Insurance Number.""" + UK_UNIQUE_TAXPAYER_NUMBER = "UKUniqueTaxpayerNumber" + """UK Unique Taxpayer Number.""" + USUK_PASSPORT_NUMBER = "USUKPassportNumber" + """US UK Passport Number.""" + US_BANK_ACCOUNT_NUMBER = "USBankAccountNumber" + """US Bank Account Number.""" + US_DRIVERS_LICENSE_NUMBER = "USDriversLicenseNumber" + """US Driver's License Number.""" + US_INDIVIDUAL_TAXPAYER_IDENTIFICATION = "USIndividualTaxpayerIdentification" + """US Individual Taxpayer Identification.""" + US_SOCIAL_SECURITY_NUMBER = "USSocialSecurityNumber" + """US Social Security Number.""" + UA_PASSPORT_NUMBER_DOMESTIC = "UAPassportNumberDomestic" + """UA Passport Number Domestic.""" + UA_PASSPORT_NUMBER_INTERNATIONAL = "UAPassportNumberInternational" + """UA Passport Number International.""" + ORGANIZATION = "Organization" + """Organization.""" + EMAIL = "Email" + """Email.""" + URL = "URL" + """URL.""" + AGE = "Age" + """Age.""" + PHONE_NUMBER = "PhoneNumber" + """Phone Number.""" + IP_ADDRESS = "IPAddress" + """IP Address.""" + DATE = "Date" + """Date.""" + PERSON = "Person" + """Person.""" + ADDRESS = "Address" + """Address.""" + ALL = "All" + """All PII categories.""" + DEFAULT = "Default" + """Default PII categories for the language.""" + + +class PiiDomain(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """PII domains.""" + + PHI = "phi" + """Indicates that entities in the Personal Health Information domain should be redacted.""" + NONE = "none" + """Indicates that no domain is specified.""" + + +class RedactionCharacter(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Optional parameter to use a Custom Character to be used for redaction in PII responses. Default + character will be * as before. We allow specific ascii characters for redaction. + """ + + EXCLAMATION_POINT = "!" + """Exclamation point character.""" + NUMBER_SIGN = "#" + """Number sign character.""" + DOLLAR = "$" + """Dollar sign character.""" + PER_CENT = "%" + """Percent sign character.""" + AMPERSAND = "&" + """Ampersand character.""" + ASTERISK = "*" + """Asterisk character.""" + PLUS = "+" + """Plus sign character.""" + MINUS = "-" + """Minus sign character.""" + EQUALS = "=" + """Equals sign character.""" + QUESTION_MARK = "?" + """Question mark character.""" + AT_SIGN = "@" + """At sign character.""" + CARET = "^" + """Caret character.""" + UNDERSCORE = "_" + """Underscore character.""" + TILDE = "~" + """Tilde character.""" + + +class RedactionPolicyKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Kinds of redaction policies supported.""" + + NO_MASK = "noMask" + """Do not redact detected entities.""" + CHARACTER_MASK = "characterMask" + """React detected entities with redaction character.""" + ENTITY_MASK = "entityMask" + """Redact detected entities with entity type.""" + MARKER_MASK = "markerMask" + """Redact detected entities using a marker-style mask.""" + SYNTHETIC_REPLACEMENT = "syntheticReplacement" + """Replace detected entities with synthetic values.""" + + +class State(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The status of the task at the mentioned last update time.""" + + NOT_STARTED = "notStarted" + """Not started status.""" + RUNNING = "running" + """Running status.""" + SUCCEEDED = "succeeded" + """Succeeded status.""" + PARTIALLY_COMPLETED = "partiallyCompleted" + """Partially completed status.""" + FAILED = "failed" + """Failed status.""" + CANCELLED = "cancelled" + """Cancelled status.""" + CANCELLING = "cancelling" + """Cancelling status.""" + + +class StringIndexType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Specifies the method used to interpret string offsets. Defaults to documents Elements + (Graphemes) according to Unicode v8.0.0. For additional information see + `https://aka.ms/documents-analytics-offsets `_. + """ + + TEXT_ELEMENTS_V8 = "TextElements_v8" + """Returned offset and length values will correspond to textElements (Graphemes and Grapheme + clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is + written in .Net Framework or .Net Core and you will be using StringInfo.""" + UNICODE_CODE_POINT = "UnicodeCodePoint" + """Returned offset and length values will correspond to Unicode code points. Use this option if + your application is written in a language that support Unicode, for example Python.""" + UTF16_CODE_UNIT = "Utf16CodeUnit" + """Returned offset and length values will correspond to UTF-16 code units. Use this option if your + application is written in a language that support Unicode, for example Java, JavaScript.""" + + +class WarningCodeValue(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Defines the list of the warning codes.""" + + LONG_WORDS_IN_DOCUMENT = "LongWordsInDocument" + """Long words in document warning.""" + DOCUMENT_TRUNCATED = "DocumentTruncated" + """Document truncated warning.""" diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py new file mode 100644 index 000000000000..92cd8001f32e --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py @@ -0,0 +1,1885 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation + +import datetime +from typing import Any, Literal, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .._utils.model_base import Model as _Model, rest_discriminator, rest_field +from ._enums import ( + AnalyzeDocumentsLROResultsKind, + AnalyzeDocumentsLROTaskKind, + DocumentLocationKind, + RedactionPolicyKind, +) + +if TYPE_CHECKING: + from .. import models as _models + + +class AnalyzeDocumentsLROResult(_Model): + """Contains the AnalyzeDocuments long running operation result object. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + AbstractiveSummarizationLROResult, PiiEntityRecognitionLROResult + + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: Kind of the task. Required. Known values are: "PiiEntityRecognitionLROResults", + "ExtractiveSummarizationLROResults", and "AbstractiveSummarizationLROResults". + :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROResultsKind + """ + + __mapping__: dict[str, _Model] = {} + last_update_date_time: datetime.datetime = rest_field( + name="lastUpdateDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The last updated time in UTC for the task. Required.""" + status: Union[str, "_models.State"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The status of the task at the mentioned last update time. Required. Known values are: + \"notStarted\", \"running\", \"succeeded\", \"partiallyCompleted\", \"failed\", \"cancelled\", + and \"cancelling\".""" + task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) + """task name.""" + kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) + """Kind of the task. Required. Known values are: \"PiiEntityRecognitionLROResults\", + \"ExtractiveSummarizationLROResults\", and \"AbstractiveSummarizationLROResults\".""" + + @overload + def __init__( + self, + *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + kind: str, + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AbstractiveSummarizationLROResult(AnalyzeDocumentsLROResult, discriminator="AbstractiveSummarizationLROResults"): + """An object representing the results for an Abstractive Summarization task. + + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: Kind of the task. Required. Abstractive summarization LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS + :ivar results: Results of the task. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + """ + + kind: Literal[AnalyzeDocumentsLROResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. Abstractive summarization LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Results of the task. Required.""" + + @overload + def __init__( + self, + *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore + + +class AnalyzeDocumentJobsInput(_Model): + """The input object for the analyze documents LRO. + + :ivar display_name: Name for the task. + :vartype display_name: str + :ivar analysis_input: Contains the input to be analyzed. Required. + :vartype analysis_input: ~azure.ai.language.documents.models.MultiLanguageAnalysisInput + :ivar tasks: List of tasks to be performed as part of the LRO. Required. + :vartype tasks: list[~azure.ai.language.documents.models.AnalyzeDocumentsLROTask] + :ivar default_language: Default language to use for records. + :vartype default_language: str + """ + + display_name: Optional[str] = rest_field( + name="displayName", visibility=["read", "create", "update", "delete", "query"] + ) + """Name for the task.""" + analysis_input: "_models.MultiLanguageAnalysisInput" = rest_field( + name="analysisInput", visibility=["read", "create", "update", "delete", "query"] + ) + """Contains the input to be analyzed. Required.""" + tasks: list["_models.AnalyzeDocumentsLROTask"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """List of tasks to be performed as part of the LRO. Required.""" + default_language: Optional[str] = rest_field( + name="defaultLanguage", visibility=["read", "create", "update", "delete", "query"] + ) + """Default language to use for records.""" + + @overload + def __init__( + self, + *, + analysis_input: "_models.MultiLanguageAnalysisInput", + tasks: list["_models.AnalyzeDocumentsLROTask"], + display_name: Optional[str] = None, + default_language: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AnalyzeDocumentsDocumentError(_Model): + """Contains the error object with errors encountered for the processed document. + + :ivar id: Document Id. Required. + :vartype id: str + :ivar error: Document Error. Required. + :vartype error: ~azure.ai.language.documents.models.Error + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Document Id. Required.""" + error: "_models.Error" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Document Error. Required.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + error: "_models.Error", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AnalyzeDocumentsJobState(_Model): + """The object containing the analyze job LRO job state. + + :ivar display_name: display name. + :vartype display_name: str + :ivar created_date_time: Date and time job created. Required. + :vartype created_date_time: ~datetime.datetime + :ivar expiration_date_time: Date and time job expires. + :vartype expiration_date_time: ~datetime.datetime + :ivar job_id: job ID. Required. + :vartype job_id: str + :ivar last_updated_date_time: last updated date and time. Required. + :vartype last_updated_date_time: ~datetime.datetime + :ivar status: status. Required. Known values are: "notStarted", "running", "succeeded", + "partiallyCompleted", "failed", "cancelled", and "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State + :ivar errors: errors. + :vartype errors: list[~azure.ai.language.documents.models.Error] + :ivar next_link: next link. + :vartype next_link: str + :ivar tasks: List of tasks. Required. + :vartype tasks: ~azure.ai.language.documents.models.Tasks + :ivar statistics: if showStats=true was specified in the request this field will contain + information about the request payload. + :vartype statistics: ~azure.ai.language.documents.models.RequestStatistics + """ + + display_name: Optional[str] = rest_field( + name="displayName", visibility=["read", "create", "update", "delete", "query"] + ) + """display name.""" + created_date_time: datetime.datetime = rest_field( + name="createdDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """Date and time job created. Required.""" + expiration_date_time: Optional[datetime.datetime] = rest_field( + name="expirationDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """Date and time job expires.""" + job_id: str = rest_field(name="jobId", visibility=["read"]) + """job ID. Required.""" + last_updated_date_time: datetime.datetime = rest_field( + name="lastUpdatedDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """last updated date and time. Required.""" + status: Union[str, "_models.State"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """status. Required. Known values are: \"notStarted\", \"running\", \"succeeded\", + \"partiallyCompleted\", \"failed\", \"cancelled\", and \"cancelling\".""" + errors: Optional[list["_models.Error"]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """errors.""" + next_link: Optional[str] = rest_field(name="nextLink", visibility=["read", "create", "update", "delete", "query"]) + """next link.""" + tasks: "_models.Tasks" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """List of tasks. Required.""" + statistics: Optional["_models.RequestStatistics"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """if showStats=true was specified in the request this field will contain information about the + request payload.""" + + @overload + def __init__( + self, + *, + created_date_time: datetime.datetime, + last_updated_date_time: datetime.datetime, + status: Union[str, "_models.State"], + tasks: "_models.Tasks", + display_name: Optional[str] = None, + expiration_date_time: Optional[datetime.datetime] = None, + errors: Optional[list["_models.Error"]] = None, + next_link: Optional[str] = None, + statistics: Optional["_models.RequestStatistics"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AnalyzeDocumentsLROTask(_Model): + """The long running task to be performed by the service on the input documents. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + PiiLROTask + + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: The kind of task to perform. Required. Known values are: "PiiEntityRecognition", + "ExtractiveSummarization", and "AbstractiveSummarization". + :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind + """ + + __mapping__: dict[str, _Model] = {} + task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) + """task name.""" + kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) + """The kind of task to perform. Required. Known values are: \"PiiEntityRecognition\", + \"ExtractiveSummarization\", and \"AbstractiveSummarization\".""" + + @overload + def __init__( + self, + *, + kind: str, + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AnalyzeDocumentsResult(_Model): + """Contains the result object for the processed document. + + :ivar errors: Errors by document id. Required. + :vartype errors: list[~azure.ai.language.documents.models.AnalyzeDocumentsDocumentError] + :ivar statistics: if showStats=true was specified in the request this field will contain + information about the request payload. + :vartype statistics: ~azure.ai.language.documents.models.RequestStatistics + :ivar model_version: This field indicates which model is used for analysis. Required. + :vartype model_version: str + :ivar documents: Response by document. Required. + :vartype documents: list[~azure.ai.language.documents.models.DocumentAnalysisDocumentResult] + """ + + errors: list["_models.AnalyzeDocumentsDocumentError"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Errors by document id. Required.""" + statistics: Optional["_models.RequestStatistics"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """if showStats=true was specified in the request this field will contain information about the + request payload.""" + model_version: str = rest_field(name="modelVersion", visibility=["read", "create", "update", "delete", "query"]) + """This field indicates which model is used for analysis. Required.""" + documents: list["_models.DocumentAnalysisDocumentResult"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Response by document. Required.""" + + @overload + def __init__( + self, + *, + errors: list["_models.AnalyzeDocumentsDocumentError"], + model_version: str, + documents: list["_models.DocumentAnalysisDocumentResult"], + statistics: Optional["_models.RequestStatistics"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DocumentLocation(_Model): + """Contains the location of the document. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + AzureBlobDocumentLocation, AzureContainerDocumentLocation, AzureContainerFolderDocumentLocation + + :ivar kind: The kind of the document location. Required. Known values are: "AzureBlob", + "AzureContainer", and "AzureContainerFolder". + :vartype kind: str or ~azure.ai.language.documents.models.DocumentLocationKind + :ivar location: The location of the document. Required. + :vartype location: str + """ + + __mapping__: dict[str, _Model] = {} + kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) + """The kind of the document location. Required. Known values are: \"AzureBlob\", + \"AzureContainer\", and \"AzureContainerFolder\".""" + location: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The location of the document. Required.""" + + @overload + def __init__( + self, + *, + kind: str, + location: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AzureBlobDocumentLocation(DocumentLocation, discriminator="AzureBlob"): + """Document location for azure blobs. + + :ivar kind: The kind of the document location. Required. The document is a URL. + :vartype kind: str or ~azure.ai.language.documents.models.AZURE_BLOB + :ivar location: The location of the document. Required. + :vartype location: str + :ivar managed_identity_client_id: The user managed identity client Id to use to authenticate + with the storage account. + :vartype managed_identity_client_id: str + """ + + kind: Literal[DocumentLocationKind.AZURE_BLOB] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The kind of the document location. Required. The document is a URL.""" + managed_identity_client_id: Optional[str] = rest_field( + name="managedIdentityClientId", visibility=["read", "create", "update", "delete", "query"] + ) + """The user managed identity client Id to use to authenticate with the storage account.""" + + @overload + def __init__( + self, + *, + location: str, + managed_identity_client_id: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = DocumentLocationKind.AZURE_BLOB # type: ignore + + +class AzureContainerDocumentLocation(DocumentLocation, discriminator="AzureContainer"): + """Document location for azure blob storage containers. + + :ivar kind: The kind of the document location. Required. The document location is an Azure Blob + Storage container. + :vartype kind: str or ~azure.ai.language.documents.models.AZURE_CONTAINER + :ivar location: The location of the document. Required. + :vartype location: str + :ivar managed_identity_client_id: The user managed identity client Id to use to authenticate + with the storage account. + :vartype managed_identity_client_id: str + """ + + kind: Literal[DocumentLocationKind.AZURE_CONTAINER] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The kind of the document location. Required. The document location is an Azure Blob Storage + container.""" + managed_identity_client_id: Optional[str] = rest_field( + name="managedIdentityClientId", visibility=["read", "create", "update", "delete", "query"] + ) + """The user managed identity client Id to use to authenticate with the storage account.""" + + @overload + def __init__( + self, + *, + location: str, + managed_identity_client_id: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = DocumentLocationKind.AZURE_CONTAINER # type: ignore + + +class AzureContainerFolderDocumentLocation(DocumentLocation, discriminator="AzureContainerFolder"): + """Document location for folders within azure blob storage containers. + + :ivar kind: The kind of the document location. Required. The document location is a folder + within an Azure Blob Storage container. + :vartype kind: str or ~azure.ai.language.documents.models.AZURE_CONTAINER_FOLDER + :ivar location: The location of the document. Required. + :vartype location: str + :ivar managed_identity_client_id: The user managed identity client Id to use to authenticate + with the storage account. + :vartype managed_identity_client_id: str + """ + + kind: Literal[DocumentLocationKind.AZURE_CONTAINER_FOLDER] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The kind of the document location. Required. The document location is a folder within an Azure + Blob Storage container.""" + managed_identity_client_id: Optional[str] = rest_field( + name="managedIdentityClientId", visibility=["read", "create", "update", "delete", "query"] + ) + """The user managed identity client Id to use to authenticate with the storage account.""" + + @overload + def __init__( + self, + *, + location: str, + managed_identity_client_id: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = DocumentLocationKind.AZURE_CONTAINER_FOLDER # type: ignore + + +class BaseRedactionPolicy(_Model): + """The abstract base class for RedactionPolicy. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + CharacterMaskPolicy, EntityMaskPolicy, MarkerMaskPolicy, NoMaskPolicy, + SyntheticReplacementPolicyType + + :ivar policy_kind: The entity RedactionPolicy object kind. Required. Known values are: + "noMask", "characterMask", "entityMask", "markerMask", and "syntheticReplacement". + :vartype policy_kind: str or ~azure.ai.language.documents.models.RedactionPolicyKind + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + """ + + __mapping__: dict[str, _Model] = {} + policy_kind: str = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) + """The entity RedactionPolicy object kind. Required. Known values are: \"noMask\", + \"characterMask\", \"entityMask\", \"markerMask\", and \"syntheticReplacement\".""" + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = rest_field( + name="entityTypes", visibility=["read", "create", "update", "delete", "query"] + ) + """(Optional) describes the PII categories to which the redaction policy will be applied. If not + specified, the redaction policy will be applied to all PII categories.""" + policy_name: Optional[str] = rest_field( + name="policyName", visibility=["read", "create", "update", "delete", "query"] + ) + """(Optional) name of the redaction policy for identification purposes.""" + is_default: Optional[bool] = rest_field( + name="isDefault", visibility=["read", "create", "update", "delete", "query"] + ) + """(Optional) flag to indicate whether this redaction policy is the default policy to be applied + when no specific policy is defined for a PII category. Only one policy can be marked as + default.""" + + @overload + def __init__( + self, + *, + policy_kind: str, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class CharacterMaskPolicy(BaseRedactionPolicy, discriminator="characterMask"): + """Represents the policy of redacting with a redaction character. + + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + :ivar policy_kind: The entity RedactionPolicy object kind. Required. React detected entities + with redaction character. + :vartype policy_kind: str or ~azure.ai.language.documents.models.CHARACTER_MASK + :ivar redaction_character: Optional parameter to use a Custom Character to be used for + redaction in PII responses. Default character will be * as before. We allow specific ascii + characters for redaction. Known values are: "!", "#", "$", "%", "&", "*", "+", "-", "=", "?", + "@", "^", "_", and "~". + :vartype redaction_character: str or ~azure.ai.language.documents.models.RedactionCharacter + """ + + policy_kind: Literal[RedactionPolicyKind.CHARACTER_MASK] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The entity RedactionPolicy object kind. Required. React detected entities with redaction + character.""" + redaction_character: Optional[Union[str, "_models.RedactionCharacter"]] = rest_field( + name="redactionCharacter", visibility=["read", "create", "update", "delete", "query"] + ) + """Optional parameter to use a Custom Character to be used for redaction in PII responses. Default + character will be * as before. We allow specific ascii characters for redaction. Known values + are: \"!\", \"#\", \"$\", \"%\", \"&\", \"*\", \"+\", \"-\", \"=\", \"?\", \"@\", \"^\", \"_\", + and \"~\".""" + + @overload + def __init__( + self, + *, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + redaction_character: Optional[Union[str, "_models.RedactionCharacter"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.policy_kind = RedactionPolicyKind.CHARACTER_MASK # type: ignore + + +class ConfidenceScoreThreshold(_Model): + """Configuration for confidence score threshold for PII entity recognition. + + :ivar default: Minimum confidence score threshold for the PII entities to be returned in the + response. Entities with a confidence score below this threshold will be filtered out. Value + should be between 0.0 and 1.0. Required. + :vartype default: float + :ivar overrides: List of confidence score threshold overrides for specific PII categories. + :vartype overrides: list[~azure.ai.language.documents.models.ConfidenceScoreThresholdOverride] + """ + + default: float = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Minimum confidence score threshold for the PII entities to be returned in the response. + Entities with a confidence score below this threshold will be filtered out. Value should be + between 0.0 and 1.0. Required.""" + overrides: Optional[list["_models.ConfidenceScoreThresholdOverride"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """List of confidence score threshold overrides for specific PII categories.""" + + @overload + def __init__( + self, + *, + default: float, + overrides: Optional[list["_models.ConfidenceScoreThresholdOverride"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ConfidenceScoreThresholdOverride(_Model): + """Confidence score threshold override for a specific PII category. + + :ivar entity: The PII category for which to override the confidence score threshold. Required. + Known values are: "ABARoutingNumber", "ARNationalIdentityNumber", "AUBankAccountNumber", + "AUDriversLicenseNumber", "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", + "AUBusinessNumber", "AUCompanyNumber", "ATIdentityCard", "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", "AzureDocumentDBAuthKey", "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", "AzurePublishSettingPassword", "AzureRedisCacheString", "AzureSAS", + "AzureServiceBusString", "AzureStorageAccountKey", "AzureStorageAccountGeneric", + "BENationalNumber", "BENationalNumberV2", "BEValueAddedTaxNumber", "BRCPFNumber", + "BRLegalEntityNumber", "BRNationalIDRG", "BGUniformCivilNumber", "CABankAccountNumber", + "CADriversLicenseNumber", "CAHealthServiceNumber", "CAPassportNumber", + "CAPersonalHealthIdentification", "CASocialInsuranceNumber", "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", "CreditCardNumber", "HRIdentityCardNumber", + "HRNationalIDNumber", "HRPersonalIdentificationNumber", "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", "CYTaxIdentificationNumber", "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", "DKPersonalIdentificationNumber", "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", "EEPersonalIdentificationCode", "EUDebitCardNumber", + "EUDriversLicenseNumber", "EUGPSCoordinates", "EUNationalIdentificationNumber", + "EUPassportNumber", "EUSocialSecurityNumber", "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", "FINationalID", "FINationalIDV2", "FIPassportNumber", + "FRDriversLicenseNumber", "FRHealthInsuranceNumber", "FRNationalID", "FRPassportNumber", + "FRSocialSecurityNumber", "FRTaxIdentificationNumber", "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", "DEPassportNumber", "DEIdentityCardNumber", + "DETaxIdentificationNumber", "DEValueAddedNumber", "GRNationalIDCard", "GRNationalIDV2", + "GRTaxIdentificationNumber", "HKIdentityCardNumber", "HUValueAddedNumber", + "HUPersonalIdentificationNumber", "HUTaxIdentificationNumber", "INPermanentAccount", + "INUniqueIdentificationNumber", "IDIdentityCardNumber", "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", "IEPersonalPublicServiceNumberV2", "ILBankAccountNumber", + "ILNationalID", "ITDriversLicenseNumber", "ITFiscalCode", "ITValueAddedTaxNumber", + "JPBankAccountNumber", "JPDriversLicenseNumber", "JPPassportNumber", + "JPResidentRegistrationNumber", "JPSocialInsuranceNumber", "JPMyNumberCorporate", + "JPMyNumberPersonal", "JPResidenceCardNumber", "LVPersonalCode", "LTPersonalCode", + "LUNationalIdentificationNumberNatural", "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", "MTIdentityCardNumber", "MTTaxIDNumber", "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", "NLTaxIdentificationNumber", "NLValueAddedTaxNumber", + "NZBankAccountNumber", "NZDriversLicenseNumber", "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", "NZSocialWelfareNumber", "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", "PLIdentityCard", "PLNationalID", "PLNationalIDV2", + "PLPassportNumber", "PLTaxIdentificationNumber", "PLREGONNumber", "PTCitizenCardNumber", + "PTCitizenCardNumberV2", "PTTaxIdentificationNumber", "ROPersonalNumericalCode", + "RUPassportNumberDomestic", "RUPassportNumberInternational", "SANationalID", + "SGNationalRegistrationIdentityCardNumber", "SKPersonalNumber", "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", "ZAIdentificationNumber", "KRResidentRegistrationNumber", + "ESDNI", "ESSocialSecurityNumber", "ESTaxIdentificationNumber", "SQLServerConnectionString", + "SENationalID", "SENationalIDV2", "SEPassportNumber", "SETaxIdentificationNumber", "SWIFTCode", + "CHSocialSecurityNumber", "TWNationalID", "TWPassportNumber", "TWResidentCertificate", + "THPopulationIdentificationCode", "TRNationalIdentificationNumber", "UKDriversLicenseNumber", + "UKElectoralRollNumber", "UKNationalHealthNumber", "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", "USUKPassportNumber", "USBankAccountNumber", + "USDriversLicenseNumber", "USIndividualTaxpayerIdentification", "USSocialSecurityNumber", + "UAPassportNumberDomestic", "UAPassportNumberInternational", "Organization", "Email", "URL", + "Age", "PhoneNumber", "IPAddress", "Date", "Person", and "Address". + :vartype entity: str or ~azure.ai.language.documents.models.PiiCategories + :ivar value: The confidence score threshold for the specified PII category. Required. + :vartype value: float + :ivar language: The 2 letter ISO 639-1 language for which the override applies. If not + specified, the override applies to all languages. Required. + :vartype language: str + """ + + entity: Union[str, "_models.PiiCategories"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The PII category for which to override the confidence score threshold. Required. Known values + are: \"ABARoutingNumber\", \"ARNationalIdentityNumber\", \"AUBankAccountNumber\", + \"AUDriversLicenseNumber\", \"AUMedicalAccountNumber\", \"AUPassportNumber\", + \"AUTaxFileNumber\", \"AUBusinessNumber\", \"AUCompanyNumber\", \"ATIdentityCard\", + \"ATTaxIdentificationNumber\", \"ATValueAddedTaxNumber\", \"AzureDocumentDBAuthKey\", + \"AzureIAASDatabaseConnectionAndSQLString\", \"AzureIoTConnectionString\", + \"AzurePublishSettingPassword\", \"AzureRedisCacheString\", \"AzureSAS\", + \"AzureServiceBusString\", \"AzureStorageAccountKey\", \"AzureStorageAccountGeneric\", + \"BENationalNumber\", \"BENationalNumberV2\", \"BEValueAddedTaxNumber\", \"BRCPFNumber\", + \"BRLegalEntityNumber\", \"BRNationalIDRG\", \"BGUniformCivilNumber\", \"CABankAccountNumber\", + \"CADriversLicenseNumber\", \"CAHealthServiceNumber\", \"CAPassportNumber\", + \"CAPersonalHealthIdentification\", \"CASocialInsuranceNumber\", \"CLIdentityCardNumber\", + \"CNResidentIdentityCardNumber\", \"CreditCardNumber\", \"HRIdentityCardNumber\", + \"HRNationalIDNumber\", \"HRPersonalIdentificationNumber\", + \"HRPersonalIdentificationOIBNumberV2\", \"CYIdentityCard\", \"CYTaxIdentificationNumber\", + \"CZPersonalIdentityNumber\", \"CZPersonalIdentityV2\", \"DKPersonalIdentificationNumber\", + \"DKPersonalIdentificationV2\", \"DrugEnforcementAgencyNumber\", + \"EEPersonalIdentificationCode\", \"EUDebitCardNumber\", \"EUDriversLicenseNumber\", + \"EUGPSCoordinates\", \"EUNationalIdentificationNumber\", \"EUPassportNumber\", + \"EUSocialSecurityNumber\", \"EUTaxIdentificationNumber\", \"FIEuropeanHealthNumber\", + \"FINationalID\", \"FINationalIDV2\", \"FIPassportNumber\", \"FRDriversLicenseNumber\", + \"FRHealthInsuranceNumber\", \"FRNationalID\", \"FRPassportNumber\", + \"FRSocialSecurityNumber\", \"FRTaxIdentificationNumber\", \"FRValueAddedTaxNumber\", + \"DEDriversLicenseNumber\", \"DEPassportNumber\", \"DEIdentityCardNumber\", + \"DETaxIdentificationNumber\", \"DEValueAddedNumber\", \"GRNationalIDCard\", + \"GRNationalIDV2\", \"GRTaxIdentificationNumber\", \"HKIdentityCardNumber\", + \"HUValueAddedNumber\", \"HUPersonalIdentificationNumber\", \"HUTaxIdentificationNumber\", + \"INPermanentAccount\", \"INUniqueIdentificationNumber\", \"IDIdentityCardNumber\", + \"InternationalBankingAccountNumber\", \"IEPersonalPublicServiceNumber\", + \"IEPersonalPublicServiceNumberV2\", \"ILBankAccountNumber\", \"ILNationalID\", + \"ITDriversLicenseNumber\", \"ITFiscalCode\", \"ITValueAddedTaxNumber\", + \"JPBankAccountNumber\", \"JPDriversLicenseNumber\", \"JPPassportNumber\", + \"JPResidentRegistrationNumber\", \"JPSocialInsuranceNumber\", \"JPMyNumberCorporate\", + \"JPMyNumberPersonal\", \"JPResidenceCardNumber\", \"LVPersonalCode\", \"LTPersonalCode\", + \"LUNationalIdentificationNumberNatural\", \"LUNationalIdentificationNumberNonNatural\", + \"MYIdentityCardNumber\", \"MTIdentityCardNumber\", \"MTTaxIDNumber\", + \"NLCitizensServiceNumber\", \"NLCitizensServiceNumberV2\", \"NLTaxIdentificationNumber\", + \"NLValueAddedTaxNumber\", \"NZBankAccountNumber\", \"NZDriversLicenseNumber\", + \"NZInlandRevenueNumber\", \"NZMinistryOfHealthNumber\", \"NZSocialWelfareNumber\", + \"NOIdentityNumber\", \"PHUnifiedMultiPurposeIDNumber\", \"PLIdentityCard\", \"PLNationalID\", + \"PLNationalIDV2\", \"PLPassportNumber\", \"PLTaxIdentificationNumber\", \"PLREGONNumber\", + \"PTCitizenCardNumber\", \"PTCitizenCardNumberV2\", \"PTTaxIdentificationNumber\", + \"ROPersonalNumericalCode\", \"RUPassportNumberDomestic\", \"RUPassportNumberInternational\", + \"SANationalID\", \"SGNationalRegistrationIdentityCardNumber\", \"SKPersonalNumber\", + \"SITaxIdentificationNumber\", \"SIUniqueMasterCitizenNumber\", \"ZAIdentificationNumber\", + \"KRResidentRegistrationNumber\", \"ESDNI\", \"ESSocialSecurityNumber\", + \"ESTaxIdentificationNumber\", \"SQLServerConnectionString\", \"SENationalID\", + \"SENationalIDV2\", \"SEPassportNumber\", \"SETaxIdentificationNumber\", \"SWIFTCode\", + \"CHSocialSecurityNumber\", \"TWNationalID\", \"TWPassportNumber\", \"TWResidentCertificate\", + \"THPopulationIdentificationCode\", \"TRNationalIdentificationNumber\", + \"UKDriversLicenseNumber\", \"UKElectoralRollNumber\", \"UKNationalHealthNumber\", + \"UKNationalInsuranceNumber\", \"UKUniqueTaxpayerNumber\", \"USUKPassportNumber\", + \"USBankAccountNumber\", \"USDriversLicenseNumber\", \"USIndividualTaxpayerIdentification\", + \"USSocialSecurityNumber\", \"UAPassportNumberDomestic\", \"UAPassportNumberInternational\", + \"Organization\", \"Email\", \"URL\", \"Age\", \"PhoneNumber\", \"IPAddress\", \"Date\", + \"Person\", and \"Address\".""" + value: float = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The confidence score threshold for the specified PII category. Required.""" + language: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The 2 letter ISO 639-1 language for which the override applies. If not specified, the override + applies to all languages. Required.""" + + @overload + def __init__( + self, + *, + entity: Union[str, "_models.PiiCategories"], + value: float, + language: str, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DocumentAnalysisDocumentResult(_Model): + """Contains the result object for the processed document. + + :ivar id: Unique, non-empty document identifier. Required. + :vartype id: str + :ivar warnings: Warnings encountered while processing document. Required. + :vartype warnings: list[~azure.ai.language.documents.models.DocumentWarning] + :ivar statistics: if showStats=true was specified in the request this field will contain + information about the document payload. + :vartype statistics: ~azure.ai.language.documents.models.DocumentStatistics + :ivar source: Location of the input document. Required. + :vartype source: ~azure.ai.language.documents.models.DocumentLocation + :ivar target: Array of document results generated after the analysis. Required. + :vartype target: list[~azure.ai.language.documents.models.DocumentLocation] + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Unique, non-empty document identifier. Required.""" + warnings: list["_models.DocumentWarning"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Warnings encountered while processing document. Required.""" + statistics: Optional["_models.DocumentStatistics"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """if showStats=true was specified in the request this field will contain information about the + document payload.""" + source: "_models.DocumentLocation" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Location of the input document. Required.""" + target: list["_models.DocumentLocation"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Array of document results generated after the analysis. Required.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + warnings: list["_models.DocumentWarning"], + source: "_models.DocumentLocation", + target: list["_models.DocumentLocation"], + statistics: Optional["_models.DocumentStatistics"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DocumentStatistics(_Model): + """if showStats=true was specified in the request this field will contain information about the + document payload. + + :ivar characters_count: Number of documents elements recognized in the document. Required. + :vartype characters_count: int + :ivar transactions_count: Number of transactions for the document. Required. + :vartype transactions_count: int + """ + + characters_count: int = rest_field( + name="charactersCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of documents elements recognized in the document. Required.""" + transactions_count: int = rest_field( + name="transactionsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of transactions for the document. Required.""" + + @overload + def __init__( + self, + *, + characters_count: int, + transactions_count: int, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class DocumentWarning(_Model): + """Contains the warnings object with warnings encountered for the processed document. + + :ivar code: Warning code. Required. Known values are: "LongWordsInDocument" and + "DocumentTruncated". + :vartype code: str or ~azure.ai.language.documents.models.WarningCodeValue + :ivar message: Warning message. Required. + :vartype message: str + :ivar target_ref: A JSON pointer reference indicating the target object. + :vartype target_ref: str + """ + + code: Union[str, "_models.WarningCodeValue"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Warning code. Required. Known values are: \"LongWordsInDocument\" and \"DocumentTruncated\".""" + message: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Warning message. Required.""" + target_ref: Optional[str] = rest_field(name="targetRef", visibility=["read", "create", "update", "delete", "query"]) + """A JSON pointer reference indicating the target object.""" + + @overload + def __init__( + self, + *, + code: Union[str, "_models.WarningCodeValue"], + message: str, + target_ref: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class EntityMaskPolicy(BaseRedactionPolicy, discriminator="entityMask"): + """Represents the policy of redacting PII with the entity type. + + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + :ivar policy_kind: The entity OverlapPolicy object kind. Required. Redact detected entities + with entity type. + :vartype policy_kind: str or ~azure.ai.language.documents.models.ENTITY_MASK + """ + + policy_kind: Literal[RedactionPolicyKind.ENTITY_MASK] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The entity OverlapPolicy object kind. Required. Redact detected entities with entity type.""" + + @overload + def __init__( + self, + *, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.policy_kind = RedactionPolicyKind.ENTITY_MASK # type: ignore + + +class EntitySynonym(_Model): + """The entity synonyms used to enhance pii entity detection. + + :ivar synonym: The synonym to be used for context. Required. + :vartype synonym: str + :ivar language: The 2 letter ISO 639-1 language the synonym. + :vartype language: str + """ + + synonym: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The synonym to be used for context. Required.""" + language: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The 2 letter ISO 639-1 language the synonym.""" + + @overload + def __init__( + self, + *, + synonym: str, + language: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class EntitySynonyms(_Model): + """Object that allows the user to provide synonyms for context words that to enhance pii entity + detection. + + :ivar entity_type: The entity name. Required. Known values are: "ABARoutingNumber", + "ARNationalIdentityNumber", "AUBankAccountNumber", "AUDriversLicenseNumber", + "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", "AUBusinessNumber", + "AUCompanyNumber", "ATIdentityCard", "ATTaxIdentificationNumber", "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", "AzurePublishSettingPassword", "AzureRedisCacheString", "AzureSAS", + "AzureServiceBusString", "AzureStorageAccountKey", "AzureStorageAccountGeneric", + "BENationalNumber", "BENationalNumberV2", "BEValueAddedTaxNumber", "BRCPFNumber", + "BRLegalEntityNumber", "BRNationalIDRG", "BGUniformCivilNumber", "CABankAccountNumber", + "CADriversLicenseNumber", "CAHealthServiceNumber", "CAPassportNumber", + "CAPersonalHealthIdentification", "CASocialInsuranceNumber", "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", "CreditCardNumber", "HRIdentityCardNumber", + "HRNationalIDNumber", "HRPersonalIdentificationNumber", "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", "CYTaxIdentificationNumber", "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", "DKPersonalIdentificationNumber", "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", "EEPersonalIdentificationCode", "EUDebitCardNumber", + "EUDriversLicenseNumber", "EUGPSCoordinates", "EUNationalIdentificationNumber", + "EUPassportNumber", "EUSocialSecurityNumber", "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", "FINationalID", "FINationalIDV2", "FIPassportNumber", + "FRDriversLicenseNumber", "FRHealthInsuranceNumber", "FRNationalID", "FRPassportNumber", + "FRSocialSecurityNumber", "FRTaxIdentificationNumber", "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", "DEPassportNumber", "DEIdentityCardNumber", + "DETaxIdentificationNumber", "DEValueAddedNumber", "GRNationalIDCard", "GRNationalIDV2", + "GRTaxIdentificationNumber", "HKIdentityCardNumber", "HUValueAddedNumber", + "HUPersonalIdentificationNumber", "HUTaxIdentificationNumber", "INPermanentAccount", + "INUniqueIdentificationNumber", "IDIdentityCardNumber", "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", "IEPersonalPublicServiceNumberV2", "ILBankAccountNumber", + "ILNationalID", "ITDriversLicenseNumber", "ITFiscalCode", "ITValueAddedTaxNumber", + "JPBankAccountNumber", "JPDriversLicenseNumber", "JPPassportNumber", + "JPResidentRegistrationNumber", "JPSocialInsuranceNumber", "JPMyNumberCorporate", + "JPMyNumberPersonal", "JPResidenceCardNumber", "LVPersonalCode", "LTPersonalCode", + "LUNationalIdentificationNumberNatural", "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", "MTIdentityCardNumber", "MTTaxIDNumber", "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", "NLTaxIdentificationNumber", "NLValueAddedTaxNumber", + "NZBankAccountNumber", "NZDriversLicenseNumber", "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", "NZSocialWelfareNumber", "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", "PLIdentityCard", "PLNationalID", "PLNationalIDV2", + "PLPassportNumber", "PLTaxIdentificationNumber", "PLREGONNumber", "PTCitizenCardNumber", + "PTCitizenCardNumberV2", "PTTaxIdentificationNumber", "ROPersonalNumericalCode", + "RUPassportNumberDomestic", "RUPassportNumberInternational", "SANationalID", + "SGNationalRegistrationIdentityCardNumber", "SKPersonalNumber", "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", "ZAIdentificationNumber", "KRResidentRegistrationNumber", + "ESDNI", "ESSocialSecurityNumber", "ESTaxIdentificationNumber", "SQLServerConnectionString", + "SENationalID", "SENationalIDV2", "SEPassportNumber", "SETaxIdentificationNumber", "SWIFTCode", + "CHSocialSecurityNumber", "TWNationalID", "TWPassportNumber", "TWResidentCertificate", + "THPopulationIdentificationCode", "TRNationalIdentificationNumber", "UKDriversLicenseNumber", + "UKElectoralRollNumber", "UKNationalHealthNumber", "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", "USUKPassportNumber", "USBankAccountNumber", + "USDriversLicenseNumber", "USIndividualTaxpayerIdentification", "USSocialSecurityNumber", + "UAPassportNumberDomestic", "UAPassportNumberInternational", "Organization", "Email", "URL", + "Age", "PhoneNumber", "IPAddress", "Date", "Person", and "Address". + :vartype entity_type: str or ~azure.ai.language.documents.models.PiiCategories + :ivar synonyms: The entity synonyms. Required. + :vartype synonyms: list[~azure.ai.language.documents.models.EntitySynonym] + """ + + entity_type: Union[str, "_models.PiiCategories"] = rest_field( + name="entityType", visibility=["read", "create", "update", "delete", "query"] + ) + """The entity name. Required. Known values are: \"ABARoutingNumber\", + \"ARNationalIdentityNumber\", \"AUBankAccountNumber\", \"AUDriversLicenseNumber\", + \"AUMedicalAccountNumber\", \"AUPassportNumber\", \"AUTaxFileNumber\", \"AUBusinessNumber\", + \"AUCompanyNumber\", \"ATIdentityCard\", \"ATTaxIdentificationNumber\", + \"ATValueAddedTaxNumber\", \"AzureDocumentDBAuthKey\", + \"AzureIAASDatabaseConnectionAndSQLString\", \"AzureIoTConnectionString\", + \"AzurePublishSettingPassword\", \"AzureRedisCacheString\", \"AzureSAS\", + \"AzureServiceBusString\", \"AzureStorageAccountKey\", \"AzureStorageAccountGeneric\", + \"BENationalNumber\", \"BENationalNumberV2\", \"BEValueAddedTaxNumber\", \"BRCPFNumber\", + \"BRLegalEntityNumber\", \"BRNationalIDRG\", \"BGUniformCivilNumber\", \"CABankAccountNumber\", + \"CADriversLicenseNumber\", \"CAHealthServiceNumber\", \"CAPassportNumber\", + \"CAPersonalHealthIdentification\", \"CASocialInsuranceNumber\", \"CLIdentityCardNumber\", + \"CNResidentIdentityCardNumber\", \"CreditCardNumber\", \"HRIdentityCardNumber\", + \"HRNationalIDNumber\", \"HRPersonalIdentificationNumber\", + \"HRPersonalIdentificationOIBNumberV2\", \"CYIdentityCard\", \"CYTaxIdentificationNumber\", + \"CZPersonalIdentityNumber\", \"CZPersonalIdentityV2\", \"DKPersonalIdentificationNumber\", + \"DKPersonalIdentificationV2\", \"DrugEnforcementAgencyNumber\", + \"EEPersonalIdentificationCode\", \"EUDebitCardNumber\", \"EUDriversLicenseNumber\", + \"EUGPSCoordinates\", \"EUNationalIdentificationNumber\", \"EUPassportNumber\", + \"EUSocialSecurityNumber\", \"EUTaxIdentificationNumber\", \"FIEuropeanHealthNumber\", + \"FINationalID\", \"FINationalIDV2\", \"FIPassportNumber\", \"FRDriversLicenseNumber\", + \"FRHealthInsuranceNumber\", \"FRNationalID\", \"FRPassportNumber\", + \"FRSocialSecurityNumber\", \"FRTaxIdentificationNumber\", \"FRValueAddedTaxNumber\", + \"DEDriversLicenseNumber\", \"DEPassportNumber\", \"DEIdentityCardNumber\", + \"DETaxIdentificationNumber\", \"DEValueAddedNumber\", \"GRNationalIDCard\", + \"GRNationalIDV2\", \"GRTaxIdentificationNumber\", \"HKIdentityCardNumber\", + \"HUValueAddedNumber\", \"HUPersonalIdentificationNumber\", \"HUTaxIdentificationNumber\", + \"INPermanentAccount\", \"INUniqueIdentificationNumber\", \"IDIdentityCardNumber\", + \"InternationalBankingAccountNumber\", \"IEPersonalPublicServiceNumber\", + \"IEPersonalPublicServiceNumberV2\", \"ILBankAccountNumber\", \"ILNationalID\", + \"ITDriversLicenseNumber\", \"ITFiscalCode\", \"ITValueAddedTaxNumber\", + \"JPBankAccountNumber\", \"JPDriversLicenseNumber\", \"JPPassportNumber\", + \"JPResidentRegistrationNumber\", \"JPSocialInsuranceNumber\", \"JPMyNumberCorporate\", + \"JPMyNumberPersonal\", \"JPResidenceCardNumber\", \"LVPersonalCode\", \"LTPersonalCode\", + \"LUNationalIdentificationNumberNatural\", \"LUNationalIdentificationNumberNonNatural\", + \"MYIdentityCardNumber\", \"MTIdentityCardNumber\", \"MTTaxIDNumber\", + \"NLCitizensServiceNumber\", \"NLCitizensServiceNumberV2\", \"NLTaxIdentificationNumber\", + \"NLValueAddedTaxNumber\", \"NZBankAccountNumber\", \"NZDriversLicenseNumber\", + \"NZInlandRevenueNumber\", \"NZMinistryOfHealthNumber\", \"NZSocialWelfareNumber\", + \"NOIdentityNumber\", \"PHUnifiedMultiPurposeIDNumber\", \"PLIdentityCard\", \"PLNationalID\", + \"PLNationalIDV2\", \"PLPassportNumber\", \"PLTaxIdentificationNumber\", \"PLREGONNumber\", + \"PTCitizenCardNumber\", \"PTCitizenCardNumberV2\", \"PTTaxIdentificationNumber\", + \"ROPersonalNumericalCode\", \"RUPassportNumberDomestic\", \"RUPassportNumberInternational\", + \"SANationalID\", \"SGNationalRegistrationIdentityCardNumber\", \"SKPersonalNumber\", + \"SITaxIdentificationNumber\", \"SIUniqueMasterCitizenNumber\", \"ZAIdentificationNumber\", + \"KRResidentRegistrationNumber\", \"ESDNI\", \"ESSocialSecurityNumber\", + \"ESTaxIdentificationNumber\", \"SQLServerConnectionString\", \"SENationalID\", + \"SENationalIDV2\", \"SEPassportNumber\", \"SETaxIdentificationNumber\", \"SWIFTCode\", + \"CHSocialSecurityNumber\", \"TWNationalID\", \"TWPassportNumber\", \"TWResidentCertificate\", + \"THPopulationIdentificationCode\", \"TRNationalIdentificationNumber\", + \"UKDriversLicenseNumber\", \"UKElectoralRollNumber\", \"UKNationalHealthNumber\", + \"UKNationalInsuranceNumber\", \"UKUniqueTaxpayerNumber\", \"USUKPassportNumber\", + \"USBankAccountNumber\", \"USDriversLicenseNumber\", \"USIndividualTaxpayerIdentification\", + \"USSocialSecurityNumber\", \"UAPassportNumberDomestic\", \"UAPassportNumberInternational\", + \"Organization\", \"Email\", \"URL\", \"Age\", \"PhoneNumber\", \"IPAddress\", \"Date\", + \"Person\", and \"Address\".""" + synonyms: list["_models.EntitySynonym"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The entity synonyms. Required.""" + + @overload + def __init__( + self, + *, + entity_type: Union[str, "_models.PiiCategories"], + synonyms: list["_models.EntitySynonym"], + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class Error(_Model): + """The error response object returned when the service encounters some errors during processing + the request. + + :ivar code: One of a server-defined set of error codes. Required. Known values are: + "InvalidRequest", "InvalidArgument", "Unauthorized", "Forbidden", "NotFound", + "ProjectNotFound", "OperationNotFound", "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", "TooManyRequests", "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", "InternalServerError", "ServiceUnavailable", + "Timeout", "QuotaExceeded", "Conflict", and "Warning". + :vartype code: str or ~azure.ai.language.documents.models.ErrorCode + :ivar message: A human-readable representation of the error. Required. + :vartype message: str + :ivar target: The target of the error. + :vartype target: str + :ivar details: An array of details about specific errors that led to this reported error. + :vartype details: list[~azure.ai.language.documents.models.Error] + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.ai.language.documents.models.InnerErrorModel + """ + + code: Union[str, "_models.ErrorCode"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """One of a server-defined set of error codes. Required. Known values are: \"InvalidRequest\", + \"InvalidArgument\", \"Unauthorized\", \"Forbidden\", \"NotFound\", \"ProjectNotFound\", + \"OperationNotFound\", \"AzureCognitiveSearchNotFound\", \"AzureCognitiveSearchIndexNotFound\", + \"TooManyRequests\", \"AzureCognitiveSearchThrottling\", + \"AzureCognitiveSearchIndexLimitReached\", \"InternalServerError\", \"ServiceUnavailable\", + \"Timeout\", \"QuotaExceeded\", \"Conflict\", and \"Warning\".""" + message: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """A human-readable representation of the error. Required.""" + target: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The target of the error.""" + details: Optional[list["_models.Error"]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """An array of details about specific errors that led to this reported error.""" + innererror: Optional["_models.InnerErrorModel"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: Union[str, "_models.ErrorCode"], + message: str, + target: Optional[str] = None, + details: Optional[list["_models.Error"]] = None, + innererror: Optional["_models.InnerErrorModel"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ErrorResponse(_Model): + """Error response. + + :ivar error: The error object. Required. + :vartype error: ~azure.ai.language.documents.models.Error + """ + + error: "_models.Error" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The error object. Required.""" + + @overload + def __init__( + self, + *, + error: "_models.Error", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class InnerErrorModel(_Model): + """An object containing more specific information about the error. As per Microsoft One API + guidelines - + `https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses + `_. + + :ivar code: One of a server-defined set of error codes. Required. Known values are: + "InvalidRequest", "InvalidParameterValue", "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", "AzureCognitiveSearchThrottling", "ExtractionFailure", + "InvalidRequestBodyFormat", "EmptyRequest", "MissingInputDocuments", "InvalidDocument", + "ModelVersionIncorrect", "InvalidDocumentBatch", "UnsupportedLanguageCode", and + "InvalidCountryHint". + :vartype code: str or ~azure.ai.language.documents.models.InnerErrorCode + :ivar message: Error message. Required. + :vartype message: str + :ivar details: Error details. + :vartype details: dict[str, str] + :ivar target: Error target. + :vartype target: str + :ivar innererror: An object containing more specific information than the current object about + the error. + :vartype innererror: ~azure.ai.language.documents.models.InnerErrorModel + """ + + code: Union[str, "_models.InnerErrorCode"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """One of a server-defined set of error codes. Required. Known values are: \"InvalidRequest\", + \"InvalidParameterValue\", \"KnowledgeBaseNotFound\", \"AzureCognitiveSearchNotFound\", + \"AzureCognitiveSearchThrottling\", \"ExtractionFailure\", \"InvalidRequestBodyFormat\", + \"EmptyRequest\", \"MissingInputDocuments\", \"InvalidDocument\", \"ModelVersionIncorrect\", + \"InvalidDocumentBatch\", \"UnsupportedLanguageCode\", and \"InvalidCountryHint\".""" + message: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error message. Required.""" + details: Optional[dict[str, str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error details.""" + target: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error target.""" + innererror: Optional["_models.InnerErrorModel"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """An object containing more specific information than the current object about the error.""" + + @overload + def __init__( + self, + *, + code: Union[str, "_models.InnerErrorCode"], + message: str, + details: Optional[dict[str, str]] = None, + target: Optional[str] = None, + innererror: Optional["_models.InnerErrorModel"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MarkerMaskPolicy(BaseRedactionPolicy, discriminator="markerMask"): + """Represents the policy of redacting PII with marker style. + + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + :ivar policy_kind: The entity RedactionPolicy object kind. Required. Redact detected entities + using a marker-style mask. + :vartype policy_kind: str or ~azure.ai.language.documents.models.MARKER_MASK + """ + + policy_kind: Literal[RedactionPolicyKind.MARKER_MASK] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The entity RedactionPolicy object kind. Required. Redact detected entities using a marker-style + mask.""" + + @overload + def __init__( + self, + *, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.policy_kind = RedactionPolicyKind.MARKER_MASK # type: ignore + + +class MultiLanguageAnalysisInput(_Model): + """Collection of input documents to be analyzed by the service. + + :ivar documents: The input documents to be analyzed. + :vartype documents: list[~azure.ai.language.documents.models.MultiLanguageInput] + """ + + documents: Optional[list["_models.MultiLanguageInput"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """The input documents to be analyzed.""" + + @overload + def __init__( + self, + *, + documents: Optional[list["_models.MultiLanguageInput"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class MultiLanguageInput(_Model): + """Contains an input document to be analyzed by the service. + + :ivar id: A unique, non-empty document identifier. Required. + :vartype id: str + :ivar source: The location of the input document to process. Required. + :vartype source: ~azure.ai.language.documents.models.DocumentLocation + :ivar target: The location where the processed document will be stored. Required. + :vartype target: ~azure.ai.language.documents.models.DocumentLocation + :ivar language: (Optional) This is the 2 letter ISO 639-1 representation of a language. For + example, use \\"en\\" for English; \\"es\\" for Spanish etc. If not set, use \\"en\\" for + English as default. + :vartype language: str + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """A unique, non-empty document identifier. Required.""" + source: "_models.DocumentLocation" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The location of the input document to process. Required.""" + target: "_models.DocumentLocation" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The location where the processed document will be stored. Required.""" + language: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use + \\"en\\" for English; \\"es\\" for Spanish etc. If not set, use \\"en\\" for English as + default.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + source: "_models.DocumentLocation", + target: "_models.DocumentLocation", + language: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class NoMaskPolicy(BaseRedactionPolicy, discriminator="noMask"): + """Represents the policy of not redacting found PII. + + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + :ivar policy_kind: The entity RedactionPolicy object kind. Required. Do not redact detected + entities. + :vartype policy_kind: str or ~azure.ai.language.documents.models.NO_MASK + """ + + policy_kind: Literal[RedactionPolicyKind.NO_MASK] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The entity RedactionPolicy object kind. Required. Do not redact detected entities.""" + + @overload + def __init__( + self, + *, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.policy_kind = RedactionPolicyKind.NO_MASK # type: ignore + + +class PiiEntityRecognitionLROResult(AnalyzeDocumentsLROResult, discriminator="PiiEntityRecognitionLROResults"): + """Contains the PII LRO results. + + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: The kind of the task. Required. PII entity recognition LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION_LRO_RESULTS + :ivar results: The list of pii document results. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + """ + + kind: Literal[AnalyzeDocumentsLROResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The kind of the task. Required. PII entity recognition LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The list of pii document results. Required.""" + + @overload + def __init__( + self, + *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS # type: ignore + + +class PiiLROTask(AnalyzeDocumentsLROTask, discriminator="PiiEntityRecognition"): + """Contains the analyze text PIIEntityRecognition LRO task. + + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: Kind of the task. Required. PII entity recognition task. + :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION + :ivar parameters: Pii task parameters. + :vartype parameters: ~azure.ai.language.documents.models.PiiTaskParameters + """ + + kind: Literal[AnalyzeDocumentsLROTaskKind.PII_ENTITY_RECOGNITION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. PII entity recognition task.""" + parameters: Optional["_models.PiiTaskParameters"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Pii task parameters.""" + + @overload + def __init__( + self, + *, + task_name: Optional[str] = None, + parameters: Optional["_models.PiiTaskParameters"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROTaskKind.PII_ENTITY_RECOGNITION # type: ignore + + +class PiiTaskParameters(_Model): + """Supported parameters for a PII Entities Recognition task. + + :ivar logging_opt_out: logging opt out. + :vartype logging_opt_out: bool + :ivar model_version: model version. + :vartype model_version: str + :ivar domain: Domain for PII task. Known values are: "phi" and "none". + :vartype domain: str or ~azure.ai.language.documents.models.PiiDomain + :ivar pii_categories: Enumeration of PII categories to be returned in the response. + :vartype pii_categories: list[str or ~azure.ai.language.documents.models.PiiCategoriesExtended] + :ivar string_index_type: StringIndexType to be used for analysis. Known values are: + "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". + :vartype string_index_type: str or ~azure.ai.language.documents.models.StringIndexType + :ivar exclude_pii_categories: Enumeration of PII categories to be excluded in the response. + :vartype exclude_pii_categories: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar value_exclusion_policy: Policy for specific words and terms that should be excluded from + detection by the PII detection service. + :vartype value_exclusion_policy: ~azure.ai.language.documents.models.ValueExclusionPolicy + :ivar entity_synonyms: (Optional) request parameter that allows the user to provide synonyms + for context words that to enhance pii entity detection. + :vartype entity_synonyms: list[~azure.ai.language.documents.models.EntitySynonyms] + :ivar redaction_policies: List of RedactionPolicies to be used on the input. + :vartype redaction_policies: list[~azure.ai.language.documents.models.BaseRedactionPolicy] + :ivar confidence_score_threshold: Confidence score threshold configuration for PII entity + recognition. + :vartype confidence_score_threshold: + ~azure.ai.language.documents.models.ConfidenceScoreThreshold + :ivar disable_entity_validation: Disable entity validation for PII entity recognition. + :vartype disable_entity_validation: bool + """ + + logging_opt_out: Optional[bool] = rest_field( + name="loggingOptOut", visibility=["read", "create", "update", "delete", "query"] + ) + """logging opt out.""" + model_version: Optional[str] = rest_field( + name="modelVersion", visibility=["read", "create", "update", "delete", "query"] + ) + """model version.""" + domain: Optional[Union[str, "_models.PiiDomain"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Domain for PII task. Known values are: \"phi\" and \"none\".""" + pii_categories: Optional[list[Union[str, "_models.PiiCategoriesExtended"]]] = rest_field( + name="piiCategories", visibility=["read", "create", "update", "delete", "query"] + ) + """Enumeration of PII categories to be returned in the response.""" + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = rest_field( + name="stringIndexType", visibility=["read", "create", "update", "delete", "query"] + ) + """StringIndexType to be used for analysis. Known values are: \"TextElements_v8\", + \"UnicodeCodePoint\", and \"Utf16CodeUnit\".""" + exclude_pii_categories: Optional[list[Union[str, "_models.PiiCategories"]]] = rest_field( + name="excludePiiCategories", visibility=["read", "create", "update", "delete", "query"] + ) + """Enumeration of PII categories to be excluded in the response.""" + value_exclusion_policy: Optional["_models.ValueExclusionPolicy"] = rest_field( + name="valueExclusionPolicy", visibility=["read", "create", "update", "delete", "query"] + ) + """Policy for specific words and terms that should be excluded from detection by the PII detection + service.""" + entity_synonyms: Optional[list["_models.EntitySynonyms"]] = rest_field( + name="entitySynonyms", visibility=["read", "create", "update", "delete", "query"] + ) + """(Optional) request parameter that allows the user to provide synonyms for context words that to + enhance pii entity detection.""" + redaction_policies: Optional[list["_models.BaseRedactionPolicy"]] = rest_field( + name="redactionPolicies", visibility=["read", "create", "update", "delete", "query"] + ) + """List of RedactionPolicies to be used on the input.""" + confidence_score_threshold: Optional["_models.ConfidenceScoreThreshold"] = rest_field( + name="confidenceScoreThreshold", visibility=["read", "create", "update", "delete", "query"] + ) + """Confidence score threshold configuration for PII entity recognition.""" + disable_entity_validation: Optional[bool] = rest_field( + name="disableEntityValidation", visibility=["read", "create", "update", "delete", "query"] + ) + """Disable entity validation for PII entity recognition.""" + + @overload + def __init__( + self, + *, + logging_opt_out: Optional[bool] = None, + model_version: Optional[str] = None, + domain: Optional[Union[str, "_models.PiiDomain"]] = None, + pii_categories: Optional[list[Union[str, "_models.PiiCategoriesExtended"]]] = None, + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = None, + exclude_pii_categories: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + value_exclusion_policy: Optional["_models.ValueExclusionPolicy"] = None, + entity_synonyms: Optional[list["_models.EntitySynonyms"]] = None, + redaction_policies: Optional[list["_models.BaseRedactionPolicy"]] = None, + confidence_score_threshold: Optional["_models.ConfidenceScoreThreshold"] = None, + disable_entity_validation: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class RequestStatistics(_Model): + """if showStats=true was specified in the request this field will contain information about the + request payload. + + :ivar documents_count: Number of documents submitted in the request. Required. + :vartype documents_count: int + :ivar valid_documents_count: Number of valid documents. This excludes empty, over-size limit or + non-supported languages documents. Required. + :vartype valid_documents_count: int + :ivar erroneous_documents_count: Number of invalid documents. This includes empty, over-size + limit or non-supported languages documents. Required. + :vartype erroneous_documents_count: int + :ivar transactions_count: Number of transactions for the request. Required. + :vartype transactions_count: int + """ + + documents_count: int = rest_field(name="documentsCount", visibility=["read", "create", "update", "delete", "query"]) + """Number of documents submitted in the request. Required.""" + valid_documents_count: int = rest_field( + name="validDocumentsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of valid documents. This excludes empty, over-size limit or non-supported languages + documents. Required.""" + erroneous_documents_count: int = rest_field( + name="erroneousDocumentsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of invalid documents. This includes empty, over-size limit or non-supported languages + documents. Required.""" + transactions_count: int = rest_field( + name="transactionsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of transactions for the request. Required.""" + + @overload + def __init__( + self, + *, + documents_count: int, + valid_documents_count: int, + erroneous_documents_count: int, + transactions_count: int, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class SyntheticReplacementPolicyType(BaseRedactionPolicy, discriminator="syntheticReplacement"): + """Represents the policy of replacing detected PII with synthetic values. + + :ivar entity_types: (Optional) describes the PII categories to which the redaction policy will + be applied. If not specified, the redaction policy will be applied to all PII categories. + :vartype entity_types: list[str or ~azure.ai.language.documents.models.PiiCategories] + :ivar policy_name: (Optional) name of the redaction policy for identification purposes. + :vartype policy_name: str + :ivar is_default: (Optional) flag to indicate whether this redaction policy is the default + policy to be applied when no specific policy is defined for a PII category. Only one policy can + be marked as default. + :vartype is_default: bool + :ivar policy_kind: The entity RedactionPolicy object kind. Required. Replace detected entities + with synthetic values. + :vartype policy_kind: str or ~azure.ai.language.documents.models.SYNTHETIC_REPLACEMENT + :ivar preserve_data_format: Optional flag to indicate whether to preserve the original data + format in the synthetic replacement. Default is false. + :vartype preserve_data_format: bool + """ + + policy_kind: Literal[RedactionPolicyKind.SYNTHETIC_REPLACEMENT] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The entity RedactionPolicy object kind. Required. Replace detected entities with synthetic + values.""" + preserve_data_format: Optional[bool] = rest_field( + name="preserveDataFormat", visibility=["read", "create", "update", "delete", "query"] + ) + """Optional flag to indicate whether to preserve the original data format in the synthetic + replacement. Default is false.""" + + @overload + def __init__( + self, + *, + entity_types: Optional[list[Union[str, "_models.PiiCategories"]]] = None, + policy_name: Optional[str] = None, + is_default: Optional[bool] = None, + preserve_data_format: Optional[bool] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.policy_kind = RedactionPolicyKind.SYNTHETIC_REPLACEMENT # type: ignore + + +class Tasks(_Model): + """Container for the tasks status for the LRO job. + + :ivar completed: Count of completed tasks. Required. + :vartype completed: int + :ivar failed: Count of failed tasks. Required. + :vartype failed: int + :ivar in_progress: Count of inprogress tasks. Required. + :vartype in_progress: int + :ivar total: Count of total tasks. Required. + :vartype total: int + :ivar items_property: Enumerable of Analyze documents job results. + :vartype items_property: list[~azure.ai.language.documents.models.AnalyzeDocumentsLROResult] + """ + + completed: int = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Count of completed tasks. Required.""" + failed: int = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Count of failed tasks. Required.""" + in_progress: int = rest_field(name="inProgress", visibility=["read", "create", "update", "delete", "query"]) + """Count of inprogress tasks. Required.""" + total: int = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Count of total tasks. Required.""" + items_property: Optional[list["_models.AnalyzeDocumentsLROResult"]] = rest_field( + name="items", visibility=["read", "create", "update", "delete", "query"], original_tsp_name="items" + ) + """Enumerable of Analyze documents job results.""" + + @overload + def __init__( + self, + *, + completed: int, + failed: int, + in_progress: int, + total: int, + items_property: Optional[list["_models.AnalyzeDocumentsLROResult"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ValueExclusionPolicy(_Model): + """Policy for specific words and terms that should be excluded from detection by the PII detection + service. + + :ivar case_sensitive: Option to make the values excluded values case sensitive. Required. + :vartype case_sensitive: bool + :ivar excluded_values: List of words and terms that should be excluded from detection by the + PII detection service. Required. + :vartype excluded_values: list[str] + """ + + case_sensitive: bool = rest_field(name="caseSensitive", visibility=["read", "create", "update", "delete", "query"]) + """Option to make the values excluded values case sensitive. Required.""" + excluded_values: list[str] = rest_field( + name="excludedValues", visibility=["read", "create", "update", "delete", "query"] + ) + """List of words and terms that should be excluded from detection by the PII detection service. + Required.""" + + @overload + def __init__( + self, + *, + case_sensitive: bool, + excluded_values: list[str], + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_patch.py new file mode 100644 index 000000000000..87676c65a8f0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_patch.py @@ -0,0 +1,21 @@ +# 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. +# -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/py.typed b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt b/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt new file mode 100644 index 000000000000..0e53b6a72db5 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt @@ -0,0 +1,3 @@ +-e ../../../eng/tools/azure-sdk-tools +../../core/azure-core +aiohttp \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py new file mode 100644 index 000000000000..6a9f8ba7f9db --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py @@ -0,0 +1,33 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_job_status_task_status_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + response = client.analyze_documents_job_status( + job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + ) + print(response) + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py new file mode 100644 index 000000000000..e2ac62b0a74f --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py @@ -0,0 +1,32 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_jobs_cancel_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + client.begin_analyze_documents_cancel_job( + job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + ).result() + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py new file mode 100644 index 000000000000..f938d069e557 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py @@ -0,0 +1,57 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_jobs_task_submit_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + client.begin_analyze_documents_submit_job( + body={ + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "source": { + "kind": "AzureBlob", + "location": "https://myblob.blob.core.windows.net/Container/document.txt", + }, + "target": {"kind": "AzureBlob", "location": "https://myblob.blob.core.windows.net/Container"}, + } + ] + }, + "displayName": "Redact PII from documents example", + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "piiCategories": ["Person", "Organization"], + "redactionPolicies": [{"policyKind": "characterMask", "redactionCharacter": "-"}], + }, + "taskName": "Redact PII Task 1", + } + ], + }, + ).result() + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py new file mode 100644 index 000000000000..fbc56efe75b0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py @@ -0,0 +1,39 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import os +import pytest +from dotenv import load_dotenv +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) + +load_dotenv() + + +# For security, please avoid record sensitive identity information in recordings +@pytest.fixture(scope="session", autouse=True) +def add_sanitizers(test_proxy): + analyzedocuments_subscription_id = os.environ.get( + "ANALYZEDOCUMENTS_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000" + ) + analyzedocuments_tenant_id = os.environ.get("ANALYZEDOCUMENTS_TENANT_ID", "00000000-0000-0000-0000-000000000000") + analyzedocuments_client_id = os.environ.get("ANALYZEDOCUMENTS_CLIENT_ID", "00000000-0000-0000-0000-000000000000") + analyzedocuments_client_secret = os.environ.get( + "ANALYZEDOCUMENTS_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" + ) + add_general_regex_sanitizer(regex=analyzedocuments_subscription_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=analyzedocuments_tenant_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=analyzedocuments_client_id, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer(regex=analyzedocuments_client_secret, value="00000000-0000-0000-0000-000000000000") + + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") + add_header_regex_sanitizer(key="Cookie", value="cookie;") + add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py new file mode 100644 index 000000000000..6a8f991be17b --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py @@ -0,0 +1,55 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import AnalyzeDocumentsClientTestBase, AnalyzeDocumentsPreparer + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_analyze_documents_job_status(self, analyzedocuments_endpoint): + client = self.create_client(endpoint=analyzedocuments_endpoint) + response = client.analyze_documents_job_status( + job_id="str", + ) + + # please add some check logic here by yourself + # ... + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoint): + client = self.create_client(endpoint=analyzedocuments_endpoint) + response = client.begin_analyze_documents_submit_job( + body={ + "analysisInput": { + "documents": [ + {"id": "str", "source": "document_location", "target": "document_location", "language": "str"} + ] + }, + "tasks": ["analyze_documents_lro_task"], + "defaultLanguage": "str", + "displayName": "str", + }, + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_begin_analyze_documents_cancel_job(self, analyzedocuments_endpoint): + client = self.create_client(endpoint=analyzedocuments_endpoint) + response = client.begin_analyze_documents_cancel_job( + job_id="str", + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py new file mode 100644 index 000000000000..ec145edc9c32 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py @@ -0,0 +1,65 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils.aio import recorded_by_proxy_async +from testpreparer import AnalyzeDocumentsPreparer +from testpreparer_async import AnalyzeDocumentsClientTestBaseAsync + + +@pytest.mark.skip("you may need to update the auto-generated test case before run it") +class TestAnalyzeDocumentsAsync(AnalyzeDocumentsClientTestBaseAsync): + @AnalyzeDocumentsPreparer() + @recorded_by_proxy_async + async def test_analyze_documents_job_status(self, analyzedocuments_endpoint): + client = self.create_async_client(endpoint=analyzedocuments_endpoint) + response = await client.analyze_documents_job_status( + job_id="str", + ) + + # please add some check logic here by yourself + # ... + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy_async + async def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoint): + client = self.create_async_client(endpoint=analyzedocuments_endpoint) + response = await ( + await client.begin_analyze_documents_submit_job( + body={ + "analysisInput": { + "documents": [ + { + "id": "str", + "source": "document_location", + "target": "document_location", + "language": "str", + } + ] + }, + "tasks": ["analyze_documents_lro_task"], + "defaultLanguage": "str", + "displayName": "str", + }, + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy_async + async def test_begin_analyze_documents_cancel_job(self, analyzedocuments_endpoint): + client = self.create_async_client(endpoint=analyzedocuments_endpoint) + response = await ( + await client.begin_analyze_documents_cancel_job( + job_id="str", + ) + ).result() # call '.result()' to poll until service return final result + + # please add some check logic here by yourself + # ... diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py new file mode 100644 index 000000000000..7989d9415d7f --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py @@ -0,0 +1,26 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.ai.language.documents import AnalyzeDocumentsClient +from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer +import functools + + +class AnalyzeDocumentsClientTestBase(AzureRecordedTestCase): + + def create_client(self, endpoint): + credential = self.get_credential(AnalyzeDocumentsClient) + return self.create_client_from_credential( + AnalyzeDocumentsClient, + credential=credential, + endpoint=endpoint, + ) + + +AnalyzeDocumentsPreparer = functools.partial( + PowerShellPreparer, "analyzedocuments", analyzedocuments_endpoint="https://fake_analyzedocuments_endpoint.com" +) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py new file mode 100644 index 000000000000..e622a903ccb8 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py @@ -0,0 +1,20 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +from azure.ai.language.documents.aio import AnalyzeDocumentsClient +from devtools_testutils import AzureRecordedTestCase + + +class AnalyzeDocumentsClientTestBaseAsync(AzureRecordedTestCase): + + def create_async_client(self, endpoint): + credential = self.get_credential(AnalyzeDocumentsClient, is_async=True) + return self.create_client_from_credential( + AnalyzeDocumentsClient, + credential=credential, + endpoint=endpoint, + ) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/pyproject.toml b/sdk/cognitivelanguage/azure-ai-language-documents/pyproject.toml new file mode 100644 index 000000000000..9be276831c77 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/pyproject.toml @@ -0,0 +1,62 @@ +# -------------------------------------------------------------------------- +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-ai-language-documents" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Ai Language Documents Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +requires-python = ">=3.9" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.37.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.ai.language.documents._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.ai", + "azure.ai.language", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml new file mode 100644 index 000000000000..87c29fc20de4 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments +commit: 0295acbed05cf1cb9f92f7307e2a049e8d7058cd +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/cognitivelanguage/ci.yml b/sdk/cognitivelanguage/ci.yml index a3f6f546494b..a3ba0bc671fd 100644 --- a/sdk/cognitivelanguage/ci.yml +++ b/sdk/cognitivelanguage/ci.yml @@ -43,3 +43,5 @@ extends: safeName: azureaitextanalyticsauthoring - name: azure-ai-textanalytics safeName: azureaitextanalytics + - name: azure-ai-language-documents + safeName: azureailanguagedocuments \ No newline at end of file From e5c4d579ed8b920ca81dcaf960a19822a09390af Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:13:05 -0700 Subject: [PATCH 02/37] updated ReadMe --- .../azure-ai-language-documents/README.md | 444 +++++++++++++++++- 1 file changed, 421 insertions(+), 23 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index c9383e996078..375d4eefa49a 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -1,43 +1,441 @@ -# Azure Ai Language Documents client library for Python - +# Azure AI Language Documents client library for Python + +Azure AI Language Documents lets you submit documents stored in Azure Blob Storage for long-running language analysis jobs. You define the input documents, where output artifacts should be written, and one or more analysis tasks such as personally identifiable information (PII) entity recognition. + +[Source code][documents_client_src] +| [Package (PyPI)][documents_pypi_package] +| [Package (Conda)](https://anaconda.org/microsoft/azure-ai-language-documents/) +| +| [Product documentation][documents_docs] +| +| [Documents REST API][documents_rest_docs] + +> _Python 2.7 is not supported. For details see the Azure SDK for Python end-of-support notice._ ## Getting started +### Prerequisites + +* Python 3.9 or later. +* An [Azure subscription][azure_subscription]. +* An Azure [Language resource][language_service] with a custom domain endpoint if you plan to use Azure Active Directory authentication. +* Azure Blob Storage locations for your source documents and output targets. + ### Install the package +Install the Azure AI Language Documents client library for Python with [pip][pip_link]: + ```bash python -m pip install azure-ai-language-documents ``` -#### Prequisites +> This version of the client library targets the service REST API version `2026-05-01`. + +### Authenticate the client + +To interact with the Documents service, create an instance of `AnalyzeDocumentsClient`. The **recommended** approach is to use Azure Active Directory via `DefaultAzureCredential` from the [azure-identity][azure_identity_credentials] library. + +> Important: To use Azure AD (AAD) you must use your resource's **custom subdomain** endpoint, for example `https://.cognitiveservices.azure.com/`. Regional endpoints do **not** support AAD token authentication. + +#### Recommended: `DefaultAzureCredential` + +Prerequisites for AAD authentication: + +* [Install azure-identity][install_azure_identity] +* [Register an AAD application][register_aad_app] +* [Grant access][grant_role_access] to the Language resource + +Set these environment variables only if you’re using a service principal with a client secret: + +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Then create the client: + +```python +from azure.identity import DefaultAzureCredential +from azure.ai.language.documents import AnalyzeDocumentsClient + +endpoint = "https://.cognitiveservices.azure.com/" +credential = DefaultAzureCredential() + +client = AnalyzeDocumentsClient(endpoint, credential) +``` + + +**Why `DefaultAzureCredential`?** + +* Eliminates hard-coded secrets +* Works locally, in CI, and in production +* Supports managed identity without code changes +* Centralizes token acquisition and caching + +## Key concepts + +### `AnalyzeDocumentsClient` + +[`AnalyzeDocumentsClient`][documents_client_class] is the primary interface for submitting document analysis jobs, checking job status, and cancelling submitted jobs. + +For asynchronous operations, an async `AnalyzeDocumentsClient` is available in the `azure.ai.language.documents.aio` namespace. + +### Input and task model relationships + +The request body for job submission is built from these models: + +* `AnalyzeDocumentJobsInput` – top-level job definition +* `MultiLanguageAnalysisInput` – collection of documents to analyze +* `MultiLanguageInput` – one input document, including: + * `source` – input document location + * `target` – output location +* `DocumentLocation` subtypes – storage-backed document locations: + * `AzureBlobDocumentLocation` + * `AzureContainerDocumentLocation` + * `AzureContainerFolderDocumentLocation` +* `AnalyzeDocumentsLROTask` subtypes – tasks to run for the job, such as: + * `PiiLROTask` + +PII task configuration is provided through `PiiTaskParameters`, including optional `redaction_policies`. + +### Results model relationships + +`analyze_documents_job_status` returns `AnalyzeDocumentsJobState`, which contains: + +* overall job metadata and status +* `tasks`, a `Tasks` object +* `tasks.items_property`, which contains per-task results such as: + * `PiiEntityRecognitionLROResult` + * `AbstractiveSummarizationLROResult` + +Each task result contains an `AnalyzeDocumentsResult`, which exposes: + +* `documents` +* `errors` +* `statistics` +* `model_version` + +## Examples + +### `AnalyzeDocumentsClient` usage examples + +The `azure-ai-language-documents` client library provides both synchronous and asynchronous APIs. + +* [Submit a job (model objects)](#submit-a-job-model-objects) +* [Submit a job (JSON body)](#submit-a-job-json-body) +* [Get job status and results](#get-job-status-and-results) +* [Cancel a job](#cancel-a-job) +* [Async usage](#async-usage) + +#### Submit a job (model objects) + +This example submits a PII analysis job using strongly typed model objects: + +```python + +import os + +from azure.identity import DefaultAzureCredential +from azure.ai.language.documents import AnalyzeDocumentsClient +from azure.ai.language.documents.models import ( + AnalyzeDocumentJobsInput, + MultiLanguageAnalysisInput, + MultiLanguageInput, + AzureBlobDocumentLocation, + AzureContainerFolderDocumentLocation, + PiiLROTask, + PiiTaskParameters, + CharacterMaskPolicy, +) + +endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"] +client = AnalyzeDocumentsClient(endpoint, DefaultAzureCredential()) + +job = AnalyzeDocumentJobsInput( + display_name="sample-documents-job", + analysis_input=MultiLanguageAnalysisInput( + documents=[ + MultiLanguageInput( + id="1", + source=AzureBlobDocumentLocation( + location="https://.blob.core.windows.net/input/invoice-1.txt" + ), + target=AzureContainerFolderDocumentLocation( + location="https://.blob.core.windows.net/output/pii-results/" + ), + language="en", + ) + ] + ), + tasks=[ + PiiLROTask( + task_name="pii-redaction", + parameters=PiiTaskParameters( + redaction_policies=[ + CharacterMaskPolicy(is_default=True) + ] + ), + ) + ], + default_language="en", +) + +poller = client.begin_analyze_documents_submit_job(job) +poller.result() + +print(f"Job completed with status: {poller.status()}") +``` + +#### Submit a job (JSON body) + +You can also submit the request as a JSON-compatible dictionary: + +```python +import os + +from azure.identity import DefaultAzureCredential +from azure.ai.language.documents import AnalyzeDocumentsClient + +endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"] +client = AnalyzeDocumentsClient(endpoint, DefaultAzureCredential()) + +body = { + "displayName": "sample-documents-job", + "analysisInput": { + "documents": [ + { + "id": "1", + "source": { + "kind": "AzureBlob", + "location": "https://.blob.core.windows.net/input/invoice-1.txt", + }, + "target": { + "kind": "AzureContainerFolder", + "location": "https://.blob.core.windows.net/output/pii-results/", + }, + "language": "en", + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "taskName": "pii-redaction", + "parameters": { + "redactionPolicies": [ + { + "policyKind": "characterMask", + "isDefault": True, + } + ] + }, + } + ], + "defaultLanguage": "en", +} + +poller = client.begin_analyze_documents_submit_job(body) +poller.result() + +print(f"Job completed with status: {poller.status()}") +``` -- Python 3.9 or later is required to use this package. -- You need an [Azure subscription][azure_sub] to use this package. -- An existing Azure Ai Language Documents instance. +#### Get job status and results +If you have a job ID, use `analyze_documents_job_status` to retrieve the full job state and task results: + +```python +from azure.core.exceptions import HttpResponseError + +job_id = "" + +try: + job_state = client.analyze_documents_job_status(job_id, show_stats=True) + + print(f"Job ID: {job_state.job_id}") + print(f"Status: {job_state.status}") + print(f"Created: {job_state.created_date_time}") + print(f"Updated: {job_state.last_updated_date_time}") + + if job_state.statistics: + print(f"Documents: {job_state.statistics.documents_count}") + print(f"Transactions: {job_state.statistics.transactions_count}") + + for task in job_state.tasks.items_property or []: + print(f"Task kind: {task.kind}") + print(f"Task status: {task.status}") + + if hasattr(task, "results"): + print(f"Model version: {task.results.model_version}") + for document in task.results.documents: + print(f"Document ID: {document.id}") + print(f"Source: {document.source.location}") + for target in document.target: + print(f"Target: {target.location}") + +except HttpResponseError as error: + print(f"Request failed: {error.message}") +``` + +#### Cancel a job + +If you need to cancel a submitted job, use `begin_analyze_documents_cancel_job`: + +```python + +job_id = "" + +cancel_poller = client.begin_analyze_documents_cancel_job(job_id) +cancel_poller.result() + +print(f"Cancellation request completed with status: {cancel_poller.status()}") + +``` + +#### Async usage + +The same patterns are available with the async client in `azure.ai.language.documents.aio`: + +```python + +import os +import asyncio + +from azure.identity.aio import DefaultAzureCredential +from azure.ai.language.documents.aio import AnalyzeDocumentsClient +from azure.ai.language.documents.models import ( + AnalyzeDocumentJobsInput, + MultiLanguageAnalysisInput, + MultiLanguageInput, + AzureBlobDocumentLocation, + AzureContainerFolderDocumentLocation, + PiiLROTask, +) + + +async def main(): + credential = DefaultAzureCredential() + client = AnalyzeDocumentsClient( + os.environ["AZURE_LANGUAGE_ENDPOINT"], + credential, + ) + + try: + job = AnalyzeDocumentJobsInput( + display_name="async-documents-job", + analysis_input=MultiLanguageAnalysisInput( + documents=[ + MultiLanguageInput( + id="1", + source=AzureBlobDocumentLocation( + location="https://.blob.core.windows.net/input/invoice-1.txt" + ), + target=AzureContainerFolderDocumentLocation( + location="https://.blob.core.windows.net/output/pii-results/" + ), + language="en", + ) + ] + ), + tasks=[ + PiiLROTask(task_name="pii-analysis") + ], + default_language="en", + ) + + poller = await client.begin_analyze_documents_submit_job(job) + await poller.result() + + print(f"Job completed with status: {poller.status()}") + + finally: + await client.close() + await credential.close() + + +asyncio.run(main()) + +``` + +## Optional configuration + +Optional keyword arguments can be passed at both the client and per-operation level. The azure-core [reference documentation][azure_core_ref_docs] describes available configurations for retries, logging, transport protocols, and more. + +## Troubleshooting + +### General + +Azure AI Language Documents clients raise exceptions defined in [Azure Core][azure_core_readme]. + +When you interact with the service using the Python SDK, service errors map to the same HTTP status codes returned by the [REST API][documents_rest_docs]. + +For example: + +```python + +from azure.core.exceptions import HttpResponseError + +try: + client.analyze_documents_job_status("invalid-job-id") +except HttpResponseError as error: + print(f"Query failed: {error.message}") + +``` + +### Logging + +This library uses the standard [logging][python_logging] library for logging. + +Basic information about HTTP sessions, such as URLs and headers, is logged at INFO level. + +Detailed DEBUG logging, including request and response bodies and unredacted headers, can be enabled with the `logging_enable` argument. + +See the full SDK logging documentation in the [logging guidance][sdk_logging_docs]. + +## API usage notes + +This library supports both: + +* **Strongly typed model inputs** via `AnalyzeDocumentJobsInput` +* **JSON-compatible dictionary inputs** for direct request construction + +The typed-model approach is recommended for clarity, static analysis, and discoverability. + +## Next steps + +* View our [samples][documents_samples]. +* Read more about [Azure AI Language][documents_docs]. +* Review the [REST API][documents_rest_docs]. ## Contributing -This project welcomes contributions and suggestions. Most contributions require -you to agree to a Contributor License Agreement (CLA) declaring that you have -the right to, and actually do, grant us the rights to use your contribution. -For details, visit https://cla.microsoft.com. +See the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to this library. + +This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. -When you submit a pull request, a CLA-bot will automatically determine whether -you need to provide a CLA and decorate the PR appropriately (e.g., label, -comment). Simply follow the instructions provided by the bot. You will only -need to do this once across all repos using our CLA. +When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (for example, label or comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. -This project has adopted the -[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, -see the Code of Conduct FAQ or contact opencode@microsoft.com with any -additional questions or comments. +This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. + +[azure_subscription]: https://azure.microsoft.com/free/ +[language_service]: https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesTextAnalytics +[cla]: https://cla.microsoft.com +[coc_contact]: mailto:opencode@microsoft.com +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ -[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[contributing]: https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md +[python_logging]: https://docs.python.org/3/library/logging.html +[sdk_logging_docs]: https://learn.microsoft.com/azure/developer/python/azure-sdk-logging +[azure_core_ref_docs]: https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/latest/azure.core.html +[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md +[pip_link]: https://pypi.org/project/pip/ + +[documents_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/ +[documents_docs]: https://learn.microsoft.com/azure/ai-services/language-service/ +[documents_pypi_package]: https://pypi.org/project/azure-ai-language-documents/ + + +[documents_rest_docs]: https://learn.microsoft.com/rest/api/language/ [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials -[azure_identity_pip]: https://pypi.org/project/azure-identity/ -[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential -[pip]: https://pypi.org/project/pip/ -[azure_sub]: https://azure.microsoft.com/free/ +[install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#install-the-package +[register_aad_app]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal +[grant_role_access]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal \ No newline at end of file From e83a21acc25ef41040a1c67f33a99dbfa189c0a8 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:18:47 -0700 Subject: [PATCH 03/37] fix Check spelling --- .vscode/cspell.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.vscode/cspell.json b/.vscode/cspell.json index 577b4f0584fa..ab8290c7d000 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -898,6 +898,11 @@ "words": [ "conv", "summ", "Enviar", "presentación", "CLU's"], "caseSensitive": false }, + { + "filename": "sdk/cognitivelanguage/azure-ai-language-documents/**", + "words": [ "BRCPF", "IDRG", "EUGPS", "PLREGON", "REGON", "ESDNI", "USUK", "BRCPF", "IDRG", "EUGPS", "PLREGON" ], + "caseSensitive": false + }, { "filename": "sdk/cognitivelanguage/azure-ai-language-conversations/doc/*.rst", "words": [ "undoc" ] From f63a74ff4fbea790758cf804ea439c5a4027a577 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:20:16 -0700 Subject: [PATCH 04/37] removed generated samples --- ...ocuments_job_status_task_status_request.py | 33 ----------- ...l_analyze_documents_jobs_cancel_request.py | 32 ----------- ...lyze_documents_jobs_task_submit_request.py | 57 ------------------- 3 files changed, 122 deletions(-) delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py deleted file mode 100644 index 6a9f8ba7f9db..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py +++ /dev/null @@ -1,33 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_job_status_task_status_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - response = client.analyze_documents_job_status( - job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - ) - print(response) - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json -if __name__ == "__main__": - main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py deleted file mode 100644 index e2ac62b0a74f..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py +++ /dev/null @@ -1,32 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_jobs_cancel_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - client.begin_analyze_documents_cancel_job( - job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - ).result() - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json -if __name__ == "__main__": - main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py deleted file mode 100644 index f938d069e557..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py +++ /dev/null @@ -1,57 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_jobs_task_submit_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - client.begin_analyze_documents_submit_job( - body={ - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "source": { - "kind": "AzureBlob", - "location": "https://myblob.blob.core.windows.net/Container/document.txt", - }, - "target": {"kind": "AzureBlob", "location": "https://myblob.blob.core.windows.net/Container"}, - } - ] - }, - "displayName": "Redact PII from documents example", - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "piiCategories": ["Person", "Organization"], - "redactionPolicies": [{"policyKind": "characterMask", "redactionCharacter": "-"}], - }, - "taskName": "Redact PII Task 1", - } - ], - }, - ).result() - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json -if __name__ == "__main__": - main() From f0be81e2b501fd7fc3905ddb7a787e32a3d6fce2 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:23:57 -0700 Subject: [PATCH 05/37] updated docstring --- .../azure/ai/language/documents/_client.py | 7 ++++--- .../azure/ai/language/documents/aio/_client.py | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py index ab31168f0799..9339db5d8a00 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py @@ -28,9 +28,10 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview - https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + detection and question answering. + + Further documentation: + https://learn.microsoft.com/azure/cognitive-services/language-service/overview :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py index 513cccb77baf..3b4d4c2bcd3d 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py @@ -28,9 +28,10 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview - https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + detection and question answering. + + Further documentation: + https://learn.microsoft.com/azure/cognitive-services/language-service/overview :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. From 75215daa81972400d0c9d0a19c05dde087b88ebc Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:27:47 -0700 Subject: [PATCH 06/37] added azure-identity --- .../azure-ai-language-documents/dev_requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt b/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt index 0e53b6a72db5..396f26f367a1 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt +++ b/sdk/cognitivelanguage/azure-ai-language-documents/dev_requirements.txt @@ -1,3 +1,4 @@ -e ../../../eng/tools/azure-sdk-tools ../../core/azure-core -aiohttp \ No newline at end of file +aiohttp +../../identity/azure-identity \ No newline at end of file From acd6e86fbb5062a5b98c027a6646d72aec150a6c Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 20 Apr 2026 00:33:02 -0700 Subject: [PATCH 07/37] updated ReadMe --- sdk/cognitivelanguage/azure-ai-language-documents/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index 375d4eefa49a..ce10e7fe3c4b 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -29,7 +29,7 @@ Install the Azure AI Language Documents client library for Python with [pip][pip python -m pip install azure-ai-language-documents ``` -> This version of the client library targets the service REST API version `2026-05-01`. +> This version of the client library targets the service REST API version `2026-05-15-preview`. ### Authenticate the client From a791bf6866fb5d727ea9e1dee65b74b5a5f6eb15 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 14 May 2026 13:10:54 -0700 Subject: [PATCH 08/37] updated --- .../_metadata.json | 6 +- .../apiview-properties.json | 23 +- .../azure/ai/language/documents/_client.py | 7 +- .../documents/_operations/_operations.py | 40 +- .../ai/language/documents/aio/_client.py | 7 +- .../documents/aio/_operations/_operations.py | 32 +- .../ai/language/documents/models/__init__.py | 14 + .../ai/language/documents/models/_enums.py | 37 +- .../ai/language/documents/models/_models.py | 350 +++++++++++++++--- .../generated_tests/test_analyze_documents.py | 12 +- .../test_analyze_documents_async.py | 12 +- .../tsp-location.yaml | 4 +- 12 files changed, 420 insertions(+), 124 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json b/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json index 329287a6a0cc..785f8fd9f6d7 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/_metadata.json @@ -2,9 +2,5 @@ "apiVersion": "2026-05-15-preview", "apiVersions": { "Language.AnalyzeDocuments": "2026-05-15-preview" - }, - "commit": "0295acbed05cf1cb9f92f7307e2a049e8d7058cd", - "repository_url": "https://github.com/Azure/azure-rest-api-specs", - "typespec_src": "specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments", - "emitterVersion": "0.61.3" + } } \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json index ae72cbfb8e46..b47f197839e4 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json @@ -3,10 +3,12 @@ "CrossLanguageDefinitionId": { "azure.ai.language.documents.models.AnalyzeDocumentsLROResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationLROResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", + "azure.ai.language.documents.models.AnalyzeDocumentsLROTask": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTask", + "azure.ai.language.documents.models.AbstractiveSummarizationLROTask": "Language.AnalyzeDocuments.AbstractiveSummarizationLROTask", + "azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.AbstractiveSummarizationTaskParameters", "azure.ai.language.documents.models.AnalyzeDocumentJobsInput": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", "azure.ai.language.documents.models.AnalyzeDocumentsDocumentError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", "azure.ai.language.documents.models.AnalyzeDocumentsJobState": "Language.AnalyzeDocuments.AnalyzeDocumentsJobState", - "azure.ai.language.documents.models.AnalyzeDocumentsLROTask": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTask", "azure.ai.language.documents.models.AnalyzeDocumentsResult": "Language.AnalyzeDocuments.AnalyzeDocumentsResult", "azure.ai.language.documents.models.DocumentLocation": "Language.AnalyzeDocuments.DocumentLocation", "azure.ai.language.documents.models.AzureBlobDocumentLocation": "Language.AnalyzeDocuments.AzureBlobDocumentLocation", @@ -24,6 +26,9 @@ "azure.ai.language.documents.models.EntitySynonyms": "Language.AnalyzeDocuments.EntitySynonyms", "azure.ai.language.documents.models.Error": "Language.AnalyzeDocuments.Error", "azure.ai.language.documents.models.ErrorResponse": "Language.AnalyzeDocuments.ErrorResponse", + "azure.ai.language.documents.models.ExtractiveSummarizationLROResult": "Language.AnalyzeDocuments.ExtractiveSummarizationLROResult", + "azure.ai.language.documents.models.ExtractiveSummarizationLROTask": "Language.AnalyzeDocuments.ExtractiveSummarizationLROTask", + "azure.ai.language.documents.models.ExtractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.ExtractiveSummarizationTaskParameters", "azure.ai.language.documents.models.InnerErrorModel": "Language.AnalyzeDocuments.InnerErrorModel", "azure.ai.language.documents.models.MarkerMaskPolicy": "Language.AnalyzeDocuments.MarkerMaskPolicy", "azure.ai.language.documents.models.MultiLanguageAnalysisInput": "Language.AnalyzeDocuments.MultiLanguageAnalysisInput", @@ -43,17 +48,19 @@ "azure.ai.language.documents.models.WarningCodeValue": "Language.AnalyzeDocuments.WarningCodeValue", "azure.ai.language.documents.models.DocumentLocationKind": "Language.AnalyzeDocuments.DocumentLocationKind", "azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTaskKind", + "azure.ai.language.documents.models.StringIndexType": "Language.AnalyzeDocuments.StringIndexType", + "azure.ai.language.documents.models.SummaryLengthBucket": "Language.AnalyzeDocuments.SummaryLengthBucket", + "azure.ai.language.documents.models.ExtractiveSummarizationSortingCriteria": "Language.AnalyzeDocuments.ExtractiveSummarizationSortingCriteria", "azure.ai.language.documents.models.PiiDomain": "Language.AnalyzeDocuments.PiiDomain", "azure.ai.language.documents.models.PiiCategoriesExtended": "Language.AnalyzeDocuments.PiiCategoriesExtended", - "azure.ai.language.documents.models.StringIndexType": "Language.AnalyzeDocuments.StringIndexType", "azure.ai.language.documents.models.PiiCategories": "Language.AnalyzeDocuments.PiiCategories", "azure.ai.language.documents.models.RedactionPolicyKind": "Language.AnalyzeDocuments.RedactionPolicyKind", "azure.ai.language.documents.models.RedactionCharacter": "Language.AnalyzeDocuments.redactionCharacter", - "azure.ai.language.documents.AnalyzeDocumentsClient.analyze_documents_job_status": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", - "azure.ai.language.documents.aio.AnalyzeDocumentsClient.analyze_documents_job_status": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", - "azure.ai.language.documents.AnalyzeDocumentsClient.begin_analyze_documents_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", - "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_analyze_documents_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", - "azure.ai.language.documents.AnalyzeDocumentsClient.begin_analyze_documents_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob", - "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_analyze_documents_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob" + "azure.ai.language.documents.AnalyzeDocumentsClient.get_job_state": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.get_job_state": "Language.AnalyzeDocuments.analyzeDocumentsJobStatus", + "azure.ai.language.documents.AnalyzeDocumentsClient.begin_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_submit_job": "Language.AnalyzeDocuments.analyzeDocumentsSubmitJob", + "azure.ai.language.documents.AnalyzeDocumentsClient.begin_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob", + "azure.ai.language.documents.aio.AnalyzeDocumentsClient.begin_cancel_job": "Language.AnalyzeDocuments.analyzeDocumentsCancelJob" } } \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py index 9339db5d8a00..ab31168f0799 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py @@ -28,10 +28,9 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. - - Further documentation: - https://learn.microsoft.com/azure/cognitive-services/language-service/overview + detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview + https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py index 0567d40f4d7c..94b5aa7ee036 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py @@ -42,13 +42,13 @@ _SERIALIZER.client_side_validation = False -def build_analyze_documents_analyze_documents_job_status_request( # pylint: disable=name-too-long +def build_analyze_documents_get_job_state_request( # pylint: disable=name-too-long job_id: str, *, show_stats: Optional[bool] = None, top: Optional[int] = None, skip: Optional[int] = None, - **kwargs: Any, + **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) @@ -79,9 +79,7 @@ def build_analyze_documents_analyze_documents_job_status_request( # pylint: dis return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_analyze_documents_analyze_documents_submit_job_request( # pylint: disable=name-too-long - **kwargs: Any, -) -> HttpRequest: +def build_analyze_documents_submit_job_request(**kwargs: Any) -> HttpRequest: # pylint: disable=name-too-long _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) @@ -100,7 +98,7 @@ def build_analyze_documents_analyze_documents_submit_job_request( # pylint: dis return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_analyze_documents_analyze_documents_cancel_job_request( # pylint: disable=name-too-long +def build_analyze_documents_cancel_job_request( # pylint: disable=name-too-long job_id: str, **kwargs: Any ) -> HttpRequest: _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) @@ -125,14 +123,14 @@ class _AnalyzeDocumentsClientOperationsMixin( ): @distributed_trace - def analyze_documents_job_status( + def get_job_state( self, job_id: str, *, show_stats: Optional[bool] = None, top: Optional[int] = None, skip: Optional[int] = None, - **kwargs: Any, + **kwargs: Any ) -> _models.AnalyzeDocumentsJobState: """Get analysis status and results. @@ -169,7 +167,7 @@ def analyze_documents_job_status( cls: ClsType[_models.AnalyzeDocumentsJobState] = kwargs.pop("cls", None) - _request = build_analyze_documents_analyze_documents_job_status_request( + _request = build_analyze_documents_get_job_state_request( job_id=job_id, show_stats=show_stats, top=top, @@ -214,7 +212,7 @@ def analyze_documents_job_status( return deserialized # type: ignore - def _analyze_documents_submit_job_initial( + def _submit_job_initial( self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any ) -> Iterator[bytes]: error_map: MutableMapping = { @@ -238,7 +236,7 @@ def _analyze_documents_submit_job_initial( else: _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_analyze_documents_analyze_documents_submit_job_request( + _request = build_analyze_documents_submit_job_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -281,7 +279,7 @@ def _analyze_documents_submit_job_initial( return deserialized # type: ignore @overload - def begin_analyze_documents_submit_job( + def begin_submit_job( self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -298,9 +296,7 @@ def begin_analyze_documents_submit_job( """ @overload - def begin_analyze_documents_submit_job( - self, body: JSON, *, content_type: str = "application/json", **kwargs: Any - ) -> LROPoller[None]: + def begin_submit_job(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. @@ -315,7 +311,7 @@ def begin_analyze_documents_submit_job( """ @overload - def begin_analyze_documents_submit_job( + def begin_submit_job( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -332,7 +328,7 @@ def begin_analyze_documents_submit_job( """ @distributed_trace - def begin_analyze_documents_submit_job( + def begin_submit_job( self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any ) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -354,7 +350,7 @@ def begin_analyze_documents_submit_job( lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: - raw_result = self._analyze_documents_submit_job_initial( + raw_result = self._submit_job_initial( body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) raw_result.http_response.read() # type: ignore @@ -385,7 +381,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- ) return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore - def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> Iterator[bytes]: + def _cancel_job_initial(self, job_id: str, **kwargs: Any) -> Iterator[bytes]: error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -399,7 +395,7 @@ def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> I cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) - _request = build_analyze_documents_analyze_documents_cancel_job_request( + _request = build_analyze_documents_cancel_job_request( job_id=job_id, api_version=self._config.api_version, headers=_headers, @@ -441,7 +437,7 @@ def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> I return deserialized # type: ignore @distributed_trace - def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: + def begin_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: """Cancel a long-running Text Analysis job. Cancel a long-running Text Analysis job. @@ -460,7 +456,7 @@ def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) -> LROP lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: - raw_result = self._analyze_documents_cancel_job_initial( + raw_result = self._cancel_job_initial( job_id=job_id, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) raw_result.http_response.read() # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py index 3b4d4c2bcd3d..513cccb77baf 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py @@ -28,10 +28,9 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. - - Further documentation: - https://learn.microsoft.com/azure/cognitive-services/language-service/overview + detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview + https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py index 264e6db877f6..92047c41b876 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py @@ -31,9 +31,9 @@ from ... import models as _models from ..._operations._operations import ( - build_analyze_documents_analyze_documents_cancel_job_request, - build_analyze_documents_analyze_documents_job_status_request, - build_analyze_documents_analyze_documents_submit_job_request, + build_analyze_documents_cancel_job_request, + build_analyze_documents_get_job_state_request, + build_analyze_documents_submit_job_request, ) from ..._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize from ..._utils.utils import ClientMixinABC @@ -49,7 +49,7 @@ class _AnalyzeDocumentsClientOperationsMixin( ): @distributed_trace_async - async def analyze_documents_job_status( + async def get_job_state( self, job_id: str, *, @@ -93,7 +93,7 @@ async def analyze_documents_job_status( cls: ClsType[_models.AnalyzeDocumentsJobState] = kwargs.pop("cls", None) - _request = build_analyze_documents_analyze_documents_job_status_request( + _request = build_analyze_documents_get_job_state_request( job_id=job_id, show_stats=show_stats, top=top, @@ -138,7 +138,7 @@ async def analyze_documents_job_status( return deserialized # type: ignore - async def _analyze_documents_submit_job_initial( + async def _submit_job_initial( self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any ) -> AsyncIterator[bytes]: error_map: MutableMapping = { @@ -162,7 +162,7 @@ async def _analyze_documents_submit_job_initial( else: _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_analyze_documents_analyze_documents_submit_job_request( + _request = build_analyze_documents_submit_job_request( content_type=content_type, api_version=self._config.api_version, content=_content, @@ -205,7 +205,7 @@ async def _analyze_documents_submit_job_initial( return deserialized # type: ignore @overload - async def begin_analyze_documents_submit_job( + async def begin_submit_job( self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -222,7 +222,7 @@ async def begin_analyze_documents_submit_job( """ @overload - async def begin_analyze_documents_submit_job( + async def begin_submit_job( self, body: JSON, *, content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -239,7 +239,7 @@ async def begin_analyze_documents_submit_job( """ @overload - async def begin_analyze_documents_submit_job( + async def begin_submit_job( self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -256,7 +256,7 @@ async def begin_analyze_documents_submit_job( """ @distributed_trace_async - async def begin_analyze_documents_submit_job( + async def begin_submit_job( self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be @@ -278,7 +278,7 @@ async def begin_analyze_documents_submit_job( lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: - raw_result = await self._analyze_documents_submit_job_initial( + raw_result = await self._submit_job_initial( body=body, content_type=content_type, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) await raw_result.http_response.read() # type: ignore @@ -310,7 +310,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- ) return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore - async def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any) -> AsyncIterator[bytes]: + async def _cancel_job_initial(self, job_id: str, **kwargs: Any) -> AsyncIterator[bytes]: error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, @@ -324,7 +324,7 @@ async def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) - _request = build_analyze_documents_analyze_documents_cancel_job_request( + _request = build_analyze_documents_cancel_job_request( job_id=job_id, api_version=self._config.api_version, headers=_headers, @@ -366,7 +366,7 @@ async def _analyze_documents_cancel_job_initial(self, job_id: str, **kwargs: Any return deserialized # type: ignore @distributed_trace_async - async def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[None]: + async def begin_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[None]: """Cancel a long-running Text Analysis job. Cancel a long-running Text Analysis job. @@ -385,7 +385,7 @@ async def begin_analyze_documents_cancel_job(self, job_id: str, **kwargs: Any) - lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token: Optional[str] = kwargs.pop("continuation_token", None) if cont_token is None: - raw_result = await self._analyze_documents_cancel_job_initial( + raw_result = await self._cancel_job_initial( job_id=job_id, cls=lambda x, y, z: x, headers=_headers, params=_params, **kwargs ) await raw_result.http_response.read() # type: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py index 6c46f0c471bb..e0596ab62c24 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py @@ -15,6 +15,8 @@ from ._models import ( # type: ignore AbstractiveSummarizationLROResult, + AbstractiveSummarizationLROTask, + AbstractiveSummarizationTaskParameters, AnalyzeDocumentJobsInput, AnalyzeDocumentsDocumentError, AnalyzeDocumentsJobState, @@ -37,6 +39,9 @@ EntitySynonyms, Error, ErrorResponse, + ExtractiveSummarizationLROResult, + ExtractiveSummarizationLROTask, + ExtractiveSummarizationTaskParameters, InnerErrorModel, MarkerMaskPolicy, MultiLanguageAnalysisInput, @@ -56,6 +61,7 @@ AnalyzeDocumentsLROTaskKind, DocumentLocationKind, ErrorCode, + ExtractiveSummarizationSortingCriteria, InnerErrorCode, PiiCategories, PiiCategoriesExtended, @@ -64,6 +70,7 @@ RedactionPolicyKind, State, StringIndexType, + SummaryLengthBucket, WarningCodeValue, ) from ._patch import __all__ as _patch_all @@ -72,6 +79,8 @@ __all__ = [ "AbstractiveSummarizationLROResult", + "AbstractiveSummarizationLROTask", + "AbstractiveSummarizationTaskParameters", "AnalyzeDocumentJobsInput", "AnalyzeDocumentsDocumentError", "AnalyzeDocumentsJobState", @@ -94,6 +103,9 @@ "EntitySynonyms", "Error", "ErrorResponse", + "ExtractiveSummarizationLROResult", + "ExtractiveSummarizationLROTask", + "ExtractiveSummarizationTaskParameters", "InnerErrorModel", "MarkerMaskPolicy", "MultiLanguageAnalysisInput", @@ -110,6 +122,7 @@ "AnalyzeDocumentsLROTaskKind", "DocumentLocationKind", "ErrorCode", + "ExtractiveSummarizationSortingCriteria", "InnerErrorCode", "PiiCategories", "PiiCategoriesExtended", @@ -118,6 +131,7 @@ "RedactionPolicyKind", "State", "StringIndexType", + "SummaryLengthBucket", "WarningCodeValue", ] __all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py index 0c81181aff54..88bfa0d00353 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py @@ -84,6 +84,16 @@ class ErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Warning error.""" +class ExtractiveSummarizationSortingCriteria(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The sorting criteria to use for the results of Extractive Summarization.""" + + OFFSET = "Offset" + """Indicates that results should be sorted in order of appearance in the text.""" + RANK = "Rank" + """Indicates that results should be sorted in order of importance (i.e. rank score) according to + the model.""" + + class InnerErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Human-readable error code.""" @@ -161,7 +171,8 @@ class PiiCategories(str, Enum, metaclass=CaseInsensitiveEnumMeta): AZURE_STORAGE_ACCOUNT_KEY = "AzureStorageAccountKey" """Azure Storage Account Key.""" AZURE_STORAGE_ACCOUNT_GENERIC = "AzureStorageAccountGeneric" - """Azure Storage Account Generic.""" + """Azure Storage account-related secrets or credentials that do not match a more specific Azure + Storage category.""" BE_NATIONAL_NUMBER = "BENationalNumber" """BE National Number.""" BE_NATIONAL_NUMBER_V2 = "BENationalNumberV2" @@ -508,7 +519,8 @@ class PiiCategoriesExtended(str, Enum, metaclass=CaseInsensitiveEnumMeta): AZURE_STORAGE_ACCOUNT_KEY = "AzureStorageAccountKey" """Azure Storage Account Key.""" AZURE_STORAGE_ACCOUNT_GENERIC = "AzureStorageAccountGeneric" - """Azure Storage Account Generic.""" + """Azure Storage account-related secrets or credentials that do not match a more specific Azure + Storage category.""" BE_NATIONAL_NUMBER = "BENationalNumber" """BE National Number.""" BE_NATIONAL_NUMBER_V2 = "BENationalNumberV2" @@ -865,7 +877,7 @@ class RedactionPolicyKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): NO_MASK = "noMask" """Do not redact detected entities.""" CHARACTER_MASK = "characterMask" - """React detected entities with redaction character.""" + """Redact detected entities with redaction character.""" ENTITY_MASK = "entityMask" """Redact detected entities with entity type.""" MARKER_MASK = "markerMask" @@ -901,14 +913,25 @@ class StringIndexType(str, Enum, metaclass=CaseInsensitiveEnumMeta): TEXT_ELEMENTS_V8 = "TextElements_v8" """Returned offset and length values will correspond to textElements (Graphemes and Grapheme - clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is - written in .Net Framework or .Net Core and you will be using StringInfo.""" + clusters) conforming to the Unicode 8.0.0 standard. Use this option if your application is + written in .NET Framework or .NET Core and you will be using StringInfo.""" UNICODE_CODE_POINT = "UnicodeCodePoint" """Returned offset and length values will correspond to Unicode code points. Use this option if - your application is written in a language that support Unicode, for example Python.""" + your application is written in a language that supports Unicode, for example Python.""" UTF16_CODE_UNIT = "Utf16CodeUnit" """Returned offset and length values will correspond to UTF-16 code units. Use this option if your - application is written in a language that support Unicode, for example Java, JavaScript.""" + application is written in a language that supports Unicode, for example Java, JavaScript.""" + + +class SummaryLengthBucket(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Enum that defines the length of the output summaries.""" + + SHORT = "short" + """Instructs model to generate shorter length summaries.""" + MEDIUM = "medium" + """Instructs model to generate medium length summaries.""" + LONG = "long" + """Instructs model to generate longer length summaries.""" class WarningCodeValue(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py index 92cd8001f32e..96ef5b9a5fdb 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py @@ -27,7 +27,8 @@ class AnalyzeDocumentsLROResult(_Model): """Contains the AnalyzeDocuments long running operation result object. You probably want to use the sub-classes and not this class directly. Known sub-classes are: - AbstractiveSummarizationLROResult, PiiEntityRecognitionLROResult + AbstractiveSummarizationLROResult, ExtractiveSummarizationLROResult, + PiiEntityRecognitionLROResult :ivar last_update_date_time: The last updated time in UTC for the task. Required. :vartype last_update_date_time: ~datetime.datetime @@ -122,6 +123,153 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.kind = AnalyzeDocumentsLROResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore +class AnalyzeDocumentsLROTask(_Model): + """The long running task to be performed by the service on the input documents. + + You probably want to use the sub-classes and not this class directly. Known sub-classes are: + AbstractiveSummarizationLROTask, ExtractiveSummarizationLROTask, PiiLROTask + + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: The kind of task to perform. Required. Known values are: "PiiEntityRecognition", + "ExtractiveSummarization", and "AbstractiveSummarization". + :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind + """ + + __mapping__: dict[str, _Model] = {} + task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) + """task name.""" + kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) + """The kind of task to perform. Required. Known values are: \"PiiEntityRecognition\", + \"ExtractiveSummarization\", and \"AbstractiveSummarization\".""" + + @overload + def __init__( + self, + *, + kind: str, + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AbstractiveSummarizationLROTask(AnalyzeDocumentsLROTask, discriminator="AbstractiveSummarization"): + """An object representing the task definition for an Abstractive Summarization task. + + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: The Abstractive Summarization kind of the long running task. Required. Abstractive + summarization task. + :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION + :ivar parameters: Parameters for the Abstractive Summarization task. Required. + :vartype parameters: ~azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters + """ + + kind: Literal[AnalyzeDocumentsLROTaskKind.ABSTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The Abstractive Summarization kind of the long running task. Required. Abstractive + summarization task.""" + parameters: "_models.AbstractiveSummarizationTaskParameters" = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Parameters for the Abstractive Summarization task. Required.""" + + @overload + def __init__( + self, + *, + parameters: "_models.AbstractiveSummarizationTaskParameters", + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROTaskKind.ABSTRACTIVE_SUMMARIZATION # type: ignore + + +class AbstractiveSummarizationTaskParameters(_Model): + """Supported parameters for the pre-built Abstractive Summarization task. + + :ivar logging_opt_out: logging opt out. + :vartype logging_opt_out: bool + :ivar model_version: model version. + :vartype model_version: str + :ivar sentence_count: Controls the approximate number of sentences in the output summaries. + :vartype sentence_count: int + :ivar string_index_type: String index type. Known values are: "TextElements_v8", + "UnicodeCodePoint", and "Utf16CodeUnit". + :vartype string_index_type: str or ~azure.ai.language.documents.models.StringIndexType + :ivar summary_length: (NOTE: Recommended to use summaryLength over sentenceCount) Controls the + approximate length of the output summaries. Known values are: "short", "medium", and "long". + :vartype summary_length: str or ~azure.ai.language.documents.models.SummaryLengthBucket + :ivar instruction: (Optional) If provided, the instruction will be used to generate the + summary. + :vartype instruction: str + """ + + logging_opt_out: Optional[bool] = rest_field( + name="loggingOptOut", visibility=["read", "create", "update", "delete", "query"] + ) + """logging opt out.""" + model_version: Optional[str] = rest_field( + name="modelVersion", visibility=["read", "create", "update", "delete", "query"] + ) + """model version.""" + sentence_count: Optional[int] = rest_field( + name="sentenceCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Controls the approximate number of sentences in the output summaries.""" + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = rest_field( + name="stringIndexType", visibility=["read", "create", "update", "delete", "query"] + ) + """String index type. Known values are: \"TextElements_v8\", \"UnicodeCodePoint\", and + \"Utf16CodeUnit\".""" + summary_length: Optional[Union[str, "_models.SummaryLengthBucket"]] = rest_field( + name="summaryLength", visibility=["read", "create", "update", "delete", "query"] + ) + """(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of + the output summaries. Known values are: \"short\", \"medium\", and \"long\".""" + instruction: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(Optional) If provided, the instruction will be used to generate the summary.""" + + @overload + def __init__( + self, + *, + logging_opt_out: Optional[bool] = None, + model_version: Optional[str] = None, + sentence_count: Optional[int] = None, + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = None, + summary_length: Optional[Union[str, "_models.SummaryLengthBucket"]] = None, + instruction: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + class AnalyzeDocumentJobsInput(_Model): """The input object for the analyze documents LRO. @@ -292,45 +440,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeDocumentsLROTask(_Model): - """The long running task to be performed by the service on the input documents. - - You probably want to use the sub-classes and not this class directly. Known sub-classes are: - PiiLROTask - - :ivar task_name: task name. - :vartype task_name: str - :ivar kind: The kind of task to perform. Required. Known values are: "PiiEntityRecognition", - "ExtractiveSummarization", and "AbstractiveSummarization". - :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind - """ - - __mapping__: dict[str, _Model] = {} - task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) - """task name.""" - kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) - """The kind of task to perform. Required. Known values are: \"PiiEntityRecognition\", - \"ExtractiveSummarization\", and \"AbstractiveSummarization\".""" - - @overload - def __init__( - self, - *, - kind: str, - task_name: Optional[str] = None, - ) -> None: ... - - @overload - def __init__(self, mapping: Mapping[str, Any]) -> None: - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - - class AnalyzeDocumentsResult(_Model): """Contains the result object for the processed document. @@ -616,7 +725,7 @@ class CharacterMaskPolicy(BaseRedactionPolicy, discriminator="characterMask"): policy to be applied when no specific policy is defined for a PII category. Only one policy can be marked as default. :vartype is_default: bool - :ivar policy_kind: The entity RedactionPolicy object kind. Required. React detected entities + :ivar policy_kind: The entity RedactionPolicy object kind. Required. Redact detected entities with redaction character. :vartype policy_kind: str or ~azure.ai.language.documents.models.CHARACTER_MASK :ivar redaction_character: Optional parameter to use a Custom Character to be used for @@ -627,7 +736,7 @@ class CharacterMaskPolicy(BaseRedactionPolicy, discriminator="characterMask"): """ policy_kind: Literal[RedactionPolicyKind.CHARACTER_MASK] = rest_discriminator(name="policyKind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """The entity RedactionPolicy object kind. Required. React detected entities with redaction + """The entity RedactionPolicy object kind. Required. Redact detected entities with redaction character.""" redaction_character: Optional[Union[str, "_models.RedactionCharacter"]] = rest_field( name="redactionCharacter", visibility=["read", "create", "update", "delete", "query"] @@ -1279,6 +1388,159 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) +class ExtractiveSummarizationLROResult(AnalyzeDocumentsLROResult, discriminator="ExtractiveSummarizationLROResults"): + """An object representing the results for an Extractive Summarization task. + + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: Kind of the task. Required. Extractive summarization LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS + :ivar results: Results of the document task. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + """ + + kind: Literal[AnalyzeDocumentsLROResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. Extractive summarization LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Results of the document task. Required.""" + + @overload + def __init__( + self, + *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", + task_name: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore + + +class ExtractiveSummarizationLROTask(AnalyzeDocumentsLROTask, discriminator="ExtractiveSummarization"): + """An object representing the task definition for an Extractive Summarization task. + + :ivar task_name: task name. + :vartype task_name: str + :ivar kind: The Extractive Summarization kind of the long running task. Required. Extractive + summarization task. + :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION + :ivar parameters: Parameters for the Extractive Summarization task. + :vartype parameters: ~azure.ai.language.documents.models.ExtractiveSummarizationTaskParameters + """ + + kind: Literal[AnalyzeDocumentsLROTaskKind.EXTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The Extractive Summarization kind of the long running task. Required. Extractive summarization + task.""" + parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Parameters for the Extractive Summarization task.""" + + @overload + def __init__( + self, + *, + task_name: Optional[str] = None, + parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + self.kind = AnalyzeDocumentsLROTaskKind.EXTRACTIVE_SUMMARIZATION # type: ignore + + +class ExtractiveSummarizationTaskParameters(_Model): + """Supported parameters for an Extractive Summarization task. + + :ivar logging_opt_out: logging opt out. + :vartype logging_opt_out: bool + :ivar model_version: model version. + :vartype model_version: str + :ivar sentence_count: Specifies the number of sentences in the extracted summary. + :vartype sentence_count: int + :ivar sort_by: Specifies how to sort the extracted summaries. Known values are: "Offset" and + "Rank". + :vartype sort_by: str or + ~azure.ai.language.documents.models.ExtractiveSummarizationSortingCriteria + :ivar string_index_type: Specifies the method used to interpret string offsets. Known values + are: "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". + :vartype string_index_type: str or ~azure.ai.language.documents.models.StringIndexType + :ivar query: (Optional) If provided, the query will be used to extract most relevant sentences + from the document. + :vartype query: str + """ + + logging_opt_out: Optional[bool] = rest_field( + name="loggingOptOut", visibility=["read", "create", "update", "delete", "query"] + ) + """logging opt out.""" + model_version: Optional[str] = rest_field( + name="modelVersion", visibility=["read", "create", "update", "delete", "query"] + ) + """model version.""" + sentence_count: Optional[int] = rest_field( + name="sentenceCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Specifies the number of sentences in the extracted summary.""" + sort_by: Optional[Union[str, "_models.ExtractiveSummarizationSortingCriteria"]] = rest_field( + name="sortBy", visibility=["read", "create", "update", "delete", "query"] + ) + """Specifies how to sort the extracted summaries. Known values are: \"Offset\" and \"Rank\".""" + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = rest_field( + name="stringIndexType", visibility=["read", "create", "update", "delete", "query"] + ) + """Specifies the method used to interpret string offsets. Known values are: \"TextElements_v8\", + \"UnicodeCodePoint\", and \"Utf16CodeUnit\".""" + query: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(Optional) If provided, the query will be used to extract most relevant sentences from the + document.""" + + @overload + def __init__( + self, + *, + logging_opt_out: Optional[bool] = None, + model_version: Optional[str] = None, + sentence_count: Optional[int] = None, + sort_by: Optional[Union[str, "_models.ExtractiveSummarizationSortingCriteria"]] = None, + string_index_type: Optional[Union[str, "_models.StringIndexType"]] = None, + query: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + class InnerErrorModel(_Model): """An object containing more specific information about the error. As per Microsoft One API guidelines - @@ -1704,7 +1966,7 @@ class RequestStatistics(_Model): :ivar erroneous_documents_count: Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. Required. :vartype erroneous_documents_count: int - :ivar transactions_count: Number of transactions for the request. Required. + :ivar transactions_count: Number of billing or usage transactions for the request. Required. :vartype transactions_count: int """ @@ -1723,7 +1985,7 @@ class RequestStatistics(_Model): transactions_count: int = rest_field( name="transactionsCount", visibility=["read", "create", "update", "delete", "query"] ) - """Number of transactions for the request. Required.""" + """Number of billing or usage transactions for the request. Required.""" @overload def __init__( diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py index 6a8f991be17b..b6f21eaf2bcd 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py @@ -14,9 +14,9 @@ class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): @AnalyzeDocumentsPreparer() @recorded_by_proxy - def test_analyze_documents_job_status(self, analyzedocuments_endpoint): + def test_get_job_state(self, analyzedocuments_endpoint): client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.analyze_documents_job_status( + response = client.get_job_state( job_id="str", ) @@ -25,9 +25,9 @@ def test_analyze_documents_job_status(self, analyzedocuments_endpoint): @AnalyzeDocumentsPreparer() @recorded_by_proxy - def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoint): + def test_begin_submit_job(self, analyzedocuments_endpoint): client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.begin_analyze_documents_submit_job( + response = client.begin_submit_job( body={ "analysisInput": { "documents": [ @@ -45,9 +45,9 @@ def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoint): @AnalyzeDocumentsPreparer() @recorded_by_proxy - def test_begin_analyze_documents_cancel_job(self, analyzedocuments_endpoint): + def test_begin_cancel_job(self, analyzedocuments_endpoint): client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.begin_analyze_documents_cancel_job( + response = client.begin_cancel_job( job_id="str", ).result() # call '.result()' to poll until service return final result diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py index ec145edc9c32..e48cb13cf221 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py @@ -15,9 +15,9 @@ class TestAnalyzeDocumentsAsync(AnalyzeDocumentsClientTestBaseAsync): @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_analyze_documents_job_status(self, analyzedocuments_endpoint): + async def test_get_job_state(self, analyzedocuments_endpoint): client = self.create_async_client(endpoint=analyzedocuments_endpoint) - response = await client.analyze_documents_job_status( + response = await client.get_job_state( job_id="str", ) @@ -26,10 +26,10 @@ async def test_analyze_documents_job_status(self, analyzedocuments_endpoint): @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoint): + async def test_begin_submit_job(self, analyzedocuments_endpoint): client = self.create_async_client(endpoint=analyzedocuments_endpoint) response = await ( - await client.begin_analyze_documents_submit_job( + await client.begin_submit_job( body={ "analysisInput": { "documents": [ @@ -53,10 +53,10 @@ async def test_begin_analyze_documents_submit_job(self, analyzedocuments_endpoin @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_begin_analyze_documents_cancel_job(self, analyzedocuments_endpoint): + async def test_begin_cancel_job(self, analyzedocuments_endpoint): client = self.create_async_client(endpoint=analyzedocuments_endpoint) response = await ( - await client.begin_analyze_documents_cancel_job( + await client.begin_cancel_job( job_id="str", ) ).result() # call '.result()' to poll until service return final result diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml index 87c29fc20de4..8edf995490f6 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments -commit: 0295acbed05cf1cb9f92f7307e2a049e8d7058cd -repo: Azure/azure-rest-api-specs +commit: +repo: additionalDirectories: From 6974e56ab455a6d0f94a9444a07a6962b0817b12 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 14 May 2026 13:12:30 -0700 Subject: [PATCH 09/37] replace LRO in names. --- .../apiview-properties.json | 20 +- .../ai/language/documents/models/__init__.py | 40 +-- .../ai/language/documents/models/_enums.py | 24 +- .../ai/language/documents/models/_models.py | 304 +++++++++--------- .../generated_tests/test_analyze_documents.py | 2 +- .../test_analyze_documents_async.py | 2 +- 6 files changed, 201 insertions(+), 191 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json index b47f197839e4..f2b4a8ca9657 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json @@ -1,10 +1,10 @@ { "CrossLanguagePackageId": "Language.AnalyzeDocuments", "CrossLanguageDefinitionId": { - "azure.ai.language.documents.models.AnalyzeDocumentsLROResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", - "azure.ai.language.documents.models.AbstractiveSummarizationLROResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", - "azure.ai.language.documents.models.AnalyzeDocumentsLROTask": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTask", - "azure.ai.language.documents.models.AbstractiveSummarizationLROTask": "Language.AnalyzeDocuments.AbstractiveSummarizationLROTask", + "azure.ai.language.documents.models.AnalyzeDocumentsOperationAction": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTask", + "azure.ai.language.documents.models.AbstractiveSummarizationOperationAction": "Language.AnalyzeDocuments.AbstractiveSummarizationLROTask", + "azure.ai.language.documents.models.AnalyzeDocumentsOperationResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", + "azure.ai.language.documents.models.AbstractiveSummarizationOperationResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.AbstractiveSummarizationTaskParameters", "azure.ai.language.documents.models.AnalyzeDocumentJobsInput": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", "azure.ai.language.documents.models.AnalyzeDocumentsDocumentError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", @@ -26,16 +26,16 @@ "azure.ai.language.documents.models.EntitySynonyms": "Language.AnalyzeDocuments.EntitySynonyms", "azure.ai.language.documents.models.Error": "Language.AnalyzeDocuments.Error", "azure.ai.language.documents.models.ErrorResponse": "Language.AnalyzeDocuments.ErrorResponse", - "azure.ai.language.documents.models.ExtractiveSummarizationLROResult": "Language.AnalyzeDocuments.ExtractiveSummarizationLROResult", - "azure.ai.language.documents.models.ExtractiveSummarizationLROTask": "Language.AnalyzeDocuments.ExtractiveSummarizationLROTask", + "azure.ai.language.documents.models.ExtractiveSummarizationOperationAction": "Language.AnalyzeDocuments.ExtractiveSummarizationLROTask", + "azure.ai.language.documents.models.ExtractiveSummarizationOperationResult": "Language.AnalyzeDocuments.ExtractiveSummarizationLROResult", "azure.ai.language.documents.models.ExtractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.ExtractiveSummarizationTaskParameters", "azure.ai.language.documents.models.InnerErrorModel": "Language.AnalyzeDocuments.InnerErrorModel", "azure.ai.language.documents.models.MarkerMaskPolicy": "Language.AnalyzeDocuments.MarkerMaskPolicy", "azure.ai.language.documents.models.MultiLanguageAnalysisInput": "Language.AnalyzeDocuments.MultiLanguageAnalysisInput", "azure.ai.language.documents.models.MultiLanguageInput": "Language.AnalyzeDocuments.MultiLanguageInput", "azure.ai.language.documents.models.NoMaskPolicy": "Language.AnalyzeDocuments.NoMaskPolicy", - "azure.ai.language.documents.models.PiiEntityRecognitionLROResult": "Language.AnalyzeDocuments.PiiEntityRecognitionLROResult", - "azure.ai.language.documents.models.PiiLROTask": "Language.AnalyzeDocuments.PiiLROTask", + "azure.ai.language.documents.models.PiiEntityRecognitionAction": "Language.AnalyzeDocuments.PiiLROTask", + "azure.ai.language.documents.models.PiiEntityRecognitionOperationResult": "Language.AnalyzeDocuments.PiiEntityRecognitionLROResult", "azure.ai.language.documents.models.PiiTaskParameters": "Language.AnalyzeDocuments.PiiTaskParameters", "azure.ai.language.documents.models.RequestStatistics": "Language.AnalyzeDocuments.RequestStatistics", "azure.ai.language.documents.models.SyntheticReplacementPolicyType": "Language.AnalyzeDocuments.SyntheticReplacementPolicyType", @@ -44,10 +44,10 @@ "azure.ai.language.documents.models.State": "Language.AnalyzeDocuments.State", "azure.ai.language.documents.models.ErrorCode": "Language.AnalyzeDocuments.ErrorCode", "azure.ai.language.documents.models.InnerErrorCode": "Language.AnalyzeDocuments.InnerErrorCode", - "azure.ai.language.documents.models.AnalyzeDocumentsLROResultsKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResultsKind", + "azure.ai.language.documents.models.AnalyzeDocumentsOperationResultsKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResultsKind", "azure.ai.language.documents.models.WarningCodeValue": "Language.AnalyzeDocuments.WarningCodeValue", "azure.ai.language.documents.models.DocumentLocationKind": "Language.AnalyzeDocuments.DocumentLocationKind", - "azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTaskKind", + "azure.ai.language.documents.models.AnalyzeDocumentsOperationActionKind": "Language.AnalyzeDocuments.AnalyzeDocumentsLROTaskKind", "azure.ai.language.documents.models.StringIndexType": "Language.AnalyzeDocuments.StringIndexType", "azure.ai.language.documents.models.SummaryLengthBucket": "Language.AnalyzeDocuments.SummaryLengthBucket", "azure.ai.language.documents.models.ExtractiveSummarizationSortingCriteria": "Language.AnalyzeDocuments.ExtractiveSummarizationSortingCriteria", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py index e0596ab62c24..c758818c7ab1 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py @@ -14,14 +14,14 @@ from ._models import ( # type: ignore - AbstractiveSummarizationLROResult, - AbstractiveSummarizationLROTask, + AbstractiveSummarizationOperationAction, + AbstractiveSummarizationOperationResult, AbstractiveSummarizationTaskParameters, AnalyzeDocumentJobsInput, AnalyzeDocumentsDocumentError, AnalyzeDocumentsJobState, - AnalyzeDocumentsLROResult, - AnalyzeDocumentsLROTask, + AnalyzeDocumentsOperationAction, + AnalyzeDocumentsOperationResult, AnalyzeDocumentsResult, AzureBlobDocumentLocation, AzureContainerDocumentLocation, @@ -39,16 +39,16 @@ EntitySynonyms, Error, ErrorResponse, - ExtractiveSummarizationLROResult, - ExtractiveSummarizationLROTask, + ExtractiveSummarizationOperationAction, + ExtractiveSummarizationOperationResult, ExtractiveSummarizationTaskParameters, InnerErrorModel, MarkerMaskPolicy, MultiLanguageAnalysisInput, MultiLanguageInput, NoMaskPolicy, - PiiEntityRecognitionLROResult, - PiiLROTask, + PiiEntityRecognitionAction, + PiiEntityRecognitionOperationResult, PiiTaskParameters, RequestStatistics, SyntheticReplacementPolicyType, @@ -57,8 +57,8 @@ ) from ._enums import ( # type: ignore - AnalyzeDocumentsLROResultsKind, - AnalyzeDocumentsLROTaskKind, + AnalyzeDocumentsOperationActionKind, + AnalyzeDocumentsOperationResultsKind, DocumentLocationKind, ErrorCode, ExtractiveSummarizationSortingCriteria, @@ -78,14 +78,14 @@ from ._patch import patch_sdk as _patch_sdk __all__ = [ - "AbstractiveSummarizationLROResult", - "AbstractiveSummarizationLROTask", + "AbstractiveSummarizationOperationAction", + "AbstractiveSummarizationOperationResult", "AbstractiveSummarizationTaskParameters", "AnalyzeDocumentJobsInput", "AnalyzeDocumentsDocumentError", "AnalyzeDocumentsJobState", - "AnalyzeDocumentsLROResult", - "AnalyzeDocumentsLROTask", + "AnalyzeDocumentsOperationAction", + "AnalyzeDocumentsOperationResult", "AnalyzeDocumentsResult", "AzureBlobDocumentLocation", "AzureContainerDocumentLocation", @@ -103,23 +103,23 @@ "EntitySynonyms", "Error", "ErrorResponse", - "ExtractiveSummarizationLROResult", - "ExtractiveSummarizationLROTask", + "ExtractiveSummarizationOperationAction", + "ExtractiveSummarizationOperationResult", "ExtractiveSummarizationTaskParameters", "InnerErrorModel", "MarkerMaskPolicy", "MultiLanguageAnalysisInput", "MultiLanguageInput", "NoMaskPolicy", - "PiiEntityRecognitionLROResult", - "PiiLROTask", + "PiiEntityRecognitionAction", + "PiiEntityRecognitionOperationResult", "PiiTaskParameters", "RequestStatistics", "SyntheticReplacementPolicyType", "Tasks", "ValueExclusionPolicy", - "AnalyzeDocumentsLROResultsKind", - "AnalyzeDocumentsLROTaskKind", + "AnalyzeDocumentsOperationActionKind", + "AnalyzeDocumentsOperationResultsKind", "DocumentLocationKind", "ErrorCode", "ExtractiveSummarizationSortingCriteria", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py index 88bfa0d00353..5c69af5b0fcd 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py @@ -10,18 +10,7 @@ from azure.core import CaseInsensitiveEnumMeta -class AnalyzeDocumentsLROResultsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The kind of the response object returned by the analyze-documents long running task.""" - - PII_ENTITY_RECOGNITION_LRO_RESULTS = "PiiEntityRecognitionLROResults" - """PII entity recognition LRO results.""" - EXTRACTIVE_SUMMARIZATION_LRO_RESULTS = "ExtractiveSummarizationLROResults" - """Extractive summarization LRO results.""" - ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS = "AbstractiveSummarizationLROResults" - """Abstractive summarization LRO results.""" - - -class AnalyzeDocumentsLROTaskKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): +class AnalyzeDocumentsOperationActionKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The kind of the long running analyze documents tasks supported.""" PII_ENTITY_RECOGNITION = "PiiEntityRecognition" @@ -32,6 +21,17 @@ class AnalyzeDocumentsLROTaskKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Abstractive summarization task.""" +class AnalyzeDocumentsOperationResultsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """The kind of the response object returned by the analyze-documents long running task.""" + + PII_ENTITY_RECOGNITION_LRO_RESULTS = "PiiEntityRecognitionLROResults" + """PII entity recognition LRO results.""" + EXTRACTIVE_SUMMARIZATION_LRO_RESULTS = "ExtractiveSummarizationLROResults" + """Extractive summarization LRO results.""" + ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS = "AbstractiveSummarizationLROResults" + """Abstractive summarization LRO results.""" + + class DocumentLocationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Enumeration of supported document locations.""" diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py index 96ef5b9a5fdb..3f012d9582d8 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py @@ -13,8 +13,8 @@ from .._utils.model_base import Model as _Model, rest_discriminator, rest_field from ._enums import ( - AnalyzeDocumentsLROResultsKind, - AnalyzeDocumentsLROTaskKind, + AnalyzeDocumentsOperationActionKind, + AnalyzeDocumentsOperationResultsKind, DocumentLocationKind, RedactionPolicyKind, ) @@ -23,47 +23,31 @@ from .. import models as _models -class AnalyzeDocumentsLROResult(_Model): - """Contains the AnalyzeDocuments long running operation result object. +class AnalyzeDocumentsOperationAction(_Model): + """The long running task to be performed by the service on the input documents. You probably want to use the sub-classes and not this class directly. Known sub-classes are: - AbstractiveSummarizationLROResult, ExtractiveSummarizationLROResult, - PiiEntityRecognitionLROResult + AbstractiveSummarizationOperationAction, ExtractiveSummarizationOperationAction, + PiiEntityRecognitionAction - :ivar last_update_date_time: The last updated time in UTC for the task. Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the task at the mentioned last update time. Required. Known values - are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and - "cancelling". - :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: Kind of the task. Required. Known values are: "PiiEntityRecognitionLROResults", - "ExtractiveSummarizationLROResults", and "AbstractiveSummarizationLROResults". - :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROResultsKind + :ivar kind: The kind of task to perform. Required. Known values are: "PiiEntityRecognition", + "ExtractiveSummarization", and "AbstractiveSummarization". + :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsOperationActionKind """ __mapping__: dict[str, _Model] = {} - last_update_date_time: datetime.datetime = rest_field( - name="lastUpdateDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" - ) - """The last updated time in UTC for the task. Required.""" - status: Union[str, "_models.State"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """The status of the task at the mentioned last update time. Required. Known values are: - \"notStarted\", \"running\", \"succeeded\", \"partiallyCompleted\", \"failed\", \"cancelled\", - and \"cancelling\".""" task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) """task name.""" kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) - """Kind of the task. Required. Known values are: \"PiiEntityRecognitionLROResults\", - \"ExtractiveSummarizationLROResults\", and \"AbstractiveSummarizationLROResults\".""" + """The kind of task to perform. Required. Known values are: \"PiiEntityRecognition\", + \"ExtractiveSummarization\", and \"AbstractiveSummarization\".""" @overload def __init__( self, *, - last_update_date_time: datetime.datetime, - status: Union[str, "_models.State"], kind: str, task_name: Optional[str] = None, ) -> None: ... @@ -79,35 +63,33 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AbstractiveSummarizationLROResult(AnalyzeDocumentsLROResult, discriminator="AbstractiveSummarizationLROResults"): - """An object representing the results for an Abstractive Summarization task. +class AbstractiveSummarizationOperationAction( + AnalyzeDocumentsOperationAction, discriminator="AbstractiveSummarization" +): + """An object representing the task definition for an Abstractive Summarization task. - :ivar last_update_date_time: The last updated time in UTC for the task. Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the task at the mentioned last update time. Required. Known values - are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and - "cancelling". - :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: Kind of the task. Required. Abstractive summarization LRO results. - :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS - :ivar results: Results of the task. Required. - :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + :ivar kind: The Abstractive Summarization kind of the long running task. Required. Abstractive + summarization task. + :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION + :ivar parameters: Parameters for the Abstractive Summarization task. Required. + :vartype parameters: ~azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters """ - kind: Literal[AnalyzeDocumentsLROResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """Kind of the task. Required. Abstractive summarization LRO results.""" - results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """Results of the task. Required.""" + kind: Literal[AnalyzeDocumentsOperationActionKind.ABSTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The Abstractive Summarization kind of the long running task. Required. Abstractive + summarization task.""" + parameters: "_models.AbstractiveSummarizationTaskParameters" = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Parameters for the Abstractive Summarization task. Required.""" @overload def __init__( self, *, - last_update_date_time: datetime.datetime, - status: Union[str, "_models.State"], - results: "_models.AnalyzeDocumentsResult", + parameters: "_models.AbstractiveSummarizationTaskParameters", task_name: Optional[str] = None, ) -> None: ... @@ -120,33 +102,50 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore + self.kind = AnalyzeDocumentsOperationActionKind.ABSTRACTIVE_SUMMARIZATION # type: ignore -class AnalyzeDocumentsLROTask(_Model): - """The long running task to be performed by the service on the input documents. +class AnalyzeDocumentsOperationResult(_Model): + """Contains the AnalyzeDocuments long running operation result object. You probably want to use the sub-classes and not this class directly. Known sub-classes are: - AbstractiveSummarizationLROTask, ExtractiveSummarizationLROTask, PiiLROTask + AbstractiveSummarizationOperationResult, ExtractiveSummarizationOperationResult, + PiiEntityRecognitionOperationResult + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: The kind of task to perform. Required. Known values are: "PiiEntityRecognition", - "ExtractiveSummarization", and "AbstractiveSummarization". - :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsLROTaskKind + :ivar kind: Kind of the task. Required. Known values are: "PiiEntityRecognitionLROResults", + "ExtractiveSummarizationLROResults", and "AbstractiveSummarizationLROResults". + :vartype kind: str or ~azure.ai.language.documents.models.AnalyzeDocumentsOperationResultsKind """ __mapping__: dict[str, _Model] = {} + last_update_date_time: datetime.datetime = rest_field( + name="lastUpdateDateTime", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" + ) + """The last updated time in UTC for the task. Required.""" + status: Union[str, "_models.State"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The status of the task at the mentioned last update time. Required. Known values are: + \"notStarted\", \"running\", \"succeeded\", \"partiallyCompleted\", \"failed\", \"cancelled\", + and \"cancelling\".""" task_name: Optional[str] = rest_field(name="taskName", visibility=["read", "create", "update", "delete", "query"]) """task name.""" kind: str = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) - """The kind of task to perform. Required. Known values are: \"PiiEntityRecognition\", - \"ExtractiveSummarization\", and \"AbstractiveSummarization\".""" + """Kind of the task. Required. Known values are: \"PiiEntityRecognitionLROResults\", + \"ExtractiveSummarizationLROResults\", and \"AbstractiveSummarizationLROResults\".""" @overload def __init__( self, *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], kind: str, task_name: Optional[str] = None, ) -> None: ... @@ -162,31 +161,37 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AbstractiveSummarizationLROTask(AnalyzeDocumentsLROTask, discriminator="AbstractiveSummarization"): - """An object representing the task definition for an Abstractive Summarization task. +class AbstractiveSummarizationOperationResult( + AnalyzeDocumentsOperationResult, discriminator="AbstractiveSummarizationLROResults" +): + """An object representing the results for an Abstractive Summarization task. + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: The Abstractive Summarization kind of the long running task. Required. Abstractive - summarization task. - :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION - :ivar parameters: Parameters for the Abstractive Summarization task. Required. - :vartype parameters: ~azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters + :ivar kind: Kind of the task. Required. Abstractive summarization LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS + :ivar results: Results of the task. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult """ - kind: Literal[AnalyzeDocumentsLROTaskKind.ABSTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """The Abstractive Summarization kind of the long running task. Required. Abstractive - summarization task.""" - parameters: "_models.AbstractiveSummarizationTaskParameters" = rest_field( - visibility=["read", "create", "update", "delete", "query"] - ) - """Parameters for the Abstractive Summarization task. Required.""" + kind: Literal[AnalyzeDocumentsOperationResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. Abstractive summarization LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Results of the task. Required.""" @overload def __init__( self, *, - parameters: "_models.AbstractiveSummarizationTaskParameters", + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", task_name: Optional[str] = None, ) -> None: ... @@ -199,7 +204,7 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROTaskKind.ABSTRACTIVE_SUMMARIZATION # type: ignore + self.kind = AnalyzeDocumentsOperationResultsKind.ABSTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore class AbstractiveSummarizationTaskParameters(_Model): @@ -278,7 +283,7 @@ class AnalyzeDocumentJobsInput(_Model): :ivar analysis_input: Contains the input to be analyzed. Required. :vartype analysis_input: ~azure.ai.language.documents.models.MultiLanguageAnalysisInput :ivar tasks: List of tasks to be performed as part of the LRO. Required. - :vartype tasks: list[~azure.ai.language.documents.models.AnalyzeDocumentsLROTask] + :vartype tasks: list[~azure.ai.language.documents.models.AnalyzeDocumentsOperationAction] :ivar default_language: Default language to use for records. :vartype default_language: str """ @@ -291,7 +296,7 @@ class AnalyzeDocumentJobsInput(_Model): name="analysisInput", visibility=["read", "create", "update", "delete", "query"] ) """Contains the input to be analyzed. Required.""" - tasks: list["_models.AnalyzeDocumentsLROTask"] = rest_field( + tasks: list["_models.AnalyzeDocumentsOperationAction"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) """List of tasks to be performed as part of the LRO. Required.""" @@ -305,7 +310,7 @@ def __init__( self, *, analysis_input: "_models.MultiLanguageAnalysisInput", - tasks: list["_models.AnalyzeDocumentsLROTask"], + tasks: list["_models.AnalyzeDocumentsOperationAction"], display_name: Optional[str] = None, default_language: Optional[str] = None, ) -> None: ... @@ -1388,36 +1393,32 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ExtractiveSummarizationLROResult(AnalyzeDocumentsLROResult, discriminator="ExtractiveSummarizationLROResults"): - """An object representing the results for an Extractive Summarization task. +class ExtractiveSummarizationOperationAction(AnalyzeDocumentsOperationAction, discriminator="ExtractiveSummarization"): + """An object representing the task definition for an Extractive Summarization task. - :ivar last_update_date_time: The last updated time in UTC for the task. Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the task at the mentioned last update time. Required. Known values - are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and - "cancelling". - :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: Kind of the task. Required. Extractive summarization LRO results. - :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS - :ivar results: Results of the document task. Required. - :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + :ivar kind: The Extractive Summarization kind of the long running task. Required. Extractive + summarization task. + :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION + :ivar parameters: Parameters for the Extractive Summarization task. + :vartype parameters: ~azure.ai.language.documents.models.ExtractiveSummarizationTaskParameters """ - kind: Literal[AnalyzeDocumentsLROResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """Kind of the task. Required. Extractive summarization LRO results.""" - results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """Results of the document task. Required.""" + kind: Literal[AnalyzeDocumentsOperationActionKind.EXTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The Extractive Summarization kind of the long running task. Required. Extractive summarization + task.""" + parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Parameters for the Extractive Summarization task.""" @overload def __init__( self, *, - last_update_date_time: datetime.datetime, - status: Union[str, "_models.State"], - results: "_models.AnalyzeDocumentsResult", task_name: Optional[str] = None, + parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = None, ) -> None: ... @overload @@ -1429,35 +1430,41 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore + self.kind = AnalyzeDocumentsOperationActionKind.EXTRACTIVE_SUMMARIZATION # type: ignore -class ExtractiveSummarizationLROTask(AnalyzeDocumentsLROTask, discriminator="ExtractiveSummarization"): - """An object representing the task definition for an Extractive Summarization task. +class ExtractiveSummarizationOperationResult( + AnalyzeDocumentsOperationResult, discriminator="ExtractiveSummarizationLROResults" +): + """An object representing the results for an Extractive Summarization task. + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: The Extractive Summarization kind of the long running task. Required. Extractive - summarization task. - :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION - :ivar parameters: Parameters for the Extractive Summarization task. - :vartype parameters: ~azure.ai.language.documents.models.ExtractiveSummarizationTaskParameters + :ivar kind: Kind of the task. Required. Extractive summarization LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS + :ivar results: Results of the document task. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult """ - kind: Literal[AnalyzeDocumentsLROTaskKind.EXTRACTIVE_SUMMARIZATION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """The Extractive Summarization kind of the long running task. Required. Extractive summarization - task.""" - parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = rest_field( - visibility=["read", "create", "update", "delete", "query"] - ) - """Parameters for the Extractive Summarization task.""" + kind: Literal[AnalyzeDocumentsOperationResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. Extractive summarization LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Results of the document task. Required.""" @overload def __init__( self, *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", task_name: Optional[str] = None, - parameters: Optional["_models.ExtractiveSummarizationTaskParameters"] = None, ) -> None: ... @overload @@ -1469,7 +1476,7 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROTaskKind.EXTRACTIVE_SUMMARIZATION # type: ignore + self.kind = AnalyzeDocumentsOperationResultsKind.EXTRACTIVE_SUMMARIZATION_LRO_RESULTS # type: ignore class ExtractiveSummarizationTaskParameters(_Model): @@ -1764,36 +1771,30 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.policy_kind = RedactionPolicyKind.NO_MASK # type: ignore -class PiiEntityRecognitionLROResult(AnalyzeDocumentsLROResult, discriminator="PiiEntityRecognitionLROResults"): - """Contains the PII LRO results. +class PiiEntityRecognitionAction(AnalyzeDocumentsOperationAction, discriminator="PiiEntityRecognition"): + """Contains the analyze text PIIEntityRecognition LRO task. - :ivar last_update_date_time: The last updated time in UTC for the task. Required. - :vartype last_update_date_time: ~datetime.datetime - :ivar status: The status of the task at the mentioned last update time. Required. Known values - are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and - "cancelling". - :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: The kind of the task. Required. PII entity recognition LRO results. - :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION_LRO_RESULTS - :ivar results: The list of pii document results. Required. - :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult + :ivar kind: Kind of the task. Required. PII entity recognition task. + :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION + :ivar parameters: Pii task parameters. + :vartype parameters: ~azure.ai.language.documents.models.PiiTaskParameters """ - kind: Literal[AnalyzeDocumentsLROResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """The kind of the task. Required. PII entity recognition LRO results.""" - results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """The list of pii document results. Required.""" + kind: Literal[AnalyzeDocumentsOperationActionKind.PII_ENTITY_RECOGNITION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """Kind of the task. Required. PII entity recognition task.""" + parameters: Optional["_models.PiiTaskParameters"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Pii task parameters.""" @overload def __init__( self, *, - last_update_date_time: datetime.datetime, - status: Union[str, "_models.State"], - results: "_models.AnalyzeDocumentsResult", task_name: Optional[str] = None, + parameters: Optional["_models.PiiTaskParameters"] = None, ) -> None: ... @overload @@ -1805,33 +1806,41 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS # type: ignore + self.kind = AnalyzeDocumentsOperationActionKind.PII_ENTITY_RECOGNITION # type: ignore -class PiiLROTask(AnalyzeDocumentsLROTask, discriminator="PiiEntityRecognition"): - """Contains the analyze text PIIEntityRecognition LRO task. +class PiiEntityRecognitionOperationResult( + AnalyzeDocumentsOperationResult, discriminator="PiiEntityRecognitionLROResults" +): + """Contains the PII LRO results. + :ivar last_update_date_time: The last updated time in UTC for the task. Required. + :vartype last_update_date_time: ~datetime.datetime + :ivar status: The status of the task at the mentioned last update time. Required. Known values + are: "notStarted", "running", "succeeded", "partiallyCompleted", "failed", "cancelled", and + "cancelling". + :vartype status: str or ~azure.ai.language.documents.models.State :ivar task_name: task name. :vartype task_name: str - :ivar kind: Kind of the task. Required. PII entity recognition task. - :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION - :ivar parameters: Pii task parameters. - :vartype parameters: ~azure.ai.language.documents.models.PiiTaskParameters + :ivar kind: The kind of the task. Required. PII entity recognition LRO results. + :vartype kind: str or ~azure.ai.language.documents.models.PII_ENTITY_RECOGNITION_LRO_RESULTS + :ivar results: The list of pii document results. Required. + :vartype results: ~azure.ai.language.documents.models.AnalyzeDocumentsResult """ - kind: Literal[AnalyzeDocumentsLROTaskKind.PII_ENTITY_RECOGNITION] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore - """Kind of the task. Required. PII entity recognition task.""" - parameters: Optional["_models.PiiTaskParameters"] = rest_field( - visibility=["read", "create", "update", "delete", "query"] - ) - """Pii task parameters.""" + kind: Literal[AnalyzeDocumentsOperationResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS] = rest_discriminator(name="kind", visibility=["read", "create", "update", "delete", "query"]) # type: ignore + """The kind of the task. Required. PII entity recognition LRO results.""" + results: "_models.AnalyzeDocumentsResult" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The list of pii document results. Required.""" @overload def __init__( self, *, + last_update_date_time: datetime.datetime, + status: Union[str, "_models.State"], + results: "_models.AnalyzeDocumentsResult", task_name: Optional[str] = None, - parameters: Optional["_models.PiiTaskParameters"] = None, ) -> None: ... @overload @@ -1843,7 +1852,7 @@ def __init__(self, mapping: Mapping[str, Any]) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) - self.kind = AnalyzeDocumentsLROTaskKind.PII_ENTITY_RECOGNITION # type: ignore + self.kind = AnalyzeDocumentsOperationResultsKind.PII_ENTITY_RECOGNITION_LRO_RESULTS # type: ignore class PiiTaskParameters(_Model): @@ -2071,7 +2080,8 @@ class Tasks(_Model): :ivar total: Count of total tasks. Required. :vartype total: int :ivar items_property: Enumerable of Analyze documents job results. - :vartype items_property: list[~azure.ai.language.documents.models.AnalyzeDocumentsLROResult] + :vartype items_property: + list[~azure.ai.language.documents.models.AnalyzeDocumentsOperationResult] """ completed: int = rest_field(visibility=["read", "create", "update", "delete", "query"]) @@ -2082,7 +2092,7 @@ class Tasks(_Model): """Count of inprogress tasks. Required.""" total: int = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Count of total tasks. Required.""" - items_property: Optional[list["_models.AnalyzeDocumentsLROResult"]] = rest_field( + items_property: Optional[list["_models.AnalyzeDocumentsOperationResult"]] = rest_field( name="items", visibility=["read", "create", "update", "delete", "query"], original_tsp_name="items" ) """Enumerable of Analyze documents job results.""" @@ -2095,7 +2105,7 @@ def __init__( failed: int, in_progress: int, total: int, - items_property: Optional[list["_models.AnalyzeDocumentsLROResult"]] = None, + items_property: Optional[list["_models.AnalyzeDocumentsOperationResult"]] = None, ) -> None: ... @overload diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py index b6f21eaf2bcd..5427514fca54 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py @@ -34,7 +34,7 @@ def test_begin_submit_job(self, analyzedocuments_endpoint): {"id": "str", "source": "document_location", "target": "document_location", "language": "str"} ] }, - "tasks": ["analyze_documents_lro_task"], + "tasks": ["analyze_documents_operation_action"], "defaultLanguage": "str", "displayName": "str", }, diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py index e48cb13cf221..46ef55253243 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py @@ -41,7 +41,7 @@ async def test_begin_submit_job(self, analyzedocuments_endpoint): } ] }, - "tasks": ["analyze_documents_lro_task"], + "tasks": ["analyze_documents_operation_action"], "defaultLanguage": "str", "displayName": "str", }, From f0ff3af9721c3ff844b4485fa8f6ce0507ffde0b Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Wed, 20 May 2026 10:20:06 -0700 Subject: [PATCH 10/37] updated. --- .../apiview-properties.json | 4 +- .../documents/_operations/_operations.py | 12 +- .../documents/aio/_operations/_operations.py | 12 +- .../ai/language/documents/models/__init__.py | 8 +- .../ai/language/documents/models/_enums.py | 4 +- .../ai/language/documents/models/_models.py | 188 +++++++++--------- 6 files changed, 114 insertions(+), 114 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json index f2b4a8ca9657..f284725ad3eb 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json @@ -6,8 +6,8 @@ "azure.ai.language.documents.models.AnalyzeDocumentsOperationResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationOperationResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.AbstractiveSummarizationTaskParameters", - "azure.ai.language.documents.models.AnalyzeDocumentJobsInput": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", "azure.ai.language.documents.models.AnalyzeDocumentsDocumentError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", + "azure.ai.language.documents.models.AnalyzeDocumentsJob": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", "azure.ai.language.documents.models.AnalyzeDocumentsJobState": "Language.AnalyzeDocuments.AnalyzeDocumentsJobState", "azure.ai.language.documents.models.AnalyzeDocumentsResult": "Language.AnalyzeDocuments.AnalyzeDocumentsResult", "azure.ai.language.documents.models.DocumentLocation": "Language.AnalyzeDocuments.DocumentLocation", @@ -34,10 +34,10 @@ "azure.ai.language.documents.models.MultiLanguageAnalysisInput": "Language.AnalyzeDocuments.MultiLanguageAnalysisInput", "azure.ai.language.documents.models.MultiLanguageInput": "Language.AnalyzeDocuments.MultiLanguageInput", "azure.ai.language.documents.models.NoMaskPolicy": "Language.AnalyzeDocuments.NoMaskPolicy", + "azure.ai.language.documents.models.OperationStatistics": "Language.AnalyzeDocuments.RequestStatistics", "azure.ai.language.documents.models.PiiEntityRecognitionAction": "Language.AnalyzeDocuments.PiiLROTask", "azure.ai.language.documents.models.PiiEntityRecognitionOperationResult": "Language.AnalyzeDocuments.PiiEntityRecognitionLROResult", "azure.ai.language.documents.models.PiiTaskParameters": "Language.AnalyzeDocuments.PiiTaskParameters", - "azure.ai.language.documents.models.RequestStatistics": "Language.AnalyzeDocuments.RequestStatistics", "azure.ai.language.documents.models.SyntheticReplacementPolicyType": "Language.AnalyzeDocuments.SyntheticReplacementPolicyType", "azure.ai.language.documents.models.Tasks": "Language.AnalyzeDocuments.Tasks", "azure.ai.language.documents.models.ValueExclusionPolicy": "Language.AnalyzeDocuments.ValueExclusionPolicy", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py index 94b5aa7ee036..3ad4ac0aa0eb 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py @@ -213,7 +213,7 @@ def get_job_state( return deserialized # type: ignore def _submit_job_initial( - self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + self, body: Union[_models.AnalyzeDocumentsJob, JSON, IO[bytes]], **kwargs: Any ) -> Iterator[bytes]: error_map: MutableMapping = { 401: ClientAuthenticationError, @@ -280,13 +280,13 @@ def _submit_job_initial( @overload def begin_submit_job( - self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any + self, body: _models.AnalyzeDocumentsJob, *, content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. :param body: The input for the analyze documents operation. Required. - :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentsJob :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str @@ -329,14 +329,14 @@ def begin_submit_job( @distributed_trace def begin_submit_job( - self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + self, body: Union[_models.AnalyzeDocumentsJob, JSON, IO[bytes]], **kwargs: Any ) -> LROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. :param body: The input for the analyze documents operation. Is one of the following types: - AnalyzeDocumentJobsInput, JSON, IO[bytes] Required. - :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput or JSON or IO[bytes] + AnalyzeDocumentsJob, JSON, IO[bytes] Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentsJob or JSON or IO[bytes] :return: An instance of LROPoller that returns None :rtype: ~azure.core.polling.LROPoller[None] :raises ~azure.core.exceptions.HttpResponseError: diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py index 92047c41b876..4d86540efb90 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py @@ -139,7 +139,7 @@ async def get_job_state( return deserialized # type: ignore async def _submit_job_initial( - self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + self, body: Union[_models.AnalyzeDocumentsJob, JSON, IO[bytes]], **kwargs: Any ) -> AsyncIterator[bytes]: error_map: MutableMapping = { 401: ClientAuthenticationError, @@ -206,13 +206,13 @@ async def _submit_job_initial( @overload async def begin_submit_job( - self, body: _models.AnalyzeDocumentJobsInput, *, content_type: str = "application/json", **kwargs: Any + self, body: _models.AnalyzeDocumentsJob, *, content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. :param body: The input for the analyze documents operation. Required. - :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentsJob :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str @@ -257,14 +257,14 @@ async def begin_submit_job( @distributed_trace_async async def begin_submit_job( - self, body: Union[_models.AnalyzeDocumentJobsInput, JSON, IO[bytes]], **kwargs: Any + self, body: Union[_models.AnalyzeDocumentsJob, JSON, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[None]: """Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation. :param body: The input for the analyze documents operation. Is one of the following types: - AnalyzeDocumentJobsInput, JSON, IO[bytes] Required. - :type body: ~azure.ai.language.documents.models.AnalyzeDocumentJobsInput or JSON or IO[bytes] + AnalyzeDocumentsJob, JSON, IO[bytes] Required. + :type body: ~azure.ai.language.documents.models.AnalyzeDocumentsJob or JSON or IO[bytes] :return: An instance of AsyncLROPoller that returns None :rtype: ~azure.core.polling.AsyncLROPoller[None] :raises ~azure.core.exceptions.HttpResponseError: diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py index c758818c7ab1..2e7daa873df4 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py @@ -17,8 +17,8 @@ AbstractiveSummarizationOperationAction, AbstractiveSummarizationOperationResult, AbstractiveSummarizationTaskParameters, - AnalyzeDocumentJobsInput, AnalyzeDocumentsDocumentError, + AnalyzeDocumentsJob, AnalyzeDocumentsJobState, AnalyzeDocumentsOperationAction, AnalyzeDocumentsOperationResult, @@ -47,10 +47,10 @@ MultiLanguageAnalysisInput, MultiLanguageInput, NoMaskPolicy, + OperationStatistics, PiiEntityRecognitionAction, PiiEntityRecognitionOperationResult, PiiTaskParameters, - RequestStatistics, SyntheticReplacementPolicyType, Tasks, ValueExclusionPolicy, @@ -81,8 +81,8 @@ "AbstractiveSummarizationOperationAction", "AbstractiveSummarizationOperationResult", "AbstractiveSummarizationTaskParameters", - "AnalyzeDocumentJobsInput", "AnalyzeDocumentsDocumentError", + "AnalyzeDocumentsJob", "AnalyzeDocumentsJobState", "AnalyzeDocumentsOperationAction", "AnalyzeDocumentsOperationResult", @@ -111,10 +111,10 @@ "MultiLanguageAnalysisInput", "MultiLanguageInput", "NoMaskPolicy", + "OperationStatistics", "PiiEntityRecognitionAction", "PiiEntityRecognitionOperationResult", "PiiTaskParameters", - "RequestStatistics", "SyntheticReplacementPolicyType", "Tasks", "ValueExclusionPolicy", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py index 5c69af5b0fcd..2f775e2a04f1 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_enums.py @@ -158,7 +158,7 @@ class PiiCategories(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Azure Document DB Auth Key.""" AZURE_IAAS_DATABASE_CONNECTION_AND_SQL_STRING = "AzureIAASDatabaseConnectionAndSQLString" """Azure IAAS Database Connection And SQL String.""" - AZURE_IO_T_CONNECTION_STRING = "AzureIoTConnectionString" + AZURE_IOT_CONNECTION_STRING = "AzureIoTConnectionString" """Azure IoT Connection String.""" AZURE_PUBLISH_SETTING_PASSWORD = "AzurePublishSettingPassword" """Azure Publish Setting Password.""" @@ -506,7 +506,7 @@ class PiiCategoriesExtended(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Azure Document DB Auth Key.""" AZURE_IAAS_DATABASE_CONNECTION_AND_SQL_STRING = "AzureIAASDatabaseConnectionAndSQLString" """Azure IAAS Database Connection And SQL String.""" - AZURE_IO_T_CONNECTION_STRING = "AzureIoTConnectionString" + AZURE_IOT_CONNECTION_STRING = "AzureIoTConnectionString" """Azure IoT Connection String.""" AZURE_PUBLISH_SETTING_PASSWORD = "AzurePublishSettingPassword" """Azure Publish Setting Password.""" diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py index 3f012d9582d8..7a62164b58ee 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py @@ -275,7 +275,40 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeDocumentJobsInput(_Model): +class AnalyzeDocumentsDocumentError(_Model): + """Contains the error object with errors encountered for the processed document. + + :ivar id: Document Id. Required. + :vartype id: str + :ivar error: Document Error. Required. + :vartype error: ~azure.ai.language.documents.models.Error + """ + + id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Document Id. Required.""" + error: "_models.Error" = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Document Error. Required.""" + + @overload + def __init__( + self, + *, + id: str, # pylint: disable=redefined-builtin + error: "_models.Error", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class AnalyzeDocumentsJob(_Model): """The input object for the analyze documents LRO. :ivar display_name: Name for the task. @@ -326,39 +359,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeDocumentsDocumentError(_Model): - """Contains the error object with errors encountered for the processed document. - - :ivar id: Document Id. Required. - :vartype id: str - :ivar error: Document Error. Required. - :vartype error: ~azure.ai.language.documents.models.Error - """ - - id: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """Document Id. Required.""" - error: "_models.Error" = rest_field(visibility=["read", "create", "update", "delete", "query"]) - """Document Error. Required.""" - - @overload - def __init__( - self, - *, - id: str, # pylint: disable=redefined-builtin - error: "_models.Error", - ) -> None: ... - - @overload - def __init__(self, mapping: Mapping[str, Any]) -> None: - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - - class AnalyzeDocumentsJobState(_Model): """The object containing the analyze job LRO job state. @@ -383,7 +383,7 @@ class AnalyzeDocumentsJobState(_Model): :vartype tasks: ~azure.ai.language.documents.models.Tasks :ivar statistics: if showStats=true was specified in the request this field will contain information about the request payload. - :vartype statistics: ~azure.ai.language.documents.models.RequestStatistics + :vartype statistics: ~azure.ai.language.documents.models.OperationStatistics """ display_name: Optional[str] = rest_field( @@ -413,7 +413,7 @@ class AnalyzeDocumentsJobState(_Model): """next link.""" tasks: "_models.Tasks" = rest_field(visibility=["read", "create", "update", "delete", "query"]) """List of tasks. Required.""" - statistics: Optional["_models.RequestStatistics"] = rest_field( + statistics: Optional["_models.OperationStatistics"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) """if showStats=true was specified in the request this field will contain information about the @@ -431,7 +431,7 @@ def __init__( expiration_date_time: Optional[datetime.datetime] = None, errors: Optional[list["_models.Error"]] = None, next_link: Optional[str] = None, - statistics: Optional["_models.RequestStatistics"] = None, + statistics: Optional["_models.OperationStatistics"] = None, ) -> None: ... @overload @@ -452,7 +452,7 @@ class AnalyzeDocumentsResult(_Model): :vartype errors: list[~azure.ai.language.documents.models.AnalyzeDocumentsDocumentError] :ivar statistics: if showStats=true was specified in the request this field will contain information about the request payload. - :vartype statistics: ~azure.ai.language.documents.models.RequestStatistics + :vartype statistics: ~azure.ai.language.documents.models.OperationStatistics :ivar model_version: This field indicates which model is used for analysis. Required. :vartype model_version: str :ivar documents: Response by document. Required. @@ -463,7 +463,7 @@ class AnalyzeDocumentsResult(_Model): visibility=["read", "create", "update", "delete", "query"] ) """Errors by document id. Required.""" - statistics: Optional["_models.RequestStatistics"] = rest_field( + statistics: Optional["_models.OperationStatistics"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) """if showStats=true was specified in the request this field will contain information about the @@ -482,7 +482,7 @@ def __init__( errors: list["_models.AnalyzeDocumentsDocumentError"], model_version: str, documents: list["_models.DocumentAnalysisDocumentResult"], - statistics: Optional["_models.RequestStatistics"] = None, + statistics: Optional["_models.OperationStatistics"] = None, ) -> None: ... @overload @@ -1771,6 +1771,60 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.policy_kind = RedactionPolicyKind.NO_MASK # type: ignore +class OperationStatistics(_Model): + """if showStats=true was specified in the request this field will contain information about the + request payload. + + :ivar documents_count: Number of documents submitted in the request. Required. + :vartype documents_count: int + :ivar valid_documents_count: Number of valid documents. This excludes empty, over-size limit or + non-supported languages documents. Required. + :vartype valid_documents_count: int + :ivar erroneous_documents_count: Number of invalid documents. This includes empty, over-size + limit or non-supported languages documents. Required. + :vartype erroneous_documents_count: int + :ivar transactions_count: Number of billing or usage transactions for the request. Required. + :vartype transactions_count: int + """ + + documents_count: int = rest_field(name="documentsCount", visibility=["read", "create", "update", "delete", "query"]) + """Number of documents submitted in the request. Required.""" + valid_documents_count: int = rest_field( + name="validDocumentsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of valid documents. This excludes empty, over-size limit or non-supported languages + documents. Required.""" + erroneous_documents_count: int = rest_field( + name="erroneousDocumentsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of invalid documents. This includes empty, over-size limit or non-supported languages + documents. Required.""" + transactions_count: int = rest_field( + name="transactionsCount", visibility=["read", "create", "update", "delete", "query"] + ) + """Number of billing or usage transactions for the request. Required.""" + + @overload + def __init__( + self, + *, + documents_count: int, + valid_documents_count: int, + erroneous_documents_count: int, + transactions_count: int, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + class PiiEntityRecognitionAction(AnalyzeDocumentsOperationAction, discriminator="PiiEntityRecognition"): """Contains the analyze text PIIEntityRecognition LRO task. @@ -1963,60 +2017,6 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class RequestStatistics(_Model): - """if showStats=true was specified in the request this field will contain information about the - request payload. - - :ivar documents_count: Number of documents submitted in the request. Required. - :vartype documents_count: int - :ivar valid_documents_count: Number of valid documents. This excludes empty, over-size limit or - non-supported languages documents. Required. - :vartype valid_documents_count: int - :ivar erroneous_documents_count: Number of invalid documents. This includes empty, over-size - limit or non-supported languages documents. Required. - :vartype erroneous_documents_count: int - :ivar transactions_count: Number of billing or usage transactions for the request. Required. - :vartype transactions_count: int - """ - - documents_count: int = rest_field(name="documentsCount", visibility=["read", "create", "update", "delete", "query"]) - """Number of documents submitted in the request. Required.""" - valid_documents_count: int = rest_field( - name="validDocumentsCount", visibility=["read", "create", "update", "delete", "query"] - ) - """Number of valid documents. This excludes empty, over-size limit or non-supported languages - documents. Required.""" - erroneous_documents_count: int = rest_field( - name="erroneousDocumentsCount", visibility=["read", "create", "update", "delete", "query"] - ) - """Number of invalid documents. This includes empty, over-size limit or non-supported languages - documents. Required.""" - transactions_count: int = rest_field( - name="transactionsCount", visibility=["read", "create", "update", "delete", "query"] - ) - """Number of billing or usage transactions for the request. Required.""" - - @overload - def __init__( - self, - *, - documents_count: int, - valid_documents_count: int, - erroneous_documents_count: int, - transactions_count: int, - ) -> None: ... - - @overload - def __init__(self, mapping: Mapping[str, Any]) -> None: - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: - super().__init__(*args, **kwargs) - - class SyntheticReplacementPolicyType(BaseRedactionPolicy, discriminator="syntheticReplacement"): """Represents the policy of replacing detected PII with synthetic values. From 55a6a0e814bd6e6143e313a06b6250a685903343 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Tue, 26 May 2026 16:36:54 -0700 Subject: [PATCH 11/37] updated. --- .../apiview-properties.json | 4 +- .../ai/language/documents/models/__init__.py | 8 +- .../ai/language/documents/models/_models.py | 16 ++-- ...ocuments_job_status_task_status_request.py | 33 ++++++++ ...l_analyze_documents_jobs_cancel_request.py | 32 ++++++++ ...lyze_documents_jobs_task_submit_request.py | 57 +++++++++++++ .../generated_tests/test_analyze_documents.py | 82 ++++++++++++++++--- 7 files changed, 205 insertions(+), 27 deletions(-) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json index f284725ad3eb..a2c14b1c6ded 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/apiview-properties.json @@ -6,7 +6,7 @@ "azure.ai.language.documents.models.AnalyzeDocumentsOperationResult": "Language.AnalyzeDocuments.AnalyzeDocumentsLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationOperationResult": "Language.AnalyzeDocuments.AbstractiveSummarizationLROResult", "azure.ai.language.documents.models.AbstractiveSummarizationTaskParameters": "Language.AnalyzeDocuments.AbstractiveSummarizationTaskParameters", - "azure.ai.language.documents.models.AnalyzeDocumentsDocumentError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", + "azure.ai.language.documents.models.AnalyzeDocumentsError": "Language.AnalyzeDocuments.AnalyzeDocumentsDocumentError", "azure.ai.language.documents.models.AnalyzeDocumentsJob": "Language.AnalyzeDocuments.AnalyzeDocumentJobsInput", "azure.ai.language.documents.models.AnalyzeDocumentsJobState": "Language.AnalyzeDocuments.AnalyzeDocumentsJobState", "azure.ai.language.documents.models.AnalyzeDocumentsResult": "Language.AnalyzeDocuments.AnalyzeDocumentsResult", @@ -18,7 +18,7 @@ "azure.ai.language.documents.models.CharacterMaskPolicy": "Language.AnalyzeDocuments.CharacterMaskPolicy", "azure.ai.language.documents.models.ConfidenceScoreThreshold": "Language.AnalyzeDocuments.ConfidenceScoreThreshold", "azure.ai.language.documents.models.ConfidenceScoreThresholdOverride": "Language.AnalyzeDocuments.ConfidenceScoreThresholdOverride", - "azure.ai.language.documents.models.DocumentAnalysisDocumentResult": "Language.AnalyzeDocuments.DocumentAnalysisDocumentResult", + "azure.ai.language.documents.models.DocumentAnalysisResult": "Language.AnalyzeDocuments.DocumentAnalysisDocumentResult", "azure.ai.language.documents.models.DocumentStatistics": "Language.AnalyzeDocuments.DocumentStatistics", "azure.ai.language.documents.models.DocumentWarning": "Language.AnalyzeDocuments.DocumentWarning", "azure.ai.language.documents.models.EntityMaskPolicy": "Language.AnalyzeDocuments.EntityMaskPolicy", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py index 2e7daa873df4..a67570b2e567 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/__init__.py @@ -17,7 +17,7 @@ AbstractiveSummarizationOperationAction, AbstractiveSummarizationOperationResult, AbstractiveSummarizationTaskParameters, - AnalyzeDocumentsDocumentError, + AnalyzeDocumentsError, AnalyzeDocumentsJob, AnalyzeDocumentsJobState, AnalyzeDocumentsOperationAction, @@ -30,7 +30,7 @@ CharacterMaskPolicy, ConfidenceScoreThreshold, ConfidenceScoreThresholdOverride, - DocumentAnalysisDocumentResult, + DocumentAnalysisResult, DocumentLocation, DocumentStatistics, DocumentWarning, @@ -81,7 +81,7 @@ "AbstractiveSummarizationOperationAction", "AbstractiveSummarizationOperationResult", "AbstractiveSummarizationTaskParameters", - "AnalyzeDocumentsDocumentError", + "AnalyzeDocumentsError", "AnalyzeDocumentsJob", "AnalyzeDocumentsJobState", "AnalyzeDocumentsOperationAction", @@ -94,7 +94,7 @@ "CharacterMaskPolicy", "ConfidenceScoreThreshold", "ConfidenceScoreThresholdOverride", - "DocumentAnalysisDocumentResult", + "DocumentAnalysisResult", "DocumentLocation", "DocumentStatistics", "DocumentWarning", diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py index 7a62164b58ee..3df5a4be4035 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/models/_models.py @@ -275,7 +275,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AnalyzeDocumentsDocumentError(_Model): +class AnalyzeDocumentsError(_Model): """Contains the error object with errors encountered for the processed document. :ivar id: Document Id. Required. @@ -449,17 +449,17 @@ class AnalyzeDocumentsResult(_Model): """Contains the result object for the processed document. :ivar errors: Errors by document id. Required. - :vartype errors: list[~azure.ai.language.documents.models.AnalyzeDocumentsDocumentError] + :vartype errors: list[~azure.ai.language.documents.models.AnalyzeDocumentsError] :ivar statistics: if showStats=true was specified in the request this field will contain information about the request payload. :vartype statistics: ~azure.ai.language.documents.models.OperationStatistics :ivar model_version: This field indicates which model is used for analysis. Required. :vartype model_version: str :ivar documents: Response by document. Required. - :vartype documents: list[~azure.ai.language.documents.models.DocumentAnalysisDocumentResult] + :vartype documents: list[~azure.ai.language.documents.models.DocumentAnalysisResult] """ - errors: list["_models.AnalyzeDocumentsDocumentError"] = rest_field( + errors: list["_models.AnalyzeDocumentsError"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) """Errors by document id. Required.""" @@ -470,7 +470,7 @@ class AnalyzeDocumentsResult(_Model): request payload.""" model_version: str = rest_field(name="modelVersion", visibility=["read", "create", "update", "delete", "query"]) """This field indicates which model is used for analysis. Required.""" - documents: list["_models.DocumentAnalysisDocumentResult"] = rest_field( + documents: list["_models.DocumentAnalysisResult"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) """Response by document. Required.""" @@ -479,9 +479,9 @@ class AnalyzeDocumentsResult(_Model): def __init__( self, *, - errors: list["_models.AnalyzeDocumentsDocumentError"], + errors: list["_models.AnalyzeDocumentsError"], model_version: str, - documents: list["_models.DocumentAnalysisDocumentResult"], + documents: list["_models.DocumentAnalysisResult"], statistics: Optional["_models.OperationStatistics"] = None, ) -> None: ... @@ -957,7 +957,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class DocumentAnalysisDocumentResult(_Model): +class DocumentAnalysisResult(_Model): """Contains the result object for the processed document. :ivar id: Unique, non-empty document identifier. Required. diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py new file mode 100644 index 000000000000..41b4c3dafe4d --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py @@ -0,0 +1,33 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_job_status_task_status_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + response = client.get_job_state( + job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + ) + print(response) + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py new file mode 100644 index 000000000000..1adc3e8f42eb --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py @@ -0,0 +1,32 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_jobs_cancel_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + client.begin_cancel_job( + job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + ).result() + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py new file mode 100644 index 000000000000..1503c87dcd8e --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py @@ -0,0 +1,57 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from azure.ai.language.documents import AnalyzeDocumentsClient + +""" +# PREREQUISITES + pip install azure-ai-language-documents +# USAGE + python successful_analyze_documents_jobs_task_submit_request.py +""" + + +def main(): + client = AnalyzeDocumentsClient( + endpoint="{Endpoint}", + credential="CREDENTIAL", + ) + + client.begin_submit_job( + body={ + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "source": { + "kind": "AzureBlob", + "location": "https://myblob.blob.core.windows.net/Container/document.txt", + }, + "target": {"kind": "AzureBlob", "location": "https://myblob.blob.core.windows.net/Container"}, + } + ] + }, + "displayName": "Redact PII from documents example", + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "piiCategories": ["Person", "Organization"], + "redactionPolicies": [{"policyKind": "characterMask", "redactionCharacter": "-"}], + }, + "taskName": "Redact PII Task 1", + } + ], + }, + ).result() + + +# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json +if __name__ == "__main__": + main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py index 5427514fca54..dd65ba24d083 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py @@ -10,38 +10,94 @@ from testpreparer import AnalyzeDocumentsClientTestBase, AnalyzeDocumentsPreparer -@pytest.mark.skip("you may need to update the auto-generated test case before run it") class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): @AnalyzeDocumentsPreparer() @recorded_by_proxy def test_get_job_state(self, analyzedocuments_endpoint): client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.get_job_state( - job_id="str", + + poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": "" + }, + "target": { + "location": "" + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + } ) - # please add some check logic here by yourself - # ... + job_id = poller.details["job_id"] + response = client.get_job_state(job_id=job_id) + + assert response is not None + assert response.job_id == job_id + assert response.status is not None @AnalyzeDocumentsPreparer() @recorded_by_proxy def test_begin_submit_job(self, analyzedocuments_endpoint): client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.begin_submit_job( + + poller = client.begin_submit_job( body={ + "displayName": "Document Analysis.", "analysisInput": { "documents": [ - {"id": "str", "source": "document_location", "target": "document_location", "language": "str"} + { + "language": "en", + "id": "1", + "source": { + "location": "" + }, + "target": { + "location": "" + }, + } ] }, - "tasks": ["analyze_documents_operation_action"], - "defaultLanguage": "str", - "displayName": "str", + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], }, - ).result() # call '.result()' to poll until service return final result + ) - # please add some check logic here by yourself - # ... + assert poller is not None + assert poller.details["job_id"] @AnalyzeDocumentsPreparer() @recorded_by_proxy From 497f792e79ba9e36ccca67a9d02355f57b109411 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 28 May 2026 16:48:33 -0700 Subject: [PATCH 12/37] add all tests --- .../azure/ai/language/documents/_client.py | 2 +- .../documents/_operations/_operations.py | 10 +- .../ai/language/documents/aio/_client.py | 2 +- .../documents/aio/_operations/_operations.py | 10 +- .../generated_tests/test_analyze_documents.py | 111 ---------- .../{generated_tests => tests}/conftest.py | 19 ++ ...AnalyzeDocumentstest_begin_cancel_job.json | 130 ++++++++++++ ...AnalyzeDocumentstest_begin_submit_job.json | 96 +++++++++ ...estAnalyzeDocumentstest_get_job_state.json | 96 +++++++++ .../tests/test_analyze_documents.py | 191 ++++++++++++++++++ .../recordings.json | 59 ++++++ .../test_analyze_documents_async.py | 0 .../testpreparer.py | 6 +- .../testpreparer_async.py | 0 14 files changed, 608 insertions(+), 124 deletions(-) delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py rename sdk/cognitivelanguage/azure-ai-language-documents/{generated_tests => tests}/conftest.py (74%) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json rename sdk/cognitivelanguage/azure-ai-language-documents/{generated_tests => tests}/test_analyze_documents_async.py (100%) rename sdk/cognitivelanguage/azure-ai-language-documents/{generated_tests => tests}/testpreparer.py (76%) rename sdk/cognitivelanguage/azure-ai-language-documents/{generated_tests => tests}/testpreparer_async.py (100%) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py index ab31168f0799..f9d8f7a50b4f 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py @@ -94,7 +94,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py index 3ad4ac0aa0eb..6d0dc46184d3 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py @@ -177,7 +177,7 @@ def get_job_state( params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -244,7 +244,7 @@ def _submit_job_initial( params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -361,7 +361,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return cls(pipeline_response, None, {}) # type: ignore path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } if polling is True: @@ -402,7 +402,7 @@ def _cancel_job_initial(self, job_id: str, **kwargs: Any) -> Iterator[bytes]: params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -467,7 +467,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return cls(pipeline_response, None, {}) # type: ignore path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } if polling is True: diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py index 513cccb77baf..08578d9173ee 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py @@ -98,7 +98,7 @@ def send_request( request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py index 4d86540efb90..aef58ad803a9 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py @@ -103,7 +103,7 @@ async def get_job_state( params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -170,7 +170,7 @@ async def _submit_job_initial( params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -289,7 +289,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return cls(pipeline_response, None, {}) # type: ignore path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } if polling is True: @@ -331,7 +331,7 @@ async def _cancel_job_initial(self, job_id: str, **kwargs: Any) -> AsyncIterator params=_params, ) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } _request.url = self._client.format_url(_request.url, **path_format_arguments) @@ -396,7 +396,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return cls(pipeline_response, None, {}) # type: ignore path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"), + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } if polling is True: diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py deleted file mode 100644 index dd65ba24d083..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents.py +++ /dev/null @@ -1,111 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- -import pytest -from devtools_testutils import recorded_by_proxy -from testpreparer import AnalyzeDocumentsClientTestBase, AnalyzeDocumentsPreparer - - -class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): - @AnalyzeDocumentsPreparer() - @recorded_by_proxy - def test_get_job_state(self, analyzedocuments_endpoint): - client = self.create_client(endpoint=analyzedocuments_endpoint) - - poller = client.begin_submit_job( - body={ - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "1", - "source": { - "location": "" - }, - "target": { - "location": "" - }, - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": True, - } - ] - }, - } - ], - } - ) - - job_id = poller.details["job_id"] - response = client.get_job_state(job_id=job_id) - - assert response is not None - assert response.job_id == job_id - assert response.status is not None - - @AnalyzeDocumentsPreparer() - @recorded_by_proxy - def test_begin_submit_job(self, analyzedocuments_endpoint): - client = self.create_client(endpoint=analyzedocuments_endpoint) - - poller = client.begin_submit_job( - body={ - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "1", - "source": { - "location": "" - }, - "target": { - "location": "" - }, - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": True, - } - ] - }, - } - ], - }, - ) - - assert poller is not None - assert poller.details["job_id"] - - @AnalyzeDocumentsPreparer() - @recorded_by_proxy - def test_begin_cancel_job(self, analyzedocuments_endpoint): - client = self.create_client(endpoint=analyzedocuments_endpoint) - response = client.begin_cancel_job( - job_id="str", - ).result() # call '.result()' to poll until service return final result - - # please add some check logic here by yourself - # ... diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py similarity index 74% rename from sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py rename to sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py index fbc56efe75b0..9af91a66703d 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/conftest.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py @@ -6,6 +6,7 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import os +import re import pytest from dotenv import load_dotenv from devtools_testutils import ( @@ -29,11 +30,29 @@ def add_sanitizers(test_proxy): analyzedocuments_client_secret = os.environ.get( "ANALYZEDOCUMENTS_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" ) + analyzedocuments_source_location = os.environ.get( + "ANALYZEDOCUMENTS_SOURCE_LOCATION", + "https://fakeaccount.blob.core.windows.net/input/fake.docx", + ) + analyzedocuments_target_location = os.environ.get( + "ANALYZEDOCUMENTS_TARGET_LOCATION", + "https://fakeaccount.blob.core.windows.net/output", + ) + add_general_regex_sanitizer(regex=analyzedocuments_subscription_id, value="00000000-0000-0000-0000-000000000000") add_general_regex_sanitizer(regex=analyzedocuments_tenant_id, value="00000000-0000-0000-0000-000000000000") add_general_regex_sanitizer(regex=analyzedocuments_client_id, value="00000000-0000-0000-0000-000000000000") add_general_regex_sanitizer(regex=analyzedocuments_client_secret, value="00000000-0000-0000-0000-000000000000") + add_general_regex_sanitizer( + regex=re.escape(analyzedocuments_source_location), + value="https://fakeaccount.blob.core.windows.net/input/fake.docx", + ) + add_general_regex_sanitizer( + regex=re.escape(analyzedocuments_target_location), + value="https://fakeaccount.blob.core.windows.net/output", + ) + add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") add_header_regex_sanitizer(key="Cookie", value="cookie;") add_body_key_sanitizer(json_path="$..access_token", value="access_token") diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json new file mode 100644 index 000000000000..1df95435d0ee --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json @@ -0,0 +1,130 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "5e8cbf0c-b524-428a-84c2-2080a5b37414", + "Content-Length": "0", + "Date": "Thu, 28 May 2026 23:47:06 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "153", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6:cancel?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "Content-Length": "0", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "994f723c-dc10-45e3-aaf4-31d6b32e43fe", + "Content-Length": "0", + "Date": "Thu, 28 May 2026 23:47:06 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "35", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "77b77b4b-9c17-4629-bc26-19dd7317c359", + "Content-Length": "488", + "Content-Type": "application/json; charset=utf-8", + "Date": "Thu, 28 May 2026 23:47:07 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "201", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "f2304f33-591f-4321-991f-29214c22acc6", + "lastUpdatedDateTime": "2026-05-28T23:47:06Z", + "createdDateTime": "2026-05-28T23:47:06Z", + "expirationDateTime": "2026-05-29T23:47:06Z", + "status": "cancelled", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "PiiEntityRecognitionLROResults", + "lastUpdateDateTime": "2026-05-28T23:47:06.6773779Z", + "status": "cancelled", + "results": { + "documents": [], + "errors": [], + "modelVersion": "" + } + } + ] + } + } + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json new file mode 100644 index 000000000000..e931dfb13dd0 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json @@ -0,0 +1,96 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "4b6fad01-108c-4b86-be7e-8c658b33660a", + "Content-Length": "0", + "Date": "Thu, 28 May 2026 23:45:19 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/acb44929-b42b-4319-92ef-4334f98f1a33?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "277", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/acb44929-b42b-4319-92ef-4334f98f1a33?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "a8a9956f-8926-4d2e-9fe8-4d166070221f", + "Content-Length": "318", + "Content-Type": "application/json; charset=utf-8", + "Date": "Thu, 28 May 2026 23:45:19 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "20", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "acb44929-b42b-4319-92ef-4334f98f1a33", + "lastUpdatedDateTime": "2026-05-28T23:45:20Z", + "createdDateTime": "2026-05-28T23:45:20Z", + "expirationDateTime": "2026-05-29T23:45:20Z", + "status": "notStarted", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 1, + "total": 1, + "items": [] + } + } + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json new file mode 100644 index 000000000000..a53dfdd7338d --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json @@ -0,0 +1,96 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "f252d0f4-9514-4f92-8d18-2235a4e3f77e", + "Content-Length": "0", + "Date": "Thu, 28 May 2026 23:46:26 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/35530fb0-90cd-466c-8465-8cf0deb23532?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "136", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/35530fb0-90cd-466c-8465-8cf0deb23532?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "Connection": "keep-alive", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "35ae19d6-fcde-41a3-a64b-ab4d08d0dc46", + "Content-Length": "318", + "Content-Type": "application/json; charset=utf-8", + "Date": "Thu, 28 May 2026 23:46:26 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "16", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "35530fb0-90cd-466c-8465-8cf0deb23532", + "lastUpdatedDateTime": "2026-05-28T23:46:26Z", + "createdDateTime": "2026-05-28T23:46:26Z", + "expirationDateTime": "2026-05-29T23:46:26Z", + "status": "notStarted", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 1, + "total": 1, + "items": [] + } + } + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py new file mode 100644 index 000000000000..5dd16391d542 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py @@ -0,0 +1,191 @@ +# 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) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import pytest +from devtools_testutils import recorded_by_proxy +from testpreparer import AnalyzeDocumentsClientTestBase, AnalyzeDocumentsPreparer +from urllib.parse import urlparse + + +class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_get_job_state( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + operation_location = {} + + def _raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=_raw_response_hook, + polling=False, + ) + + assert poller is not None + assert operation_location["value"] + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + response = client.get_job_state(job_id=job_id) + + assert response is not None + assert response["jobId"] == job_id + assert response["status"] is not None + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_begin_submit_job( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + ) + + assert poller is not None + assert poller.continuation_token() + assert poller.status() + + @AnalyzeDocumentsPreparer() + @recorded_by_proxy + def test_begin_cancel_job( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + operation_location = {} + + def _raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + submit_poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=_raw_response_hook, + polling=False, + ) + + assert submit_poller is not None + assert operation_location["value"] + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + cancel_poller = client.begin_cancel_job(job_id=job_id) + assert cancel_poller is not None + assert cancel_poller.continuation_token() + # cancel_poller.result() + + # response = client.get_job_state(job_id=job_id) + # assert response is not None + # assert response["jobId"] == job_id + # assert response["status"] in ["cancelled", "cancelling", "notStarted"] diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json new file mode 100644 index 000000000000..92c436de5b6f --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json @@ -0,0 +1,59 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Connection": "keep-alive", + "Content-Length": "436", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://ambertextdevwestus2.blob.core.windows.net/input/git_operation.docx" + }, + "target": { + "location": "https://ambertextdevwestus2.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "2f6796bd-e6ec-465b-84dc-2c8ff4d417ee", + "Content-Length": "0", + "Date": "Wed, 27 May 2026 19:08:33 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/9bcc2f9b-9fb1-4595-8b4f-f6139046057b?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "295", + "x-ms-region": "East US" + }, + "ResponseBody": null + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py similarity index 100% rename from sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/test_analyze_documents_async.py rename to sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py similarity index 76% rename from sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py rename to sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py index 7989d9415d7f..41ad6a806f54 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py @@ -22,5 +22,9 @@ def create_client(self, endpoint): AnalyzeDocumentsPreparer = functools.partial( - PowerShellPreparer, "analyzedocuments", analyzedocuments_endpoint="https://fake_analyzedocuments_endpoint.com" + PowerShellPreparer, + "analyzedocuments", + analyzedocuments_endpoint="https://fake_analyzedocuments_endpoint.com", + analyzedocuments_source_location="https://fakeaccount.blob.core.windows.net/input/fake.docx", + analyzedocuments_target_location="https://fakeaccount.blob.core.windows.net/output", ) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer_async.py similarity index 100% rename from sdk/cognitivelanguage/azure-ai-language-documents/generated_tests/testpreparer_async.py rename to sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer_async.py From 650aae63fd71f8637444de3ee8d08b37845b8f42 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Fri, 29 May 2026 11:58:52 -0700 Subject: [PATCH 13/37] added custom poller --- .../azure/ai/language/documents/_lro.py | 23 ++++ .../language/documents/_operations/_patch.py | 129 +++++++++++++++++- ...AnalyzeDocumentstest_begin_cancel_job.json | 84 +++++++++--- .../tests/test_analyze_documents.py | 16 ++- 4 files changed, 228 insertions(+), 24 deletions(-) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py new file mode 100644 index 000000000000..96fe40da92ba --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +# -------------------------------------------------------------------------- + +from azure.core.polling.base_polling import LROBasePolling + +_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed"]) + + +class AnalyzeDocumentsLROPollingMethod(LROBasePolling): + """Custom polling method for Analyze Documents LROs. + + The service may report terminal cancellation state as ``cancelled``. + azure-core's default LROBasePolling only recognizes ``canceled``. + """ + + def finished(self) -> bool: + status = self.status() + if hasattr(status, "value"): + status = status.value + return str(status).lower() in _FINISHED \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py index 87676c65a8f0..f212ca606e8e 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py @@ -8,8 +8,135 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Optional, Union, cast -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +from azure.core.polling import LROPoller, NoPolling, PollingMethod +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from ._operations import _AnalyzeDocumentsClientOperationsMixin as GeneratedAnalyzeDocumentsClientOperationsMixin +from .._lro import AnalyzeDocumentsLROPollingMethod + + +class _AnalyzeDocumentsClientOperationsMixin(GeneratedAnalyzeDocumentsClientOperationsMixin): + @distributed_trace + def begin_submit_job( + self, + body: Any, + **kwargs: Any + ) -> LROPoller[None]: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token = kwargs.pop("continuation_token", None) + + if cont_token is None: + raw_result = self._submit_job_initial( + body=body, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() + + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + if cls: + return cls(pipeline_response, None, {}) + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method = cast( + PollingMethod, + AnalyzeDocumentsLROPollingMethod( + lro_delay, + path_format_arguments=path_format_arguments, + **kwargs + ), + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) + + @distributed_trace + def begin_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) + polling: Union[bool, PollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token = kwargs.pop("continuation_token", None) + + if cont_token is None: + raw_result = self._cancel_job_initial( + job_id=job_id, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() + + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + if cls: + return cls(pipeline_response, None, {}) + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method = cast( + PollingMethod, + AnalyzeDocumentsLROPollingMethod( + lro_delay, + path_format_arguments=path_format_arguments, + **kwargs + ), + ) + elif polling is False: + polling_method = cast(PollingMethod, NoPolling()) + else: + polling_method = polling + + if cont_token: + return LROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) + + +__all__: list[str] = [ + "_AnalyzeDocumentsClientOperationsMixin", +] def patch_sdk(): diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json index 1df95435d0ee..68c9cbacb220 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json @@ -43,19 +43,19 @@ }, "StatusCode": 202, "ResponseHeaders": { - "apim-request-id": "5e8cbf0c-b524-428a-84c2-2080a5b37414", + "apim-request-id": "7d43af11-7dc9-477e-8608-0f32355f2c03", "Content-Length": "0", - "Date": "Thu, 28 May 2026 23:47:06 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "Date": "Fri, 29 May 2026 18:54:51 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "153", + "x-envoy-upstream-service-time": "365", "x-ms-region": "East US" }, "ResponseBody": null }, { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6:cancel?api-version=2026-05-15-preview", + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486:cancel?api-version=2026-05-15-preview", "RequestMethod": "POST", "RequestHeaders": { "Accept": "*/*", @@ -66,19 +66,19 @@ "RequestBody": null, "StatusCode": 202, "ResponseHeaders": { - "apim-request-id": "994f723c-dc10-45e3-aaf4-31d6b32e43fe", + "apim-request-id": "f087e3bd-b7e9-4997-95bb-03d52ae1aedb", "Content-Length": "0", - "Date": "Thu, 28 May 2026 23:47:06 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "Date": "Fri, 29 May 2026 18:54:51 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "35", + "x-envoy-upstream-service-time": "31", "x-ms-region": "East US" }, "ResponseBody": null }, { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/f2304f33-591f-4321-991f-29214c22acc6?api-version=2026-05-15-preview", + "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", "RequestMethod": "GET", "RequestHeaders": { "Accept": "*/*", @@ -88,20 +88,20 @@ "RequestBody": null, "StatusCode": 200, "ResponseHeaders": { - "apim-request-id": "77b77b4b-9c17-4629-bc26-19dd7317c359", + "apim-request-id": "ebefe885-314d-4b25-815d-33bc631ffb7e", "Content-Length": "488", "Content-Type": "application/json; charset=utf-8", - "Date": "Thu, 28 May 2026 23:47:07 GMT", + "Date": "Fri, 29 May 2026 18:54:51 GMT", "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "201", + "x-envoy-upstream-service-time": "9", "x-ms-region": "East US" }, "ResponseBody": { - "jobId": "f2304f33-591f-4321-991f-29214c22acc6", - "lastUpdatedDateTime": "2026-05-28T23:47:06Z", - "createdDateTime": "2026-05-28T23:47:06Z", - "expirationDateTime": "2026-05-29T23:47:06Z", + "jobId": "bbbc940e-cf7f-4ba4-9f46-855981f82486", + "lastUpdatedDateTime": "2026-05-29T18:54:51Z", + "createdDateTime": "2026-05-29T18:54:51Z", + "expirationDateTime": "2026-05-30T18:54:51Z", "status": "cancelled", "errors": [], "displayName": "Document Analysis.", @@ -113,7 +113,55 @@ "items": [ { "kind": "PiiEntityRecognitionLROResults", - "lastUpdateDateTime": "2026-05-28T23:47:06.6773779Z", + "lastUpdateDateTime": "2026-05-29T18:54:51.4260712Z", + "status": "cancelled", + "results": { + "documents": [], + "errors": [], + "modelVersion": "" + } + } + ] + } + } + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "Connection": "keep-alive", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "a2ee19d7-2cc0-4224-a8de-96d7cb2f60e5", + "Content-Length": "488", + "Content-Type": "application/json; charset=utf-8", + "Date": "Fri, 29 May 2026 18:54:51 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "227", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "bbbc940e-cf7f-4ba4-9f46-855981f82486", + "lastUpdatedDateTime": "2026-05-29T18:54:51Z", + "createdDateTime": "2026-05-29T18:54:51Z", + "expirationDateTime": "2026-05-30T18:54:51Z", + "status": "cancelled", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "PiiEntityRecognitionLROResults", + "lastUpdateDateTime": "2026-05-29T18:54:51.4260712Z", "status": "cancelled", "results": { "documents": [], diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py index 5dd16391d542..15f8b657b1d3 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py @@ -180,12 +180,18 @@ def _raw_response_hook(response): parsed = urlparse(operation_location["value"]) job_id = parsed.path.rstrip("/").split("/")[-1] + # cancel_poller = client.begin_cancel_job(job_id=job_id, polling=False) + # print("initial cancel poller status:", cancel_poller.status()) + + # response = client.get_job_state(job_id=job_id) + # print("job state status:", response["status"]) + cancel_poller = client.begin_cancel_job(job_id=job_id) assert cancel_poller is not None assert cancel_poller.continuation_token() - # cancel_poller.result() + cancel_poller.result() - # response = client.get_job_state(job_id=job_id) - # assert response is not None - # assert response["jobId"] == job_id - # assert response["status"] in ["cancelled", "cancelling", "notStarted"] + response = client.get_job_state(job_id=job_id) + assert response is not None + assert response["jobId"] == job_id + assert response["status"] in ["cancelled", "cancelling", "notStarted"] From c247130864a412d38f8664f4b2657f12aa8d5e84 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 1 Jun 2026 14:49:18 -0700 Subject: [PATCH 14/37] add customer poller and test for async version --- .../azure/ai/language/documents/aio/_lro.py | 23 ++ .../documents/aio/_operations/_patch.py | 129 ++++++++++- ...AnalyzeDocumentstest_begin_submit_job.json | 45 +--- ...zeDocumentsAsynctest_begin_cancel_job.json | 174 ++++++++++++++ ...zeDocumentsAsynctest_begin_submit_job.json | 58 +++++ ...alyzeDocumentsAsynctest_get_job_state.json | 94 ++++++++ .../tests/test_analyze_documents_async.py | 212 +++++++++++++++--- 7 files changed, 659 insertions(+), 76 deletions(-) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py new file mode 100644 index 000000000000..9274f8635561 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py @@ -0,0 +1,23 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +# -------------------------------------------------------------------------- + +from azure.core.polling.async_base_polling import AsyncLROBasePolling + +_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed"]) + + +class AnalyzeDocumentsAsyncLROPollingMethod(AsyncLROBasePolling): + """Custom async polling method for Analyze Documents LROs. + + The service may report terminal cancellation state as ``cancelled``. + azure-core's default AsyncLROBasePolling only recognizes ``canceled``. + """ + + def finished(self) -> bool: + status = self.status() + if hasattr(status, "value"): + status = status.value + return str(status).lower() in _FINISHED \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py index 87676c65a8f0..3b18bf05b99f 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -8,8 +8,135 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from typing import Any, Optional, Union, cast -__all__: list[str] = [] # Add all objects you want publicly available to users at this package level +from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ._operations import _AnalyzeDocumentsClientOperationsMixin as GeneratedAnalyzeDocumentsClientOperationsMixin +from .._lro import AnalyzeDocumentsAsyncLROPollingMethod + + +class _AnalyzeDocumentsClientOperationsMixin(GeneratedAnalyzeDocumentsClientOperationsMixin): + @distributed_trace_async + async def begin_submit_job( + self, + body: Any, + **kwargs: Any + ) -> AsyncLROPoller[None]: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token = kwargs.pop("continuation_token", None) + + if cont_token is None: + raw_result = await self._submit_job_initial( + body=body, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() + + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + if cls: + return cls(pipeline_response, None, {}) + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method = cast( + AsyncPollingMethod, + AnalyzeDocumentsAsyncLROPollingMethod( + lro_delay, + path_format_arguments=path_format_arguments, + **kwargs + ), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) + + @distributed_trace_async + async def begin_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[None]: + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) + polling: Union[bool, AsyncPollingMethod] = kwargs.pop("polling", True) + lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) + cont_token = kwargs.pop("continuation_token", None) + + if cont_token is None: + raw_result = await self._cancel_job_initial( + job_id=job_id, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() + + kwargs.pop("error_map", None) + + def get_long_running_output(pipeline_response): + if cls: + return cls(pipeline_response, None, {}) + + path_format_arguments = { + "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + if polling is True: + polling_method = cast( + AsyncPollingMethod, + AnalyzeDocumentsAsyncLROPollingMethod( + lro_delay, + path_format_arguments=path_format_arguments, + **kwargs + ), + ) + elif polling is False: + polling_method = cast(AsyncPollingMethod, AsyncNoPolling()) + else: + polling_method = polling + + if cont_token: + return AsyncLROPoller[None].from_continuation_token( + polling_method=polling_method, + continuation_token=cont_token, + client=self._client, + deserialization_callback=get_long_running_output, + ) + + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) + + +__all__: list[str] = [ + "_AnalyzeDocumentsClientOperationsMixin", +] def patch_sdk(): diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json index e931dfb13dd0..3dccfd9c8813 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json @@ -43,53 +43,16 @@ }, "StatusCode": 202, "ResponseHeaders": { - "apim-request-id": "4b6fad01-108c-4b86-be7e-8c658b33660a", + "apim-request-id": "8a71bb16-caeb-4ee8-9a9c-ac0bd0761803", "Content-Length": "0", - "Date": "Thu, 28 May 2026 23:45:19 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/acb44929-b42b-4319-92ef-4334f98f1a33?api-version=2026-05-15-preview", + "Date": "Mon, 01 Jun 2026 20:59:22 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f4e8ddab-6f7e-44ef-a316-4b64d50658b9?api-version=2026-05-15-preview", "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "277", + "x-envoy-upstream-service-time": "268", "x-ms-region": "East US" }, "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/acb44929-b42b-4319-92ef-4334f98f1a33?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "a8a9956f-8926-4d2e-9fe8-4d166070221f", - "Content-Length": "318", - "Content-Type": "application/json; charset=utf-8", - "Date": "Thu, 28 May 2026 23:45:19 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "20", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "acb44929-b42b-4319-92ef-4334f98f1a33", - "lastUpdatedDateTime": "2026-05-28T23:45:20Z", - "createdDateTime": "2026-05-28T23:45:20Z", - "expirationDateTime": "2026-05-29T23:45:20Z", - "status": "notStarted", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 1, - "total": 1, - "items": [] - } - } } ], "Variables": {} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json new file mode 100644 index 000000000000..9162bb999172 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json @@ -0,0 +1,174 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "8ef01b05-0a4c-4e63-89c7-069609219b79", + "Content-Length": "0", + "Date": "Mon, 01 Jun 2026 21:48:36 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "270", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc:cancel?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Content-Length": "0", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "4953635b-f256-4ae1-95f4-f8fbf018335c", + "Content-Length": "0", + "Date": "Mon, 01 Jun 2026 21:48:36 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "44", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "*/*", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "44245074-0acd-4c7b-8609-a89d2e93fa12", + "Content-Length": "488", + "Content-Type": "application/json; charset=utf-8", + "Date": "Mon, 01 Jun 2026 21:48:36 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "9", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "bb757fc4-1966-4e99-a3bd-d48184a3bfdc", + "lastUpdatedDateTime": "2026-06-01T21:48:36Z", + "createdDateTime": "2026-06-01T21:48:36Z", + "expirationDateTime": "2026-06-02T21:48:36Z", + "status": "cancelled", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "PiiEntityRecognitionLROResults", + "lastUpdateDateTime": "2026-06-01T21:48:36.2570386Z", + "status": "cancelled", + "results": { + "documents": [], + "errors": [], + "modelVersion": "" + } + } + ] + } + } + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "ebb282c3-a708-4776-b6b2-7736214239b5", + "Content-Length": "488", + "Content-Type": "application/json; charset=utf-8", + "Date": "Mon, 01 Jun 2026 21:48:36 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "7", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "bb757fc4-1966-4e99-a3bd-d48184a3bfdc", + "lastUpdatedDateTime": "2026-06-01T21:48:36Z", + "createdDateTime": "2026-06-01T21:48:36Z", + "expirationDateTime": "2026-06-02T21:48:36Z", + "status": "cancelled", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "PiiEntityRecognitionLROResults", + "lastUpdateDateTime": "2026-06-01T21:48:36.2570386Z", + "status": "cancelled", + "results": { + "documents": [], + "errors": [], + "modelVersion": "" + } + } + ] + } + } + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json new file mode 100644 index 000000000000..0294ebd6b743 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json @@ -0,0 +1,58 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "b78ce457-73f0-46a5-b073-15d007d58843", + "Content-Length": "0", + "Date": "Mon, 01 Jun 2026 21:17:12 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/48a70698-0612-401c-8862-878a280b985a?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "318", + "x-ms-region": "East US" + }, + "ResponseBody": null + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json new file mode 100644 index 000000000000..2f0dd7ecb1e7 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json @@ -0,0 +1,94 @@ +{ + "Entries": [ + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", + "RequestMethod": "POST", + "RequestHeaders": { + "Accept": "*/*", + "Content-Length": "411", + "Content-Type": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": { + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "Sanitized", + "source": { + "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" + }, + "target": { + "location": "https://fakeaccount.blob.core.windows.net/output" + } + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": true + } + ] + } + } + ] + }, + "StatusCode": 202, + "ResponseHeaders": { + "apim-request-id": "9d21ea21-8584-4d89-ac47-a21c5b3126c4", + "Content-Length": "0", + "Date": "Mon, 01 Jun 2026 21:19:30 GMT", + "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/dfc35a49-f6a8-4d16-93b3-788cb8ae60ac?api-version=2026-05-15-preview", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "333", + "x-ms-region": "East US" + }, + "ResponseBody": null + }, + { + "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/dfc35a49-f6a8-4d16-93b3-788cb8ae60ac?api-version=2026-05-15-preview", + "RequestMethod": "GET", + "RequestHeaders": { + "Accept": "application/json", + "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" + }, + "RequestBody": null, + "StatusCode": 200, + "ResponseHeaders": { + "apim-request-id": "070c5354-19fb-4e2d-b626-a59c456e65b1", + "Content-Length": "318", + "Content-Type": "application/json; charset=utf-8", + "Date": "Mon, 01 Jun 2026 21:19:31 GMT", + "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", + "X-Content-Type-Options": "nosniff", + "x-envoy-upstream-service-time": "171", + "x-ms-region": "East US" + }, + "ResponseBody": { + "jobId": "dfc35a49-f6a8-4d16-93b3-788cb8ae60ac", + "lastUpdatedDateTime": "2026-06-01T21:19:31Z", + "createdDateTime": "2026-06-01T21:19:30Z", + "expirationDateTime": "2026-06-02T21:19:30Z", + "status": "notStarted", + "errors": [], + "displayName": "Document Analysis.", + "tasks": { + "completed": 0, + "failed": 0, + "inProgress": 1, + "total": 1, + "items": [] + } + } + } + ], + "Variables": {} +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py index 46ef55253243..49560c71efdb 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents_async.py @@ -2,64 +2,208 @@ # -------------------------------------------------------------------------- # 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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from urllib.parse import urlparse + import pytest +from devtools_testutils import AzureRecordedTestCase from devtools_testutils.aio import recorded_by_proxy_async + +from azure.ai.language.documents.aio import AnalyzeDocumentsClient from testpreparer import AnalyzeDocumentsPreparer -from testpreparer_async import AnalyzeDocumentsClientTestBaseAsync -@pytest.mark.skip("you may need to update the auto-generated test case before run it") -class TestAnalyzeDocumentsAsync(AnalyzeDocumentsClientTestBaseAsync): +class AnalyzeDocumentsAsyncClientTestBase(AzureRecordedTestCase): + def create_client(self, endpoint): + credential = self.get_credential(AnalyzeDocumentsClient, is_async=True) + return self.create_client_from_credential( + AnalyzeDocumentsClient, + credential=credential, + endpoint=endpoint, + ) + + +class TestAnalyzeDocumentsAsync(AnalyzeDocumentsAsyncClientTestBase): @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_get_job_state(self, analyzedocuments_endpoint): - client = self.create_async_client(endpoint=analyzedocuments_endpoint) - response = await client.get_job_state( - job_id="str", - ) + @pytest.mark.asyncio + async def test_get_job_state( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + operation_location = {} + + def _raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + async with client: + poller = await client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=_raw_response_hook, + polling=False, + ) - # please add some check logic here by yourself - # ... + assert poller is not None + assert operation_location["value"] + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + response = await client.get_job_state(job_id=job_id) + + assert response is not None + assert response["jobId"] == job_id + assert response["status"] is not None @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_begin_submit_job(self, analyzedocuments_endpoint): - client = self.create_async_client(endpoint=analyzedocuments_endpoint) - response = await ( - await client.begin_submit_job( + @pytest.mark.asyncio + async def test_begin_submit_job( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + async with client: + poller = await client.begin_submit_job( body={ + "displayName": "Document Analysis.", "analysisInput": { "documents": [ { - "id": "str", - "source": "document_location", - "target": "document_location", - "language": "str", + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, } ] }, - "tasks": ["analyze_documents_operation_action"], - "defaultLanguage": "str", - "displayName": "str", + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], }, ) - ).result() # call '.result()' to poll until service return final result - # please add some check logic here by yourself - # ... + assert poller is not None + assert poller.continuation_token() + assert poller.status() @AnalyzeDocumentsPreparer() @recorded_by_proxy_async - async def test_begin_cancel_job(self, analyzedocuments_endpoint): - client = self.create_async_client(endpoint=analyzedocuments_endpoint) - response = await ( - await client.begin_cancel_job( - job_id="str", + @pytest.mark.asyncio + async def test_begin_cancel_job( + self, + analyzedocuments_endpoint, + analyzedocuments_source_location, + analyzedocuments_target_location, + ): + client = self.create_client(endpoint=analyzedocuments_endpoint) + + operation_location = {} + + def _raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + async with client: + submit_poller = await client.begin_submit_job( + body={ + "displayName": "Document Analysis.", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": { + "location": analyzedocuments_source_location + }, + "target": { + "location": analyzedocuments_target_location + }, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=_raw_response_hook, + polling=False, ) - ).result() # call '.result()' to poll until service return final result - # please add some check logic here by yourself - # ... + assert submit_poller is not None + assert operation_location["value"] + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + cancel_poller = await client.begin_cancel_job(job_id=job_id) + assert cancel_poller is not None + assert cancel_poller.continuation_token() + await cancel_poller.result() + + response = await client.get_job_state(job_id=job_id) + assert response is not None + assert response["jobId"] == job_id + assert response["status"] in ["cancelled", "cancelling", "notStarted"] From 80e848f5f04e2972bdd7377090be473d964e0317 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 1 Jun 2026 15:31:34 -0700 Subject: [PATCH 15/37] add all samples --- ...ocuments_job_status_task_status_request.py | 33 ------- ...l_analyze_documents_jobs_cancel_request.py | 32 ------- ...lyze_documents_jobs_task_submit_request.py | 57 ----------- .../async_samples/sample_cancel_job_async.py | 95 +++++++++++++++++++ .../sample_get_job_state_async.py | 91 ++++++++++++++++++ .../async_samples/sample_submit_job_async.py | 79 +++++++++++++++ .../samples/sample_cancel_job.py | 90 ++++++++++++++++++ .../samples/sample_get_job_state.py | 86 +++++++++++++++++ .../samples/sample_submit_job.py | 73 ++++++++++++++ 9 files changed, 514 insertions(+), 122 deletions(-) delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py deleted file mode 100644 index 41b4c3dafe4d..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_job_status_task_status_request.py +++ /dev/null @@ -1,33 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_job_status_task_status_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - response = client.get_job_state( - job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - ) - print(response) - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobStatusTaskStatusRequest.json -if __name__ == "__main__": - main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py deleted file mode 100644 index 1adc3e8f42eb..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_cancel_request.py +++ /dev/null @@ -1,32 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_jobs_cancel_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - client.begin_cancel_job( - job_id="c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - ).result() - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsCancelRequest.json -if __name__ == "__main__": - main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py b/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py deleted file mode 100644 index 1503c87dcd8e..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/generated_samples/successful_analyze_documents_jobs_task_submit_request.py +++ /dev/null @@ -1,57 +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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - -from azure.ai.language.documents import AnalyzeDocumentsClient - -""" -# PREREQUISITES - pip install azure-ai-language-documents -# USAGE - python successful_analyze_documents_jobs_task_submit_request.py -""" - - -def main(): - client = AnalyzeDocumentsClient( - endpoint="{Endpoint}", - credential="CREDENTIAL", - ) - - client.begin_submit_job( - body={ - "analysisInput": { - "documents": [ - { - "id": "1", - "language": "en", - "source": { - "kind": "AzureBlob", - "location": "https://myblob.blob.core.windows.net/Container/document.txt", - }, - "target": {"kind": "AzureBlob", "location": "https://myblob.blob.core.windows.net/Container"}, - } - ] - }, - "displayName": "Redact PII from documents example", - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "piiCategories": ["Person", "Organization"], - "redactionPolicies": [{"policyKind": "characterMask", "redactionCharacter": "-"}], - }, - "taskName": "Redact PII Task 1", - } - ], - }, - ).result() - - -# x-ms-original-file: 2026-05-15-preview/SuccessfulAnalyzeDocumentsJobsTaskSubmitRequest.json -if __name__ == "__main__": - main() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py new file mode 100644 index 000000000000..b48561c41366 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py @@ -0,0 +1,95 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_cancel_job_async.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job and cancel it asynchronously. + +USAGE: + python sample_cancel_job_async.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + +import asyncio +from urllib.parse import urlparse + + +async def sample_cancel_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents.aio import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + async with client: + await client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + cancel_poller = await client.begin_cancel_job(job_id=job_id) + await cancel_poller.result() + + response = await client.get_job_state(job_id=job_id) + + print(f"Cancel operation status: {cancel_poller.status()}") + print(f"Job ID: {response['jobId']}") + print(f"Job status: {response['status']}") + + +async def main(): + await sample_cancel_job() + + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py new file mode 100644 index 000000000000..6ec746fd7385 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py @@ -0,0 +1,91 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_get_job_state_async.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job and get its job state asynchronously. + +USAGE: + python sample_get_job_state_async.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + +import asyncio +from urllib.parse import urlparse + + +async def sample_get_job_state() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents.aio import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + async with client: + await client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + response = await client.get_job_state(job_id=job_id) + + print(f"Job ID: {response['jobId']}") + print(f"Status: {response['status']}") + + +async def main(): + await sample_get_job_state() + + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py new file mode 100644 index 000000000000..7074fe5d46f9 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py @@ -0,0 +1,79 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_submit_job_async.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job asynchronously. + +USAGE: + python sample_submit_job_async.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + +import asyncio + + +async def sample_submit_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents.aio import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + async with client: + poller = await client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + polling=False, + ) + + print(f"Continuation token: {poller.continuation_token()}") + print(f"Initial poller status: {poller.status()}") + + +async def main(): + await sample_submit_job() + + +if __name__ == "__main__": + asyncio.run(main()) \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py new file mode 100644 index 000000000000..ba6049e3f18a --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py @@ -0,0 +1,90 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_cancel_job.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job and cancel it. + +USAGE: + python sample_cancel_job.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + +from urllib.parse import urlparse + + +def sample_cancel_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + with client: + client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + cancel_poller = client.begin_cancel_job(job_id=job_id) + cancel_poller.result() + + response = client.get_job_state(job_id=job_id) + + print(f"Cancel operation status: {cancel_poller.status()}") + print(f"Job ID: {response['jobId']}") + print(f"Job status: {response['status']}") + + +if __name__ == "__main__": + sample_cancel_job() \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py new file mode 100644 index 000000000000..1fe38e5b976b --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py @@ -0,0 +1,86 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_get_job_state.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job and get its job state. + +USAGE: + python sample_get_job_state.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + +from urllib.parse import urlparse + + +def sample_get_job_state() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + with client: + client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) + + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] + + response = client.get_job_state(job_id=job_id) + + print(f"Job ID: {response['jobId']}") + print(f"Status: {response['status']}") + + +if __name__ == "__main__": + sample_get_job_state() \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py new file mode 100644 index 000000000000..416f971c8bdf --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py @@ -0,0 +1,73 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- + +""" +FILE: sample_submit_job.py + +DESCRIPTION: + This sample shows how to submit an analyze documents job. + +USAGE: + python sample_submit_job.py + + Set the environment variables with your own values before running the sample: + 1) AZURE_LANGUAGE_DOCUMENTS_ENDPOINT - the endpoint to your Language resource. + 2) AZURE_LANGUAGE_KEY - your Language subscription key. + 3) AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION - the source document location. + 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. +""" + + +def sample_submit_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + with client: + poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + polling=False, + ) + + print(f"Continuation token: {poller.continuation_token()}") + print(f"Initial poller status: {poller.status()}") + + +if __name__ == "__main__": + sample_submit_job() \ No newline at end of file From 76f7b688600cf90e7823cf3bf95f7c75792a526f Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 1 Jun 2026 17:36:43 -0700 Subject: [PATCH 16/37] updated snippets --- .../azure-ai-language-documents/README.md | 484 ++++++++++-------- .../async_samples/sample_cancel_job_async.py | 6 +- .../sample_get_job_state_async.py | 6 +- .../async_samples/sample_submit_job_async.py | 7 +- .../samples/sample_cancel_job.py | 6 +- .../samples/sample_get_job_state.py | 6 +- .../samples/sample_submit_job.py | 7 +- 7 files changed, 290 insertions(+), 232 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index ce10e7fe3c4b..161bee7d8e70 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -7,7 +7,7 @@ Azure AI Language Documents lets you submit documents stored in Azure Blob Stora | [Package (Conda)](https://anaconda.org/microsoft/azure-ai-language-documents/) | | [Product documentation][documents_docs] -| +| [Samples][documents_samples] | [Documents REST API][documents_rest_docs] > _Python 2.7 is not supported. For details see the Azure SDK for Python end-of-support notice._ @@ -73,44 +73,39 @@ client = AnalyzeDocumentsClient(endpoint, credential) ### `AnalyzeDocumentsClient` -[`AnalyzeDocumentsClient`][documents_client_class] is the primary interface for submitting document analysis jobs, checking job status, and cancelling submitted jobs. +`AnalyzeDocumentsClient` is the primary interface for: -For asynchronous operations, an async `AnalyzeDocumentsClient` is available in the `azure.ai.language.documents.aio` namespace. +- submitting long-running document analysis jobs with `begin_submit_job` +- checking job status with `get_job_state` +- cancelling jobs with `begin_cancel_job` -### Input and task model relationships +For asynchronous operations, use `AnalyzeDocumentsClient` from the `azure.ai.language.documents.aio` namespace. -The request body for job submission is built from these models: +### Input models -* `AnalyzeDocumentJobsInput` – top-level job definition -* `MultiLanguageAnalysisInput` – collection of documents to analyze -* `MultiLanguageInput` – one input document, including: - * `source` – input document location - * `target` – output location -* `DocumentLocation` subtypes – storage-backed document locations: - * `AzureBlobDocumentLocation` - * `AzureContainerDocumentLocation` - * `AzureContainerFolderDocumentLocation` -* `AnalyzeDocumentsLROTask` subtypes – tasks to run for the job, such as: - * `PiiLROTask` +The request body for job submission can be passed either as: -PII task configuration is provided through `PiiTaskParameters`, including optional `redaction_policies`. +- an `AnalyzeDocumentsJob` model +- a JSON-compatible `dict` -### Results model relationships +Common related models include: -`analyze_documents_job_status` returns `AnalyzeDocumentsJobState`, which contains: +- `AnalyzeDocumentsJob` +- `MultiLanguageAnalysisInput` +- `MultiLanguageInput` +- `AzureBlobDocumentLocation` +- `AzureContainerDocumentLocation` +- `AzureContainerFolderDocumentLocation` +- `PiiEntityRecognitionAction` +- `PiiTaskParameters` -* overall job metadata and status -* `tasks`, a `Tasks` object -* `tasks.items_property`, which contains per-task results such as: - * `PiiEntityRecognitionLROResult` - * `AbstractiveSummarizationLROResult` +### Job state -Each task result contains an `AnalyzeDocumentsResult`, which exposes: +`get_job_state` returns an `AnalyzeDocumentsJobState`, which contains: -* `documents` -* `errors` -* `statistics` -* `model_version` +- job metadata +- overall job status +- task summary details ## Examples @@ -118,241 +113,276 @@ Each task result contains an `AnalyzeDocumentsResult`, which exposes: The `azure-ai-language-documents` client library provides both synchronous and asynchronous APIs. -* [Submit a job (model objects)](#submit-a-job-model-objects) -* [Submit a job (JSON body)](#submit-a-job-json-body) -* [Get job status and results](#get-job-status-and-results) -* [Cancel a job](#cancel-a-job) -* [Async usage](#async-usage) +- [Submit a job](#submit-a-job) +- [Get job state](#get-job-state) +- [Cancel a job](#cancel-a-job) +- [Async usage](#async-usage) +- [Samples](#samples) -#### Submit a job (model objects) +#### Submit a job This example submits a PII analysis job using strongly typed model objects: -```python - -import os - -from azure.identity import DefaultAzureCredential -from azure.ai.language.documents import AnalyzeDocumentsClient -from azure.ai.language.documents.models import ( - AnalyzeDocumentJobsInput, - MultiLanguageAnalysisInput, - MultiLanguageInput, - AzureBlobDocumentLocation, - AzureContainerFolderDocumentLocation, - PiiLROTask, - PiiTaskParameters, - CharacterMaskPolicy, -) - -endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"] -client = AnalyzeDocumentsClient(endpoint, DefaultAzureCredential()) - -job = AnalyzeDocumentJobsInput( - display_name="sample-documents-job", - analysis_input=MultiLanguageAnalysisInput( - documents=[ - MultiLanguageInput( - id="1", - source=AzureBlobDocumentLocation( - location="https://.blob.core.windows.net/input/invoice-1.txt" - ), - target=AzureContainerFolderDocumentLocation( - location="https://.blob.core.windows.net/output/pii-results/" - ), - language="en", - ) - ] - ), - tasks=[ - PiiLROTask( - task_name="pii-redaction", - parameters=PiiTaskParameters( - redaction_policies=[ - CharacterMaskPolicy(is_default=True) - ] - ), - ) - ], - default_language="en", -) - -poller = client.begin_analyze_documents_submit_job(job) -poller.result() - -print(f"Job completed with status: {poller.status()}") -``` - -#### Submit a job (JSON body) - -You can also submit the request as a JSON-compatible dictionary: + ```python -import os - -from azure.identity import DefaultAzureCredential -from azure.ai.language.documents import AnalyzeDocumentsClient - -endpoint = os.environ["AZURE_LANGUAGE_ENDPOINT"] -client = AnalyzeDocumentsClient(endpoint, DefaultAzureCredential()) - -body = { - "displayName": "sample-documents-job", - "analysisInput": { - "documents": [ - { - "id": "1", - "source": { - "kind": "AzureBlob", - "location": "https://.blob.core.windows.net/input/invoice-1.txt", - }, - "target": { - "kind": "AzureContainerFolder", - "location": "https://.blob.core.windows.net/output/pii-results/", +def sample_submit_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + with client: + poller = client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] }, - "language": "en", - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "taskName": "pii-redaction", - "parameters": { - "redactionPolicies": [ + "tasks": [ { - "policyKind": "characterMask", - "isDefault": True, + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, } - ] + ], }, - } - ], - "defaultLanguage": "en", -} - -poller = client.begin_analyze_documents_submit_job(body) -poller.result() + polling=False, + ) -print(f"Job completed with status: {poller.status()}") + print(f"Initial poller status: {poller.status()}") ``` -#### Get job status and results + -If you have a job ID, use `analyze_documents_job_status` to retrieve the full job state and task results: +#### Get job state -```python -from azure.core.exceptions import HttpResponseError +Use `get_job_state` to retrieve the current state of a submitted job: -job_id = "" + -try: - job_state = client.analyze_documents_job_status(job_id, show_stats=True) - - print(f"Job ID: {job_state.job_id}") - print(f"Status: {job_state.status}") - print(f"Created: {job_state.created_date_time}") - print(f"Updated: {job_state.last_updated_date_time}") - - if job_state.statistics: - print(f"Documents: {job_state.statistics.documents_count}") - print(f"Transactions: {job_state.statistics.transactions_count}") +```python +def sample_get_job_state() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + with client: + client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) - for task in job_state.tasks.items_property or []: - print(f"Task kind: {task.kind}") - print(f"Task status: {task.status}") + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] - if hasattr(task, "results"): - print(f"Model version: {task.results.model_version}") - for document in task.results.documents: - print(f"Document ID: {document.id}") - print(f"Source: {document.source.location}") - for target in document.target: - print(f"Target: {target.location}") + response = client.get_job_state(job_id=job_id) -except HttpResponseError as error: - print(f"Request failed: {error.message}") + print(f"Job ID: {response['jobId']}") + print(f"Status: {response['status']}") ``` + + #### Cancel a job -If you need to cancel a submitted job, use `begin_analyze_documents_cancel_job`: +If you need to cancel a submitted job, use `begin_cancel_job`: + + ```python +def sample_cancel_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + operation_location = {} + + def raw_response_hook(response): + operation_location["value"] = response.http_response.headers.get("Operation-Location") + + with client: + client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + raw_response_hook=raw_response_hook, + polling=False, + ) -job_id = "" + parsed = urlparse(operation_location["value"]) + job_id = parsed.path.rstrip("/").split("/")[-1] -cancel_poller = client.begin_analyze_documents_cancel_job(job_id) -cancel_poller.result() + cancel_poller = client.begin_cancel_job(job_id=job_id) + cancel_poller.result() -print(f"Cancellation request completed with status: {cancel_poller.status()}") + response = client.get_job_state(job_id=job_id) + print(f"Cancel operation status: {cancel_poller.status()}") + print(f"Job ID: {response['jobId']}") + print(f"Job status: {response['status']}") ``` + + #### Async usage The same patterns are available with the async client in `azure.ai.language.documents.aio`: -```python + -import os +```python import asyncio -from azure.identity.aio import DefaultAzureCredential -from azure.ai.language.documents.aio import AnalyzeDocumentsClient -from azure.ai.language.documents.models import ( - AnalyzeDocumentJobsInput, - MultiLanguageAnalysisInput, - MultiLanguageInput, - AzureBlobDocumentLocation, - AzureContainerFolderDocumentLocation, - PiiLROTask, -) - - -async def main(): - credential = DefaultAzureCredential() - client = AnalyzeDocumentsClient( - os.environ["AZURE_LANGUAGE_ENDPOINT"], - credential, - ) - - try: - job = AnalyzeDocumentJobsInput( - display_name="async-documents-job", - analysis_input=MultiLanguageAnalysisInput( - documents=[ - MultiLanguageInput( - id="1", - source=AzureBlobDocumentLocation( - location="https://.blob.core.windows.net/input/invoice-1.txt" - ), - target=AzureContainerFolderDocumentLocation( - location="https://.blob.core.windows.net/output/pii-results/" - ), - language="en", - ) - ] - ), - tasks=[ - PiiLROTask(task_name="pii-analysis") - ], - default_language="en", - ) - poller = await client.begin_analyze_documents_submit_job(job) - await poller.result() +async def sample_submit_job() -> None: + import os + from azure.core.credentials import AzureKeyCredential + from azure.ai.language.documents.aio import AnalyzeDocumentsClient + + endpoint = os.environ["AZURE_LANGUAGE_DOCUMENTS_ENDPOINT"] + key = os.environ["AZURE_LANGUAGE_KEY"] + source_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_SOURCE_LOCATION"] + target_location = os.environ["AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION"] + + client = AnalyzeDocumentsClient(endpoint=endpoint, credential=AzureKeyCredential(key)) + + async with client: + poller = await client.begin_submit_job( + body={ + "displayName": "Document Analysis Sample", + "analysisInput": { + "documents": [ + { + "language": "en", + "id": "1", + "source": {"location": source_location}, + "target": {"location": target_location}, + } + ] + }, + "tasks": [ + { + "kind": "PiiEntityRecognition", + "parameters": { + "redactionPolicies": [ + { + "policyName": "defaultPolicy", + "policyKind": "EntityMask", + "isDefault": True, + } + ] + }, + } + ], + }, + polling=False, + ) - print(f"Job completed with status: {poller.status()}") + print(f"Initial poller status: {poller.status()}") +``` - finally: - await client.close() - await credential.close() + +## Samples -asyncio.run(main()) +The following samples are available in this package: -``` +|**File Name**|**Description**| +|----------------|-------------| +|[sample_submit_job.py][sample_submit_job] and [sample_submit_job_async.py][sample_submit_job_async]|Submit an analyze documents job| +|[sample_get_job_state.py][sample_get_job_state] and [sample_get_job_state_async.py][sample_get_job_state_async]|Submit a job and retrieve its job state| +|[sample_cancel_job.py][sample_cancel_job] and [sample_cancel_job_async.py][sample_cancel_job_async]|Submit a job and cancel it| ## Optional configuration @@ -393,7 +423,7 @@ See the full SDK logging documentation in the [logging guidance][sdk_logging_doc This library supports both: -* **Strongly typed model inputs** via `AnalyzeDocumentJobsInput` +* **Strongly typed model inputs** via `AnalyzeDocumentsJob` * **JSON-compatible dictionary inputs** for direct request construction The typed-model approach is recommended for clarity, static analysis, and discoverability. @@ -428,14 +458,20 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [azure_core_ref_docs]: https://azuresdkdocs.z19.web.core.windows.net/python/azure-core/latest/azure.core.html [azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md [pip_link]: https://pypi.org/project/pip/ - +[documents_client_class]: https://azuresdkdocs.z19.web.core.windows.net/python/azure-ai-language-documents/latest/azure.ai.language.documents.html#azure.ai.language.documents.AnalyzeDocumentsClient [documents_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/ [documents_docs]: https://learn.microsoft.com/azure/ai-services/language-service/ [documents_pypi_package]: https://pypi.org/project/azure-ai-language-documents/ - - +[documents_refdocs]: https://azuresdkdocs.z19.web.core.windows.net/python/azure-ai-language-documents/latest/azure.ai.language.documents.html [documents_rest_docs]: https://learn.microsoft.com/rest/api/language/ [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials [install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#install-the-package [register_aad_app]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal -[grant_role_access]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal \ No newline at end of file +[grant_role_access]: https://learn.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal +[documents_samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/ +[sample_submit_job]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py +[sample_submit_job_async]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py +[sample_get_job_state]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py +[sample_get_job_state_async]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py +[sample_cancel_job]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py +[sample_cancel_job_async]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py \ No newline at end of file diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py index b48561c41366..e80a4244e8d4 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py @@ -24,6 +24,7 @@ from urllib.parse import urlparse +# [START sample_cancel_job_async] async def sample_cancel_job() -> None: import os from azure.core.credentials import AzureKeyCredential @@ -87,9 +88,12 @@ def raw_response_hook(response): print(f"Job status: {response['status']}") +# [END sample_cancel_job_async] + + async def main(): await sample_cancel_job() if __name__ == "__main__": - asyncio.run(main()) \ No newline at end of file + asyncio.run(main()) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py index 6ec746fd7385..9f83da410ce9 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py @@ -24,6 +24,7 @@ from urllib.parse import urlparse +# [START sample_get_job_state_async] async def sample_get_job_state() -> None: import os from azure.core.credentials import AzureKeyCredential @@ -83,9 +84,12 @@ def raw_response_hook(response): print(f"Status: {response['status']}") +# [END sample_get_job_state_async] + + async def main(): await sample_get_job_state() if __name__ == "__main__": - asyncio.run(main()) \ No newline at end of file + asyncio.run(main()) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py index 7074fe5d46f9..2a9cc45180fd 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py @@ -20,6 +20,7 @@ 4) AZURE_LANGUAGE_DOCUMENTS_TARGET_LOCATION - the output location. """ +# [START sample_submit_job_async] import asyncio @@ -67,13 +68,15 @@ async def sample_submit_job() -> None: polling=False, ) - print(f"Continuation token: {poller.continuation_token()}") print(f"Initial poller status: {poller.status()}") +# [END sample_submit_job_async] + + async def main(): await sample_submit_job() if __name__ == "__main__": - asyncio.run(main()) \ No newline at end of file + asyncio.run(main()) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py index ba6049e3f18a..48afb1643d83 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py @@ -23,6 +23,7 @@ from urllib.parse import urlparse +# [START sample_cancel_job] def sample_cancel_job() -> None: import os from azure.core.credentials import AzureKeyCredential @@ -86,5 +87,8 @@ def raw_response_hook(response): print(f"Job status: {response['status']}") +# [END sample_cancel_job] + + if __name__ == "__main__": - sample_cancel_job() \ No newline at end of file + sample_cancel_job() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py index 1fe38e5b976b..fe7d1770c575 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py @@ -23,6 +23,7 @@ from urllib.parse import urlparse +# [START sample_get_job_state] def sample_get_job_state() -> None: import os from azure.core.credentials import AzureKeyCredential @@ -82,5 +83,8 @@ def raw_response_hook(response): print(f"Status: {response['status']}") +# [END sample_get_job_state] + + if __name__ == "__main__": - sample_get_job_state() \ No newline at end of file + sample_get_job_state() diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py index 416f971c8bdf..f7f19240b406 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_submit_job.py @@ -21,6 +21,7 @@ """ +# [START sample_submit_job] def sample_submit_job() -> None: import os from azure.core.credentials import AzureKeyCredential @@ -65,9 +66,11 @@ def sample_submit_job() -> None: polling=False, ) - print(f"Continuation token: {poller.continuation_token()}") print(f"Initial poller status: {poller.status()}") +# [END sample_submit_job] + + if __name__ == "__main__": - sample_submit_job() \ No newline at end of file + sample_submit_job() From d57bda6f47cfc81b7e4aace592b01963a1629c18 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Tue, 2 Jun 2026 09:42:15 -0700 Subject: [PATCH 17/37] migrate test recordings --- .../azure-ai-language-documents/assets.json | 6 + ...AnalyzeDocumentstest_begin_cancel_job.json | 178 ------------------ ...AnalyzeDocumentstest_begin_submit_job.json | 59 ------ ...estAnalyzeDocumentstest_get_job_state.json | 96 ---------- ...zeDocumentsAsynctest_begin_cancel_job.json | 174 ----------------- ...zeDocumentsAsynctest_begin_submit_job.json | 58 ------ ...alyzeDocumentsAsynctest_get_job_state.json | 94 --------- 7 files changed, 6 insertions(+), 659 deletions(-) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/assets.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/assets.json b/sdk/cognitivelanguage/azure-ai-language-documents/assets.json new file mode 100644 index 000000000000..6575294d7a31 --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/assets.json @@ -0,0 +1,6 @@ +{ + "AssetsRepo": "Azure/azure-sdk-assets", + "AssetsRepoPrefixPath": "python", + "TagPrefix": "python/cognitivelanguage/azure-ai-language-documents", + "Tag": "python/cognitivelanguage/azure-ai-language-documents_dbf58dbe72" +} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json deleted file mode 100644 index 68c9cbacb220..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_cancel_job.json +++ /dev/null @@ -1,178 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "7d43af11-7dc9-477e-8608-0f32355f2c03", - "Content-Length": "0", - "Date": "Fri, 29 May 2026 18:54:51 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "365", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486:cancel?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "Content-Length": "0", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "f087e3bd-b7e9-4997-95bb-03d52ae1aedb", - "Content-Length": "0", - "Date": "Fri, 29 May 2026 18:54:51 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "31", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "ebefe885-314d-4b25-815d-33bc631ffb7e", - "Content-Length": "488", - "Content-Type": "application/json; charset=utf-8", - "Date": "Fri, 29 May 2026 18:54:51 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "9", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "bbbc940e-cf7f-4ba4-9f46-855981f82486", - "lastUpdatedDateTime": "2026-05-29T18:54:51Z", - "createdDateTime": "2026-05-29T18:54:51Z", - "expirationDateTime": "2026-05-30T18:54:51Z", - "status": "cancelled", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "PiiEntityRecognitionLROResults", - "lastUpdateDateTime": "2026-05-29T18:54:51.4260712Z", - "status": "cancelled", - "results": { - "documents": [], - "errors": [], - "modelVersion": "" - } - } - ] - } - } - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bbbc940e-cf7f-4ba4-9f46-855981f82486?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "application/json", - "Connection": "keep-alive", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "a2ee19d7-2cc0-4224-a8de-96d7cb2f60e5", - "Content-Length": "488", - "Content-Type": "application/json; charset=utf-8", - "Date": "Fri, 29 May 2026 18:54:51 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "227", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "bbbc940e-cf7f-4ba4-9f46-855981f82486", - "lastUpdatedDateTime": "2026-05-29T18:54:51Z", - "createdDateTime": "2026-05-29T18:54:51Z", - "expirationDateTime": "2026-05-30T18:54:51Z", - "status": "cancelled", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "PiiEntityRecognitionLROResults", - "lastUpdateDateTime": "2026-05-29T18:54:51.4260712Z", - "status": "cancelled", - "results": { - "documents": [], - "errors": [], - "modelVersion": "" - } - } - ] - } - } - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json deleted file mode 100644 index 3dccfd9c8813..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "8a71bb16-caeb-4ee8-9a9c-ac0bd0761803", - "Content-Length": "0", - "Date": "Mon, 01 Jun 2026 20:59:22 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/f4e8ddab-6f7e-44ef-a316-4b64d50658b9?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "268", - "x-ms-region": "East US" - }, - "ResponseBody": null - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json deleted file mode 100644 index a53dfdd7338d..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents.pyTestAnalyzeDocumentstest_get_job_state.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "f252d0f4-9514-4f92-8d18-2235a4e3f77e", - "Content-Length": "0", - "Date": "Thu, 28 May 2026 23:46:26 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/35530fb0-90cd-466c-8465-8cf0deb23532?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "136", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/35530fb0-90cd-466c-8465-8cf0deb23532?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "application/json", - "Connection": "keep-alive", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "35ae19d6-fcde-41a3-a64b-ab4d08d0dc46", - "Content-Length": "318", - "Content-Type": "application/json; charset=utf-8", - "Date": "Thu, 28 May 2026 23:46:26 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "16", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "35530fb0-90cd-466c-8465-8cf0deb23532", - "lastUpdatedDateTime": "2026-05-28T23:46:26Z", - "createdDateTime": "2026-05-28T23:46:26Z", - "expirationDateTime": "2026-05-29T23:46:26Z", - "status": "notStarted", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 1, - "total": 1, - "items": [] - } - } - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json deleted file mode 100644 index 9162bb999172..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_cancel_job.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "8ef01b05-0a4c-4e63-89c7-069609219b79", - "Content-Length": "0", - "Date": "Mon, 01 Jun 2026 21:48:36 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "270", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc:cancel?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Content-Length": "0", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "4953635b-f256-4ae1-95f4-f8fbf018335c", - "Content-Length": "0", - "Date": "Mon, 01 Jun 2026 21:48:36 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "44", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com/language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "*/*", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "44245074-0acd-4c7b-8609-a89d2e93fa12", - "Content-Length": "488", - "Content-Type": "application/json; charset=utf-8", - "Date": "Mon, 01 Jun 2026 21:48:36 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "9", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "bb757fc4-1966-4e99-a3bd-d48184a3bfdc", - "lastUpdatedDateTime": "2026-06-01T21:48:36Z", - "createdDateTime": "2026-06-01T21:48:36Z", - "expirationDateTime": "2026-06-02T21:48:36Z", - "status": "cancelled", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "PiiEntityRecognitionLROResults", - "lastUpdateDateTime": "2026-06-01T21:48:36.2570386Z", - "status": "cancelled", - "results": { - "documents": [], - "errors": [], - "modelVersion": "" - } - } - ] - } - } - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/bb757fc4-1966-4e99-a3bd-d48184a3bfdc?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "ebb282c3-a708-4776-b6b2-7736214239b5", - "Content-Length": "488", - "Content-Type": "application/json; charset=utf-8", - "Date": "Mon, 01 Jun 2026 21:48:36 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "7", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "bb757fc4-1966-4e99-a3bd-d48184a3bfdc", - "lastUpdatedDateTime": "2026-06-01T21:48:36Z", - "createdDateTime": "2026-06-01T21:48:36Z", - "expirationDateTime": "2026-06-02T21:48:36Z", - "status": "cancelled", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "PiiEntityRecognitionLROResults", - "lastUpdateDateTime": "2026-06-01T21:48:36.2570386Z", - "status": "cancelled", - "results": { - "documents": [], - "errors": [], - "modelVersion": "" - } - } - ] - } - } - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json deleted file mode 100644 index 0294ebd6b743..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_begin_submit_job.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "b78ce457-73f0-46a5-b073-15d007d58843", - "Content-Length": "0", - "Date": "Mon, 01 Jun 2026 21:17:12 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/48a70698-0612-401c-8862-878a280b985a?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "318", - "x-ms-region": "East US" - }, - "ResponseBody": null - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json deleted file mode 100644 index 2f0dd7ecb1e7..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/recordings/test_analyze_documents_async.pyTestAnalyzeDocumentsAsynctest_get_job_state.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Content-Length": "411", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://fakeaccount.blob.core.windows.net/input/fake.docx" - }, - "target": { - "location": "https://fakeaccount.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "9d21ea21-8584-4d89-ac47-a21c5b3126c4", - "Content-Length": "0", - "Date": "Mon, 01 Jun 2026 21:19:30 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/dfc35a49-f6a8-4d16-93b3-788cb8ae60ac?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "333", - "x-ms-region": "East US" - }, - "ResponseBody": null - }, - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs/dfc35a49-f6a8-4d16-93b3-788cb8ae60ac?api-version=2026-05-15-preview", - "RequestMethod": "GET", - "RequestHeaders": { - "Accept": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": null, - "StatusCode": 200, - "ResponseHeaders": { - "apim-request-id": "070c5354-19fb-4e2d-b626-a59c456e65b1", - "Content-Length": "318", - "Content-Type": "application/json; charset=utf-8", - "Date": "Mon, 01 Jun 2026 21:19:31 GMT", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "171", - "x-ms-region": "East US" - }, - "ResponseBody": { - "jobId": "dfc35a49-f6a8-4d16-93b3-788cb8ae60ac", - "lastUpdatedDateTime": "2026-06-01T21:19:31Z", - "createdDateTime": "2026-06-01T21:19:30Z", - "expirationDateTime": "2026-06-02T21:19:30Z", - "status": "notStarted", - "errors": [], - "displayName": "Document Analysis.", - "tasks": { - "completed": 0, - "failed": 0, - "inProgress": 1, - "total": 1, - "items": [] - } - } - } - ], - "Variables": {} -} From 3ba81dd81c5deef8c05997dbd43915b5609566b8 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Tue, 2 Jun 2026 11:57:42 -0700 Subject: [PATCH 18/37] updated conftest.py --- .../azure-ai-language-documents/tests/conftest.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py index 9af91a66703d..119b953e024c 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py @@ -30,6 +30,7 @@ def add_sanitizers(test_proxy): analyzedocuments_client_secret = os.environ.get( "ANALYZEDOCUMENTS_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" ) + analyzedocuments_endpoint = os.environ.get("ANALYZEDOCUMENTS_ENDPOINT") analyzedocuments_source_location = os.environ.get( "ANALYZEDOCUMENTS_SOURCE_LOCATION", "https://fakeaccount.blob.core.windows.net/input/fake.docx", @@ -44,6 +45,17 @@ def add_sanitizers(test_proxy): add_general_regex_sanitizer(regex=analyzedocuments_client_id, value="00000000-0000-0000-0000-000000000000") add_general_regex_sanitizer(regex=analyzedocuments_client_secret, value="00000000-0000-0000-0000-000000000000") + if analyzedocuments_endpoint: + normalized_endpoint = analyzedocuments_endpoint.rstrip("/") + add_general_regex_sanitizer( + regex=re.escape(normalized_endpoint), + value="https://fake_analyzedocuments_endpoint.com", + ) + add_general_regex_sanitizer( + regex=re.escape(normalized_endpoint + "/"), + value="https://fake_analyzedocuments_endpoint.com/", + ) + add_general_regex_sanitizer( regex=re.escape(analyzedocuments_source_location), value="https://fakeaccount.blob.core.windows.net/input/fake.docx", From 06094096003e5278d01e1904dae392987aecfef2 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Wed, 3 Jun 2026 12:01:54 -0700 Subject: [PATCH 19/37] update sanitizer and tests --- .../tests/conftest.py | 80 +++++++------------ .../tests/test_analyze_documents.py | 14 +++- .../recordings.json | 59 -------------- .../tests/testpreparer.py | 2 +- 4 files changed, 41 insertions(+), 114 deletions(-) delete mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py index 119b953e024c..4ade3d754e78 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/conftest.py @@ -1,70 +1,44 @@ -# coding=utf-8 -# -------------------------------------------------------------------------- +# 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) Python Code Generator. -# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# Licensed under the MIT License. See License.txt in the project root for +# license information. # -------------------------------------------------------------------------- + import os -import re import pytest -from dotenv import load_dotenv from devtools_testutils import ( test_proxy, - add_general_regex_sanitizer, - add_body_key_sanitizer, - add_header_regex_sanitizer, + add_remove_header_sanitizer, + add_oauth_response_sanitizer, + add_uri_regex_sanitizer, + add_general_string_sanitizer, ) -load_dotenv() +ENV_SOURCE_LOCATION = "ANALYZEDOCUMENTS_SOURCE_LOCATION" +ENV_TARGET_LOCATION = "ANALYZEDOCUMENTS_TARGET_LOCATION" + +FAKE_SOURCE_LOCATION = "https://fakeaccount.blob.core.windows.net/input/fake.docx" +FAKE_TARGET_LOCATION = "https://fakeaccount.blob.core.windows.net/output" -# For security, please avoid record sensitive identity information in recordings @pytest.fixture(scope="session", autouse=True) def add_sanitizers(test_proxy): - analyzedocuments_subscription_id = os.environ.get( - "ANALYZEDOCUMENTS_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000" - ) - analyzedocuments_tenant_id = os.environ.get("ANALYZEDOCUMENTS_TENANT_ID", "00000000-0000-0000-0000-000000000000") - analyzedocuments_client_id = os.environ.get("ANALYZEDOCUMENTS_CLIENT_ID", "00000000-0000-0000-0000-000000000000") - analyzedocuments_client_secret = os.environ.get( - "ANALYZEDOCUMENTS_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000" - ) - analyzedocuments_endpoint = os.environ.get("ANALYZEDOCUMENTS_ENDPOINT") - analyzedocuments_source_location = os.environ.get( - "ANALYZEDOCUMENTS_SOURCE_LOCATION", - "https://fakeaccount.blob.core.windows.net/input/fake.docx", - ) - analyzedocuments_target_location = os.environ.get( - "ANALYZEDOCUMENTS_TARGET_LOCATION", - "https://fakeaccount.blob.core.windows.net/output", + add_remove_header_sanitizer(headers="Ocp-Apim-Subscription-Key,Authorization") + add_oauth_response_sanitizer() + + add_uri_regex_sanitizer( + regex=r"https://[^/]+\.(api\.cognitive\.microsoft\.com|cognitiveservices\.azure\.com)", + value="https://Sanitized.cognitiveservices.azure.com", ) - add_general_regex_sanitizer(regex=analyzedocuments_subscription_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=analyzedocuments_tenant_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=analyzedocuments_client_id, value="00000000-0000-0000-0000-000000000000") - add_general_regex_sanitizer(regex=analyzedocuments_client_secret, value="00000000-0000-0000-0000-000000000000") + source_location = os.getenv(ENV_SOURCE_LOCATION) + target_location = os.getenv(ENV_TARGET_LOCATION) - if analyzedocuments_endpoint: - normalized_endpoint = analyzedocuments_endpoint.rstrip("/") - add_general_regex_sanitizer( - regex=re.escape(normalized_endpoint), - value="https://fake_analyzedocuments_endpoint.com", - ) - add_general_regex_sanitizer( - regex=re.escape(normalized_endpoint + "/"), - value="https://fake_analyzedocuments_endpoint.com/", - ) + if source_location: + add_general_string_sanitizer(target=source_location, value=FAKE_SOURCE_LOCATION) - add_general_regex_sanitizer( - regex=re.escape(analyzedocuments_source_location), - value="https://fakeaccount.blob.core.windows.net/input/fake.docx", - ) - add_general_regex_sanitizer( - regex=re.escape(analyzedocuments_target_location), - value="https://fakeaccount.blob.core.windows.net/output", - ) + if target_location: + add_general_string_sanitizer(target=target_location, value=FAKE_TARGET_LOCATION) - add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]") - add_header_regex_sanitizer(key="Cookie", value="cookie;") - add_body_key_sanitizer(json_path="$..access_token", value="access_token") + return diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py index 15f8b657b1d3..9ba949ef70d8 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py @@ -6,12 +6,19 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- import pytest +import os from devtools_testutils import recorded_by_proxy from testpreparer import AnalyzeDocumentsClientTestBase, AnalyzeDocumentsPreparer from urllib.parse import urlparse - class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): + + def _print_env_debug(self): + print("AZURE_TEST_RUN_LIVE =", repr(os.getenv("AZURE_TEST_RUN_LIVE"))) + print("ANALYZEDOCUMENTS_ENDPOINT =", repr(os.getenv("ANALYZEDOCUMENTS_ENDPOINT"))) + print("ANALYZEDOCUMENTS_SOURCE_LOCATION =", repr(os.getenv("ANALYZEDOCUMENTS_SOURCE_LOCATION"))) + print("ANALYZEDOCUMENTS_TARGET_LOCATION =", repr(os.getenv("ANALYZEDOCUMENTS_TARGET_LOCATION"))) + @AnalyzeDocumentsPreparer() @recorded_by_proxy def test_get_job_state( @@ -83,6 +90,11 @@ def test_begin_submit_job( analyzedocuments_source_location, analyzedocuments_target_location, ): + self._print_env_debug() + print("prepared analyzedocuments_endpoint =", analyzedocuments_endpoint) + print("prepared analyzedocuments_source_location =", analyzedocuments_source_location) + print("prepared analyzedocuments_target_location =", analyzedocuments_target_location) + client = self.create_client(endpoint=analyzedocuments_endpoint) poller = client.begin_submit_job( diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json deleted file mode 100644 index 92c436de5b6f..000000000000 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.pyTestAnalyzeDocumentstest_begin_submit_job/recordings.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "Entries": [ - { - "RequestUri": "https://Sanitized.cognitiveservices.azure.com//language/analyze-documents/jobs?api-version=2026-05-15-preview", - "RequestMethod": "POST", - "RequestHeaders": { - "Accept": "*/*", - "Connection": "keep-alive", - "Content-Length": "436", - "Content-Type": "application/json", - "User-Agent": "azsdk-python-ai-language-documents/1.0.0b1 Python/3.13.13 (Windows-11-10.0.26200-SP0)" - }, - "RequestBody": { - "displayName": "Document Analysis.", - "analysisInput": { - "documents": [ - { - "language": "en", - "id": "Sanitized", - "source": { - "location": "https://ambertextdevwestus2.blob.core.windows.net/input/git_operation.docx" - }, - "target": { - "location": "https://ambertextdevwestus2.blob.core.windows.net/output" - } - } - ] - }, - "tasks": [ - { - "kind": "PiiEntityRecognition", - "parameters": { - "redactionPolicies": [ - { - "policyName": "defaultPolicy", - "policyKind": "EntityMask", - "isDefault": true - } - ] - } - } - ] - }, - "StatusCode": 202, - "ResponseHeaders": { - "apim-request-id": "2f6796bd-e6ec-465b-84dc-2c8ff4d417ee", - "Content-Length": "0", - "Date": "Wed, 27 May 2026 19:08:33 GMT", - "operation-location": "https://fake_analyzedocuments_endpoint.comlanguage/analyze-documents/jobs/9bcc2f9b-9fb1-4595-8b4f-f6139046057b?api-version=2026-05-15-preview", - "Strict-Transport-Security": "max-age=31536000; includeSubDomains; preload", - "X-Content-Type-Options": "nosniff", - "x-envoy-upstream-service-time": "295", - "x-ms-region": "East US" - }, - "ResponseBody": null - } - ], - "Variables": {} -} diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py index 41ad6a806f54..2c2f70ea3a43 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/testpreparer.py @@ -24,7 +24,7 @@ def create_client(self, endpoint): AnalyzeDocumentsPreparer = functools.partial( PowerShellPreparer, "analyzedocuments", - analyzedocuments_endpoint="https://fake_analyzedocuments_endpoint.com", + analyzedocuments_endpoint="https://Sanitized.cognitiveservices.azure.com/", analyzedocuments_source_location="https://fakeaccount.blob.core.windows.net/input/fake.docx", analyzedocuments_target_location="https://fakeaccount.blob.core.windows.net/output", ) From cef1f104156c53eb745329c58cc1d00ec54ad068 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Wed, 3 Jun 2026 12:07:48 -0700 Subject: [PATCH 20/37] updated assets --- sdk/cognitivelanguage/azure-ai-language-documents/assets.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/assets.json b/sdk/cognitivelanguage/azure-ai-language-documents/assets.json index 6575294d7a31..03caefd7d45f 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/assets.json +++ b/sdk/cognitivelanguage/azure-ai-language-documents/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/cognitivelanguage/azure-ai-language-documents", - "Tag": "python/cognitivelanguage/azure-ai-language-documents_dbf58dbe72" + "Tag": "python/cognitivelanguage/azure-ai-language-documents_30e1b8ae6c" } From aed3865109102858b31898f0277bbe575478dfbd Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 11:41:52 -0700 Subject: [PATCH 21/37] fix pylint --- .../azure/ai/language/documents/_lro.py | 2 +- .../azure/ai/language/documents/_operations/_operations.py | 2 +- .../azure/ai/language/documents/_operations/_patch.py | 2 ++ .../azure/ai/language/documents/_utils/model_base.py | 4 ++-- .../azure/ai/language/documents/aio/_lro.py | 2 +- .../ai/language/documents/aio/_operations/_operations.py | 2 +- .../azure/ai/language/documents/aio/_operations/_patch.py | 2 ++ 7 files changed, 10 insertions(+), 6 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py index 96fe40da92ba..f3d34efa0986 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py @@ -20,4 +20,4 @@ def finished(self) -> bool: status = self.status() if hasattr(status, "value"): status = status.value - return str(status).lower() in _FINISHED \ No newline at end of file + return str(status).lower() in _FINISHED diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py index 6d0dc46184d3..26296a14e59b 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_operations.py @@ -5,7 +5,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping +from collections.abc import MutableMapping # pylint:disable=import-error from io import IOBase import json from typing import Any, Callable, IO, Iterator, Optional, TypeVar, Union, cast, overload diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py index f212ca606e8e..6d61c2624b7c 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py @@ -50,6 +50,7 @@ def begin_submit_job( def get_long_running_output(pipeline_response): if cls: return cls(pipeline_response, None, {}) + return None path_format_arguments = { "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), @@ -104,6 +105,7 @@ def begin_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: def get_long_running_output(pipeline_response): if cls: return cls(pipeline_response, None, {}) + return None path_format_arguments = { "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py index eef4e52ed1a0..045e016f8c06 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_utils/model_base.py @@ -22,7 +22,7 @@ from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder import xml.etree.ElementTree as ET -from collections.abc import MutableMapping +from collections.abc import MutableMapping # pylint:disable=import-error from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError @@ -714,7 +714,7 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: } cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") - return super().__new__(cls) + return super().__new__(cls) # pylint:disable=no-value-for-parameter def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: for base in cls.__bases__: diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py index 9274f8635561..a9c637dc443b 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py @@ -20,4 +20,4 @@ def finished(self) -> bool: status = self.status() if hasattr(status, "value"): status = status.value - return str(status).lower() in _FINISHED \ No newline at end of file + return str(status).lower() in _FINISHED diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py index aef58ad803a9..4646f6de0137 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_operations.py @@ -6,7 +6,7 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from collections.abc import MutableMapping +from collections.abc import MutableMapping # pylint:disable=import-error from io import IOBase import json from typing import Any, AsyncIterator, Callable, IO, Optional, TypeVar, Union, cast, overload diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py index 3b18bf05b99f..86a5f1430574 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -50,6 +50,7 @@ async def begin_submit_job( def get_long_running_output(pipeline_response): if cls: return cls(pipeline_response, None, {}) + return None path_format_arguments = { "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), @@ -104,6 +105,7 @@ async def begin_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[N def get_long_running_output(pipeline_response): if cls: return cls(pipeline_response, None, {}) + return None path_format_arguments = { "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), From f848da07f289b23592688e13684b693e48bcba00 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 12:01:56 -0700 Subject: [PATCH 22/37] fix mypy --- .../language/documents/_operations/_patch.py | 4 +-- .../documents/aio/_operations/_patch.py | 31 ++++++++++++++++--- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py index 6d61c2624b7c..b1dc8313d029 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py @@ -43,7 +43,7 @@ def begin_submit_job( params=_params, **kwargs ) - raw_result.http_response.read() + raw_result.http_response.read() # type: ignore[attr-defined] kwargs.pop("error_map", None) @@ -98,7 +98,7 @@ def begin_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: params=_params, **kwargs ) - raw_result.http_response.read() + raw_result.http_response.read() # type: ignore[attr-defined] kwargs.pop("error_map", None) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py index 86a5f1430574..f11d37929e25 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -8,21 +8,44 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import Any, Optional, Union, cast +from collections.abc import MutableMapping +from typing import Any, IO, Optional, Union, cast, overload from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod +from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict +from ... import models as _models from ._operations import _AnalyzeDocumentsClientOperationsMixin as GeneratedAnalyzeDocumentsClientOperationsMixin from .._lro import AnalyzeDocumentsAsyncLROPollingMethod +JSON = MutableMapping[str, Any] + class _AnalyzeDocumentsClientOperationsMixin(GeneratedAnalyzeDocumentsClientOperationsMixin): + @overload + async def begin_submit_job( + self, body: _models.AnalyzeDocumentsJob, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + ... + + @overload + async def begin_submit_job( + self, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + ... + + @overload + async def begin_submit_job( + self, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> AsyncLROPoller[None]: + ... + @distributed_trace_async async def begin_submit_job( self, - body: Any, + body: Union[_models.AnalyzeDocumentsJob, JSON, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[None]: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) @@ -43,7 +66,7 @@ async def begin_submit_job( params=_params, **kwargs ) - await raw_result.http_response.read() + await raw_result.http_response.read() # type: ignore[attr-defined] kwargs.pop("error_map", None) @@ -98,7 +121,7 @@ async def begin_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[N params=_params, **kwargs ) - await raw_result.http_response.read() + await raw_result.http_response.read() # type: ignore[attr-defined] kwargs.pop("error_map", None) From 2766b547124412a65ac7d2071d545f774bec42ab Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 13:56:52 -0700 Subject: [PATCH 23/37] fix pyright --- .../language/documents/_operations/_patch.py | 44 +++++++++---------- .../documents/aio/_operations/_patch.py | 44 +++++++++---------- 2 files changed, 42 insertions(+), 46 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py index b1dc8313d029..64037b804ef9 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_operations/_patch.py @@ -34,17 +34,6 @@ def begin_submit_job( lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token = kwargs.pop("continuation_token", None) - if cont_token is None: - raw_result = self._submit_job_initial( - body=body, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs - ) - raw_result.http_response.read() # type: ignore[attr-defined] - kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): @@ -70,7 +59,7 @@ def get_long_running_output(pipeline_response): else: polling_method = polling - if cont_token: + if cont_token is not None: return LROPoller[None].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, @@ -78,6 +67,16 @@ def get_long_running_output(pipeline_response): deserialization_callback=get_long_running_output, ) + raw_result = self._submit_job_initial( + body=body, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore[attr-defined] + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) @distributed_trace @@ -90,16 +89,6 @@ def begin_cancel_job(self, job_id: str, **kwargs: Any) -> LROPoller[None]: lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token = kwargs.pop("continuation_token", None) - if cont_token is None: - raw_result = self._cancel_job_initial( - job_id=job_id, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs - ) - raw_result.http_response.read() # type: ignore[attr-defined] - kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): @@ -125,7 +114,7 @@ def get_long_running_output(pipeline_response): else: polling_method = polling - if cont_token: + if cont_token is not None: return LROPoller[None].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, @@ -133,6 +122,15 @@ def get_long_running_output(pipeline_response): deserialization_callback=get_long_running_output, ) + raw_result = self._cancel_job_initial( + job_id=job_id, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + raw_result.http_response.read() # type: ignore[attr-defined] + return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py index f11d37929e25..3307e55cd7cc 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -57,17 +57,6 @@ async def begin_submit_job( lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token = kwargs.pop("continuation_token", None) - if cont_token is None: - raw_result = await self._submit_job_initial( - body=body, - content_type=content_type, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs - ) - await raw_result.http_response.read() # type: ignore[attr-defined] - kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): @@ -93,7 +82,7 @@ def get_long_running_output(pipeline_response): else: polling_method = polling - if cont_token: + if cont_token is not None: return AsyncLROPoller[None].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, @@ -101,6 +90,16 @@ def get_long_running_output(pipeline_response): deserialization_callback=get_long_running_output, ) + raw_result = await self._submit_job_initial( + body=body, + content_type=content_type, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore[attr-defined] + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) @distributed_trace_async @@ -113,16 +112,6 @@ async def begin_cancel_job(self, job_id: str, **kwargs: Any) -> AsyncLROPoller[N lro_delay = kwargs.pop("polling_interval", self._config.polling_interval) cont_token = kwargs.pop("continuation_token", None) - if cont_token is None: - raw_result = await self._cancel_job_initial( - job_id=job_id, - cls=lambda x, y, z: x, - headers=_headers, - params=_params, - **kwargs - ) - await raw_result.http_response.read() # type: ignore[attr-defined] - kwargs.pop("error_map", None) def get_long_running_output(pipeline_response): @@ -148,7 +137,7 @@ def get_long_running_output(pipeline_response): else: polling_method = polling - if cont_token: + if cont_token is not None: return AsyncLROPoller[None].from_continuation_token( polling_method=polling_method, continuation_token=cont_token, @@ -156,6 +145,15 @@ def get_long_running_output(pipeline_response): deserialization_callback=get_long_running_output, ) + raw_result = await self._cancel_job_initial( + job_id=job_id, + cls=lambda x, y, z: x, + headers=_headers, + params=_params, + **kwargs + ) + await raw_result.http_response.read() # type: ignore[attr-defined] + return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) From 83abe5fa6351223fe4159e4df8db0071a7b968df Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 14:00:15 -0700 Subject: [PATCH 24/37] fix pylint --- .../azure/ai/language/documents/aio/_operations/_patch.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py index 3307e55cd7cc..b614b11ebf28 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_operations/_patch.py @@ -8,11 +8,10 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from collections.abc import MutableMapping +from collections.abc import MutableMapping # pylint:disable=import-error from typing import Any, IO, Optional, Union, cast, overload from azure.core.polling import AsyncLROPoller, AsyncNoPolling, AsyncPollingMethod -from azure.core.rest import AsyncHttpResponse, HttpRequest from azure.core.tracing.decorator_async import distributed_trace_async from azure.core.utils import case_insensitive_dict From 8bf407eabc0eced7b4d6cbbf7305711008ea5b26 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 14:21:34 -0700 Subject: [PATCH 25/37] fix sphinx --- .../azure/ai/language/documents/_client.py | 5 ++--- .../azure/ai/language/documents/aio/_client.py | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py index f9d8f7a50b4f..7a6ffcf0fe70 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_client.py @@ -28,9 +28,8 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview - https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + detection and question answering. Further documentation can be found at + `Language service overview `_. :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py index 08578d9173ee..03e28d8c4797 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_client.py @@ -28,9 +28,8 @@ class AnalyzeDocumentsClient(_AnalyzeDocumentsClientOperationsMixin): """The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language - detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview - https://learn.microsoft.com/azure/cognitive-services/language-service/overview>`_.0. + detection and question answering. Further documentation can be found at + `Language service overview `_. :param endpoint: Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). Required. From 32dec02994848d42e96cdb8bbd6ecc0415611194 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Thu, 4 Jun 2026 14:37:12 -0700 Subject: [PATCH 26/37] migrate cspell.json --- .vscode/cspell.json | 5 ----- .../azure-ai-language-documents/cspell.yaml | 13 +++++++++++++ 2 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml diff --git a/.vscode/cspell.json b/.vscode/cspell.json index ab8290c7d000..577b4f0584fa 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -898,11 +898,6 @@ "words": [ "conv", "summ", "Enviar", "presentación", "CLU's"], "caseSensitive": false }, - { - "filename": "sdk/cognitivelanguage/azure-ai-language-documents/**", - "words": [ "BRCPF", "IDRG", "EUGPS", "PLREGON", "REGON", "ESDNI", "USUK", "BRCPF", "IDRG", "EUGPS", "PLREGON" ], - "caseSensitive": false - }, { "filename": "sdk/cognitivelanguage/azure-ai-language-conversations/doc/*.rst", "words": [ "undoc" ] diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml b/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml new file mode 100644 index 000000000000..18c83510eb6d --- /dev/null +++ b/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml @@ -0,0 +1,13 @@ +import: + - ../../.vscode/cspell.json + +overrides: + - filename: sdk/cognitivelanguage/azure-ai-language-documents/** + words: + - brcpf + - esdni + - eugps + - idrg + - plregon + - regon + - usuk \ No newline at end of file From e488d9deec3ab37d9aafdc8eb0f540f9d6c51bc0 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Fri, 5 Jun 2026 11:46:00 -0700 Subject: [PATCH 27/37] updated readme --- sdk/cognitivelanguage/azure-ai-language-documents/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index 161bee7d8e70..1b0369838340 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -121,7 +121,7 @@ The `azure-ai-language-documents` client library provides both synchronous and a #### Submit a job -This example submits a PII analysis job using strongly typed model objects: +This example submits a PII analysis job using JSON-compatible dictionary inputs: @@ -426,8 +426,6 @@ This library supports both: * **Strongly typed model inputs** via `AnalyzeDocumentsJob` * **JSON-compatible dictionary inputs** for direct request construction -The typed-model approach is recommended for clarity, static analysis, and discoverability. - ## Next steps * View our [samples][documents_samples]. From db01a1a82fdecba1cfcccf841bff6a55e2ebb717 Mon Sep 17 00:00:00 2001 From: "Amber Chen (Centific Technologies Inc)" Date: Mon, 8 Jun 2026 09:42:34 -0700 Subject: [PATCH 28/37] update cspell --- sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml b/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml index 18c83510eb6d..75d3867b8f6e 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml +++ b/sdk/cognitivelanguage/azure-ai-language-documents/cspell.yaml @@ -1,5 +1,5 @@ import: - - ../../.vscode/cspell.json + - ../../../.vscode/cspell.json overrides: - filename: sdk/cognitivelanguage/azure-ai-language-documents/** From 7d16d34d56382c938029551e00b16c290b12018e Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 13:19:22 -0700 Subject: [PATCH 29/37] update commit id --- .../azure-ai-language-documents/tsp-location.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml index 8edf995490f6..e48f14ce9a78 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/cognitiveservices/data-plane/LanguageAnalyzeDocuments -commit: -repo: +commit: f7d80f21f5cf3897d6befd145b268288937871e5 +repo: Azure/azure-rest-api-specs additionalDirectories: From c87b89385a0f898aff582655b95dbd6492229ef2 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 14:07:06 -0700 Subject: [PATCH 30/37] remove debug print --- .../tests/test_analyze_documents.py | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py index 9ba949ef70d8..fa0b800cfe95 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py @@ -13,12 +13,6 @@ class TestAnalyzeDocuments(AnalyzeDocumentsClientTestBase): - def _print_env_debug(self): - print("AZURE_TEST_RUN_LIVE =", repr(os.getenv("AZURE_TEST_RUN_LIVE"))) - print("ANALYZEDOCUMENTS_ENDPOINT =", repr(os.getenv("ANALYZEDOCUMENTS_ENDPOINT"))) - print("ANALYZEDOCUMENTS_SOURCE_LOCATION =", repr(os.getenv("ANALYZEDOCUMENTS_SOURCE_LOCATION"))) - print("ANALYZEDOCUMENTS_TARGET_LOCATION =", repr(os.getenv("ANALYZEDOCUMENTS_TARGET_LOCATION"))) - @AnalyzeDocumentsPreparer() @recorded_by_proxy def test_get_job_state( @@ -90,11 +84,6 @@ def test_begin_submit_job( analyzedocuments_source_location, analyzedocuments_target_location, ): - self._print_env_debug() - print("prepared analyzedocuments_endpoint =", analyzedocuments_endpoint) - print("prepared analyzedocuments_source_location =", analyzedocuments_source_location) - print("prepared analyzedocuments_target_location =", analyzedocuments_target_location) - client = self.create_client(endpoint=analyzedocuments_endpoint) poller = client.begin_submit_job( From 9a9030e760d5ca5350511f1838b8d5f90100288d Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 14:10:23 -0700 Subject: [PATCH 31/37] added "partiallycompleted" --- .../azure/ai/language/documents/_lro.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py index f3d34efa0986..43a6987f4447 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/_lro.py @@ -6,7 +6,7 @@ from azure.core.polling.base_polling import LROBasePolling -_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed"]) +_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed", "partiallycompleted"]) class AnalyzeDocumentsLROPollingMethod(LROBasePolling): From 0a705367cc75f1e58783b9cf76175b1219305cd4 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 14:11:54 -0700 Subject: [PATCH 32/37] added "partiallycompleted" in async lro --- .../azure/ai/language/documents/aio/_lro.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py index a9c637dc443b..ffefee3c9550 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/azure/ai/language/documents/aio/_lro.py @@ -6,7 +6,7 @@ from azure.core.polling.async_base_polling import AsyncLROBasePolling -_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed"]) +_FINISHED = frozenset(["succeeded", "canceled", "cancelled", "failed", "partiallycompleted"]) class AnalyzeDocumentsAsyncLROPollingMethod(AsyncLROBasePolling): From 17de97945c2cc3da754921bf899e352c6a12b142 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 14:15:25 -0700 Subject: [PATCH 33/37] updated readme --- sdk/cognitivelanguage/azure-ai-language-documents/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index 1b0369838340..cc0d43addb59 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -403,7 +403,7 @@ For example: from azure.core.exceptions import HttpResponseError try: - client.analyze_documents_job_status("invalid-job-id") + client.get_job_state("invalid-job-id") except HttpResponseError as error: print(f"Query failed: {error.message}") From b4ea04f24d05f48e4b42137f80ef0be65b9e7ca1 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 14:34:21 -0700 Subject: [PATCH 34/37] updated sample --- .../azure-ai-language-documents/samples/sample_get_job_state.py | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py index fe7d1770c575..cadfc09c2e74 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_get_job_state.py @@ -26,6 +26,7 @@ # [START sample_get_job_state] def sample_get_job_state() -> None: import os + from urllib.parse import urlparse from azure.core.credentials import AzureKeyCredential from azure.ai.language.documents import AnalyzeDocumentsClient From 36ae3abaf9958870f1a9cc8a6237a7f2f2a52e4f Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 15:26:38 -0700 Subject: [PATCH 35/37] added from urllib.parse import urlparse --- sdk/cognitivelanguage/azure-ai-language-documents/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index cc0d43addb59..71a6722897ee 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -184,6 +184,7 @@ Use `get_job_state` to retrieve the current state of a submitted job: ```python def sample_get_job_state() -> None: import os + from urllib.parse import urlparse from azure.core.credentials import AzureKeyCredential from azure.ai.language.documents import AnalyzeDocumentsClient From 6fcddc3c1794390559259afd7a800175560b66e1 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Fri, 10 Jul 2026 15:29:38 -0700 Subject: [PATCH 36/37] updated sample_cancel_job and snippets --- sdk/cognitivelanguage/azure-ai-language-documents/README.md | 1 + .../azure-ai-language-documents/samples/sample_cancel_job.py | 1 + 2 files changed, 2 insertions(+) diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/README.md b/sdk/cognitivelanguage/azure-ai-language-documents/README.md index 71a6722897ee..73f977e926d0 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/README.md +++ b/sdk/cognitivelanguage/azure-ai-language-documents/README.md @@ -253,6 +253,7 @@ If you need to cancel a submitted job, use `begin_cancel_job`: ```python def sample_cancel_job() -> None: import os + from urllib.parse import urlparse from azure.core.credentials import AzureKeyCredential from azure.ai.language.documents import AnalyzeDocumentsClient diff --git a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py index 48afb1643d83..a99eb833621d 100644 --- a/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py +++ b/sdk/cognitivelanguage/azure-ai-language-documents/samples/sample_cancel_job.py @@ -26,6 +26,7 @@ # [START sample_cancel_job] def sample_cancel_job() -> None: import os + from urllib.parse import urlparse from azure.core.credentials import AzureKeyCredential from azure.ai.language.documents import AnalyzeDocumentsClient From 028ac6b2f68132e4499ef1659af5d55bde5941a1 Mon Sep 17 00:00:00 2001 From: Amber Chen Date: Sat, 11 Jul 2026 17:47:04 -0700 Subject: [PATCH 37/37] updated assets in conversation inference --- .../azure-ai-language-conversations/assets.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitivelanguage/azure-ai-language-conversations/assets.json b/sdk/cognitivelanguage/azure-ai-language-conversations/assets.json index b1ef97344412..17c6af6814d0 100644 --- a/sdk/cognitivelanguage/azure-ai-language-conversations/assets.json +++ b/sdk/cognitivelanguage/azure-ai-language-conversations/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/cognitivelanguage/azure-ai-language-conversations", - "Tag": "python/cognitivelanguage/azure-ai-language-conversations_37aac6bbbe" + "Tag": "python/cognitivelanguage/azure-ai-language-conversations_58062aa3d9" }