使用 Python 流式传输来自 OpenAI API 的响应:分步指南

OpenAI API 提供了大量可用于执行各种 NLP 任务的尖端 AI 模型。但是,在某些情况下,仅向 OpenAI 发出 API 请求可能还不够,例如需要实时更新时。这就是服务器发送事件 (SSE) 发挥作用的地方。

SSE 是一种简单有效的技术,用于将数据从服务器实时流式传输到客户端。如何在 Windows 计算机中备份驱动程序在本文中,我们将探讨如何使用 Python 和 SSE 实时流式传输来自 OpenAI API 的响应。到本教程结束时,您将对如何实现此技术有深入的了解,并且能够轻松地将响应从 OpenAI API 流式传输到您的应用程序。

检索您的 OpenAI API 密钥

为了能够从您的 Python 脚本中访问 OpenAI API,我们需要使用 API 密钥。

要检索您的 OpenAI API 密钥,您需要在 https://openai.com/ 创建一个用户帐户并访问 OpenAI 仪表板中的 API 密钥部分以创建一个新的 API 密钥。

此密钥是秘密的,不得与任何其他人共享。稍后在实现 Python 脚本以访问 OpenAI 的 API 时,我们将需要使用此密钥。

执行脚本

在一个新文件夹中创建一个文件 main.py 并通过插入以下四行代码开始实施:

import requests
import json
import sseclient
 
API_KEY = '[INSERT YOUR OPENAI API KEY HERE]'

这段代码在 Python 中导入了三个模块:requests、json 和 sseclient。

requests 是一个流行的 Python 库,用于向服务器发送 HTTP 请求并接收响应。

json 是一个提供处理 JSON 数据的函数的库。它允许您编码和解码 JSON 数据。sseclient 是一个用于处理服务器发送事件 (SSE) 的库——一种在客户端和服务器之间通过 HTTP 进行的事件驱动通信。

如果您之前没有在 Python 开发环境中安装这些库,您首先需要使用 pip 命令来安装这些包:

pip install requests json sseclient-py

该代码还定义了一个用于存储 OpenAI API 密钥的变量 API_KEY。请将占位符文本 [INSERT YOUR OPENAI API KEY HERE] 替换为您之前从 OpenAI 帐户中检索到的 API 密钥。

接下来通过实现和执行 performRequestWithStreaming() 函数来进一步完成实现,该函数包含向 OpenAI API 完成端点执行 POST 请求并以流模式接收答案所需的所有逻辑:

import requests
import json
import sseclient
 
API_KEY = '[INSERT YOUR OPENAI API KEY HERE]'

def performRequestWithStreaming():
    reqUrl = 'https://api.openai.com/v1/completions'
    reqHeaders = {
        'Accept': 'text/event-stream',
        'Authorization': 'Bearer ' + API_KEY
    }
    reqBody = {
      "model": "text-davinci-003",
      "prompt": "What is Python?",
      "max_tokens": 100,
      "temperature": 0,
      "stream": True,
    }
    request = requests.post(reqUrl, stream=True, headers=reqHeaders, json=reqBody)
    client = sseclient.SSEClient(request)
    for event in client.events():
        if event.data != '[DONE]':
            print(json.loads(event.data)['choices'][0]['text'], end="", flush=True),

if __name__ == '__main__':
    performRequestWithStreaming()

该函数使用请求模块向 URL https://api.openai.com/v1/completions 发出 POST 请求。请求标头包括 Accept 和 Authorization 字段,授权标头使用代码中前面定义的 API_KEY 变量。

请求正文定义为 reqBody 变量,包含 API 请求的多个参数,包括模型名称、提示文本、要返回的最大令牌数、温度以及对流式响应的要求。

来自 API 请求的响应被分配给请求变量。然后,使用 sseclient 库处理响应,并将请求对象传递给 SSEClient 构造函数以创建新的客户端对象。

然后代码使用 for 循环迭代客户端对象中的事件。对于每个事件,事件数据都会打印到控制台,除非事件数据等于“[DONE]”,在这种情况下什么都不打印。json.loads()函数用于解析事件中的JSON数据,提取结果字典的choices字段,得到补全的文本。print() 函数的 end 和 flush 参数用于确保输出不被缓冲并立即显示在控制台上。

执行脚本

执行脚本

$ python main.py

然后您应该能够看到 OpenAI 提供的答案(提示“什么是 Python?”)被流式传输到命令行。

结论

总之,使用 SSE 和 Python 实时流式传输来自 OpenAI API 的响应是在应用程序中访问 AI 模型的一种强大而高效的方式。按照本文中的分步指南,您现在应该能够实施此技术并从 OpenAI API 接收实时更新。SSE 是一种简单有效的解决方案,用于将数据从服务器流式传输到客户端,对于那些希望将其应用程序的 AI 功能提升到一个新水平的人来说,它是一个很好的选择。