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

Сарлавҳаҳо

Сарлавҳаҳои дархост

Сарлавҳаҳои ҷавоб

Майдонҳои дархост

Танҳо messages ҳатмист. Сутуни Татбиқ мекунад моделҳоеро номбар мекунад, ки дар онҳо майдон ҷавобро тағйир медиҳад. Моделҳои open-weight-и хостшуда дувоздаҳ id-и рӯйхати моделҳо мебошанд; оилаи Shannon 3 shannon-3, shannon-3-pro, shannon-3.1 ва shannon-3.1-pro мебошад. Моделҳо ва нархҳо

Дигар майдонҳои OpenAI, ба монанди n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ва prompt_cache_key, қабул мешаванд, то коди мавҷудаи клиент бетағйир кор кунад. Онҳо ҷавобро тағйир намедиҳанд: ҳамеша як choice вуҷуд дорад ва ҷараён ҳамеша бо usage анҷом меёбад.

Майдон бо навъи JSON-и нодуруст, масалан "max_tokens": "100", 422 бармегардонад. Дархост бе messages низ ҳамин тавр.

Абзорҳо, баромади сохторӣ, reasoning ва ҷустуҷӯи веб ҳар кадом саҳифаи худро доранд: Даъвати функсия, Баромадҳои сохторӣ, Сатҳи кӯшиши reasoning, Ҷустуҷӯи веб.

Дархост бо имконот

Ин дархост паёми system, майдонҳои намунагирӣ ва сатҳи кӯшиши 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, ки аз кэш хонда шудаанд, ва токенҳое, ки барои 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 сатр аст, ё массиви қисмҳо вақте ки паём бештар аз матн дорад.

Бо id-и оилаи Shannon 3 дастурҳоеро, ки бояд риоя шаванд, ба паёми user гузоред.

Дар сатҳҳои Shannon дархост бе матни корбар ва бе tools 400 No user message provided бармегардонад.

Қисмҳои мундариҷа

Андозаҳо, маҳдудиятҳо ва рӯйхати пурраи шаклҳо саҳифаи худро доранд. Тасвирҳо ва файлҳо

Объекти ҷавоб

Сабабҳои анҷом

Ҷавоби бе streaming stop ё tool_calls-ро ҳисобот медиҳад.

Usage

Дар моделҳои open-weight-и хостшуда prompt_tokens паёмҳо ва таърифҳои абзори шумост, ки бо токенайзери худи модел ҳисоб шудаанд, илова бар токенҳои тасвирҳо. Endpoint-ҳои ҳисоби токен пеш аз фиристодани шумо ҳамон рақамро бармегардонанд. Ҳисоби токенҳо

Дар сатҳҳои Shannon prompt_tokens ҳар чизеро, ки модел барои навиштани ҷавоб хонд, ҳисоб мекунад, бинобар ин он аз танҳо матни паёмҳои шумо калонтар аст.

Streaming

Вақте ки stream ба true гузошта шудааст, ҷавоб ҳамчун рӯйдодҳои chat.completion.chunk меояд ва бо data: [DONE] анҷом меёбад. Чанки охирини пеш аз он finish_reason ва usage-ро дорад; stream_options лозим нест. Шаклҳои чанкҳо, хатҳои keep-alive ва хатогиҳо дар дохили ҷараён саҳифаи худро доранд. Стриминг

Хатогиҳо

Хатогӣ объекти JSON бо узви error аст. Санҷишҳо бо ин тартиб иҷро мешаванд: калиди API, бадани дархост, id-и модел, баъд баланс. Ҷадвал он чиро нишон медиҳад, ки ин endpoint аксар вақт бармегардонад. Рӯйхати пурра, бо нишони он ки чӣ бояд такрор шавад, саҳифаи худро дорад. Идораи хатогиҳо

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