设置和使用环境变量

[chenxizhang]

在使用这个模块时，我们鼓励你将一些常用的参数（尤其是机密性的参数，例如密钥）用环境变量保存起来，然后在执行命令时引用。对于最核心的 api_key, endpoint, model 三个参数，我们会默认读取环境变量，他们分别是 OPENAI_API_KEY, OPENAI_API_ENDPOINT, OPENAI_API_MODEL，这样就可以尽可能简化你的调用。

定义环境变量

那么如何定义环境变量呢？不同的操作系统有不同的做法，请分别参考如下的说明。

Windows 系统

你可以直接在PowerShell 命令窗口，输入 SETX OPENAI_API_KEY 你的密钥 这样的命令来定义。
你当然也可以通过图形化界面来定义，可以从控制面板中选择“系统”，选择“高级系统设置”，然后单击“环境变量”，然后按照提示进行定义。

MacOS 系统

你需要使用EXPORT 指令来定义，参考 https://support.apple.com/zh-cn/guide/terminal/apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac 的介绍。

Linux 系统

跟MacOS 有点类似，可以参考 https://www.cnblogs.com/amboyna/archive/2008/03/08/1096024.html 的介绍。

使用环境变量

一旦完成了环境变量的定义，如果你想在命令调用时引用它，就可以使用类似下面的语法了。

chat -api_key $env:OPENAI_API_KEY