Chat Completions

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

request តូចបំផុតគឺ model id និងសារ user មួយ។

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

Header របស់ request

Header របស់ចម្លើយ

Request field

មានតែ messages ប៉ុណ្ណោះដែលត្រូវការ។ ជួរឈរ អនុវត្តដោយ ប្រាប់ម៉ូដែលដែល field ផ្លាស់ប្តូរចម្លើយ។ ម៉ូដែល open-weight ដែលបង្ហោះគឺ id ទាំងដប់ពីរក្នុងបញ្ជីម៉ូដែល; ក្រុម Shannon 3 គឺ shannon-3, shannon-3-pro, shannon-3.1 និង shannon-3.1-pro។ ម៉ូដែល និងតម្លៃ

field OpenAI ផ្សេងទៀត ដូចជា n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store និង prompt_cache_key ត្រូវបានទទួលយក ដើម្បីឱ្យកូដ client ដែលមានស្រាប់ដំណើរការដូចដើម។ ពួកវាមិនផ្លាស់ប្តូរចម្លើយទេ៖ ជានិច្ចមាន choice តែមួយ ហើយ stream តែងបញ្ចប់ដោយ usage។

field ដែលមានប្រភេទ JSON មិនត្រឹមត្រូវ ឧទាហរណ៍ "max_tokens": "100" ត្រឡប់ 422។ request ដែលគ្មាន messages ក៏ដូច្នោះដែរ។

Tools, structured output, reasoning និងការស្វែងរកតាមវេប នីមួយៗមានទំព័រផ្ទាល់ខ្លួន៖ ការហៅមុខងារ, លទ្ធផលមានរចនាសម្ព័ន្ធ, កម្រិត reasoning, ស្វែងរកវេបក្នុងស្រាប់.

Request ដែលមានជម្រើស

Request នេះកំណត់សារ system, field sampling និងកម្រិត reasoning។ វាប្រើម៉ូដែល open-weight ដែលបង្ហោះ ដែលអនុវត្តទាំងអស់នោះ។

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

ចម្លើយមានរូបរាងដូចខាងលើ។ usage របស់វាបន្ថែមព័ត៌មានលម្អិតពីរលើម៉ូដែល open-weight ដែលបង្ហោះ៖ prompt token ដែលអានពី cache និង token ដែលចំណាយលើ reasoning។

{
  "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 ធ្វើពីរយ៉ាង។ ទីមួយ វាជាចំនួន token ដែលត្រូវបម្រុងទុកពីសមតុល្យរបស់អ្នកនៅពេល request ចាប់ផ្តើម។ នៅពេលចម្លើយពេញលេញ ចំនួននោះត្រូវបានជំនួសដោយ token ដែល request បានប្រើ។ ប្រសិនបើ max_tokens ធំជាងអ្វីដែលនៅសល់ក្នុងសមតុល្យរបស់អ្នក request ត្រឡប់ 429 Quota exceeded ទោះបីចម្លើយខ្លួនឯងអាចសមក៏ដោយ។ ផ្ញើ max_tokens ទាបជាងដើម្បីបម្រុងទុកតិចជាង។

shannon-coder-1 ត្រូវបានរាប់ខុសគ្នានៅលើ endpoint នេះ៖ រាល់ request ជាការហៅ Shannon Coder មួយរបស់គម្រោងអ្នក ហើយគ្មាន token ត្រូវបម្រុងទុកសម្រាប់វាទេ។ ដែនកំណត់ និងសមតុល្យ

ទីពីរ វាកំណត់ប្រវែងនៃចម្លើយលើម៉ូដែលទាំងនេះ៖

បើគ្មាន max_tokens ឬ max_completion_tokens តម្លៃគឺ 4,096។ លើ shannon-coder-1 វាគឺ 65,536។

សារ

សារនីមួយៗជា object ដែលមាន role និង content។ content ជា string ឬអារេនៃផ្នែក នៅពេលសារមានច្រើនជាងអត្ថបទ។

ជាមួយ id ក្នុងក្រុម Shannon 3 សូមដាក់ការណែនាំដែលត្រូវតែគោរព ចូលក្នុងសារ user។

លើកម្រិត Shannon request ដែលគ្មានអត្ថបទ user និងគ្មាន tools ត្រឡប់ 400 No user message provided។

ផ្នែកនៃមាតិកា

ទំហំ ដែនកំណត់ និងបញ្ជីពេញលេញនៃទម្រង់មានទំព័រផ្ទាល់ខ្លួន។ រូបភាព និងឯកសារ

Object ចម្លើយ

មូលហេតុនៃការបញ្ចប់

ចម្លើយដែលមិនមែន stream រាយការណ៍ stop ឬ tool_calls។

ការប្រើប្រាស់

លើម៉ូដែល open-weight ដែលបង្ហោះ prompt_tokens គឺសារ និងនិយមន័យ tool របស់អ្នក ដែលរាប់ដោយ tokenizer របស់ម៉ូដែលខ្លួនឯង បូកនឹង token នៃរូបភាពណាមួយ។ endpoint រាប់ token ត្រឡប់លេខដូចគ្នាមុនអ្នកផ្ញើ។ ការរាប់ token

លើកម្រិត Shannon prompt_tokens រាប់អ្វីៗទាំងអស់ដែលម៉ូដែលបានអានដើម្បីសរសេរចម្លើយ ដូច្នេះវាធំជាងអត្ថបទនៃសាររបស់អ្នកតែម្នាក់ឯង។

Streaming

ជាមួយ stream កំណត់ជា true ចម្លើយមកដល់ជា event chat.completion.chunk ហើយបញ្ចប់ដោយ data: [DONE]។ chunk ចុងក្រោយមុនវាមាន finish_reason និង usage; មិនត្រូវការ stream_options ទេ។ រូបរាង chunk បន្ទាត់ keep-alive និងកំហុសក្នុង stream មានទំព័រផ្ទាល់ខ្លួន។ ស្ទ្រីម

កំហុស

កំហុសគឺជា JSON object ដែលមានសមាជិក error។ ការត្រួតពិនិត្យដំណើរការតាមលំដាប់នេះ៖ API key, ខ្លឹមសារ request, model id បន្ទាប់មកសមតុល្យ។ តារាងរាយអ្វីដែល endpoint នេះឆ្លើយតបញឹកញាប់បំផុត។ បញ្ជីពេញលេញ ជាមួយអ្វីដែលត្រូវព្យាយាមម្តងទៀត មានទំព័រផ្ទាល់ខ្លួន។ ការគ្រប់គ្រងកំហុស

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