Azure AI Projects Python SDK

.gitignore

@@ -158,3 +158,8 @@ sdk/cosmos/azure-cosmos/test/test_config.py
 
 # temporary folder to refresh SDK with cadl
 TempTypeSpecFiles/
+
+# Eclipse project files
+**/.project
+**/.pydevproject
+**/.settings

sdk/ai/azure-ai-client/samples/endpoints/async_samples/sample_endpoints_async.py

@@ -0,0 +1,132 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+"""
+FILE: sample_endpoints_async.py
+
+DESCRIPTION:
+    Given an asynchronous AzureAIClient, this sample demonstrates how to enumerate endpoints
+    and get endpoint properties.
+
+USAGE:
+    python sample_endpoints_async.py
+
+    Before running the sample:
+
+    pip install azure.ai.client aiohttp azure-identity
+
+    Set the environment variables with your own values:
+    1) AI_CLIENT_CONNECTION_STRING - the Azure AI Project connection string, as found in your AI Studio Project.
+"""
+
+import asyncio
+import os
+from azure.ai.client.aio import AzureAIClient
+from azure.ai.client.models import ConnectionType, AuthenticationType
+from azure.identity import DefaultAzureCredential
+
+
+async def sample_endpoints_async():
+
+    # Create an Azure AI Client from a connection string, copied from your AI Studio project.
+    # It should be in the format "<Endpoint>;<AzureSubscriptionId>;<ResourceGroup>;<WorkspaceName>"
+    async with AzureAIClient.from_connection_string(
+        credential=DefaultAzureCredential(),
+        conn_str=os.environ["AI_CLIENT_CONNECTION_STRING"],
+    ) as ai_client:
+
+        # List all endpoints of a particular "type", with or without their credentials:
+        print("====> Listing of all Azure Open AI endpoints:")
+        async for endpoint in ai_client.endpoints.list(
+            endpoint_type=ConnectionType.AZURE_OPEN_AI,  # Optional. Defaults to all types.
+            populate_secrets=True,  # Optional. Defaults to "False"
+        ):
+            print(endpoint)
+
+        # Get the default endpoint of a particular "type" (note that since at the moment the service
+        # does not have a notion of a default endpoint, this will return the first endpoint of that type):
+        endpoint = await ai_client.endpoints.get_default(
+            endpoint_type=ConnectionType.AZURE_OPEN_AI,
+            populate_secrets=True,  # Required.  # Optional. Defaults to "False"
+        )
+        print("====> Get default Azure Open AI endpoint:")
+        print(endpoint)
+
+        # Get an endpoint by its name:
+        endpoint = await ai_client.endpoints.get(
+            endpoint_name=os.environ["AI_CLIENT_ENDPOINT_NAME"], populate_secrets=True  # Required.
+        )
+        print("====> Get endpoint by name:")
+        print(endpoint)
+
+    # Examples of how you would create Inference client
+    if endpoint.endpoint_type == ConnectionType.AZURE_OPEN_AI:
+
+        from openai import AsyncAzureOpenAI
+
+        if endpoint.authentication_type == AuthenticationType.API_KEY:
+            print("====> Creating AzureOpenAI client using API key authentication")
+            client = AsyncAzureOpenAI(
+                api_key=endpoint.key,
+                azure_endpoint=endpoint.endpoint_url,
+                api_version="2024-06-01",  # See "Data plane - inference" row in table https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#api-specs
+            )
+        elif endpoint.authentication_type == AuthenticationType.AAD:
+            print("====> Creating AzureOpenAI client using Entra ID authentication")
+            from azure.identity import get_bearer_token_provider
+
+            client = AsyncAzureOpenAI(
+                # See https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity?view=azure-python#azure-identity-get-bearer-token-provider
+                azure_ad_token_provider=get_bearer_token_provider(
+                    endpoint.token_credential, "https://cognitiveservices.azure.com/.default"
+                ),
+                azure_endpoint=endpoint.endpoint_url,
+                api_version="2024-06-01",  # See "Data plane - inference" row in table https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#api-specs
+            )
+        else:
+            raise ValueError(f"Authentication type {endpoint.authentication_type} not supported.")
+
+        response = await client.chat.completions.create(
+            model="gpt-4o",
+            messages=[
+                {
+                    "role": "user",
+                    "content": "How many feet are in a mile?",
+                },
+            ],
+        )
+        print(response.choices[0].message.content)
+
+    elif endpoint.endpoint_type == ConnectionType.SERVERLESS:
+
+        from azure.ai.inference.aio import ChatCompletionsClient
+        from azure.ai.inference.models import UserMessage
+
+        if endpoint.authentication_type == AuthenticationType.API_KEY:
+            print("====> Creating ChatCompletionsClient using API key authentication")
+            from azure.core.credentials import AzureKeyCredential
+
+            client = ChatCompletionsClient(endpoint=endpoint.endpoint_url, credential=AzureKeyCredential(endpoint.key))
+        elif endpoint.authentication_type == AuthenticationType.AAD:
+            # MaaS models do not yet support EntraID auth
+            print("====> Creating ChatCompletionsClient using Entra ID authentication")
+            client = ChatCompletionsClient(
+                endpoint=endpoint.endpoint_url, credential=endpoint.properties.token_credential
+            )
+        else:
+            raise ValueError(f"Authentication type {endpoint.authentication_type} not supported.")
+
+        response = await client.complete(messages=[UserMessage(content="How many feet are in a mile?")])
+        await client.close()
+        print(response.choices[0].message.content)
+
+
+async def main():
+    await sample_endpoints_async()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+

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

@@ -0,0 +1,5 @@
+# Release History
+
+## 1.0.0b1 (1970-01-01)
+
+- Initial version

sdk/ai/azure-ai-projects/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.

sdk/ai/azure-ai-projects/MANIFEST.in

@@ -0,0 +1,7 @@
+include *.md
+include LICENSE
+include azure/ai/projects/py.typed
+recursive-include tests *.py
+recursive-include samples *.py *.md
+include azure/__init__.py
+include azure/ai/__init__.py

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

@@ -0,0 +1,80 @@
+
+
+# Azure Ai Projects client library for Python
+<!-- write necessary description of service -->
+
+## Getting started
+
+### Install the package
+
+```bash
+python -m pip install azure-ai-projects
+```
+
+#### 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 Projects instance.
+#### Create with an Azure Active Directory Credential
+To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
+provide an instance of the desired credential type obtained from the
+[azure-identity][azure_identity_credentials] library.
+
+To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip]
+
+After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
+As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client:
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`
+
+Use the returned token credential to authenticate the client:
+
+```python
+>>> from azure.ai.projects import AIProjectClient
+>>> from azure.identity import DefaultAzureCredential
+>>> client = AIProjectClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
+```
+
+## Examples
+
+```python
+>>> from azure.ai.projects import AIProjectClient
+>>> from azure.identity import DefaultAzureCredential
+>>> from azure.core.exceptions import HttpResponseError
+
+>>> client = AIProjectClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
+>>> try:
+        <!-- write test code here -->
+    except HttpResponseError as e:
+        print('service responds error: {}'.format(e.response.json()))
+
+```
+
+## 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 [email protected] 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/
+

sdk/ai/azure-ai-projects/azure/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/ai/azure-ai-projects/azure/ai/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/ai/azure-ai-projects/azure/ai/projects/__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 AIProjectClient  # 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__ = [
+    "AIProjectClient",
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
+
+_patch_sdk()