LangChain 实战课 | 豆包MarsCode AI刷题；在课程中遇到的一些小问题[已解决]

在《LangChain 实战课》学习 OpenAI API 的过程中，我发现课程的中提到的导入 API Key 方法已经过时了。在最新的 OpenAI Python SDK 中，官方对导入 API Key 的方式进行了更新和优化。因此，我们需要根据最新的指南来调整代码，以确保程序的正常运行。

旧的用法

之前，我们通常通过以下方式设置 API Key：

python
Copy code
import openai

openai.api_key = os.environ['OPENAI_API_KEY']

这种方法直接将 API Key 设置为 openai 模块的属性，属于全局变量的范畴。这种全局配置在简单的脚本中可能没有问题，但在更复杂的应用程序中，可能会引发一些潜在的问题。

新的推荐用法

最新的 OpenAI Python SDK 推荐使用实例化客户端的方式来设置 API Key：

python
Copy code
from openai import OpenAI

client = OpenAI(
    api_key=os.environ['OPENAI_API_KEY'],  # 这是默认值，可以省略
)

在这里，我们创建了一个 OpenAI 类的实例 client，并将 API Key 作为参数传递。这种方式的优点在于：

• 配置更加明确：所有的配置都集中在客户端实例中，避免了全局变量散落在代码各处。
• 提升代码可维护性：当项目规模变大时，实例化的客户端更易于管理和维护。
• 便于测试和扩展：在单元测试中，可以轻松地模拟客户端对象，而不影响全局状态。

直接在代码中设置环境变量

如果你需要在代码中直接设置环境变量，可以使用以下方法：

python
Copy code
import os

os.environ["OPENAI_API_KEY"] = '你的 OpenAI API Key'

需要注意的是，将敏感信息如 API Key 直接写入代码并不是最佳实践。更安全的做法是使用环境变量或配置文件来管理这些信息，以防止在代码分享或版本控制时泄露。

对本地开发的影响

对于在本地编写程序的同学，这些变化尤为重要。如果继续使用旧的导入和配置方式，可能会导致代码在更新后的 SDK 中无法正常运行。因此，务必根据最新的官方指南来更新代码。

详细参考

有关这些更改的详细信息和迁移指南，可以参考 OpenAI Python 官方的 GitHub 讨论：

# v1.0.0 Migration Guide #742

个人思考与分析

这次 OpenAI Python SDK 的更新，从全局配置转向实例化客户端，体现了代码设计中“高内聚、低耦合”的原则。通过实例化客户端，我们可以更好地控制和管理 API 的调用，避免了全局变量带来的潜在风险。

我认为，这种设计方式有以下几个好处：

1. 提高代码的安全性：避免在全局范围内暴露敏感信息，降低了信息泄露的风险。
2. 增强代码的灵活性：在需要使用多个不同配置的情况下，实例化多个客户端实例比修改全局变量要更加方便。
3. 改善团队协作：在多人协作的项目中，统一的客户端实例化方式可以减少代码冲突和配置混乱。

实践中的应用

在实际项目中，我打算采用新的客户端实例化方式来重构代码。同时，会将 API Key 等敏感信息存储在环境变量或安全的配置文件中，避免硬编码。此外，我也计划在团队中推广这种做法，提高代码的可维护性和安全性。

总结

OpenAI Python SDK 的更新带来了更现代化和安全的代码编写方式。作为开发者，我们需要及时关注官方的更新和最佳实践，确保我们的代码始终保持高质量和高安全性。在学习和应用新技术的过程中，也要注重思考其背后的设计理念和优点，以便更好地应用到我们的项目中。

参考资料

• OpenAI Python 官方 GitHub：v1.0.0 Migration Guide #742