串流 - OpenModex

概覽

設定 stream: true 以 Server-Sent Events (SSE) 的形式接收回應。每個事件包含一個部分回應區塊，讓您在內容生成時即時顯示。

串流格式

串流發送包含 JSON 物件的 data: 行：

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hello"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

區塊物件

每個區塊包含：

欄位	類型	說明
`id`	string	同一回應中所有區塊共用
`object`	string	固定為 `chat.completion.chunk`
`created`	integer	Unix 時間戳記
`model`	string	生成回應的模型
`choices[].delta.role`	string	僅在第一個區塊中出現
`choices[].delta.content`	string	Token 內容（可能為空）
`choices[].finish_reason`	string \| null	`stop`、`length` 或串流中為 `null`

範例

curl https://api.openmodex.com/v1/chat/completions \
  -H "Authorization: Bearer omx_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Write a poem about the sea."}],
    "stream": true
  }'

import OpenModex from '@openmodex/sdk';

const client = new OpenModex({ apiKey: 'omx_sk_YOUR_KEY' });

const stream = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Write a poem about the sea.' }],
  stream: true,
});

for await (const chunk of stream) {
  const content = chunk.choices[0]?.delta?.content;
  if (content) process.stdout.write(content);
}

from openmodex import OpenModex

client = OpenModex(api_key="omx_sk_YOUR_KEY")

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Write a poem about the sea."}],
    stream=True,
)

for chunk in stream:
    content = chunk.choices[0].delta.content
    if content:
        print(content, end="", flush=True)

import { useChat } from '@openmodex/react';

function Chat() {
  const { messages, input, setInput, sendMessage, isLoading, stop } = useChat({
    apiKey: 'omx_sk_YOUR_KEY',
    model: 'gpt-4o',
  });

  return (
    <div>
      {messages.map((m) => (
        <p key={m.id}><b>{m.role}:</b> {m.content}</p>
      ))}
      <input value={input} onChange={(e) => setInput(e.target.value)} />
      <button onClick={() => sendMessage()} disabled={isLoading}>Send</button>
      {isLoading && <button onClick={stop}>Stop</button>}
    </div>
  );
}

中止串流

您可以取消進行中的串流：

const stream = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Write a long story...' }],
  stream: true,
});

// Abort after 2 seconds
setTimeout(() => stream.abort(), 2000);

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? '');
}

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Write a long story..."}],
    stream=True,
)

for chunk in stream:
    content = chunk.choices[0].delta.content
    if content:
        print(content, end="", flush=True)
    # Call stream.close() to abort