forked from Azure/azure-sdk-for-python
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 31925 in Azure/azure-rest-api-specs
Merge b980f35cde79dd1d3c2909fd4c15f37cde752d54 into c9a4dc04527f7fdb4a944e2c392f2de280ef7cae
- Loading branch information
SDKAuto
committed
Dec 18, 2024
1 parent
95f91d4
commit b599572
Showing
37 changed files
with
22,315 additions
and
0 deletions.
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
sdk/cognitivelanguage/azure-ai-language-text-authoring/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 1.0.0b1 (1970-01-01) | ||
|
||
- Initial version |
21 changes: 21 additions & 0 deletions
21
sdk/cognitivelanguage/azure-ai-language-text-authoring/LICENSE
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
9 changes: 9 additions & 0 deletions
9
sdk/cognitivelanguage/azure-ai-language-text-authoring/MANIFEST.in
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
include *.md | ||
include LICENSE | ||
include azure/ai/language/text/authoring/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 | ||
include azure/ai/language/text/__init__.py |
45 changes: 45 additions & 0 deletions
45
sdk/cognitivelanguage/azure-ai-language-text-authoring/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
|
||
|
||
# Azure Ai Language Text Authoring client library for Python | ||
<!-- write necessary description of service --> | ||
|
||
## Getting started | ||
|
||
### Install the package | ||
|
||
```bash | ||
python -m pip install azure-ai-language-text-authoring | ||
``` | ||
|
||
#### Prequisites | ||
|
||
- Python 3.8 or later is required to use this package. | ||
- You need an [Azure subscription][azure_sub] to use this package. | ||
- An existing Azure Ai Language Text Authoring 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. | ||
|
||
<!-- LINKS --> | ||
[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/ | ||
|
6 changes: 6 additions & 0 deletions
6
sdk/cognitivelanguage/azure-ai-language-text-authoring/_meta.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"commit": "a42d719f19594eed9e525a76ebae3759c90b53d7", | ||
"repository_url": "https://github.com/Azure/azure-rest-api-specs", | ||
"typespec_src": "specification/cognitiveservices/Language.AnalyzeText-authoring", | ||
"@azure-tools/typespec-python": "0.37.2" | ||
} |
1 change: 1 addition & 0 deletions
1
sdk/cognitivelanguage/azure-ai-language-text-authoring/azure/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore |
1 change: 1 addition & 0 deletions
1
sdk/cognitivelanguage/azure-ai-language-text-authoring/azure/ai/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore |
1 change: 1 addition & 0 deletions
1
sdk/cognitivelanguage/azure-ai-language-text-authoring/azure/ai/language/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore |
1 change: 1 addition & 0 deletions
1
sdk/cognitivelanguage/azure-ai-language-text-authoring/azure/ai/language/text/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore |
32 changes: 32 additions & 0 deletions
32
...ivelanguage/azure-ai-language-text-authoring/azure/ai/language/text/authoring/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 AuthoringClient # 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__ = [ | ||
"AuthoringClient", | ||
] | ||
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore | ||
|
||
_patch_sdk() |
114 changes: 114 additions & 0 deletions
114
...tivelanguage/azure-ai-language-text-authoring/azure/ai/language/text/authoring/_client.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# 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 AuthoringClientConfiguration | ||
from ._serialization import Deserializer, Serializer | ||
from .operations import TextAnalysisAuthoringOperations | ||
|
||
if TYPE_CHECKING: | ||
from azure.core.credentials import TokenCredential | ||
|
||
|
||
class AuthoringClient: | ||
"""The language service API is a suite of natural language processing (NLP) skills built with | ||
best-in-class Microsoft machine learning algorithms. The API can be used to analyze | ||
unstructured text for tasks such as sentiment analysis, key phrase extraction, language | ||
detection and question answering. Further documentation can be found in :code:`<a | ||
href="https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview">https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>`. | ||
:ivar text_analysis_authoring: TextAnalysisAuthoringOperations operations | ||
:vartype text_analysis_authoring: | ||
azure.ai.language.text.authoring.operations.TextAnalysisAuthoringOperations | ||
:param endpoint: Supported Cognitive Services endpoint e.g., https://\\\\ | ||
:code:`<resource-name>`.api.cognitiveservices.azure.com. Required. | ||
:type endpoint: str | ||
:param credential: Credential used to authenticate requests to the service. Is either a | ||
AzureKeyCredential type or a TokenCredential type. Required. | ||
:type credential: ~azure.core.credentials.AzureKeyCredential or | ||
~azure.core.credentials.TokenCredential | ||
:keyword api_version: The API version to use for this operation. Default value is | ||
"2024-11-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 = AuthoringClientConfiguration(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 | ||
self.text_analysis_authoring = TextAnalysisAuthoringOperations( | ||
self._client, self._config, self._serialize, self._deserialize | ||
) | ||
|
||
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/") | ||
<HttpRequest [GET], url: 'https://www.example.org/'> | ||
>>> response = client.send_request(request) | ||
<HttpResponse: 200 OK> | ||
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) |
73 changes: 73 additions & 0 deletions
73
...guage/azure-ai-language-text-authoring/azure/ai/language/text/authoring/_configuration.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 AuthoringClientConfiguration: # pylint: disable=too-many-instance-attributes | ||
"""Configuration for AuthoringClient. | ||
Note that all parameters used to create this instance are saved as instance | ||
attributes. | ||
:param endpoint: Supported Cognitive Services endpoint e.g., https://\\ | ||
:code:`<resource-name>`.api.cognitiveservices.azure.com. Required. | ||
:type endpoint: str | ||
:param credential: Credential used to authenticate requests to the service. Is either a | ||
AzureKeyCredential type or a TokenCredential type. Required. | ||
:type credential: ~azure.core.credentials.AzureKeyCredential or | ||
~azure.core.credentials.TokenCredential | ||
:keyword api_version: The API version to use for this operation. Default value is | ||
"2024-11-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", "2024-11-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-text-authoring/{}".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) |
Oops, something went wrong.