如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题

流式接收 API 响应

了解如何使用服务器发送事件,以流式方式接收 OpenAI API 返回的模型响应。

默认情况下,当您向 OpenAI API 发送请求时,模型会先生成完整输出,然后 API 通过一次 HTTP 响应将其返回。输出较长时,您可能需要等待较长时间才能收到响应。使用流式响应时,您可以先打印或处理已经收到的内容,同时模型会继续生成其余部分。

本指南介绍如何通过服务器发送事件(SSE)以流式方式接收 HTTP 响应(stream=true)。如果您需要通过持久 WebSocket 连接传输数据,并使用 previous_response_id 增量提供输入,请参阅 Responses API 的 WebSocket 模式。

启用流式响应

要开始接收流式响应,请在发往 Responses 端点的请求中设置 stream=True:

from openai import OpenAI

client = OpenAI()

stream = client.responses.create(
    model="gpt-6.2-astra",
    input=[
        {
            "role": "user",
            "content": "Say 'double bubble bath' ten times fast.",
        },
    ],
    stream=True,
)

for event in stream:
    print(event)

Responses API 使用语义事件来传输流式响应。每种事件类型都有预定义的模式,因此您可以只监听所需的事件。

如需查看所有事件类型,请参阅流式响应 API 参考。以下是几个示例:

for await (const event of stream) {
  if (event.type === "response.output_text.delta") {
    process.stdout.write(event.delta);
  } else if (event.type === "response.completed") {
    console.log("\nResponse completed.");
  } else if (event.type === "error") {
    console.error(event.message);
  }
}

读取响应

如果您使用我们的 SDK,每个事件都是具有明确类型的实例。您也可以通过事件的 type 属性识别各个事件。

在生成响应的过程中,有些关键的生命周期事件只会触发一次,其他事件则会触发多次。流式接收文本时,通常可以监听以下事件:

- `response.created`
- `response.output_text.delta`
- `response.completed`
- `error`

如需查看所有可监听的事件,请参阅流式响应 API 参考。

高级用例

对于流式接收工具调用等更高级的用例,请参阅以下专题指南:

内容审核风险

请注意,在生产应用中以流式方式返回模型输出会增加审核补全内容的难度,因为在补全结果尚不完整时,可能更难评估其中的内容。这可能会影响您的使用方式是否符合获准的用途。

如果您在生成请求中要求返回内容审核评分,只有在完整输出生成后,您才会收到评分。生成过程中返回的增量输出不包含评分。