如需完整的文件索引,請參閱 llms.txt。在文件頁面的網址末尾加上 .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-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 參考文件。

進階用法

若要瞭解如何以串流方式接收工具呼叫等進階用法,請參閱下列專題指南:

內容審核風險

在正式環境的應用程式中,以串流方式傳回模型輸出會增加內容審核的難度,因為在回應尚未完整時,可能較難判斷其內容。這可能會影響應用程式的使用方式是否符合核准範圍。

如果你在生成請求中一併要求內容審核分數,必須等完整輸出產生後才會收到分數。串流過程中傳回的各個輸出片段不會包含這些分數。