Azure OpenAI Python 企业日志项目教程

项目介绍

openai-python-enterprise-logging 是一个开源项目，旨在为使用 Azure OpenAI 的企业提供全面的日志记录功能。该项目框架集成了最新的 OpenAI 库，支持企业级日志记录，包括 OpenAI 使用指标、提示输入、用户统计和提示响应等。通过该项目的实施，企业可以确保其 OpenAI 模型的使用符合企业政策和合规要求。

项目快速启动

前提条件

在开始之前，请确保您已经具备以下条件：

• Azure 订阅
• Azure OpenAI 应用程序

安装和配置

1. 克隆项目仓库

   git clone https://github.com/Azure-Samples/openai-python-enterprise-logging.git
   cd openai-python-enterprise-logging
   

2. 安装依赖

   pip install -r requirements.txt
   

3. 配置 Azure OpenAI 在 Azure 门户中创建一个 Azure OpenAI 资源，并部署您选择的模型。

4. 配置 Azure Key Vault 创建一个 Azure Key Vault 资源，并将 Azure OpenAI 实例的 Key1 添加为密钥。

5. 配置 API 管理 通过 Azure 门户配置 API 管理服务，并按照文档设置访问权限和后端服务。

示例代码

以下是一个简单的示例代码，展示了如何使用该项目记录 OpenAI 的完成请求：

import openai

openai.api_type = "azure"
openai.api_base = "https://xxxxxxxxx.azure-api.net/"  # APIM Endpoint
openai.api_version = "2023-05-15"
openai.api_key = "APIM SUBSCRIPTION KEY"  # DO NOT USE ACTUAL AZURE OPENAI SERVICE KEY

response = openai.Completion.create(
    engine="modelname",
    prompt="prompt text",
    temperature=1,
    max_tokens=200,
    top_p=0.5,
    frequency_penalty=0,
    presence_penalty=0,
    stop=None
)

print(response)

应用案例和最佳实践

应用案例

1. 企业内部使用：企业可以使用该项目来监控和记录内部员工对 OpenAI 模型的使用情况，确保合规性和数据安全。
2. 高可用性需求：通过配置多个 Azure OpenAI 实例，企业可以确保在流量高峰期或单点故障时，服务仍然可用。

最佳实践

1. 日志记录策略：确保所有关键操作和用户交互都被记录，以便后续审计和分析。
2. 安全配置：使用 Azure Key Vault 和 API 管理来保护敏感数据和 API 密钥。
3. 性能监控：定期检查日志以监控模型性能和使用情况，及时调整资源分配。

典型生态项目

1. Azure API Management：用于管理和保护 OpenAI API 的访问。
2. Azure Monitor：用于监控和分析 OpenAI 模型的使用情况。
3. Azure Key Vault：用于安全存储和管理 API 密钥。
4. Azure Virtual Network：用于确保所有网络流量通过私有网络进行，增强安全性。

通过这些生态项目的集成，企业可以构建一个安全、可靠且易于管理的 OpenAI 使用环境。