Calling OpenAI API Service using Python(openai.api_key os.getenv)
一、OpenAI API调用方法与环境变量设置详解
A. 导入openai和os模块
- 使用
import openai导入openai模块 - 使用
import os导入os模块
B. 设置OpenAI API Key
- 通过环境变量读取API Key
- 使用
os.getenv()函数获得环境变量的值 - 传入
"OPENAI_API_KEY"作为参数，获得对应环境变量的值 - 直接在代码中设置API Key
- 使用
openai.api_key = "API Key"的情势设置API Key
C. 示例：根据区别的API调用方法使用API Key
- 文本生成API调用
- 使用
openai.Completion.create()方法 - 设置model参数为所需的模型名称
- 设置prompt参数为输入的文本
- 聊天模型API调用
- 使用
openai.ChatCompletion.create()方法 - 设置model参数为所需的模型名称
- 设置messages参数为用户和机器人的对话信息
- Fine-Tuning训练任务API调用
- 使用
openai.FineTuningJob.create()方法 - 设置training_file参数为训练数据文件
- 设置model参数为所需的模型名称
二、如何获得OpenAI API Key并设置环境变量
A. 登录OpenAI账户
- 打开OpenAI官网，进入登录页面
- 输入账户信息进行登录
B. 获得API Key
- 导航到OpenAI账户的API Key页面
- 复制生成的API Key
C. 设置环境变量
- 使用os模块的
getenv()函数获得环境变量的值 - 将获得到的API Key设置为名为”OPENAI_API_KEY”的环境变量的值
D. 示例：将API Key保存在.env文件中并加载环境变量
- 创建.env文件，将API Key保存在其中
- 使用
load_dotenv()函数加载.env文件中的环境变量 - 使用
os.getenv()函数获得加载后的环境变量的值
三、常见问题与解决方法
A. API调用出错：”valid API secret key”毛病
- 核对API Key的有效性
- 确保API Key在API调用中正确设置
B. API调用出错：”没有此网页的信息”毛病
- 检查网络连接会不会正常
- 确认API调用的URL会不会正确
C. API调用出错：”I am just trying some simple functions”毛病
- 确认API Key会不会正确设置
- 检查代码中的API调用会不会正确
四、总结
本文介绍了OpenAI API的调用方法和环境变量设置详解。通过导入openai和os模块，可使用os.getenv()函数通过环境变量的方式读取OpenAI API Key，也能够直接在代码中设置API Key。针对区别的API调用方法，使用相应的API函数并设置对应的参数。获得API Key需要登录OpenAI账户并复制生成的Key，并将其设置为环境变量的值。遇到常见问题时，需核对API Key的有效性和API调用的正确设置。
openai.api_key os.getenv的进一步展开说明
使用Python调用OpenAI API Service Renjith Ravindranathan · 关注发布于techbeatly · 浏览需要2分钟 · Apr 7 — 1分享
OpenAI标志
在这篇简短的文章中，我将展现怎样使用Python库与OpenAI API Service进行交互。发送要求和获得响应非常简单，API还有许多利用集成的可能性。让我们看看具体怎样做。
先决条件
OpenAI账户Python3
设置
第一步是从您的OpenAI账户生成API_KEY令牌。链接在这里。这使您能够与服务进行交互。在运行Python程序之前，请在环境变量中包括API_KEY、MODEL和ROLE。
目前，OpenAI API Service支持两个gpt模型
gpt⑶.5-turbo
gpt⑷
角色可以是以下之一
#一个聊天对话的格式通常是首先是系统消息，然后是用户和助手的消息。
系统
用户
助手
3.下面添加的Python代码允许用户向API服务发送单个要求并获得响应。
import os
import openai
import sys
api_key = os.getenv(‘API_KEY’)
gpt_model = os.getenv(‘MODEL’)
role = os.getenv(‘ROLE’)
if api_key is None or api_key == “”:
print(“API_KEY为空。请提供来自OpenAI Service的API_KEY”)
exit(0)
if gpt_model is None or gpt_model == “”:
gpt_model = ‘gpt⑶.5-turbo’
else:
print(“选择模型：”, gpt_model)
openai.api_key = api_key
if role is None or role == “”:
role = “user”
else:
print(“选择角色：”, role)
if len(sys.argv) != 2:
print(“使用方法：python script_name.py ‘your message'”)
else:
message = sys.argv[1]
print(“您的问题是-“,message)
result = openai.ChatCompletion.create(
model=gpt_model,
messages=[{“role”: role,
“content”: message}]
)
print(result.choices[0].message.content)
在履行之前，请将环境变量注入到您的终端会话中，请注意：
下面是博客的翻译版本：
使用Python调用OpenAI API Service
在这篇短文中，我将通过一个示例代码来演示怎样使用Python库与OpenAI API Service进行交互。发送要求和获得响应非常简单，而且在API的利用集成方面有许多可能性。接下来我们看看具体的实现进程。
先决条件
OpenAI账户
Python3
设置
第一步是从您的OpenAI账户获得生成API_KEY令牌。链接在这里。这样您就能够与服务进行交互了。在运行您的Python程序之前，请在环境变量中设置API_KEY、MODEL和ROLE参数。
目前，OpenAI API Service支持两个gpt模型：
gpt⑶.5-turbo
gpt⑷
角色可以是以下任意一个：
系统（system）
用户（user）
助手（assistant）
这里附上了一段Python代码，它可让用户向API服务发送一个要求并返回响应。
“`python
import os
import openai
import sys
api_key = os.getenv(‘API_KEY’)
gpt_model = os.getenv(‘MODEL’)
role = os.getenv(‘ROLE’)
if api_key is None or api_key == “”:
print(“API_KEY为空，请提供一个来自OpenAI Service的API_KEY”)
exit(0)
if gpt_model is None or gpt_model == “”:
gpt_model = ‘gpt⑶.5-turbo’
else:
print(“使用的模型为：”, gpt_model)
openai.api_key = api_key
if role is None or role == “”:
role = “user”
else:
print(“使用的角色为：”, role)
if len(sys.argv) != 2:
print(“用法：python script_name.py ‘your message'”)
else:
message = sys.argv[1]
print(“您的问题是：”, message)
result = openai.ChatCompletion.create(
model=gpt_model,
messages=[{“role”: role,
“content”: message}]
)
print(result.choices[0].message.content)
“`
在履行之前，请确保在终端会话中注入了这些环境变量。
请注意：
“`python
if __name__ == “__main__”:
“`
语句一定要添加到代码的最后。
当您运行上述代码时，请依照提示提供您的问题。然后，您将会收到API返回的回答。
通过这篇文章的介绍，您已了解了怎样使用Python调用OpenAI API Service。期待您在实践中能够发挥更多的创意和利用！
openai.api_key os.getenv的常见问答Q&A
问题1：OpenAI API是甚么？
答案：OpenAI API是一种能够让开发者使用OpenAI的人工智能模型进行自然语言处理和文本生成的接口。通过OpenAI API，开发者可以利用强大的人工智能模型来实现各种任务，如自动回复、内容生成、代码生成等。它提供了一种简单、灵活的方式来与OpenAI的人工智能系统进行交互。
- OpenAI API的主要功能是甚么。
- OpenAI API的优势有哪几种。
- 如何获得OpenAI API的使用凭证。
关于OpenAI API的功能
OpenAI API具有以下主要功能：
- 文本生成：OpenAI API可以根据给定的输入生成联贯的、和输入相关的文本。
- 语言翻译：OpenAI API可以将一种语言翻译成另外一种语言，提供跨语言的辅助功能。
- 对话生成：OpenAI API可以生成人类对话的摹拟，用于聊天机器人等利用。
- 代码生成：OpenAI API可以根据给定的代码片断生成相关的代码，用于代码补全和自动化开发。
- 内容摘要：OpenAI API可以根据给定的长文本生成对应的内容摘要，提供内容的概括和提取。
关于OpenAI API的优势
OpenAI API具有以下优势：
- 强大的模型能力：OpenAI API使用的是经过大量数据训练的人工智能模型，可以生成高质量的文本和代码。
- 开发者友好：OpenAI API提供了简单易用的接口和详细的文档，使开发者能够快速上手和集成。
- 灵活的利用场景：OpenAI API可以利用于多种领域和任务，如自然语言处理、智能客服、内容生成等。
- 快速迭代和更新：OpenAI团队不断改进和更新模型，使其能够适应更多的利用场景和需求。
如何获得OpenAI API的使用凭证
要使用OpenAI API，需要获得OpenAI API的使用凭证，具体步骤以下：
- 访问OpenAI网站并创建账号。
- 登录到OpenAI账号，并申请API访问权限。
- 取得API访问权限后，根据文档中的说明获得API访问密钥。
- 将API访问密钥配置到开发环境中，以便调用OpenAI API。
