Chat Completions

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

Mazākais pieprasījums ir modeļa id un viens lietotāja ziņojums.

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

Atbilde ir viens JSON objekts:

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

Galvenes

Pieprasījuma galvenes

Atbildes galvenes

Pieprasījuma lauki

Obligāts ir tikai messages. Kolonna Piemēro nosauc modeļus, kuros lauks maina atbildi. Hostētie atvērto svaru modeļi ir divpadsmit id no modeļu saraksta; Shannon 3 saime ir shannon-3, shannon-3-pro, shannon-3.1 un shannon-3.1-pro. Modeļi un cenas

Citi OpenAI lauki, piemēram, n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store un prompt_cache_key, tiek pieņemti, lai esošais klienta kods darbotos nemainīts. Tie atbildi nemaina: izvēle (choice) vienmēr ir viena, un straume vienmēr beidzas ar lietojuma datiem.

Lauks ar nepareizu JSON tipu, piemēram, "max_tokens": "100", atgriež 422. Tāpat dara pieprasījums bez messages.

Rīkiem, strukturētai izvadei, spriešanai un tīmekļa meklēšanai katram ir sava lapa: Funkciju izsaukšana, Strukturēti izvadi, Spriešanas apjoms, Tīmekļa meklēšana.

Pieprasījums ar opcijām

Šis pieprasījums iestata sistēmas ziņojumu, paraugu ņemšanas laukus un spriešanas apjomu. Tas izmanto hostētu atvērto svaru modeli, kas piemēro visu minēto.

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

Atbildei ir tāda pati forma kā iepriekš. Hostētajiem atvērto svaru modeļiem tās usage pievieno divas detaļas: no keša nolasītos uzvednes tokenus un spriešanai iztērētos tokenus.

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

Izvades garums

max_tokens dara divas lietas. Pirmkārt, tas ir tokenu skaits, ko pieprasījuma sākumā rezervē no jūsu atlikuma. Kad atbilde ir pabeigta, šis apjoms tiek aizstāts ar pieprasījuma izmantotajiem tokeniem. Ja max_tokens ir lielāks par jūsu atlikuma atlikušo daļu, pieprasījums atgriež 429 Quota exceeded, pat ja pati atbilde būtu ietilpusi. Sūtiet zemāku max_tokens, lai rezervētu mazāk.

shannon-coder-1 šajā galapunktā tiek skaitīts citādi: katrs pieprasījums ir viens jūsu plāna Shannon Coder izsaukums, un tam netiek rezervēti tokeni. Ierobežojumi un atlikums

Otrkārt, tas ierobežo atbildes garumu šiem modeļiem:

Bez max_tokens vai max_completion_tokens vērtība ir 4,096. Modelim shannon-coder-1 tā ir 65,536.

Ziņojumi

Katrs ziņojums ir objekts ar role un content. content ir virkne vai daļu masīvs, ja ziņojums nes ne tikai tekstu.

Ar Shannon 3 saimes id norādījumus, kam jāizpildās, ievietojiet user ziņojumā.

Shannon līmeņos pieprasījums bez lietotāja teksta un bez tools atgriež 400 No user message provided.

Satura daļas

Izmēriem, ierobežojumiem un pilnam formu sarakstam ir sava lapa. Attēli un faili

Atbildes objekts

Beigu iemesli

Atbilde, kas netiek straumēta, norāda stop vai tool_calls.

Lietojums

Hostētajiem atvērto svaru modeļiem prompt_tokens ir jūsu ziņojumi un rīku definīcijas, saskaitītas ar paša modeļa tokenizatoru, plus jebkuru attēlu tokeni. Tokenu skaitīšanas galapunkti atgriež to pašu skaitli, pirms jūs sūtāt. Tokenu skaitīšana

Shannon līmeņos prompt_tokens skaita visu, ko modelis nolasīja, lai uzrakstītu atbildi, tāpēc tas ir lielāks par tikai jūsu ziņojumu tekstu.

Straumēšana

Ar stream, kas iestatīts uz true, atbilde ierodas kā chat.completion.chunk notikumi un beidzas ar data: [DONE]. Pēdējā daļa pirms tā nes finish_reason un usage; stream_options nav vajadzīgas. Daļu formām, keep-alive rindām un kļūdām straumes iekšienē ir sava lapa. Straumēšana

Kļūdas

Kļūda ir JSON objekts ar error locekli. Pārbaudes notiek šādā secībā: API atslēga, pieprasījuma pamatteksts, modeļa id, tad atlikums. Tabulā ir uzskaitīts tas, ko šis galapunkts atgriež visbiežāk. Pilns saraksts ar norādēm, ko mēģināt atkārtot, ir atsevišķā lapā. Kļūdu apstrāde

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