图片是我使用dall.e模型生成的图片,
提示词: 程序员系统学习OpenAI开发者平台系统学习。
我按照SCQA模型,来开始今天的内容。
S 场景
今天是2024年3月23日,我在深圳,从事IT行业,每个人从事的行业各不相同,
但是都在被AI冲击,或多或少的改变工作方式。
C 卡点
很多IT从业人员,一定使用过ChatGPT,或者国内外推出的各种AI工具。
比如替代搜索引擎进行知识问答;
在工作领域利用AI工具生成文本,图片,视频等;
但是从开发者的视角,如果没有系统的学习AI知识。则无法很好的跟业务结合研发带AI色彩的产品,助力业务增长。
Q 问题
如何系统的建立AI知识体系?
A 回答
首先,AI的起源地是OpenAI,所以原汁原味的一手资料和资讯都在OpenAI .
然后,按照OpenAI的开发者平台的文档来学习,实践,思考,就可以系统的掌握和建立自己的AI知识体系。
最后,熟悉实践思考之后的AI知识体系建立之后,就可以在产品角度结合业务场景进行连接和落地,带来业务的新的增长。
下面是OpenAI开发者平台的首页导航。手工整理。
发起CompletionAPI请求
OpenAI API 开发者快速入门
开始使用OpenAI API
OpenAI API为开发者提供了一个简单的接口,可以在他们的应用程序中创建一个由OpenAI最先进的模型驱动的智能层。
Chat Completions端点为ChatGPT提供支持,并提供了一种简单的方式,可以将文本作为输入,并使用像GPT-4这样的模型来生成输出。
这个快速入门旨在帮助你设置本地开发环境并发送你的首个API请求。如果你是一位经验丰富的开发者或者想要立即开始使用OpenAI API,
API参考文档和GPT指南是一个很好的起点。在这个快速入门过程中,你将学习到:
- 如何设置你的开发环境
如何安装最新的SDK
OpenAI API的一些基本概念
- 如何发送你的首个API请求
如果你在开始时遇到任何挑战或有疑问,请加入我们的开发者论坛。
账户设置
首先,创建一个OpenAI账户或登录。接下来,导航到API密钥页面并“创建新的密钥”,可以选择性地为密钥命名。确保将密钥保存在安全的地方,不要与他人分享。
快速入门语言选择
选择你想要开始使用OpenAI API的工具或编程语言。
Python是一种流行的编程语言,因其易用性而常用于数据应用、Web开发以及许多其他编程任务。
OpenAI提供了一个定制的Python库,使得在Python中使用OpenAI API变得简单高效。
第一步:设置Python环境
- 安装Python
要使用OpenAI的Python库,您需要确保您的计算机上已经安装了Python。有些计算机预装了Python,
而有些则需要您自己设置。要检查您的计算机是否已安装Python,您可以打开终端或命令行:
- MacOS:打开终端:您可以在应用程序文件夹中找到它,或者使用Spotlight(Command + Space)搜索它。
- Windows:打开命令提示符:您可以通过在开始菜单中搜索"cmd"来找到它。
接下来,输入python
然后按回车/确认键。如果您进入了Python解释器,那么您的计算机上已经安装了Python,
您可以进行下一步。如果您收到一个错误消息,比如“Error: command python not found”,则可能需要安装Python并使其在您的终端/命令行中可用。
要下载Python,请访问[官方Python网站]并下载最新版本。要使用OpenAI的Python库,
您需要至少安装Python 3.7.1或更新版本。如果您是第一次安装Python,可以按照官方的Python[安装指南]进行操作。
- 设置虚拟环境(可选)
创建虚拟环境
在安装Python之后,创建一个虚拟Python环境是一个良好的实践,用于安装OpenAI Python库。虚拟环境为您的Python包提供了一个干净的工作空间,
避免了与其他项目安装的库发生冲突。如果您不想设置虚拟环境,可以直接跳到第三步。
使用内置venv模块创建虚拟环境
Python提供了一个内置的venv
模块,它提供了创建虚拟环境所需的基本功能。运行下面的命令将在您当前在终端/命令行中选择的文件夹内创建一个名为"openai-env"的虚拟环境:
python -m venv openai-env
激活虚拟环境
创建虚拟环境后,您需要激活它。在Windows上,运行:
openai-env\Scripts\activate
在Unix或MacOS上,运行:
source openai-env/bin/activate
激活虚拟环境后,您应该会发现终端/命令行界面略有变化,现在在光标输入部分的左侧应该显示"openai-env"。有关使用虚拟环境的更多详细信息,请参阅[官方Python文档]。
- 安装OpenAI Python库
一旦您安装了Python 3.7.1或更新版本,并且(可选地)设置好了虚拟环境,就可以安装OpenAI Python库了。在终端/命令行中,运行以下命令:
pip install --upgrade openai
安装完成后,运行pip list
将显示您在当前环境中安装的Python库,这应该会确认OpenAI Python库已成功安装。
第二步:设置您的API密钥
- 为所有项目设置API密钥(推荐)
将您的API密钥设置为所有项目都可访问的主要优势在于,Python库将自动检测到它并使用它,而无需编写任何代码。
MacOS 系统设置
- 打开终端:您可以在应用程序文件夹中找到它,或者使用Spotlight(Command + Space)搜索它。
- 编辑 Bash 配置文件:使用命令
nano ~/.bash_profile
或nano ~/.zshrc
(对于较新的 MacOS 版本)在文本编辑器中打开配置文件。
- 添加环境变量:在编辑器中,添加以下行,将
your-api-key-here
替换为您实际的API密钥:
export OPENAI_API_KEY='your-api-key-here'
- 保存并退出:按 Ctrl+O 保存更改,然后按 Ctrl+X 关闭编辑器。
- 加载配置文件:使用命令
source ~/.bash_profile
或source ~/.zshrc
加载更新后的配置文件。
- 验证设置:在终端中输入
echo $OPENAI_API_KEY
来验证设置。它应该显示您的API密钥。
Windows 系统设置
- 打开命令提示符:您可以通过在开始菜单中搜索 "cmd" 来找到它。
- 在当前会话中设置环境变量:要在当前会话中设置环境变量,请使用以下命令,将
your-api-key-here
替换为您实际的API密钥:
setx OPENAI_API_KEY "your-api-key-here"
此命令将为当前会话设置 OPENAI_API_KEY
环境变量。
- 永久设置:要使设置永久生效,请按照以下步骤通过系统属性添加变量:
- 右键点击“这台电脑”或“My Computer”,选择“属性”。
- 点击“高级系统设置”。
- 点击“环境变量”按钮。
- 在“系统变量”部分,点击“新建...”,输入
OPENAI_API_KEY
作为变量名,输入您的API密钥作为变量值。
- 验证设置:要验证设置,重新打开命令提示符并输入以下命令。它应该显示您的API密钥:
echo %OPENAI_API_KEY%
- 为单个项目设置API密钥
如果您只想让单个项目访问您的API密钥,您可以创建一个本地的 .env
文件,其中包含API密钥,并在接下来的步骤中显式地使用该API密钥与Python代码一起工作。
首先,转到您想要在其中创建 .env
文件的项目文件夹。
为了让您的 .env
文件被版本控制忽略,在项目目录的根目录创建一个 .gitignore
文件。在其中添加一行 .env
,
这将确保您的API密钥或其他秘密不会意外地通过版本控制共享。
一旦您使用终端或集成开发环境(IDE)创建了 .gitignore
和 .env
文件,复制您的秘密API密钥,
并将其设置为您的 .env
文件中的 OPENAI_API_KEY
。如果您还没有创建一个秘密密钥,您可以在API密钥页面上创建。
.env
文件应该如下所示:
# 在下面添加您的API密钥后,确保不要与任何人分享!API密钥应保持私密。
OPENAI_API_KEY=abc123
您可以通过运行以下代码导入API密钥:
from openai import OpenAI
client = OpenAI()
# 默认情况下,会使用 os.environ.get("OPENAI_API_KEY") 来获取密钥
# 如果您将密钥保存在不同的环境变量名下,您可以这样做:
# client = OpenAI(
# api_key=os.environ.get("CUSTOM_ENV_NAME"),
# )
第三步:发送您的第一个API请求
- 发起API请求
在Python中,您可以使用以下代码示例来发送您的第一个API请求:
from openai import OpenAI
client = OpenAI()
completion = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[
{"role": "system", "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."},
{"role": "user", "content": "Compose a poem that explains the concept of recursion in programming."}
]
)
print(completion.choices[0].message)
要运行代码,请在终端/命令行中输入
python openai-test.py
我的实验结果:
E:\src\py\aitest\ai>python testReq.py
ChatCompletionMessage(content='In the realm of code, a loop unfurled,\nRecursion rises, a concept of the world.\nA function calls itself, a dance in repeats,\nIn a rhythm divine, it flows and meets.\n\nLike a fractal unfolding, a pattern so clear,\nEach iteration whispers, "I am here."\nBreaking problems into smaller parts,\nIn a recursive embrace, it imparts.\n\nWith elegance and grace, it blooms and grows,\nSolving puzzles, conquering woes.\nA loop within a loop, a dreamlike trance,\nIn the essence of recursion, we find romance.\n\nSo let us wield this magic with care,\nNavigating complexities, beyond compare.\nFor in the heart of recursion\'s art,\nWe find the beauty of code\'s own heart.', role='assistant', function_call=None, tool_calls=None)
Chat Completions示例仅展示了我们模型的一个强项:创造力。
以格式良好的诗歌形式解释递归(编程主题)是即使是最优秀的开发者和诗人也会觉得有挑战的任务。
在这种情况下,gpt-3.5-turbo模型可以轻松做到这一点。
下一步
现在您已经发送了第一个OpenAI API请求,是时候探索更多可能性了:
- 想要更详细地了解我们的模型和API,请查看我们的[GPT指南]。
- 访问[OpenAI Cookbook],了解深入的API用例示例以及常见任务的代码片段。
- 想知道OpenAI的模型能做什么?查看我们的[示例提示库]。
- 想要不写代码就尝试API?在[Playground]中开始实验。
- 开始构建时,请记住遵守我们的[使用政策]。
原创不易,关注诚可贵,转发价更高!转载请注明出处,让我们互通有无,共同进步,欢迎沟通交流。