Chat Completions

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

Väikseim päring on mudeli id ja üks kasutaja sõnum.

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

Vastus on üks JSON-objekt:

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

Päised

Päringu päised

Vastuse päised

Päringu väljad

Nõutav on ainult messages. Veerg Rakendavad nimetab mudelid, millel väli vastust muudab. Hostitud avatud kaaludega mudelid on mudelite loendi kaksteist id-d; Shannon 3 perekond on shannon-3, shannon-3-pro, shannon-3.1 ja shannon-3.1-pro. Mudelid ja hinnad

Muud OpenAI väljad, näiteks n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ja prompt_cache_key, võetakse vastu, et olemasolev kliendikood töötaks muutmata kujul. Need ei muuda vastust: valik on alati üks ja voog lõpeb alati kasutusandmetega.

Vale JSON-tüübiga väli, näiteks "max_tokens": "100", annab 422. Sama annab päring ilma messages.

Tööriistadel, struktureeritud väljundil, arutlusel ja veebiotsingul on igaühel oma leht: Funktsioonikutse, Struktureeritud väljundid, Reasoning-pingutus, Veebiotsing.

Päring valikutega

See päring määrab süsteemisõnumi, valimisväljad ja arutluse pingutuse. Kasutusel on hostitud avatud kaaludega mudel, mis rakendab neid kõiki.

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

Vastus on sama kujuga nagu ülal. Hostitud avatud kaaludega mudelitel lisab selle usage kaks üksikasja: vahemälust loetud prompti tokenid ja arutlusele kulutatud tokenid.

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

Väljundi pikkus

max_tokens teeb kaks asja. Esiteks on see tokenite arv, mis päringu alguses sinu saldost kõrvale pannakse. Kui vastus on valmis, asendatakse see summa päringu tegelikult kasutatud tokenitega. Kui max_tokens on suurem kui sinu saldo jääk, annab päring 429 Quota exceeded isegi siis, kui vastus ise oleks ära mahtunud. Saada väiksem max_tokens, et vähem kõrvale panna.

shannon-coder-1 loetakse selles lõpp-punktis teisiti: iga päring on üks sinu paketi Shannon Coderi kõne ja selle jaoks ei panda tokeneid kõrvale. Piirangud ja saldo

Teiseks piirab see vastuse pikkust nendel mudelitel:

Ilma max_tokens või max_completion_tokens on väärtus 4,096. Mudelil shannon-coder-1 on see 65,536.

Sõnumid

Iga sõnum on objekt koos väljadega role ja content. content on string või osade massiiv, kui sõnum kannab midagi enamat kui teksti.

Shannon 3 perekonna id puhul pane juhised, mis peavad kehtima, user-sõnumisse.

Shannoni tasemetel annab päring ilma kasutaja tekstita ja ilma tools vastuse 400 No user message provided.

Sisuosad

Suurustel, piirangutel ja kõigi vormide täielikul loendil on oma leht. Pildid ja failid

Vastuse objekt

Lõpetamise põhjused

Voogedastamata vastus teatab stop või tool_calls.

Kasutus

Hostitud avatud kaaludega mudelitel on prompt_tokens sinu sõnumid ja tööriistade definitsioonid, loetud mudeli enda tokenizeriga, pluss piltide tokenid. Tokenite lugemise lõpp-punktid tagastavad enne saatmist sama arvu. Tokenite lugemine

Shannoni tasemetel loeb prompt_tokens kõike, mida mudel vastuse kirjutamiseks luges, seega on see suurem kui ainult sinu sõnumite tekst.

Voogedastus

Kui stream on true, saabub vastus chat.completion.chunk sündmustena ja lõpeb data: [DONE]. Sellele eelnev viimane chunk kannab finish_reason ja usage; stream_options ei ole vaja. Chunkide kujudel, keep-alive ridadel ja voosisestel vigadel on oma leht. Voogedastus

Vead

Viga on JSON-objekt koos liikmega error. Kontrollid käivad selles järjekorras: API võti, päringu sisu, mudeli id, seejärel saldo. Tabel loetleb, mida see lõpp-punkt kõige sagedamini tagastab. Täielik loend koos sellega, mida korrata, on oma lehel. Vigade käsitlus

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