Azure AI Generative Package客户端库，适用于Python

Azure AI Generative包是Python Azure AI SDK的一部分，包含用于构建、评估和部署利用Azure AI服务的生成式AI应用程序的功能。默认安装的包包含云连接场景的能力，通过安装额外组件，您也可以在本地运行操作（如构建索引和计算指标）。

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

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

要获取更完整的Azure库集合，请参阅 https://aka.ms/azsdk/python/all。

入门指南

先决条件

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

安装包

使用pip安装Azure AI生成Python包

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客户端

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级别进行记录。

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

有关完整SDK日志记录文档和示例，请在此处查看。

遥测

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

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

下一步

请参阅我们的示例存储库，了解如何使用Azure AI生成Python SDK。

贡献

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

发布历史

1.0.0b10 (2024-10-03)

错误修复

• 错误修复

1.0.0b9 (2024-09-16)

错误修复

• 错误修复

1.0.0b8 (2024-03-27)

其他更改

• 错误修复

1.0.0b7 (2024-02-07)

其他更改

• 错误修复

1.0.0b6 (2024-02-06)

其他更改

• 递归文本拆分器现在默认启用，用于本地索引构建，类似于云索引构建的行为
• 错误修复

1.0.0b5 (2024-02-02)

新增功能

• 支持在聊天中调用evaluate()

错误修复

• 修复promptflow评估错误

其他更改

• 重复项清理

1.0.0b4 (2024-02-01)

新增功能

• 支持自定义评估指标

其他更改

• 将evaluate()函数切换到在promptflow引擎上运行
• 使用openai v1环境变量

1.0.0b3 (2024-01-30)

其他更改

• 支持Python 3.12

1.0.0b2 (2023-11-30)

新增功能

• 在qa生成器中添加了新的数据导出格式

其他更改

• 依赖关系改进。

1.0.0b1 (2023-11-10)

新增功能

• 尝试使用langchain VectorStore并回退到供应商。
• 支持 azure-search-documents 11.4.0b11 及以上版本。
• 使用动态批大小调用 OpenAI。
• 修复 LangChain 导入路径。
• 首次预览。