Package: azure-ai-resources
Azure AI Resources Package client library for PythonThe 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|Package (PyPI)|API reference documentation|Product documentation|SamplesThis 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, seehttps://aka.ms/azsdk/python/all.Getting startedPrerequisitesPython 3.7 or later is required to use this package.You must have anAzure subscription.AnAzure Machine Learning Workspace.AnAzure AI Studio project.Install the packageInstall the Azure AI generative package for Python with pip:pip install azure-ai-resources
pip install azure-identityAuthenticate the clientfromazure.ai.resources.clientimportAIClientfromazure.identityimportDefaultAzureCredentialai_client=AIClient(credential=DefaultAzureCredential(),subscription_id='subscription_id',resource_group_name='resource_group',project_name='project_name')Key conceptsUse this library within your Azure AI projects to provide control plane operations for creating and managing data, indexes, models and deployments.ExamplesView oursamples repositoryon GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.TroubleshootingGeneralAzure AI clients raise exceptions defined in Azure Core.fromazure.core.exceptionsimportHttpResponseErrortry:ai_client.compute.get("cpu-cluster")exceptHttpResponseErroraserror:print("Request failed:{}".format(error.message))LoggingThis 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 thelogging_enableargument.See full SDK logging documentation with examples here.TelemetryThe 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. Telemetry will not be collected for any use of the Python SDK outside of a Jupyter Notebook.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 stepsView oursamples repositoryon GitHub for examples demonstrating how to use the Azure AI Generative Python SDK.ContributingIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History1.0.0b7 (2024-02-07)Other ChangesBug fixes1.0.0b6 (2024-02-06)Other ChangesBug fixes1.0.0b5 (2024-02-01)Other ChangesDuplicate cleanup1.0.0b4 (2024-02-01)Other ChangesUse openai v1 environment variable1.0.0b3 (2024-01-30)Features AddedAzureOpenAIConnection.set_current_environment supports openai 1.0 and above.Other ChangesSupport for Python 3.121.0.0b2 (2023-11-30)Other ChangesDependency improvements.1.0.0b1 (2023-11-10)Features AddedFirst preview.