# Azure AI Resources Package client library for Python
The Azure AI Resources package is part of the Azure AI SDK for Python and contains functionality for connecting to and managing your Azure AI resources and projects. Within your Azure AI projects it provides control plane operations for creating and managing data, indexes, models and deployments.
[Source code][source_code]
| [Package (PyPI)][ai_pypi]
| [API reference documentation][ai_ref_docs]
| [Product documentation][product_documentation]
| [Samples][generative_samples]
This package has been tested with Python 3.8, 3.9, 3.10, 3.11 and 3.12.
For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all.
## Getting started
### Prerequisites
- Python 3.7 or later is required to use this package.
- You must have an [Azure subscription][azure_subscription].
- An [Azure Machine Learning Workspace][workspace].
- An [Azure AI Studio project][ai_project].
### Install the package
Install the Azure AI generative package for Python with pip:
```
pip install azure-ai-resources
pip install azure-identity
```
### Authenticate the client
```python
from azure.ai.resources.client import AIClient
from azure.identity import DefaultAzureCredential
ai_client = AIClient(credential=DefaultAzureCredential(), subscription_id='subscription_id',
resource_group_name='resource_group', project_name='project_name')
```
## Key concepts
Use this library within your Azure AI projects to provide control plane operations for creating and managing data, indexes, models and deployments.
## Examples
View our [samples repository][generative_samples] on GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.
## Troubleshooting
### General
Azure AI clients raise exceptions defined in Azure Core.
```python
from azure.core.exceptions import HttpResponseError
try:
ai_client.compute.get("cpu-cluster")
except HttpResponseError as error:
print("Request failed: {}".format(error.message))
```
### Logging
This library uses the standard logging library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.
Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the `logging_enable` argument.
See full SDK logging documentation with examples here.
### Telemetry
The Azure AI Generative Python SDK includes a telemetry feature that collects usage and failure data about the SDK and sends it to Microsoft when you use the SDK in a Jupyter Notebook only. <u>Telemetry will not be collected for any use of the Python SDK outside of a Jupyter Notebook.</u>
Telemetry data helps the SDK team understand how the SDK is used so it can be improved and the information about failures helps the team resolve problems and fix bugs. The SDK telemetry feature is enabled by default for Jupyter Notebook usage and cannot be enabled for non-Jupyter scenarios. To opt out of the telemetry feature in a Jupyter scenario, set the environment variable `"AZURE_AI_RESOURCES_ENABLE_LOGGING"` to `"False"`.
## Next steps
View our [samples repository][generative_samples] on GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.
## Contributing
If you encounter any bugs or have suggestions, please file an issue in the [Issues](<https://github.com/Azure/azure-sdk-for-python/issues>) section of the project.
<!-- LINKS -->
[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-resources
[ai_project]: https://aka.ms/azureaistudio
[ai_pypi]: https://pypi.org/project/azure-ai-resources/
[ai_ref_docs]: https://learn.microsoft.com/python/api/azure-ai-resources/?view=azure-python-preview
[generative_samples]: https://github.com/Azure-Samples/azureai-samples
[product_documentation]: https://docs.microsoft.com/azure/machine-learning/
[azure_subscription]: https://azure.microsoft.com/free/
[workspace]: https://docs.microsoft.com/azure/machine-learning/concept-workspace
[python_logging]: https://docs.python.org/3/library/logging.html
[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging
[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/
[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies
[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity
[cla]: https://cla.microsoft.com
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:opencode@microsoft.com
# Release History
## 1.0.0b8 (2024-03-27)
### Features Added
- Connections LIST operation now supports returning data connections via new optional flag: include_data_connections.
- Connections have read-only support for 3 new connection types: gen 2, data lake, and azure blob.
### Bugs Fixed
- Connections docstrings now discuss scope field.
### Other Changes
- Bug fixes
## 1.0.0b7 (2024-02-07)
### Other Changes
- Bug fixes
## 1.0.0b6 (2024-02-06)
### Other Changes
- Bug fixes
## 1.0.0b5 (2024-02-01)
### Other Changes
- Duplicate cleanup
## 1.0.0b4 (2024-02-01)
### Other Changes
- Use openai v1 environment variable
## 1.0.0b3 (2024-01-30)
### Features Added
- AzureOpenAIConnection.set_current_environment supports openai 1.0 and above.
### Other Changes
- Support for Python 3.12
## 1.0.0b2 (2023-11-30)
### Other Changes
- Dependency improvements.
## 1.0.0b1 (2023-11-10)
### Features Added
- First preview.
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-ai-resources",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "azure, azuresdk, azure sdk",
"author": "Microsoft Corporation",
"author_email": "azuresdkengsysadmins@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/d7/1a/233b131e75ae76f7b81b7f93f05cc58e25ccadc79092a1095bb16bcb80da/azure-ai-resources-1.0.0b8.tar.gz",
"platform": null,
"description": "# Azure AI Resources Package client library for Python\n\nThe Azure AI Resources package is part of the Azure AI SDK for Python and contains functionality for connecting to and managing your Azure AI resources and projects. Within your Azure AI projects it provides control plane operations for creating and managing data, indexes, models and deployments.\n\n\n[Source code][source_code]\n| [Package (PyPI)][ai_pypi]\n| [API reference documentation][ai_ref_docs]\n| [Product documentation][product_documentation]\n| [Samples][generative_samples]\n\nThis package has been tested with Python 3.8, 3.9, 3.10, 3.11 and 3.12.\n\nFor a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all.\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.7 or later is required to use this package.\n- You must have an [Azure subscription][azure_subscription].\n- An [Azure Machine Learning Workspace][workspace].\n- An [Azure AI Studio project][ai_project].\n\n### Install the package\nInstall the Azure AI generative package for Python with pip:\n\n```\npip install azure-ai-resources\npip install azure-identity\n```\n### Authenticate the client\n\n```python\nfrom azure.ai.resources.client import AIClient\nfrom azure.identity import DefaultAzureCredential\n\nai_client = AIClient(credential=DefaultAzureCredential(), subscription_id='subscription_id',\n resource_group_name='resource_group', project_name='project_name')\n```\n\n## Key concepts\nUse this library within your Azure AI projects to provide control plane operations for creating and managing data, indexes, models and deployments.\n\n## Examples\n\nView our [samples repository][generative_samples] on GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.\n\n## Troubleshooting\n### General\nAzure AI clients raise exceptions defined in Azure Core.\n\n```python\nfrom azure.core.exceptions import HttpResponseError\n\ntry:\n ai_client.compute.get(\"cpu-cluster\")\nexcept HttpResponseError as error:\n print(\"Request failed: {}\".format(error.message))\n```\n\n### Logging\nThis library uses the standard logging library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.\n\nDetailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the `logging_enable` argument.\n\nSee full SDK logging documentation with examples here.\n\n### Telemetry\nThe Azure AI Generative Python SDK includes a telemetry feature that collects usage and failure data about the SDK and sends it to Microsoft when you use the SDK in a Jupyter Notebook only. <u>Telemetry will not be collected for any use of the Python SDK outside of a Jupyter Notebook.</u>\n\nTelemetry data helps the SDK team understand how the SDK is used so it can be improved and the information about failures helps the team resolve problems and fix bugs. The SDK telemetry feature is enabled by default for Jupyter Notebook usage and cannot be enabled for non-Jupyter scenarios. To opt out of the telemetry feature in a Jupyter scenario, set the environment variable `\"AZURE_AI_RESOURCES_ENABLE_LOGGING\"` to `\"False\"`.\n\n## Next steps\n\nView our [samples repository][generative_samples] on GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.\n\n## Contributing\n\nIf you encounter any bugs or have suggestions, please file an issue in the [Issues](<https://github.com/Azure/azure-sdk-for-python/issues>) section of the project.\n\n\n\n\n<!-- LINKS -->\n\n[source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-resources\n[ai_project]: https://aka.ms/azureaistudio\n[ai_pypi]: https://pypi.org/project/azure-ai-resources/\n[ai_ref_docs]: https://learn.microsoft.com/python/api/azure-ai-resources/?view=azure-python-preview\n[generative_samples]: https://github.com/Azure-Samples/azureai-samples\n[product_documentation]: https://docs.microsoft.com/azure/machine-learning/\n[azure_subscription]: https://azure.microsoft.com/free/\n[workspace]: https://docs.microsoft.com/azure/machine-learning/concept-workspace\n[python_logging]: https://docs.python.org/3/library/logging.html\n[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging\n[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md\n[pip_link]: https://pypi.org/project/pip/\n[azure_core_ref_docs]: https://aka.ms/azsdk-python-core-policies\n[azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md\n[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity\n[cla]: https://cla.microsoft.com\n[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/\n[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/\n[coc_contact]: mailto:opencode@microsoft.com\n\n# Release History\n\n## 1.0.0b8 (2024-03-27)\n\n### Features Added\n- Connections LIST operation now supports returning data connections via new optional flag: include_data_connections.\n- Connections have read-only support for 3 new connection types: gen 2, data lake, and azure blob.\n\n### Bugs Fixed\n- Connections docstrings now discuss scope field.\n\n### Other Changes\n- Bug fixes\n\n## 1.0.0b7 (2024-02-07)\n\n### Other Changes\n\n- Bug fixes\n\n## 1.0.0b6 (2024-02-06)\n\n### Other Changes\n\n- Bug fixes\n\n## 1.0.0b5 (2024-02-01)\n\n### Other Changes\n\n- Duplicate cleanup\n\n## 1.0.0b4 (2024-02-01)\n\n### Other Changes\n\n- Use openai v1 environment variable\n\n## 1.0.0b3 (2024-01-30)\n\n### Features Added\n\n- AzureOpenAIConnection.set_current_environment supports openai 1.0 and above.\n\n### Other Changes\n\n- Support for Python 3.12\n\n## 1.0.0b2 (2023-11-30)\n\n### Other Changes\n\n- Dependency improvements.\n\n## 1.0.0b1 (2023-11-10)\n\n### Features Added\n\n- First preview.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Azure AI control plane SDK Client Library for Python",
"version": "1.0.0b8",
"project_urls": {
"Bug Reports": "https://github.com/Azure/azure-sdk-for-python/issues",
"Homepage": "https://github.com/Azure/azure-sdk-for-python",
"Source": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azuresdk",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "df450820bc29f823d2f226fb0fd1a3c24f47e0806e71e1815adc84180d01b223",
"md5": "dc19dd6cc8a87f816f4fcf963a869680",
"sha256": "1dec87ef6d049f2b042bceb4ff9b508c800b942aff94ed8eb14eee25ff9e8444"
},
"downloads": -1,
"filename": "azure_ai_resources-1.0.0b8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc19dd6cc8a87f816f4fcf963a869680",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 2146016,
"upload_time": "2024-03-28T20:13:46",
"upload_time_iso_8601": "2024-03-28T20:13:46.115883Z",
"url": "https://files.pythonhosted.org/packages/df/45/0820bc29f823d2f226fb0fd1a3c24f47e0806e71e1815adc84180d01b223/azure_ai_resources-1.0.0b8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d71a233b131e75ae76f7b81b7f93f05cc58e25ccadc79092a1095bb16bcb80da",
"md5": "71274301e4d9825f0b35454b9c0239cb",
"sha256": "643e562f41359f3805259aec5e37ff645c90aec1b60c338d999ad02a07c0ed0e"
},
"downloads": -1,
"filename": "azure-ai-resources-1.0.0b8.tar.gz",
"has_sig": false,
"md5_digest": "71274301e4d9825f0b35454b9c0239cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 1868752,
"upload_time": "2024-03-28T20:13:42",
"upload_time_iso_8601": "2024-03-28T20:13:42.070170Z",
"url": "https://files.pythonhosted.org/packages/d7/1a/233b131e75ae76f7b81b7f93f05cc58e25ccadc79092a1095bb16bcb80da/azure-ai-resources-1.0.0b8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 20:13:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-ai-resources"
}
JSON
