Chat Completions
Glacann POST /v1/chat/completions comhrá agus filleann sé an chéad teachtaireacht eile ón múnla i bhformáid OpenAI Chat Completions. Úsáid é ó aon SDK OpenAI nó thar HTTP simplí; is é an leathanach seo an tagairt réimse ar réimse.
POST https://api.shannon-ai.com/v1/chat/completions
Is é an t-iarratas is lú id múnla agus teachtaireacht úsáideora amháin.
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://api.shannon-ai.com/v1",
)
response = client.chat.completions.create(
model="shannon-3",
messages=[{"role": "user", "content": "Say hello in one sentence."}],
)
print(response.choices[0].message.content) import OpenAI from "openai";
const client = new OpenAI({
apiKey: "YOUR_API_KEY",
baseURL: "https://api.shannon-ai.com/v1",
});
const response = await client.chat.completions.create({
model: "shannon-3",
messages: [{ role: "user", content: "Say hello in one sentence." }],
});
console.log(response.choices[0].message.content); curl 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": "Say hello in one sentence."}]
}' Is réad JSON amháin an freagra:
{
"id": "chatcmpl-5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
"object": "chat.completion",
"created": 1791625200,
"model": "shannon-3",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "Hello, it is good to meet you.",
"reasoning_content": "The user wants a greeting in one sentence. Keep it short and friendly."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 1184,
"completion_tokens": 46,
"total_tokens": 1230
}
} Ceanntásca
Ceanntásca iarratais
| Ceanntásc | Luach | Cur síos |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | D'eochair API. Glactar le x-api-key: YOUR_API_KEY ina háit ar gach críochphointe. |
Content-Type | application/json | Riachtanach. Filleann aon luach eile 415. |
x-request-id | Roghnach. D'id féin don iarratas. Filleann sé gan athrú ar an bhfreagra. |
Ceanntásca freagra
| Ceanntásc | Cur síos |
|---|---|
x-request-id | Ar gach freagra, earráidí agus sruthanna san áireamh: an luach a sheol tú, nó 12 charachtar heicsidheachúlacha mura seol tú aon cheann. Luaigh é nuair a thuairiscíonn tú fadhb. |
content-type | application/json, nó text/event-stream nuair is true é stream. |
Réimsí an iarratais
Ní theastaíonn ach messages. Ainmníonn an colún Curtha i bhfeidhm ag na múnlaí ar a n-athraíonn réimse an freagra. Is iad na múnlaí open-weight óstáilte an dá id dhéag de liosta na múnlaí; is é teaghlach Shannon 3 shannon-3, shannon-3-pro, shannon-3.1 agus shannon-3.1-pro. Múnlaí agus praghsáil
| Réimse | Cineál | Réamhshocrú | Cur síos | Curtha i bhfeidhm ag |
|---|---|---|---|---|
model | string | shannon-1.6-lite | An múnla a fhreagraíonn: id ó liosta na múnlaí. Seol é le gach iarratas. Ní thugtar aird ar chás na litreacha. Filleann id nach bhfuil foilsithe 400 unknown model. | Gach múnla |
messages | array | Riachtanach. An comhrá, an teachtaireacht is sine ar dtús. Féach Teachtaireachtaí thíos. | Gach múnla | |
stream | boolean | false | Seolann true an freagra mar imeachtaí a sheoltar ón bhfreastalaí agus é á scríobh. | Gach múnla |
max_tokens | integer | 4096 | Uasteorainn an fhreagra, i token. Aistrítear luach lasmuigh de 1 go 65,536 isteach san raon sin. Is é freisin an méid a chuirtear i leataobh as d'iarmhéid agus an t-iarratas ag rith. Féach Fad an aschuir thíos. | Múnlaí open-weight óstáilte, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 |
max_completion_tokens | integer | Mar an gcéanna le max_tokens. Nuair a sheoltar an dá cheann, úsáidtear max_tokens. | Múnlaí open-weight óstáilte, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | |
temperature | number | Teocht samplála. Ar na múnlaí open-weight óstáilte is é 1 an réamhshocrú agus coinnítear luachanna idir 0 agus 2. | Múnlaí open-weight óstáilte, shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | |
top_p | number | 0.95 | Samplail núicléis. Coinnítear luachanna idir 0 agus 1. | Múnlaí open-weight óstáilte |
seed | integer | Síol an tsamplálaí, aon slánuimhir. Gan é, díorthaítear an síol ón múnla agus ón gcomhrá, mar sin úsáideann an t-iarratas céanna a sheoltar faoi dhó an síol céanna. | Múnlaí open-weight óstáilte | |
stop | string | array | Sreang nó eagar sreangacha. Úsáidtear suas le 4. Críochnaíonn an freagra roimh an gcéad cheann a thagann chun cinn; ní fhilltear an téacs stoptha féin. | Múnlaí open-weight óstáilte | |
reasoning_effort | string | high | Cé mhéad a dhéanann an múnla réasúnaíocht sula bhfreagraíonn sé: off, low, medium nó high. Ciallaíonn none agus minimal off, ciallaíonn default medium, ciallaíonn max high. Filleann aon luach eile 400. | Múnlaí open-weight óstáilte |
reasoning | object | An socrú céanna i bhfoirm réada: {"effort": "low"}. Nuair a sheoltar an dá cheann, úsáidtear reasoning_effort. | Múnlaí open-weight óstáilte | |
tools | array | Na feidhmeanna a fhéadfaidh an múnla a ghlaoch, gach ceann mar {"type": "function", "function": {"name", "description", "parameters"}}. Filleann glaonna an mhúnla in tool_calls; ritheann do chód iad. | Gach múnla | |
tool_choice | string | object | auto | Ligeann "auto" don mhúnla cinneadh a dhéanamh. Cuireann "required" iachall air uirlis a ghlaoch. Cuireann {"type": "function", "function": {"name": "…"}} iachall air an uirlis sin a ghlaoch. | Múnlaí open-weight óstáilte |
response_format | object | {"type": "json_object"} le haghaidh freagra JSON, nó {"type": "json_schema", "json_schema": {…}} le haghaidh freagra a leanann do scéim. | Gach leibhéal Shannon; múnlaí open-weight óstáilte mar atá liostaithe in aghaidh an id | |
web_search | boolean | false | Ligeann true don mhúnla cuardach a dhéanamh ar an ngréasán sula bhfreagraíonn sé. | shannon-1.6-*, shannon-2-*, teaghlach Shannon 3 |
Glactar le réimsí OpenAI eile, mar n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store agus prompt_cache_key, ionas go ritheann cód cliant atá ann cheana gan athrú. Ní athraíonn siad an freagra: tá rogha amháin ann i gcónaí, agus críochnaíonn sruth i gcónaí le húsáid.
Filleann réimse le cineál JSON mícheart, mar shampla "max_tokens": "100", 422. Mar an gcéanna le hiarratas gan messages.
Tá leathanach dá gcuid féin ag uirlisí, aschur struchtúrtha, réasúnaíocht agus cuardach gréasáin: Glaonna Feidhme, Aschuir Struchtúrtha, Iarracht réasúnaíochta, Insuite i Cuardach Gréasáin.
Iarratas le roghanna
Socraíonn an t-iarratas seo teachtaireacht chórais, na réimsí samplála agus an iarracht réasúnaíochta. Úsáideann sé múnla open-weight óstáilte, a chuireann iad uile i bhfeidhm.
from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_KEY",
base_url="https://api.shannon-ai.com/v1",
)
response = client.chat.completions.create(
model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
messages=[
{"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
{"role": "user", "content": "Why is the sky blue?"},
],
max_tokens=512,
temperature=0.3,
top_p=0.9,
seed=7,
stop=["\n\n"],
reasoning_effort="low",
)
message = response.choices[0].message
print(message.reasoning_content) # the reasoning
print(message.content) # the answer
print(response.usage) import OpenAI from "openai";
const client = new OpenAI({
apiKey: "YOUR_API_KEY",
baseURL: "https://api.shannon-ai.com/v1",
});
const response = await client.chat.completions.create({
model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
messages: [
{ role: "system", content: "You are a physics teacher. Answer in two sentences." },
{ role: "user", content: "Why is the sky blue?" },
],
max_tokens: 512,
temperature: 0.3,
top_p: 0.9,
seed: 7,
stop: ["\n\n"],
reasoning_effort: "low",
});
const message = response.choices[0].message;
console.log(message.reasoning_content); // the reasoning
console.log(message.content); // the answer
console.log(response.usage); curl https://api.shannon-ai.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
"messages": [
{"role": "system", "content": "You are a physics teacher. Answer in two sentences."},
{"role": "user", "content": "Why is the sky blue?"}
],
"max_tokens": 512,
"temperature": 0.3,
"top_p": 0.9,
"seed": 7,
"stop": ["\n\n"],
"reasoning_effort": "low"
}' Tá an cruth céanna ar an bhfreagra agus thuas. Cuireann a usage dhá mhionsonra leis ar na múnlaí open-weight óstáilte: na token prompt a léadh ón gcache agus na token a caitheadh ar réasúnaíocht.
{
"usage": {
"prompt_tokens": 31,
"completion_tokens": 62,
"total_tokens": 93,
"prompt_tokens_details": {
"cached_tokens": 0
},
"completion_tokens_details": {
"reasoning_tokens": 21
}
}
} Fad an aschuir
Déanann max_tokens dhá rud. Ar an gcéad dul síos, is é líon na token a chuirtear i leataobh as d'iarmhéid nuair a thosaíonn an t-iarratas. Nuair a bhíonn an freagra críochnaithe, cuirtear na token a d'úsáid an t-iarratas in ionad an méid sin. Má tá max_tokens níos mó ná an méid atá fágtha de d'iarmhéid, filleann an t-iarratas 429 Quota exceeded fiú dá n-oirfeadh an freagra féin. Seol max_tokens níos ísle chun níos lú a chur i leataobh.
Comhairtear shannon-coder-1 ar bhealach difriúil ar an gcríochphointe seo: is glao Shannon Coder de do phlean gach iarratas, agus ní chuirtear aon token i leataobh dó. Teorainneacha agus iarmhéid
Ar an dara dul síos, cuireann sé teorainn le fad an fhreagra ar na múnlaí seo:
| Múnlaí | Cad a dhéanann max_tokens |
|---|---|
shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 | Stopann an freagra nuair a shroicheann sé an teorainn. Ansin críochnaíonn sruth le finish_reason length. |
| Múnlaí open-weight óstáilte | Stopann téacs an fhreagra ag max_tokens. Ní chomhairtear réasúnaíocht ina choinne. Gníomhaíonn luachanna faoi bhun 256 mar 256. |
Gan max_tokens ná max_completion_tokens, is é 4,096 an luach. Ar shannon-coder-1 is é 65,536 é.
Teachtaireachtaí
Is réad é gach teachtaireacht le role agus content. Is sreang é content, nó eagar codanna nuair a iompraíonn an teachtaireacht níos mó ná téacs.
| Ról | Cur síos | Curtha i bhfeidhm ag |
|---|---|---|
system | Treoracha don mhúnla. Cuir ar dtús é. Ar leibhéil Shannon is í an chéad teachtaireacht system an ceann a úsáidtear. | Múnlaí open-weight óstáilte, shannon-1.6-*, shannon-2-*, shannon-coder-1 |
developer | Léitear mar system. | Múnlaí open-weight óstáilte |
user | An rud a iarrann tú. Ar leibhéil Shannon is í an teachtaireacht user dheireanach an prompt agus is í an stair na teachtaireachtaí roimpi. | Gach múnla |
assistant | Freagraí níos luaithe an mhúnla. Coinnigh a tool_calls nuair a sheolann tú toradh uirlise ina dhiaidh. | Gach múnla |
tool | Toradh glaoigh uirlise: tá id an ghlaoigh i tool_call_id agus an toradh mar shreang in content. | Gach múnla |
Le id de theaghlach Shannon 3, cuir treoracha atá le comhlíonadh isteach sa teachtaireacht user.
Ar leibhéil Shannon filleann iarratas gan téacs úsáideora agus gan tools 400 No user message provided.
Codanna ábhair
| Cuid | Cur síos | Ar fáil ar |
|---|---|---|
{"type": "text", "text": "…"} | Téacs simplí. | Gach múnla |
{"type": "image_url", "image_url": {"url": "…"}} | Íomhá, mar URL data: le hábhar base64 nó mar URL http(s). | Teaghlach Shannon 3, shannon-1.6-lite, shannon-1.6-pro, agus na múnlaí open-weight óstáilte a liostaíonn ionchur íomhá |
{"type": "file", "source": {"type": "base64", "media_type": "application/pdf", "data": "…"}} | Doiciméad (PDF, Word, PowerPoint nó Excel), mar base64 nó trí URL. | Teaghlach Shannon 3 |
Tá leathanach dá gcuid féin ag méideanna, teorainneacha agus an liosta iomlán foirmeacha. Íomhánna agus comhaid
An réad freagra
| Réimse | Cineál | Cur síos |
|---|---|---|
id | string | chatcmpl- agus 32 charachtar heicsidheachúlacha ina dhiaidh. |
object | string | chat.completion i gcónaí. |
created | integer | Am an fhreagra, i soicindí Unix. |
model | string | An id canónach den mhúnla a d'fhreagair. Is féidir leis a bheith difriúil ó thaobh litrithe ón id a sheol tú. |
choices | array | Rogha amháin go díreach i gcónaí, le index 0. |
choices[0].message.role | string | assistant i gcónaí. |
choices[0].message.content | string | null | Téacs an fhreagra. Le tool_calls is null é ar leibhéil Shannon; féadfaidh na múnlaí open-weight óstáilte téacs a sheoladh in aice leis na glaonna. |
choices[0].message.reasoning_content | string | null | An réasúnaíocht a scríobh an múnla roimh an bhfreagra, nó null mura bhfuil aon cheann ann. |
choices[0].message.tool_calls | array | Ann amháin nuair a ghlaonn an múnla uirlisí. Tá id, type function, agus function le name agus na arguments mar shreang JSON i ngach iontráil. |
choices[0].message.annotations | array | Ní bhíonn ann ach ar iarratas a bhfuil web_search: true air agus gur aimsigh a chuardach rud éigin. url_citation amháin do gach foinse a ainmníonn marcóir i content, le url, title, start_index agus end_index (suíomh an mharcóra, arna chomhaireamh i gcarachtair, gan an deireadh a chuimsiú). |
choices[0].finish_reason | string | Cén fáth ar tháinig deireadh leis an bhfreagra. Féach Cúiseanna críochnaithe. |
usage | object | Token an iarratais. Féach Úsáid. |
sources | array | Ní bhíonn ann ach ar iarratas a bhfuil web_search: true air agus gur aimsigh a chuardach rud éigin: na torthaí a tugadh don mhúnla, gach ceann le index, title agus url. Is é [1] sa fhreagra an iontráil a bhfuil index 1 aici. |
Cúiseanna críochnaithe
| finish_reason | Cur síos |
|---|---|
stop | Chríochnaigh an múnla a fhreagra, nó tháinig sreang stop chun cinn. |
tool_calls | Glaonn an múnla uirlis amháin nó níos mó. Rith iad agus seol na torthaí i dteachtaireachtaí tool. |
length | Gearradh an freagra ag an teorainn aschuir. Tuairiscítear i sruthanna shannon-1.6-lite, shannon-1.6-pro, shannon-coder-1 agus teaghlach Shannon 3. |
Tuairiscíonn freagra nach sruthaítear stop nó tool_calls.
Úsáid
| Réimse | Cineál | Cur síos | Ar fáil ar |
|---|---|---|---|
usage.prompt_tokens | integer | Token ionchuir. | Gach múnla |
usage.completion_tokens | integer | Token aschuir: réasúnaíocht, freagra agus glaonna uirlisí le chéile. | Gach múnla |
usage.total_tokens | integer | prompt_tokens móide completion_tokens. | Gach múnla |
usage.prompt_tokens_details.cached_tokens | integer | An chuid de prompt_tokens a léadh ón gcache prompt. | Múnlaí open-weight óstáilte |
usage.completion_tokens_details.reasoning_tokens | integer | An chuid de completion_tokens a caitheadh ar réasúnaíocht. | Múnlaí open-weight óstáilte |
Ar na múnlaí open-weight óstáilte, is iad prompt_tokens do theachtaireachtaí agus sainmhínithe uirlisí arna gcomhaireamh le tokenizer an mhúnla féin, móide token aon íomhá. Filleann na críochphointí comhairimh token an uimhir chéanna sula seolann tú. Comhaireamh token
Ar leibhéil Shannon, comhaireann prompt_tokens gach rud a léigh an múnla chun an freagra a scríobh, mar sin tá sé níos mó ná téacs do theachtaireachtaí amháin.
Sruthú
Le stream socraithe go true tagann an freagra mar imeachtaí chat.completion.chunk agus críochnaíonn sé le data: [DONE]. Tá finish_reason agus usage sa phíosa deireanach roimhe; ní theastaíonn aon stream_options. Tá leathanach dá gcuid féin ag cruthanna na bpíosaí, línte keep-alive agus earráidí laistigh de shruth. Sruthú
Earráidí
Is réad JSON é earráid le ball error. Ritheann seiceálacha san ord seo: eochair API, corp iarratais, id múnla, ansin iarmhéid. Liostaíonn an tábla an méid a fhilleann an críochphointe seo is minice. Tá leathanach dá chuid féin ag an liosta iomlán, leis an méid ar cheart triail eile a bhaint as. Láimhseáil Earráide
{
"error": {
"type": "invalid_request_error",
"message": "unknown model: no-such-model"
}
} | Stádas | Cineál | Teachtaireacht | Cathain |
|---|---|---|---|
401 | authentication_error | Missing authenticationInvalid API key | Níor seoladh aon eochair API, nó tá an eochair anaithnid nó cúlghairthe. |
400 | invalid_request_error | unknown model: <id> | Ní id foilsithe é model. |
400 | invalid_request_error | No user message provided | Leibhéil Shannon: níl aon téacs úsáideora ná tools san iarratas. |
400 | invalid_request_error | <id> does not accept image input | Seoladh cuid íomhá chuig múnla open-weight óstáilte gan ionchur íomhá. |
400 | invalid_request_error | <id> does not accept response_format | Seoladh response_format chuig múnla open-weight óstáilte gan aschur struchtúrtha. |
400 | invalid_request_error | unknown reasoning effort '<value>'; expected off, low, medium or high | Tá luach lasmuigh den liosta i reasoning_effort. |
422 | invalid_request_error | Failed to deserialize the JSON body into the target type: … | Tá messages ar iarraidh, nó tá cineál JSON mícheart ar réimse. |
429 | rate_limit_error | Quota exceeded. Upgrade your plan at shannon-ai.com/plan | Tá max_tokens níos mó ná an méid atá fágtha de d'iarmhéid. |
429 | rate_limit_error | Too many requests. Retry in <n>s. | Cosaint tuile: níos mó ná 120 iarratas in aon nóiméad amháin ar do chuntas. |
500 | server_error | The model backend failed to answer. Please retry. | Níor tháirg an múnla freagra. Seol an t-iarratas arís. |
502 | api_error | The model backend failed to answer. Please retry. | An rud céanna, ar theaghlach Shannon 3 agus ar na múnlaí open-weight óstáilte. |