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

Headers

Հարցման header-ներ

Պատասխանի header-ներ

Հարցման դաշտեր

Պարտադիր է միայն messages-ը։ Կիրառվում է սյունը նշում է այն մոդելները, որոնց վրա դաշտը փոխում է պատասխանը։ Hosted 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 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-ը ավելացնում է երկու մանրամասն՝ cache-ից կարդացված 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-ը տող է, կամ մասերի զանգված, երբ հաղորդագրությունը տեքստից բացի այլ բան է կրում։

Shannon 3 ընտանիքի id-ի դեպքում պարտադիր հրահանգները դրեք user հաղորդագրության մեջ։

Shannon մակարդակներում օգտատիրոջ տեքստ և tools չունեցող հարցումը վերադարձնում է 400 No user message provided։

Բովանդակության մասեր

Չափերը, սահմանաչափերը և ձևերի լրիվ ցանկն ունեն իրենց էջը։ Պատկերներ և ֆայլեր

Պատասխանի օբյեկտ

Ավարտի պատճառներ

Հոսքով չուղարկված պատասխանը նշում է stop կամ tool_calls։

Usage

Hosted open-weight մոդելների վրա prompt_tokens-ը ձեր հաղորդագրություններն ու գործիքների սահմանումներն են՝ հաշվված մոդելի սեփական tokenizer-ով, գումարած պատկերների թոքենները։ Թոքենների հաշվարկի endpoint-ները նույն թիվը վերադարձնում են ուղարկելուց առաջ։ Թոքենների հաշվարկ

Shannon մակարդակներում prompt_tokens-ը հաշվում է այն ամենը, ինչ մոդելը կարդացել է պատասխանը գրելու համար, ուստի այն մեծ է միայն ձեր հաղորդագրությունների տեքստից։

Streaming

Երբ stream-ը true է, պատասխանը գալիս է որպես chat.completion.chunk իրադարձություններ և ավարտվում է data: [DONE]-ով։ Դրանից առաջ վերջին chunk-ը կրում է finish_reason և usage. stream_options պետք չեն։ Chunk-երի կառուցվածքները, keep-alive տողերը և հոսքի ներսի սխալներն ունեն իրենց էջը։ Ստրիմինգ

Սխալներ

Սխալը JSON օբյեկտ է error անդամով։ Ստուգումները կատարվում են այս հերթականությամբ՝ API բանալի, հարցման մարմին, մոդելի id, ապա մնացորդ։ Աղյուսակում թվարկված են այս endpoint-ի ամենահաճախ վերադարձվող սխալները։ Լրիվ ցանկը՝ կրկնելու ցուցումներով, ունի իր էջը։ Սխալների մշակում

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