OpenAI API 快速入门 - Python

此仓库托管了多个针对不同 OpenAI API 端点 (API endpoints)（如聊天、助手等）的快速入门应用。请查看 examples 文件夹以尝试不同的示例，并开始使用 OpenAI API。

基本请求

要使用 OpenAI Python SDK（软件开发工具包） 发送您的第一个 API 请求，请确保已安装正确的 依赖项 (dependencies)，然后运行以下代码：

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)

设置

1. 如果您尚未安装 Python，请从 Python.org 安装它。

2. 克隆 (Clone) 此仓库。

3. 进入项目目录：

   $ cd openai-quickstart-python
   

4. 创建一个新的 虚拟环境 (virtual environment)：

   • macOS:

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

   • Windows:

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

5. 安装依赖项：

   $ pip install -r requirements.txt
   

6. 复制示例 环境变量 (environment variables) 文件：

   $ cp .env.example .env
   

7. 将您的 API 密钥 (API key) 添加到新创建的 .env 文件中。

8. 运行应用程序：

此步骤取决于应用程序本身。如果代码使用了 Flask（Web 框架）（例如 chat-basic 示例），您可以运行：

$ flask run

现在您应该可以通过浏览器访问该应用程序，网址为：http://localhost:5000!

如果代码只是一个简单的 Python 脚本，您可以使用以下方式运行它：

$ python my_file.py

OpenAI API Quickstart - Python 快速上手指南

1. 环境准备

• 系统要求：已安装 Python (参考 Python.org)
• 前置依赖：Git、OpenAI API Key (获取地址)

2. 安装步骤

1. 克隆仓库并进入目录：

   $ git clone <repository_url>
   $ cd openai-quickstart-python
   

2. 创建虚拟环境：

   • macOS:

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

   • Windows:

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

3. 安装项目依赖：

   $ pip install -r requirements.txt
   

4. 配置环境变量：

   $ cp .env.example .env
   

   将您的 API Key 添加到新生成的 .env 文件中。

3. 基本使用

代码示例

发送第一个 API 请求：

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)

运行应用

根据示例类型选择运行方式：

• Flask 应用（如 chat-basic）：

  $ flask run
  

  浏览器访问：http://localhost:5000

• 简单 Python 脚本：

  $ python my_file.py
  

更多示例请查看 examples 文件夹。