Chat Completions

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

Mažiausia užklausa yra modelio id ir viena vartotojo žinutė.

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

Atsakymas yra vienas JSON objektas:

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

Antraštės

Užklausos antraštės

Atsakymo antraštės

Užklausos laukai

Būtinas tik messages. Stulpelyje Taiko nurodyti modeliai, kuriuose laukas keičia atsakymą. Talpinami atvirų svorių modeliai yra dvylika modelių sąrašo id; Shannon 3 šeima yra shannon-3, shannon-3-pro, shannon-3.1 ir shannon-3.1-pro. Modeliai ir kainos

Kiti OpenAI laukai, tokie kaip n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ir prompt_cache_key, priimami, kad esamas kliento kodas veiktų nepakeistas. Jie nekeičia atsakymo: visada yra vienas pasirinkimas, o srautas visada baigiasi naudojimo duomenimis.

Laukas su neteisingu JSON tipu, pavyzdžiui, "max_tokens": "100", grąžina 422. Taip pat ir užklausa be messages.

Įrankiai, struktūruota išvestis, mąstymas ir paieška internete turi savo puslapius: Funkcijų kvietimas, Struktūruoti išėjimai, Mąstymo pastangos, Žiniatinklio paieška.

Užklausa su parinktimis

Ši užklausa nustato sistemos žinutę, mėginių ėmimo laukus ir mąstymo pastangas. Ji naudoja talpinamą atvirų svorių modelį, kuris taiko visus šiuos nustatymus.

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

Atsakymas turi tą pačią formą kaip aukščiau. Talpinamuose atvirų svorių modeliuose jo usage prideda dvi detales: iš kešo nuskaitytus prompt tokenus ir mąstymui sunaudotus tokenus.

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

Išvesties ilgis

max_tokens daro dvi dalykus. Pirma, tai tokenų skaičius, kuris jūsų balanse rezervuojamas užklausai prasidedant. Kai atsakymas baigtas, ši suma pakeičiama užklausos sunaudotais tokenais. Jei max_tokens didesnis nei jūsų balanso likutis, užklausa grąžina 429 Quota exceeded, net jei pats atsakymas būtų tilpęs. Siųskite mažesnį max_tokens, kad rezervuotumėte mažiau.

shannon-coder-1 šiame galiniame taške skaičiuojamas kitaip: kiekviena užklausa yra vienas jūsų plano Shannon Coder kreipinys, ir tokenai jai nerezervuojami. Ribos ir balansas

Antra, jis riboja atsakymo ilgį šiuose modeliuose:

Be max_tokens ar max_completion_tokens reikšmė yra 4,096. Modeliui shannon-coder-1 ji yra 65,536.

Žinutės

Kiekviena žinutė yra objektas su role ir content. content yra eilutė arba dalių masyvas, kai žinutėje yra ne tik tekstas.

Su Shannon 3 šeimos id nurodymus, kurie privalo galioti, įrašykite į user žinutę.

Shannon lygiuose užklausa be vartotojo teksto ir be tools grąžina 400 No user message provided.

Turinio dalys

Dydžiai, ribos ir pilnas formų sąrašas aprašyti atskirame puslapyje. Vaizdai ir failai

Atsakymo objektas

Pabaigos priežastys

Ne srautu siunčiamas atsakymas praneša stop arba tool_calls.

Naudojimas

Talpinamuose atvirų svorių modeliuose prompt_tokens yra jūsų žinutės ir įrankių apibrėžimai, suskaičiuoti paties modelio tokenizatoriumi, plius visų vaizdų tokenai. Tokenų skaičiavimo galiniai taškai grąžina tą patį skaičių prieš jums siunčiant. Tokenų skaičiavimas

Shannon lygiuose prompt_tokens skaičiuoja viską, ką modelis perskaitė atsakymui parašyti, todėl jis didesnis nei vien jūsų žinučių tekstas.

Srautinis perdavimas

Kai stream nustatytas į true, atsakymas ateina kaip chat.completion.chunk įvykiai ir baigiasi data: [DONE]. Paskutinis gabalas prieš jį perduoda finish_reason ir usage; stream_options nereikia. Gabalų formos, keep-alive eilutės ir klaidos sraute aprašytos atskirame puslapyje. Srautinė transliacija

Klaidos

Klaida yra JSON objektas su nariu error. Patikros vykdomos šia tvarka: API raktas, užklausos turinys, modelio id, tada balansas. Lentelėje išvardyta, ką šis galinis taškas grąžina dažniausiai. Pilnas sąrašas su nurodymais, ką kartoti, yra atskirame puslapyje. Klaidų tvarkymas

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