Chat Completions

POST https://api.shannon-ai.com/v1/chat/completions

အသေးငယ်ဆုံး request တွင် model id တစ်ခုနှင့် user message တစ်ခုသာ ပါသည်။

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."}]
  }'

ပြန်ကြားချက်သည် JSON object တစ်ခုဖြစ်သည်-

{
  "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
  }
}

Headers

Request headers

ပြန်ကြားချက် headers

Request fields

messages တစ်ခုတည်းသာ လိုအပ်သည်။ Applied by ကော်လံတွင် field တစ်ခုက reply ကို ပြောင်းလဲစေသည့် model များကို ဖော်ပြထားသည်။ Host လုပ်ထားသော open-weight မော်ဒယ်များသည် model စာရင်းရှိ id ဆယ့်နှစ်ခု ဖြစ်သည်။ Shannon 3 မိသားစုမှာ shannon-3၊ shannon-3-pro၊ shannon-3.1 နှင့် shannon-3.1-pro ဖြစ်သည်။ Model များနှင့် ဈေးနှုန်း

n၊ user၊ stream_options၊ parallel_tool_calls၊ presence_penalty၊ frequency_penalty၊ logit_bias၊ logprobs၊ metadata၊ store နှင့် prompt_cache_key ကဲ့သို့ အခြား OpenAI field များကို လက်ခံသဖြင့် ရှိပြီးသား client code များ ပြောင်းလဲမှုမလိုဘဲ အလုပ်လုပ်သည်။ ၎င်းတို့သည် reply ကို မပြောင်းလဲစေပါ- choice တစ်ခုတည်း အမြဲရှိပြီး stream သည် usage ဖြင့် အမြဲအဆုံးသတ်သည်။

JSON type မှားနေသော field၊ ဥပမာ "max_tokens": "100" သည် 422 ကို ပြန်ပေးသည်။ messages မပါသော request သည်လည်း ထိုနည်းတူ ဖြစ်သည်။

Tools၊ structured output၊ reasoning နှင့် web search တို့တွင် ကိုယ်ပိုင်စာမျက်နှာ တစ်ခုစီရှိသည်- လုပ်ဆောင်ချက် ခေါ်ဆိုမှု, ဖွဲ့စည်းထားသော အထွက်, Reasoning effort, ဝဘ်ရှာဖွေမှု.

Options ပါသော request

ဤ request သည် system message၊ sampling field များနှင့် reasoning effort ကို သတ်မှတ်သည်။ ၎င်းတို့အားလုံးကို အသုံးပြုသော host လုပ်ထားသည့် open-weight model တစ်ခုကို သုံးထားသည်။

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"
  }'

ပြန်ကြားချက်သည် အထက်ပါအတိုင်း ပုံစံတူသည်။ Host လုပ်ထားသော open-weight models များတွင် ၎င်း၏ usage သည် အသေးစိတ်နှစ်ခု ထပ်ထည့်သည်- cache မှ ဖတ်ထားသော prompt tokens နှင့် reasoning အတွက် သုံးစွဲသော tokens။

{
  "usage": {
    "prompt_tokens": 31,
    "completion_tokens": 62,
    "total_tokens": 93,
    "prompt_tokens_details": {
      "cached_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 21
    }
  }
}

Output အရှည်

max_tokens သည် အလုပ်နှစ်ခု လုပ်သည်။ ပထမ၊ request စတင်သည့်အခါ သင့် လက်ကျန်ငွေ မှ ဖယ်ထားသော tokens အရေအတွက် ဖြစ်သည်။ ပြန်ကြားချက် ပြီးမြောက်သောအခါ ထိုပမာဏကို request အမှန်တကယ်သုံးခဲ့သော tokens ဖြင့် အစားထိုးသည်။ max_tokens သည် သင့် လက်ကျန်ငွေ ၏ ကျန်ရှိသည်ထက် ပိုကြီးလျှင် ပြန်ကြားချက်ကိုယ်တိုင် ဆန့်မည်ဖြစ်စေကာမူ request သည် 429 Quota exceeded ကို ပြန်ပေးသည်။ ဖယ်ထားမှုနည်းစေရန် max_tokens ကို နိမ့်နိမ့်ပို့ပါ။

