Chat Completions

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

Minnsta beiðnin er líkanauðkenni og ein notandaskilaboð.

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

Svarið er einn JSON-hlutur:

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

Hausar

Beiðnihausar

Svarhausar

Beiðnireitir

Aðeins messages er skylda. Dálkurinn Notað af nefnir líkönin þar sem reitur breytir svarinu. Hýstu líkönin með opnum þyngdum eru auðkennin tólf á líkanalistanum; Shannon 3 fjölskyldan er shannon-3, shannon-3-pro, shannon-3.1 og shannon-3.1-pro. Líkön og verð

Aðrir OpenAI-reitir, svo sem n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store og prompt_cache_key, eru samþykktir svo að núverandi biðlarakóði keyri óbreyttur. Þeir breyta ekki svarinu: það er alltaf eitt val, og straumur endar alltaf með notkun.

Reitur með rangt JSON-gagnatag, til dæmis "max_tokens": "100", skilar 422. Beiðni án messages gerir það líka.

Tól, skipulagt úttak, rökhugsun og vefleit hafa hvert sína eigin síðu: Aðgerðaköll, Skipulögð úttök, Rökhugsunarátak, Vefleit.

Beiðni með valkostum

Þessi beiðni stillir system-skilaboð, sýnatökureitina og rökhugsunarátakið. Hún notar hýst líkan með opnum þyngdum, sem tekur tillit til þessa alls.

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

Svarið hefur sama form og hér að ofan. usage þess bætir við tveimur atriðum á hýstum líkönum með opnum þyngdum: prompt-táknin sem lesin voru úr skyndiminni og táknin sem fóru í rökhugsun.

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

Úttakslengd

max_tokens gerir tvennt. Í fyrsta lagi er það fjöldi tákna sem tekinn er frá af stöðunni þinni þegar beiðnin hefst. Þegar svarið er fullbúið kemur táknafjöldinn sem beiðnin notaði í stað þess magns. Ef max_tokens er stærra en það sem eftir er af stöðunni þinni skilar beiðnin 429 Quota exceeded jafnvel þótt svarið sjálft hefði komist fyrir. Sendu lægra max_tokens til að taka minna frá.

shannon-coder-1 er talið öðruvísi á þessum endapunkti: hver beiðni er eitt af Shannon Coder köllum áskriftarinnar þinnar og engin tákn eru tekin frá fyrir hana. Mörk og staða

Í öðru lagi takmarkar það lengd svarsins á þessum líkönum:

Án max_tokens eða max_completion_tokens er gildið 4,096. Á shannon-coder-1 er það 65,536.

Skilaboð

Hver skilaboð eru hlutur með role og content. content er strengur, eða fylki af hlutum þegar skilaboðin bera meira en texta.

Með auðkenni úr Shannon 3 fjölskyldunni skaltu setja fyrirmæli sem verða að gilda inn í user skilaboðin.

Á Shannon-þrepunum skilar beiðni án notandatexta og án tools 400 No user message provided.

Efnishlutar

Stærðir, mörk og tæmandi listi yfir form hafa sína eigin síðu. Myndir og skrár

Svarhluturinn

Lokaástæður

Svar sem er ekki streymt skráir stop eða tool_calls.

Notkun

Á hýstum líkönum með opnum þyngdum eru prompt_tokens skilaboðin þín og tólaskilgreiningar taldar með eigin táknara líkansins, auk tákna mynda. Talningarendapunktar tákna skila sömu tölu áður en þú sendir. Tókatalning

Á Shannon-þrepunum telja prompt_tokens allt sem líkanið las til að skrifa svarið, svo talan er stærri en texti skilaboðanna þinna einn og sér.

Streymi

Með stream stillt á true berst svarið sem chat.completion.chunk atburðir og endar á data: [DONE]. Síðasti búturinn á undan því ber finish_reason og usage; engin stream_options eru nauðsynleg. Form bútanna, keep-alive línur og villur inni í streymi hafa sína eigin síðu. Streymi

Villur

Villa er JSON-hlutur með error meðlim. Athuganir keyra í þessari röð: API-lykill, beiðnameginmál, líkanauðkenni, síðan staða. Taflan sýnir það sem þessi endapunktur skilar oftast. Heildarlistinn, með því hvað á að endurreyna, hefur sína eigin síðu. Villumeðhöndlun

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