స్ట్రీమింగ్
stream ను true కి సెట్ చేస్తే, మోడల్ రాస్తున్నప్పుడే సమాధానం server-sent events గా వస్తుంది: ముందు రీజనింగ్, తర్వాత సమాధానం, చివరగా ఫినిష్ రీజన్ మరియు usage తో ఒక చంక్. ఒక వ్యక్తి టెక్స్ట్ కోసం ఎదురుచూస్తున్నప్పుడు, మరియు పొడవైన సమాధానాల కోసం దీన్ని ఉపయోగించండి.
POST https://api.shannon-ai.com/v1/chat/completions
OpenAI SDKలు మీకు చంక్లను ఒక్కొక్కటిగా ఇస్తాయి. ప్రతి చంక్ను అది కలిగి ఉన్న దాని ఆధారంగా చదవండి: రీజనింగ్ భాగం, సమాధాన భాగం, టూల్ కాల్, లేదా సమాధానం ముగింపు.
from openai import OpenAI, APIError
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://api.shannon-ai.com/v1",
)
stream = client.chat.completions.create(
model="shannon-3",
messages=[{"role": "user", "content": "Explain server-sent events in three sentences."}],
stream=True,
)
answer, reasoning, tool_calls = [], [], []
finish_reason = usage = None
try:
for chunk in stream:
if chunk.usage:
usage = chunk.usage
if not chunk.choices:
continue
choice = chunk.choices[0]
delta = choice.delta
thought = getattr(delta, "reasoning_content", None)
if thought:
reasoning.append(thought)
if delta.content:
answer.append(delta.content)
print(delta.content, end="", flush=True)
for call in delta.tool_calls or []:
tool_calls.append((call.id, call.function.name, call.function.arguments))
if choice.finish_reason:
finish_reason = choice.finish_reason
except APIError as error:
# A failure after the stream started arrives as an error chunk.
print(f"\nstream failed: {error}")
print(f"\n{finish_reason} {usage}") import OpenAI from "openai";
const client = new OpenAI({
apiKey: "YOUR_API_KEY",
baseURL: "https://api.shannon-ai.com/v1",
});
const stream = await client.chat.completions.create({
model: "shannon-3",
messages: [{ role: "user", content: "Explain server-sent events in three sentences." }],
stream: true,
});
let answer = "";
let reasoning = "";
const toolCalls = [];
let finishReason = null;
let usage = null;
try {
for await (const chunk of stream) {
if (chunk.usage) usage = chunk.usage;
const choice = chunk.choices?.[0];
if (!choice) continue;
const delta = choice.delta;
if (delta.reasoning_content) reasoning += delta.reasoning_content;
if (delta.content) {
answer += delta.content;
process.stdout.write(delta.content);
}
for (const call of delta.tool_calls ?? []) {
toolCalls.push({ id: call.id, name: call.function.name, arguments: call.function.arguments });
}
if (choice.finish_reason) finishReason = choice.finish_reason;
}
} catch (error) {
// A failure after the stream started arrives as an error chunk.
console.error("\nstream failed:", error.message);
}
console.log("\n", finishReason, usage); curl -N https://api.shannon-ai.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "shannon-3",
"messages": [{"role": "user", "content": "Explain server-sent events in three sentences."}],
"stream": true
}' స్ట్రీమ్ ఫ్రేమింగ్ ఎలా ఉంటుంది
- సమాధానం స్టేటస్
200తో, మరియుcontent-type: text/event-stream,cache-control: no-cacheహెడర్లతో వస్తుంది. - ప్రతి ఈవెంట్
data:తో మొదలయ్యే ఒక లైన్, దాని తర్వాత ఖాళీ లైన్ ఉంటుంది.data:తర్వాతి టెక్స్ట్ ఒక JSON చంక్.event:లేదాid:లైన్లు ఉండవు. - కోలన్తో మొదలయ్యే లైన్, ఉదాహరణకు
: ping, కనెక్షన్ను తెరిచి ఉంచే కామెంట్. దాన్ని దాటవేయండి. - స్ట్రీమ్
data: [DONE]తో ముగుస్తుంది. అది లేకుండా ఆగిపోయిన స్ట్రీమ్ అసంపూర్ణం.
క్రమంలో చంక్లు
ప్రతి చంక్ ఒక chat.completion.chunk ఆబ్జెక్ట్:
{
"id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
"object": "chat.completion.chunk",
"created": 1791625200,
"model": "shannon-3",
"choices": [
{
"index": 0,
"delta": {
"content": "Server-sent"
},
"finish_reason": null
}
]
} ఒక స్ట్రీమ్లోని అన్ని చంక్లలో ఒకే id, created మరియు model ఉంటాయి. choices లో ఎల్లప్పుడూ ఒక ఎంట్రీ ఉంటుంది. దాని delta లో కొత్తది ఉంటుంది, మరియు చివరి చంక్ వరకు finish_reason null గా ఉంటుంది.
| delta లో కీ | రకం | వివరణ | పంపేవి |
|---|---|---|---|
role | string | ఎల్లప్పుడూ assistant. ఇది స్ట్రీమ్ ప్రారంభంలో ఒక్కసారి వస్తుంది. | హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్, shannon-2-lite, shannon-2-pro |
reasoning_content | string | మోడల్ రీజనింగ్లో ఒక భాగం. భాగాలను క్రమంలో కలపండి. | హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్, Shannon 3 ఫ్యామిలీ, shannon-1.6-pro, shannon-coder-1 |
content | string | సమాధానంలో ఒక భాగం. భాగాలను క్రమంలో కలపండి. | అన్ని మోడల్స్ |
tool_calls | array | ఒక పూర్తి టూల్ కాల్. టూల్ కాల్ డెల్టాల విభాగం చూడండి. | అన్ని మోడల్స్ |
ముందు రీజనింగ్, తర్వాత సమాధానం, ఆపై టూల్ కాల్స్ వస్తాయి. చంక్ను స్ట్రీమ్లో దాని స్థానం బట్టి కాకుండా, దాని delta లోని కీల ద్వారా చదవండి: ఒక delta లో మొదటి టెక్స్ట్ భాగంతో పాటు role ఉండవచ్చు, మరియు చివరిది ఖాళీగా ఉంటుంది.
ఒక మొత్తం స్ట్రీమ్ ప్రయాణించే రూపంలో. లైన్లు పొట్టిగా ఉండటానికి, ఇక్కడ ప్రతి చంక్ నుండి id, object, created మరియు model వదిలివేయబడ్డాయి.
data: {"choices":[{"index":0,"delta":{"reasoning_content":"Three sentences:"},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{"reasoning_content":" what it is, how it is framed, why it is used."},"finish_reason":null}]}
: ping
data: {"choices":[{"index":0,"delta":{"content":"Server-sent"},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{"content":" events let a server push text to a client over one HTTP reply."},"finish_reason":null}]}
data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":1190,"completion_tokens":84,"total_tokens":1274}}
data: [DONE] రీజనింగ్ డెల్టాలు
రీజనింగ్ చేసే మోడల్ సమాధానం కంటే ముందు తన రీజనింగ్ను delta.reasoning_content లో పంపుతుంది. ఆ రెండు టెక్స్ట్లను వేరుగా ఉంచండి: రీజనింగ్ను వేరే, మడతపెట్టగల భాగంగా చూపండి, లేదా వదిలేయండి.
reasoning_effort విలువ off అయినప్పుడు, మరియు రిక్వెస్ట్లో response_format ఉన్నప్పుడు, హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్ ఏ రీజనింగ్నూ పంపవు.
shannon-2-lite మరియు shannon-2-pro కూడా సమాధానం ఇచ్చే ముందు రీజనింగ్ చేస్తాయి. ఈ ఎండ్పాయింట్లో అవి రీజనింగ్ చేస్తున్నప్పుడు : thinking కామెంట్ లైన్లను, ఆ తర్వాత సమాధానాన్ని పంపుతాయి.
reasoning_content OpenAI SDKల టైప్ చేసిన మోడల్స్లో లేదు. Python లో దాన్ని getattr(delta, "reasoning_content", None) తో చదవండి; JavaScript లో delta.reasoning_content అలాగే పనిచేస్తుంది.
టూల్ కాల్ డెల్టాలు
టూల్ కాల్ పూర్తిగా వస్తుంది: ప్రతి కాల్కు ఒక చంక్, దాని delta లో పూర్తి arguments string తో కాల్ ఉంటుంది. index సమాధానంలోని కాల్స్కు 0 నుండి నంబర్ ఇస్తుంది. arguments ను ముక్క ముక్కగా కలిపే కోడ్ మార్పు లేకుండా పనిచేస్తుంది, ఎందుకంటే అది ఒకే ముక్కను కలుపుతుంది.
{
"tool_calls": [
{
"index": 0,
"id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
"type": "function",
"function": {
"name": "get_weather",
"arguments": "{\"city\":\"Paris\"}"
}
}
]
} కాల్స్ తర్వాత, చివరి చంక్లో finish_reason విలువ tool_calls ఉంటుంది.
రిక్వెస్ట్లో tools ఉన్నప్పుడు, shannon-1.6-lite, shannon-1.6-pro మరియు shannon-coder-1 సమాధాన టెక్స్ట్ను సమాధానం చివరలో ఒకే డెల్టాగా పంపుతాయి.
చివరి చంక్
data: [DONE] ముందు ఉన్న చివరి చంక్లో ఖాళీ delta, finish_reason మరియు రిక్వెస్ట్ యొక్క usage ఉంటాయి, అన్నీ ఒకే చంక్లో. ప్రతి స్ట్రీమ్లో ఇది ఉంటుంది; మీకు stream_options అవసరం లేదు.
{
"id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
"object": "chat.completion.chunk",
"created": 1791625200,
"model": "shannon-3",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 1190,
"completion_tokens": 84,
"total_tokens": 1274
}
} హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్లో usage లో prompt_tokens_details.cached_tokens మరియు completion_tokens_details.reasoning_tokens కూడా ఉంటాయి.
శోధనలో ఏదైనా దొరికిన web_search: true రిక్వెస్ట్ తర్వాత, చివరి చంక్లో sources కూడా ఉంటుంది, దానికి ముందు ఉన్న ఒక చంక్ ఉటంకింపు గుర్తులను delta.annotations గా కలిగి ఉంటుంది. వెబ్ శోధన
| finish_reason | వివరణ | పంపేవి |
|---|---|---|
stop | మోడల్ తన సమాధానాన్ని ముగించింది, లేదా ఒక stop string కనిపించింది. | అన్ని మోడల్స్ |
tool_calls | సమాధానంలో ఒకటి లేదా అంతకంటే ఎక్కువ టూల్ కాల్స్ ఉన్నాయి. | అన్ని మోడల్స్ |
length | అవుట్పుట్ పరిమితి వద్ద సమాధానం కత్తిరించబడింది. | Shannon 3 ఫ్యామిలీ, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 |
usage ఫీల్డ్లు ఎండ్పాయింట్తో పాటు వివరించబడ్డాయి. Chat Completions
కీప్-అలైవ్ లైన్లు
మోడల్ పని చేస్తూ, ఇంకా పంపడానికి ఏమీ లేనప్పుడు, స్ట్రీమ్ కామెంట్ లైన్లను పంపుతుంది. వాటిలో డేటా ఉండదు. SSE పార్సర్ వాటిని దానంతట అదే దాటవేస్తుంది; ముడి లైన్లను చదివే కోడ్ కోలన్తో మొదలయ్యే ప్రతి లైన్ను దాటవేయాలి.
| లైన్ | పంపేవి | ఎప్పుడు |
|---|---|---|
: ping | Shannon 3 ఫ్యామిలీ, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | ప్రతి 15 సెకన్లకు. |
: keepalive | హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్ | మోడల్ పని చేస్తున్నంత సేపు ప్రతి 15 సెకన్లకు. |
: thinking | shannon-2-lite, shannon-2-pro | మోడల్ రీజనింగ్ చేస్తున్నప్పుడు. |
స్ట్రీమ్ లోపల ఎర్రర్లు
స్ట్రీమ్ మొదలైన తర్వాత దాని స్టేటస్ 200, కాబట్టి వైఫల్యం స్ట్రీమ్ లోపలే వస్తుంది: choices ఉండాల్సిన చోట error సభ్యుడు ఉన్న చంక్.
data: {"error":{"message":"The model backend failed to answer. Please retry.","type":"api_error","code":null,"param":null}}
data: {"choices":[{"index":0,"delta":{},"finish_reason":"stop"}],"usage":{"prompt_tokens":1190,"completion_tokens":12,"total_tokens":1202}}
data: [DONE] ఎర్రర్ చంక్ తర్వాత కూడా finish_reason మరియు usage ఉన్న చివరి చంక్, మరియు data: [DONE] వస్తాయి. ప్రతి చంక్లో error ఉందేమో తనిఖీ చేయండి. ఆ తనిఖీ లేకపోతే, మధ్యలో విఫలమైన సమాధానం పూర్తయినదిగా కనిపిస్తుంది.
| రకం | కోడ్ | మెసేజ్ | ఎప్పుడు |
|---|---|---|---|
api_error | The model backend failed to answer. Please retry. | మోడల్ విఫలమైంది, లేదా ఏమీ రాయలేదు. రిక్వెస్ట్ను మళ్ళీ పంపండి. | |
rate_limit_error | Shannon routes are temporarily busy. Please retry. | ఈ క్షణంలో మోడల్ బిజీగా ఉంది. కొన్ని సెకన్లు వేచి ఉండి రిక్వెస్ట్ను మళ్ళీ పంపండి. | |
invalid_request_error | context_length_exceeded | సంభాషణ మోడల్ కాంటెక్స్ట్ విండో కంటే పొడవుగా ఉంది. మళ్ళీ పంపే ముందు దాన్ని చిన్నది చేయండి. మెసేజ్ టెక్స్ట్ మారుతూ ఉంటుంది. |
హోస్ట్ చేసిన ఓపెన్-వెయిట్ మోడల్స్ error సభ్యుడిని type మరియు message తో మాత్రమే పంపుతాయి.
OpenAI Python మరియు JavaScript SDKలు మీరు ఇటరేట్ చేస్తున్నప్పుడు ఎర్రర్ చంక్ను API ఎర్రర్గా రైజ్ చేస్తాయి, కాబట్టి లూప్ను మీ సాధారణ ఎర్రర్ హ్యాండ్లింగ్లో ఉంచండి.
స్టేటస్ కోడ్లు, ఎర్రర్ బాడీ మరియు ఏవి మళ్ళీ ప్రయత్నించాలో అనే విషయాలకు వాటి స్వంత పేజీ ఉంది. ఎరర్ హ్యాండ్లింగ్
కనెక్షన్ను మూసివేయడం
కనెక్షన్ను మూసివేస్తే డెలివరీ ఆగుతుంది, రిక్వెస్ట్ కాదు. మోడల్ సమాధానాన్ని చివరి వరకు రాస్తుంది, మరియు మీరు మొత్తం చదివినట్లే రిక్వెస్ట్కు ఛార్జ్ చేయబడుతుంది. తక్కువ చెల్లించాలంటే తక్కువ అడగండి: దాన్ని అమలు చేసే మోడల్లో తక్కువ max_tokens సెట్ చేయండి.
స్ట్రీమ్ మీకు చేరే దారిలో కూడా ముందే ముగియవచ్చు, ఉదాహరణకు నెట్వర్క్ తెగినప్పుడు లేదా సర్వర్ అప్డేట్ అవుతున్నప్పుడు. అప్పుడు అది చివరి చంక్ లేకుండా మరియు data: [DONE] లేకుండా ఆగిపోతుంది. ఆ సమాధానాన్ని అసంపూర్ణంగా పరిగణించి రిక్వెస్ట్ను మళ్ళీ పంపండి.
SDK లేకుండా స్ట్రీమ్ చదవడం
సరైన రీడర్ ఐదు పనులు చేస్తుంది: స్ట్రీమ్ కంటే ముందు వచ్చే ఎర్రర్లను తన ఎర్రర్ హ్యాండ్లింగ్కు పంపుతుంది, బాడీని లైన్లుగా విభజిస్తుంది, కామెంట్ లైన్లను దాటవేస్తుంది, data: [DONE] వద్ద ఆగుతుంది, మరియు ప్రతి చంక్లో error ఉందేమో తనిఖీ చేస్తుంది.
import json
import requests
response = requests.post(
"https://api.shannon-ai.com/v1/chat/completions",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={
"model": "shannon-3",
"messages": [{"role": "user", "content": "Explain server-sent events in three sentences."}],
"stream": True,
},
stream=True,
)
# 1. Errors before the stream are plain JSON with their own status.
if response.status_code != 200:
raise RuntimeError(f"{response.status_code}: {response.text}")
answer, done = [], False
for raw in response.iter_lines(): # 2. one line at a time
line = raw.decode("utf-8")
if not line.startswith("data: "): # 3. empty lines and ": ping" comments
continue
data = line[len("data: "):]
if data == "[DONE]": # 4. the end of the stream
done = True
break
chunk = json.loads(data)
if "error" in chunk: # 5. a failure inside the stream
raise RuntimeError(chunk["error"]["message"])
delta = chunk["choices"][0]["delta"]
if delta.get("content"):
answer.append(delta["content"])
if chunk.get("usage"):
print(chunk["choices"][0]["finish_reason"], chunk["usage"])
if not done:
raise RuntimeError("the stream ended before [DONE]")
print("".join(answer)) const response = await fetch("https://api.shannon-ai.com/v1/chat/completions", {
method: "POST",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
model: "shannon-3",
messages: [{ role: "user", content: "Explain server-sent events in three sentences." }],
stream: true,
}),
});
// 1. Errors before the stream are plain JSON with their own status.
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const decoder = new TextDecoder();
let buffer = "";
let answer = "";
let done = false;
read: for await (const bytes of response.body) {
buffer += decoder.decode(bytes, { stream: true });
const lines = buffer.split("\n"); // 2. one line at a time
buffer = lines.pop(); // keep the unfinished line
for (const line of lines) {
if (!line.startsWith("data: ")) continue; // 3. empty lines and ": ping" comments
const data = line.slice(6);
if (data === "[DONE]") { // 4. the end of the stream
done = true;
break read;
}
const chunk = JSON.parse(data);
if (chunk.error) throw new Error(chunk.error.message); // 5. a failure inside the stream
const choice = chunk.choices[0];
if (choice.delta.content) answer += choice.delta.content;
if (chunk.usage) console.log(choice.finish_reason, chunk.usage);
}
}
if (!done) throw new Error("the stream ended before [DONE]");
console.log(answer); Python నమూనా requests ప్యాకేజీని ఉపయోగిస్తుంది. JavaScript నమూనా Node.js 18 లేదా ఆపై వెర్షన్లో నడుస్తుంది.
ఇతర ఫార్మాట్ల స్ట్రీమ్లు
Responses మరియు Messages ఎండ్పాయింట్లు కూడా స్ట్రీమ్ చేస్తాయి. వాటి ఫ్రేమ్లలో ఈవెంట్ పేరుతో event: లైన్, దాని JSON తో data: లైన్ ఉంటాయి. ప్రతి పేజీ తన ఈవెంట్లను క్రమంలో చూపిస్తుంది.
| స్ట్రీమ్లో | Chat Completions | Responses | Messages |
|---|---|---|---|
| ఫ్రేమ్లు | data: లైన్లు | event: మరియు data: లైన్లు | event: మరియు data: లైన్లు |
| రీజనింగ్ వచ్చేది | delta.reasoning_content | response.reasoning_summary_text.delta | thinking_delta |
| సమాధాన టెక్స్ట్ వచ్చేది | delta.content | response.output_text.delta | text_delta |
| Usage వచ్చేది | చివరి చంక్ | response.completed | message_delta |
| స్ట్రీమ్ ముగింపు | చివరి చంక్, తర్వాత data: [DONE] | response.completed | message_stop |