ဤ endpoint တွင် shannon-coder-1 ကို ကွဲပြားစွာ ရေတွက်သည်- request တစ်ခုစီသည် သင့် plan ၏ Shannon Coder calls တစ်ခုဖြစ်ပြီး ၎င်းအတွက် tokens မထားရှိပါ။ ကန့်သတ်ချက်များနှင့် လက်ကျန်ငွေ

ဒုတိယ၊ ဤ model များတွင် ပြန်ကြားချက်၏ အရှည်ကို ကန့်သတ်သည်-

max_tokens သို့မဟုတ် max_completion_tokens မပါလျှင် တန်ဖိုးမှာ 4,096 ဖြစ်သည်။ shannon-coder-1 တွင် 65,536 ဖြစ်သည်။

Messages

message တစ်ခုစီသည် role နှင့် content ပါသော object ဖြစ်သည်။ content သည် စာကြောင်းတစ်ခု၊ သို့မဟုတ် message တွင် စာသားထက်ပိုပါလျှင် အစိတ်အပိုင်းများ၏ array ဖြစ်သည်။

Shannon 3 မိသားစု id ဖြင့် မဖြစ်မနေ လိုက်နာရမည့် ညွှန်ကြားချက်များကို user message ထဲတွင် ထည့်ပါ။

Shannon အဆင့်များတွင် user စာသားမပါဘဲ tools လည်း မပါသော request သည် 400 No user message provided ကို ပြန်ပေးသည်။

Content parts

အရွယ်အစားများ၊ ကန့်သတ်ချက်များနှင့် ပုံစံအားလုံးစာရင်းတို့တွင် ကိုယ်ပိုင်စာမျက်နှာရှိသည်။ ပုံများနှင့် ဖိုင်များ

ပြန်ကြားချက် object

ပြီးဆုံးရခြင်း အကြောင်းရင်းများ

stream မလုပ်သော ပြန်ကြားချက်သည် stop သို့မဟုတ် tool_calls ကို ဖော်ပြသည်။

အသုံးပြုမှု

Host လုပ်ထားသော open-weight models များတွင် prompt_tokens သည် သင့် messages နှင့် tool အဓိပ္ပာယ်ဖွင့်ဆိုချက်များကို model ၏ ကိုယ်ပိုင် tokenizer ဖြင့် ရေတွက်ထားသည့်အပြင် ပုံများ၏ tokens ကိုပါ ပေါင်းထားသည်။ Token ရေတွက်သော endpoint များသည် မပို့မီ တူညီသောနံပါတ်ကို ပြန်ပေးသည်။ Token ရေတွက်ခြင်း

Shannon အဆင့်များတွင် prompt_tokens သည် ပြန်ကြားချက်ရေးရန် model ဖတ်ခဲ့သည့် အရာအားလုံးကို ရေတွက်သဖြင့် သင့် messages ၏ စာသားတစ်ခုတည်းထက် ပိုကြီးသည်။

Streaming

stream ကို true ဟု သတ်မှတ်လျှင် ပြန်ကြားချက်သည် chat.completion.chunk events အဖြစ် ရောက်လာပြီး data: [DONE] ဖြင့် အဆုံးသတ်သည်။ ၎င်းမတိုင်မီ နောက်ဆုံး chunk တွင် finish_reason နှင့် usage ပါသည်၊ stream_options မလိုအပ်ပါ။ chunk ပုံစံများ၊ keep-alive စာကြောင်းများနှင့် stream အတွင်းရှိ အမှားများတွင် ကိုယ်ပိုင်စာမျက်နှာရှိသည်။ စตรีမင်း

အမှားများ

Error ဆိုသည်မှာ error member ပါသော JSON object တစ်ခုဖြစ်သည်။ စစ်ဆေးမှုများကို ဤအစီအစဉ်အတိုင်း run သည်- API key၊ request body၊ model id၊ ထို့နောက် လက်ကျန်ငွေ။ ဇယားတွင် ဤ endpoint က အများဆုံးပြန်ပေးသော error များကို ဖော်ပြထားသည်။ ထပ်ကြိုးစားရမည့် အရာများပါသည့် စာရင်းအပြည့်အစုံအတွက် သီးခြားစာမျက်နှာ ရှိသည်။ အမှားကိုင်တွယ်မှု

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: no-such-model"
  }
}