Chat Completions

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

Хамгийн жижиг хүсэлт нь загварын id болон нэг хэрэглэгчийн мессеж.

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 объект:

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

Header-ууд

Хүсэлтийн header-ууд

Хариултын header-ууд

Хүсэлтийн талбарууд

Зөвхөн messages заавал шаардлагатай. Хэрэгжүүлэгч багана нь талбар хариултыг өөрчилдөг загваруудыг нэрлэнэ. Hosted open-weight загварууд нь загварын жагсаалтын арван хоёр id; Shannon 3 гэр бүл нь shannon-3, shannon-3-pro, shannon-3.1 болон shannon-3.1-pro. Загвар ба үнэ

n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ба prompt_cache_key зэрэг OpenAI-ийн бусад талбаруудыг хүлээн авдаг тул одоо байгаа клиент код өөрчлөлтгүй ажиллана. Эдгээр нь хариултыг өөрчлөхгүй: choice үргэлж нэг байх бөгөөд stream үргэлж usage-ээр төгсдөг.

JSON төрөл буруу талбар, жишээ нь "max_tokens": "100", 422 буцаана. messages-гүй хүсэлт ч мөн адил.

Tools, бүтэцтэй гаралт, reasoning ба вэб хайлт тус бүр өөрийн хуудастай: Функц дуудлага, Бүтэцтэй гаралт, Reasoning effort, Вэб хайлт.

Сонголттой хүсэлт

Энэ хүсэлт system мессеж, sampling талбарууд ба reasoning effort-ийг тогтооно. Бүгдийг хэрэгжүүлдэг hosted 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"
  }'

Хариулт дээрхтэй ижил хэлбэртэй. Hosted open-weight загварууд дээр түүний usage хоёр нэмэлт мэдээлэл агуулна: кэшээс уншсан prompt токен ба reasoning-д зарцуулсан токен.

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

Гаралтын урт

max_tokens хоёр зүйл хийдэг. Нэгдүгээрт, хүсэлт эхлэх үед таны үлдэгдлээс нөөцлөгдөх токены тоо юм. Хариулт дуусахад тэр хэмжээг хүсэлтийн ашигласан токеноор солино. Хэрэв max_tokens таны үлдэгдлээс их бол хариулт өөрөө багтах байсан ч хүсэлт 429 Quota exceeded буцаана. Бага нөөцлөхийн тулд бага max_tokens илгээнэ үү.

shannon-coder-1-ийг энэ endpoint дээр өөрөөр тоолно: хүсэлт бүр таны багцын Shannon Coder дуудлагын нэг бөгөөд түүнд токен нөөцлөгдөхгүй. Хязгаар ба үлдэгдэл

Хоёрдугаарт, эдгээр загвар дээр хариултын уртыг хязгаарлана:

max_tokens эсвэл max_completion_tokens-гүй бол утга 4,096. shannon-coder-1 дээр 65,536.

Мессежүүд

Мессеж бүр role ба content-той объект. content нь string, эсвэл мессеж текстээс илүүг агуулах үед хэсгүүдийн массив.

Shannon 3 гэр бүлийн id-тай бол заавал мөрдөх зааврыг user мессежид оруулна уу.

Shannon түвшингүүд дээр хэрэглэгчийн текст ч, tools ч байхгүй хүсэлт 400 No user message provided буцаана.

Content хэсгүүд

Хэмжээ, хязгаар болон хэлбэрүүдийн бүрэн жагсаалт тусдаа хуудастай. Зураг ба файл

Хариултын объект

Дуусах шалтгаанууд

Stream биш хариулт stop эсвэл tool_calls гэж мэдээлнэ.

Usage

Hosted open-weight загварууд дээр prompt_tokens нь таны мессеж болон tool тодорхойлолтыг загварын өөрийн tokenizer-ээр тоолсон, дээр нь зургийн токенууд. Токен тоолох endpoint-ууд илгээхээс өмнө ижил тоог буцаана. Токен тоолох

Shannon түвшингүүд дээр prompt_tokens нь загвар хариулт бичихдээ уншсан бүхнийг тоолдог тул зөвхөн таны мессежийн текстээс их байна.

Streaming

stream-ийг true болгосон үед хариулт chat.completion.chunk event хэлбэрээр ирж, data: [DONE]-оор төгсөнө. Түүний өмнөх сүүлийн chunk finish_reason ба usage-ийг агуулна; stream_options шаардлагагүй. Chunk-ийн хэлбэр, keep-alive мөр, stream доторх алдаа тусдаа хуудастай. Дамжуулалт

Алдаа

Алдаа нь error гишүүнтэй JSON объект. Шалгалт дараах дарааллаар явагдана: API түлхүүр, хүсэлтийн body, загварын id, дараа нь үлдэгдэл. Хүснэгтэд энэ endpoint-ийн хамгийн их буцаадаг алдаа байна. Бүрэн жагсаалт, юуг дахин оролдохыг тусдаа хуудсанд харуулсан. Алдаа боловсруулах

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