5分钟掌握OpenAI流式响应处理：告别等待，实时交互ChatGPT
项目地址: https://gitcode.com/GitHub_Trending/op/openai-python 你是否遇到过调用OpenAI API时，等待完整响应时间过长的问题？特别是在处理长文本生成或实时对话场景时，用户体验会大打折扣。本文将带你快速掌握OpenAI Python库中Chat Completions流式解析的正确使用方式，让你实现实时交互，提升应用响应速度。读完本文，你将能够：
- 理解流式响应与非流式响应的区别
- 掌握同步和异步两种流式调用方法
- 学会处理流式响应中的delta内容
- 解决流式处理中的常见问题
流式响应 vs 非流式响应
在使用OpenAI API时，我们通常有两种获取响应的方式：流式响应和非流式响应。下面通过一个表格来对比它们的区别：
| 响应方式 | 特点 | 适用场景 |
|---|---|---|
| 非流式响应 | 一次性返回完整结果，等待时间长 | 短文本生成、简单问答 |
| 流式响应 | 分块返回结果，可实时处理 | 长文本生成、实时对话、打字机效果展示 |
流式响应采用Server-Sent Events（SSE）技术，将响应内容分块传输，客户端可以边接收边处理，大大提升了用户体验。OpenAI Python库通过Stream和AsyncStream类实现了对流式响应的处理，具体实现可参考src/openai/_streaming.py。
快速上手：基本流式调用
下面我们分别介绍同步和异步两种方式的流式调用方法。
同步流式调用
from openai import OpenAI
client = OpenAI()
stream = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "请介绍一下Python的主要特点"}],
stream=True,
)
for chunk in stream:
content = chunk.choices[0].delta.content
if content:
print(content, end="", flush=True)
异步流式调用
import asyncio
from openai import AsyncOpenAI
client = AsyncOpenAI()
async def main():
stream = await client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "请介绍一下Python的主要特点"}],
stream=True,
)
async for chunk in stream:
content = chunk.choices[0].delta.content
if content:
print(content, end="", flush=True)
asyncio.run(main())
以上代码示例展示了Chat Completions的基本流式调用方式。与examples/streaming.py中展示的Completions API不同，Chat Completions使用chat.completions.create方法，并需要传入messages参数。
流式响应的解析与处理
流式响应返回的是一系列ChatCompletionChunk对象，每个对象包含一个或多个choices，每个choice中包含delta字段，即当前块的内容。我们需要对这些delta内容进行处理，才能得到完整的响应。
delta内容的结构
每个delta对象可能包含以下字段：
role: 角色（如"assistant"）content: 文本内容function_call: 函数调用信息（如果有）
具体的类型定义可参考src/openai/types/chat/chat_completion.py中的ChatCompletionChunk类。
处理完整响应
在实际应用中，我们通常需要将所有delta内容拼接起来，得到完整的响应。下面是一个处理完整响应的示例：
from openai import OpenAI
client = OpenAI()
stream = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "请介绍一下Python的主要特点"}],
stream=True,
)
full_response = ""
for chunk in stream:
content = chunk.choices[0].delta.content
if content:
full_response += content
print(content, end="", flush=True)
print("\n完整响应：", full_response)
高级技巧：错误处理与取消流
在实际应用中，我们需要考虑流式处理过程中可能出现的错误，以及如何取消正在进行的流。
错误处理
OpenAI Python库会在流式响应中遇到错误时抛出APIError异常。我们可以使用try-except块来捕获并处理这些错误：
from openai import OpenAI, APIError
client = OpenAI()
try:
stream = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "请介绍一下Python的主要特点"}],
stream=True,
)
for chunk in stream:
content = chunk.choices[0].delta.content
if content:
print(content, end="", flush=True)
except APIError as e:
print(f"发生错误：{e}")
取消流
如果需要在获取完所有响应前取消流，可以使用close()方法：
from openai import OpenAI
client = OpenAI()
stream = client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": "请介绍一下Python的主要特点"}],
stream=True,
)
try:
for i, chunk in enumerate(stream):
content = chunk.choices[0].delta.content
if content:
print(content, end="", flush=True)
# 获取3个块后取消流
if i >= 3:
stream.close()
break
except Exception as e:
print(f"发生错误：{e}")
常见问题及解决方案
在使用流式响应时，我们可能会遇到一些常见问题，下面列举几个并提供解决方案：
问题1：delta内容为空
有时候，流式响应中的某些chunk的delta内容可能为空。这是正常现象，我们只需要跳过这些chunk即可。
for chunk in stream:
content = chunk.choices[0].delta.content
if content: # 只处理非空内容
print(content, end="", flush=True)
问题2：中文显示乱码
如果在打印流式响应时出现中文乱码，可以在打开终端时设置正确的编码，或者使用encode()和decode()方法处理：
for chunk in stream:
content = chunk.choices[0].delta.content
if content:
print(content.encode('utf-8').decode('utf-8'), end="", flush=True)
问题3：异步流式调用时事件循环错误
在使用异步流式调用时，如果遇到事件循环相关的错误，可以尝试使用asyncio.run()来运行异步函数，或者检查是否已经存在事件循环。
总结与展望
本文介绍了OpenAI Python库中Chat Completions流式解析的正确使用方式，包括基本调用、响应处理、高级技巧和常见问题解决。通过使用流式响应，我们可以大大提升应用的实时性和用户体验。
未来，OpenAI可能会推出更多支持流式处理的功能，例如更细粒度的控制、自定义分块策略等。我们可以关注CHANGELOG.md来了解最新的功能更新。
如果你觉得本文对你有帮助，请点赞、收藏并关注我们，获取更多关于OpenAI API的使用技巧。下期我们将介绍如何使用OpenAI Python库实现函数调用功能，敬请期待！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
