Skip to content

Commit e42e657

Browse files
author
SDKAuto
committed
CodeGen from PR 31340 in Azure/azure-rest-api-specs
Merge 64ae42508ae4d91c85da8283e2dd98c1097f26a3 into 72ef7595f212aaa8acca500939df0839a23df5e1
1 parent f118df2 commit e42e657

36 files changed

+25006
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Release History
2+
3+
## 1.0.0b1 (1970-01-01)
4+
5+
- Initial version

sdk/ai/azure-ai-projects/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Copyright (c) Microsoft Corporation.
2+
3+
MIT License
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
include *.md
2+
include LICENSE
3+
include azure/ai/projects/py.typed
4+
recursive-include tests *.py
5+
recursive-include samples *.py *.md
6+
include azure/__init__.py
7+
include azure/ai/__init__.py

sdk/ai/azure-ai-projects/README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
3+
# Azure Ai Projects client library for Python
4+
<!-- write necessary description of service -->
5+
6+
## Getting started
7+
8+
### Install the package
9+
10+
```bash
11+
python -m pip install azure-ai-projects
12+
```
13+
14+
#### Prequisites
15+
16+
- Python 3.8 or later is required to use this package.
17+
- You need an [Azure subscription][azure_sub] to use this package.
18+
- An existing Azure Ai Projects instance.
19+
#### Create with an Azure Active Directory Credential
20+
To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
21+
provide an instance of the desired credential type obtained from the
22+
[azure-identity][azure_identity_credentials] library.
23+
24+
To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
25+
26+
After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
27+
As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
28+
29+
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
30+
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
31+
32+
Use the returned token credential to authenticate the client:
33+
34+
```python
35+
>>> from azure.ai.projects import AIProjectClient
36+
>>> from azure.identity import DefaultAzureCredential
37+
>>> client = AIProjectClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
38+
```
39+
40+
## Examples
41+
42+
```python
43+
>>> from azure.ai.projects import AIProjectClient
44+
>>> from azure.identity import DefaultAzureCredential
45+
>>> from azure.core.exceptions import HttpResponseError
46+
47+
>>> client = AIProjectClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
48+
>>> try:
49+
<!-- write test code here -->
50+
except HttpResponseError as e:
51+
print('service responds error: {}'.format(e.response.json()))
52+
53+
```
54+
55+
## Contributing
56+
57+
This project welcomes contributions and suggestions. Most contributions require
58+
you to agree to a Contributor License Agreement (CLA) declaring that you have
59+
the right to, and actually do, grant us the rights to use your contribution.
60+
For details, visit https://cla.microsoft.com.
61+
62+
When you submit a pull request, a CLA-bot will automatically determine whether
63+
you need to provide a CLA and decorate the PR appropriately (e.g., label,
64+
comment). Simply follow the instructions provided by the bot. You will only
65+
need to do this once across all repos using our CLA.
66+
67+
This project has adopted the
68+
[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
69+
see the Code of Conduct FAQ or contact [email protected] with any
70+
additional questions or comments.
71+
72+
<!-- LINKS -->
73+
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
74+
[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
75+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
76+
[azure_identity_pip]: https://pypi.org/project/azure-identity/
77+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
78+
[pip]: https://pypi.org/project/pip/
79+
[azure_sub]: https://azure.microsoft.com/free/
80+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"commit": "461d3afd9c93d6e9b00d09243817b304ec0ba8b8",
3+
"repository_url": "https://github.com/Azure/azure-rest-api-specs",
4+
"typespec_src": "specification/ai/Azure.AI.Projects",
5+
"@azure-tools/typespec-python": "0.36.1"
6+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
# pylint: disable=wrong-import-position
9+
10+
from typing import TYPE_CHECKING
11+
12+
if TYPE_CHECKING:
13+
from ._patch import * # pylint: disable=unused-wildcard-import
14+
15+
from ._client import AIProjectClient # type: ignore
16+
from ._version import VERSION
17+
18+
__version__ = VERSION
19+
20+
try:
21+
from ._patch import __all__ as _patch_all
22+
from ._patch import *
23+
except ImportError:
24+
_patch_all = []
25+
from ._patch import patch_sdk as _patch_sdk
26+
27+
__all__ = [
28+
"AIProjectClient",
29+
]
30+
__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore
31+
32+
_patch_sdk()
Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from copy import deepcopy
10+
from typing import Any, TYPE_CHECKING
11+
from typing_extensions import Self
12+
13+
from azure.core import PipelineClient
14+
from azure.core.pipeline import policies
15+
from azure.core.rest import HttpRequest, HttpResponse
16+
17+
from ._configuration import AIProjectClientConfiguration
18+
from ._serialization import Deserializer, Serializer
19+
from .operations import AgentsOperations, ConnectionsOperations, EvaluationsOperations, TelemetryOperations
20+
21+
if TYPE_CHECKING:
22+
from azure.core.credentials import TokenCredential
23+
24+
25+
class AIProjectClient:
26+
"""AIProjectClient.
27+
28+
:ivar agents: AgentsOperations operations
29+
:vartype agents: azure.ai.projects.operations.AgentsOperations
30+
:ivar connections: ConnectionsOperations operations
31+
:vartype connections: azure.ai.projects.operations.ConnectionsOperations
32+
:ivar telemetry: TelemetryOperations operations
33+
:vartype telemetry: azure.ai.projects.operations.TelemetryOperations
34+
:ivar evaluations: EvaluationsOperations operations
35+
:vartype evaluations: azure.ai.projects.operations.EvaluationsOperations
36+
:param endpoint: The Azure AI Studio project endpoint, in the form
37+
``https://<azure-region>.api.azureml.ms`` or
38+
``https://<private-link-guid>.<azure-region>.api.azureml.ms``\\\\ , where
39+
:code:`<azure-region>` is the Azure region where the project is deployed (e.g. westus) and
40+
:code:`<private-link-guid>` is the GUID of the Enterprise private link. Required.
41+
:type endpoint: str
42+
:param subscription_id: The Azure subscription ID. Required.
43+
:type subscription_id: str
44+
:param resource_group_name: The name of the Azure Resource Group. Required.
45+
:type resource_group_name: str
46+
:param project_name: The Azure AI Studio project name. Required.
47+
:type project_name: str
48+
:param credential: Credential used to authenticate requests to the service. Required.
49+
:type credential: ~azure.core.credentials.TokenCredential
50+
:keyword api_version: The API version to use for this operation. Default value is
51+
"2024-07-01-preview". Note that overriding this default value may result in unsupported
52+
behavior.
53+
:paramtype api_version: str
54+
"""
55+
56+
def __init__(
57+
self,
58+
endpoint: str,
59+
subscription_id: str,
60+
resource_group_name: str,
61+
project_name: str,
62+
credential: "TokenCredential",
63+
**kwargs: Any
64+
) -> None:
65+
_endpoint = "{endpoint}/agents/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{projectName}" # pylint: disable=line-too-long
66+
self._config = AIProjectClientConfiguration(
67+
endpoint=endpoint,
68+
subscription_id=subscription_id,
69+
resource_group_name=resource_group_name,
70+
project_name=project_name,
71+
credential=credential,
72+
**kwargs
73+
)
74+
_policies = kwargs.pop("policies", None)
75+
if _policies is None:
76+
_policies = [
77+
policies.RequestIdPolicy(**kwargs),
78+
self._config.headers_policy,
79+
self._config.user_agent_policy,
80+
self._config.proxy_policy,
81+
policies.ContentDecodePolicy(**kwargs),
82+
self._config.redirect_policy,
83+
self._config.retry_policy,
84+
self._config.authentication_policy,
85+
self._config.custom_hook_policy,
86+
self._config.logging_policy,
87+
policies.DistributedTracingPolicy(**kwargs),
88+
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
89+
self._config.http_logging_policy,
90+
]
91+
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
92+
93+
self._serialize = Serializer()
94+
self._deserialize = Deserializer()
95+
self._serialize.client_side_validation = False
96+
self.agents = AgentsOperations(self._client, self._config, self._serialize, self._deserialize)
97+
self.connections = ConnectionsOperations(self._client, self._config, self._serialize, self._deserialize)
98+
self.telemetry = TelemetryOperations(self._client, self._config, self._serialize, self._deserialize)
99+
self.evaluations = EvaluationsOperations(self._client, self._config, self._serialize, self._deserialize)
100+
101+
def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
102+
"""Runs the network request through the client's chained policies.
103+
104+
>>> from azure.core.rest import HttpRequest
105+
>>> request = HttpRequest("GET", "https://www.example.org/")
106+
<HttpRequest [GET], url: 'https://www.example.org/'>
107+
>>> response = client.send_request(request)
108+
<HttpResponse: 200 OK>
109+
110+
For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
111+
112+
:param request: The network request you want to make. Required.
113+
:type request: ~azure.core.rest.HttpRequest
114+
:keyword bool stream: Whether the response payload will be streamed. Defaults to False.
115+
:return: The response of your network call. Does not do error handling on your response.
116+
:rtype: ~azure.core.rest.HttpResponse
117+
"""
118+
119+
request_copy = deepcopy(request)
120+
path_format_arguments = {
121+
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str"),
122+
"subscriptionId": self._serialize.url("self._config.subscription_id", self._config.subscription_id, "str"),
123+
"resourceGroupName": self._serialize.url(
124+
"self._config.resource_group_name", self._config.resource_group_name, "str"
125+
),
126+
"projectName": self._serialize.url("self._config.project_name", self._config.project_name, "str"),
127+
}
128+
129+
request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
130+
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore
131+
132+
def close(self) -> None:
133+
self._client.close()
134+
135+
def __enter__(self) -> Self:
136+
self._client.__enter__()
137+
return self
138+
139+
def __exit__(self, *exc_details: Any) -> None:
140+
self._client.__exit__(*exc_details)
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# coding=utf-8
2+
# --------------------------------------------------------------------------
3+
# Copyright (c) Microsoft Corporation. All rights reserved.
4+
# Licensed under the MIT License. See License.txt in the project root for license information.
5+
# Code generated by Microsoft (R) Python Code Generator.
6+
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
7+
# --------------------------------------------------------------------------
8+
9+
from typing import Any, TYPE_CHECKING
10+
11+
from azure.core.pipeline import policies
12+
13+
from ._version import VERSION
14+
15+
if TYPE_CHECKING:
16+
from azure.core.credentials import TokenCredential
17+
18+
19+
class AIProjectClientConfiguration: # pylint: disable=too-many-instance-attributes
20+
"""Configuration for AIProjectClient.
21+
22+
Note that all parameters used to create this instance are saved as instance
23+
attributes.
24+
25+
:param endpoint: The Azure AI Studio project endpoint, in the form
26+
``https://<azure-region>.api.azureml.ms`` or
27+
``https://<private-link-guid>.<azure-region>.api.azureml.ms``\\ , where :code:`<azure-region>`
28+
is the Azure region where the project is deployed (e.g. westus) and :code:`<private-link-guid>`
29+
is the GUID of the Enterprise private link. Required.
30+
:type endpoint: str
31+
:param subscription_id: The Azure subscription ID. Required.
32+
:type subscription_id: str
33+
:param resource_group_name: The name of the Azure Resource Group. Required.
34+
:type resource_group_name: str
35+
:param project_name: The Azure AI Studio project name. Required.
36+
:type project_name: str
37+
:param credential: Credential used to authenticate requests to the service. Required.
38+
:type credential: ~azure.core.credentials.TokenCredential
39+
:keyword api_version: The API version to use for this operation. Default value is
40+
"2024-07-01-preview". Note that overriding this default value may result in unsupported
41+
behavior.
42+
:paramtype api_version: str
43+
"""
44+
45+
def __init__(
46+
self,
47+
endpoint: str,
48+
subscription_id: str,
49+
resource_group_name: str,
50+
project_name: str,
51+
credential: "TokenCredential",
52+
**kwargs: Any
53+
) -> None:
54+
api_version: str = kwargs.pop("api_version", "2024-07-01-preview")
55+
56+
if endpoint is None:
57+
raise ValueError("Parameter 'endpoint' must not be None.")
58+
if subscription_id is None:
59+
raise ValueError("Parameter 'subscription_id' must not be None.")
60+
if resource_group_name is None:
61+
raise ValueError("Parameter 'resource_group_name' must not be None.")
62+
if project_name is None:
63+
raise ValueError("Parameter 'project_name' must not be None.")
64+
if credential is None:
65+
raise ValueError("Parameter 'credential' must not be None.")
66+
67+
self.endpoint = endpoint
68+
self.subscription_id = subscription_id
69+
self.resource_group_name = resource_group_name
70+
self.project_name = project_name
71+
self.credential = credential
72+
self.api_version = api_version
73+
self.credential_scopes = kwargs.pop("credential_scopes", ["https://management.azure.com/.default"])
74+
kwargs.setdefault("sdk_moniker", "ai-projects/{}".format(VERSION))
75+
self.polling_interval = kwargs.get("polling_interval", 30)
76+
self._configure(**kwargs)
77+
78+
def _configure(self, **kwargs: Any) -> None:
79+
self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
80+
self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
81+
self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
82+
self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
83+
self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs)
84+
self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
85+
self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
86+
self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
87+
self.authentication_policy = kwargs.get("authentication_policy")
88+
if self.credential and not self.authentication_policy:
89+
self.authentication_policy = policies.BearerTokenCredentialPolicy(
90+
self.credential, *self.credential_scopes, **kwargs
91+
)

0 commit comments

Comments
 (0)