openai-quickstart-python

项目介绍：OpenAI 快速入门 - Python

OpenAI 快速入门 - Python 项目是一个GitHub上的开源库，旨在帮助开发者快速上手并使用OpenAI的不同API端点（如聊天、助手等）。此项目中包含多个快速入门应用，开发者可以通过“examples”文件夹中的示例来尝试和了解如何使用OpenAI API。

基本请求

要想使用OpenAI的Python SDK发出第一个API请求，用户需确保已正确安装相关依赖。然后可以通过以下代码与OpenAI进行简单的交互：

from openai import OpenAI
client = OpenAI()

completion = client.chat.completions.create(
  model="gpt-3.5-turbo",
  messages=[
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ]
)

print(completion.choices[0].message)

在这个例子中，系统会生成一个友好的助手响应给用户。代码中调用的模型是“gpt-3.5-turbo”，这是OpenAI提供的一个强大对话模型。

环境设置

为了运行项目，用户需要按照以下步骤进行设置：

1. 如果机器上未安装Python，请从Python官网下载安装。

2. 克隆此仓库到本地。

3. 转到项目目录：

   $ cd openai-quickstart-python

4. 创建一个新的虚拟环境：

   • 对于 macOS:

     $ python -m venv venv
     $ . venv/bin/activate

   • 对于 Windows:

     > python -m venv venv
     > .\venv\Scripts\activate

5. 安装项目的依赖包：

   $ pip install -r requirements.txt

6. 复制示例环境变量文件：

   $ cp .env.example .env

7. 将你的API密钥添加到.env文件中。

8. 运行应用：

最后一步取决于具体的应用程序。如果代码使用了Flask（如chat-basic示例），可以通过以下命令运行：

$ flask run

然后可以通过浏览器访问此URL查看应用：http://localhost:5000。

如果代码只是一个简单的Python脚本，可以通过以下命令运行：

$ python my_file.py

通过这些步骤，用户可以轻松地在本地设置并运行OpenAI应用程序。这些步骤确保开发者能够快速上手，并在自己机器上独立实验和开发基于OpenAI的应用。