Chat Completions

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

Eskaerarik txikiena modelo-id bat eta erabiltzaile-mezu bat da.

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

Erantzuna JSON objektu bakar bat da:

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

Goiburuak

Eskaera-goiburuak

Erantzun-goiburuak

Eskaera-eremuak

messages bakarrik da beharrezkoa. Aplikatzen duena zutabeak eremu batek erantzuna aldatzen duen modeloak adierazten ditu. Pisu irekiko modelo ostatatuak modelo-zerrendako hamabi id dira; Shannon 3 familia shannon-3, shannon-3-pro, shannon-3.1 eta shannon-3.1-pro da. Modeloak eta prezioak

OpenAI-ren beste eremu batzuk, hala nola n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store eta prompt_cache_key, onartzen dira lehendik dagoen bezero-kodea aldatu gabe ibil dadin. Ez dute erantzuna aldatzen: beti dago aukera bakarra, eta stream bat beti erabilerarekin amaitzen da.

JSON mota okerra duen eremu batek, adibidez "max_tokens": "100", 422 itzultzen du. messages gabeko eskaerak ere bai.

Tresnek, irteera egituratuak, arrazonamenduak eta web bilaketak beren orrialdea dute: Funtzio-deiak, Irteera egituratuak, Arrazonamendu-esfortzua, Web bilaketa.

Aukerak dituen eskaera

Eskaera honek system mezu bat, laginketa-eremuak eta arrazonamendu-esfortzua ezartzen ditu. Pisu irekiko modelo ostatatu bat erabiltzen du, eta horrek guztiak aplikatzen ditu.

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

Erantzunak goiko forma bera du. Bere usage-k bi xehetasun gehitzen ditu pisu irekiko modelo ostatatuetan: cachetik irakurritako prompt-tokenak eta arrazonamenduan gastatutako tokenak.

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

Irteeraren luzera

max_tokens-ek bi gauza egiten ditu. Lehenik, eskaera hasten denean zure saldotik bereizten den token-kopurua da. Erantzuna osatzen denean, kopuru hori eskaerak erabilitako tokenek ordezkatzen dute. max_tokens zure saldoan geratzen dena baino handiagoa bada, eskaerak 429 Quota exceeded itzultzen du erantzuna bera sartuko litzatekeenean ere. Bidali max_tokens txikiagoa gutxiago bereizteko.

shannon-coder-1 modu desberdinean kontatzen da endpoint honetan: eskaera bakoitza zure planeko Shannon Coder dei bat da, eta ez da tokenik bereizten. Mugak eta saldoa

Bigarrenik, erantzunaren luzera mugatzen du modelo hauetan:

max_tokens edo max_completion_tokens gabe, balioa 4,096 da. shannon-coder-1-en 65,536 da.

Mezuak

Mezu bakoitza role eta content dituen objektu bat da. content kate bat da, edo zati-array bat mezuak testua baino gehiago daramanean.

Shannon 3 familiako id batekin, jarri bete behar diren jarraibideak user mezuan.

Shannon mailetan, erabiltzaile-testurik eta tools-ik gabeko eskaerak 400 No user message provided itzultzen du.

Eduki-zatiak

Tamainek, mugek eta forma guztien zerrendak beren orrialdea dute. Irudiak eta fitxategiak

Erantzun-objektua

Amaiera-arrazoiak

Stream bidez ez doan erantzun batek stop edo tool_calls jakinarazten du.

Erabilera

Pisu irekiko modelo ostatatuetan, prompt_tokens zure mezuak eta tresna-definizioak dira, modeloaren tokenizatzaile propioarekin kontatuta, gehi irudien tokenak. Token-kontaketako endpoint-ek zenbaki bera itzultzen dute bidali aurretik. Tokenen kontaketa

Shannon mailetan, prompt_tokens-ek modeloak erantzuna idazteko irakurri duen guztia kontatzen du, beraz zure mezuen testua bakarrik baino handiagoa da.

Streaminga

stream true bezala ezarrita, erantzuna chat.completion.chunk gertaera gisa iristen da eta data: [DONE]-rekin amaitzen da. Haren aurreko azken chunk-ak finish_reason eta usage ditu; ez da stream_options beharrik. Chunk-en formek, keep-alive lerroek eta streamen barruko erroreek beren orrialdea dute. Streaminga

Erroreak

Errore bat error kide bat duen JSON objektu bat da. Egiaztapenak ordena honetan egiten dira: API gakoa, eskaera-gorputza, modelo-id-a, eta gero saldoa. Taulak endpoint honek maizen itzultzen duena zerrendatzen du. Zerrenda osoak, zer berriz saiatu behar den adierazita, bere orrialdea du. Errore‑kudeaketa

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