通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 Python 的 Azure AI 生成包客户端库 - 版本 1.0.0b2

  • 项目

Azure AI 生成包是用于 Python 的 Azure AI SDK 的一部分，包含用于生成、评估和部署利用 Azure AI 服务的生成 AI 应用程序的功能。 包的默认安装包含云连接方案的功能，通过安装附加功能，还可以在本地 (运行操作，例如) 生成索引和计算指标。

源代码 | 包 (PyPI) | API 参考文档 | 产品文档 |[示例][ml_samples]

此包已使用 Python 3.7、3.8、3.9 和 3.10 进行测试。

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

入门

先决条件

安装包

使用 pip 安装适用于 Python 的 Azure AI 生成包：

pip install azure-ai-generative[index,evaluate,promptflow]
pip install azure-identity

关键概念

语法 [index,evaluate,promptflow] 指定了在不需要该功能时可以选择删除的额外包：

  • [index] 添加了在本地开发环境中生成索引的功能
  • [evaluate] 添加了在本地开发环境中运行评估和计算指标的功能
  • [promptflow] 添加了使用连接到 Azure AI 项目的提示流进行开发的功能

使用情况

连接到项目

生成包包括 azure-ai-resources 包，并使用 AIClient 连接到项目。

首先，创建 ：AI Client

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 生成 Python SDK 提供以下关键功能。

若要在本地生成索引，请导入 build_index 函数：

from azure.ai.generative.index import build_index

若要运行本地计算，请导入 evaluate 函数：

from azure.ai.generative.evaluate import evaluate

若要部署聊天函数和提示流，请导入 deploy 函数：

from azure.ai.resources.entities.deployment import Deployment

有关这些示例的示例用法，请参阅此示例

示例

有关如何使用 Azure AI 生成 Python SDK 的示例，请参阅 示例存储库 。

疑难解答

常规

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

from azure.core.exceptions import HttpResponseError

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

日志记录

此库使用标准日志记录库进行日志记录。 有关 HTTP 会话 (URL、标头等的基本信息，) 在 INFO 级别记录。

可以使用 参数在客户端 logging_enable 上启用详细的调试级别日志记录，包括请求/响应正文和未处理标头。

请参阅此处提供示例的完整 SDK 日志记录文档。

遥测

Azure AI 生成 Python SDK 包含一个遥测功能，该功能收集有关 SDK 的使用情况和故障数据，并在仅在Jupyter Notebook中使用该 SDK 时将其发送给 Microsoft。 不会收集遥测数据，以便在 Jupyter Notebook之外使用 Python SDK。

遥测数据可帮助 SDK 团队了解 SDK 的使用方式，以便对其进行改进，有关故障的信息可帮助团队解决问题和修复 bug。 SDK 遥测功能默认为Jupyter Notebook使用启用，不能为非 Jupyter 方案启用。 若要选择退出 Jupyter 方案中的遥测功能，请将 环境变量 "AZURE_AI_GENERATIVE_ENABLE_LOGGING" 设置为 "False"。

后续步骤

有关如何使用 Azure AI 生成 Python SDK 的示例，请参阅 示例存储库 。

贡献

如果遇到任何 bug 或有建议，请在项目的“ 问题 ”部分中提出问题。

曝光数