Azure AI 资源包客户端库（Python版）

Azure AI 资源包是Azure AI SDK for Python的一部分，包含连接和管理您的Azure AI资源的功能。在您的Azure AI项目中，它提供控制平面操作来创建和管理数据、索引、模型和部署。

源代码 | 包（PyPI） | API参考文档 | 产品文档 | 示例

此包已在Python 3.8、3.9、3.10、3.11和3.12上进行了测试。

有关更完整的Azure库集，请参阅 https://aka.ms/azsdk/python/all。

入门

先决条件

• 使用此包需要 Python 3.7 或更高版本。
• 您必须有一个 Azure 订阅。
• 一个 Azure 机器学习工作区。
• 一个 Azure AI Studio 项目。

安装包

使用 pip 安装 Azure AI 生成包

pip install azure-ai-resources
pip install azure-identity

认证客户端

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')

关键概念

在您的 Azure AI 项目中使用此库，以提供创建和管理数据、索引、模型和部署的控制平面操作。

示例

查看我们的 GitHub 上的 示例存储库，了解如何使用 Azure AI 生成 Python SDK。

故障排除

一般

Azure AI 客户端会引发 Azure 核心中定义的异常。

from azure.core.exceptions import HttpResponseError

try:
    ai_client.compute.get("cpu-cluster")
except HttpResponseError as error:
    print("Request failed: {}".format(error.message))

日志记录

此库使用标准日志记录库进行日志记录。基本信息（如 URL、标题等）以 INFO 级别记录。

启用具有 logging_enable 参数的客户端的详细 DEBUG 级别日志记录，包括请求/响应体和未编辑的标题。

在此处查看完整的 SDK 日志记录文档和示例。

遥测

Azure AI 生成 Python SDK 包含一个遥测功能，它收集有关 SDK 的使用和失败数据，并在您在 Jupyter Notebook 中使用 SDK 时将其发送到 Microsoft。在 Jupyter Notebook 之外使用 Python SDK 不会收集遥测数据。

遥测数据有助于 SDK 团队了解 SDK 的使用情况，以便进行改进。有关失败的信息有助于团队解决问题和修复错误。SDK 遥测功能默认启用，并且不能用于非 Jupyter 场景。要在 Jupyter 场景中退出遥测功能，请将环境变量 "AZURE_AI_RESOURCES_ENABLE_LOGGING" 设置为 "False"。

下一步

查看我们的 GitHub 上的 示例存储库，了解如何使用 Azure AI 生成 Python SDK。

贡献

如果您遇到任何错误或有任何建议，请在项目的 问题 部分中提交问题。

发行历史

1.0.0b8 (2024-03-27)

新增功能

• 连接 LIST 操作现在支持通过新的可选标志：include_data_connections 返回数据连接。
• 连接支持 3 种新的连接类型：gen 2、数据湖和 Azure Blob 的只读支持。

错误修复

• 连接 docstrings 现在讨论范围字段。

其他更改

• 错误修复

1.0.0b7 (2024-02-07)

其他更改

• 错误修复

1.0.0b6 (2024-02-06)

其他更改

• 错误修复

1.0.0b5 (2024-02-01)

其他更改

• 重复项清理

1.0.0b4 (2024-02-01)

其他更改

• 使用 openai v1 环境变量

1.0.0b3 (2024-01-30)

新增功能

• AzureOpenAIConnection.set_current_environment 支持 openai 1.0 及以上版本。

其他更改

• 支持 Python 3.12

1.0.0b2 (2023-11-30)

其他更改

• 依赖项改进。

1.0.0b1 (2023-11-10)

新增功能

• 第一个预览版本。