Chat Completions

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

Y cais lleiaf yw id model ac un neges defnyddiwr.

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

Un gwrthrych JSON yw'r ateb:

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

Penawdau

Penawdau'r cais

Penawdau'r ateb

Meysydd y cais

Dim ond messages sy'n ofynnol. Mae'r golofn Yn cael ei gymhwyso gan yn enwi'r modelau lle mae maes yn newid yr ateb. Y modelau pwysau agored a gynhelir yw deuddeg id y rhestr fodelau; teulu Shannon 3 yw shannon-3, shannon-3-pro, shannon-3.1 a shannon-3.1-pro. Modelau a phrisiau

Derbynnir meysydd OpenAI eraill, megis n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store a prompt_cache_key, fel bod cod cleient presennol yn rhedeg heb newid. Nid ydynt yn newid yr ateb: mae un dewis bob amser, ac mae ffrwd bob amser yn gorffen gyda'r defnydd.

Mae maes â'r math JSON anghywir, er enghraifft "max_tokens": "100", yn dychwelyd 422. Felly hefyd cais heb messages.

Mae gan offer, allbwn strwythuredig, rhesymu a chwilio'r we eu tudalen eu hunain: Galw swyddogaeth, Allbynnau strwythuredig, Ymdrech rhesymu, Chwilio gwe.

Cais gyda dewisiadau

Mae'r cais hwn yn gosod neges system, y meysydd samplu a'r ymdrech rhesymu. Mae'n defnyddio model pwysau agored a gynhelir, sy'n cymhwyso pob un ohonynt.

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

Mae gan yr ateb yr un ffurf â'r uchod. Mae ei usage yn ychwanegu dau fanylyn ar y modelau pwysau agored a gynhelir: y tokenau prompt a ddarllenwyd o'r cache a'r tokenau a wariwyd ar resymu.

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

Hyd yr allbwn

Mae max_tokens yn gwneud dau beth. Yn gyntaf, dyma nifer y tokenau a neilltuir o'ch balans pan fydd y cais yn dechrau. Pan fydd yr ateb yn gyflawn, caiff y swm hwnnw ei ddisodli gan y tokenau a ddefnyddiodd y cais. Os yw max_tokens yn fwy na'r hyn sydd ar ôl o'ch balans, mae'r cais yn dychwelyd 429 Quota exceeded hyd yn oed pe bai'r ateb ei hun wedi ffitio. Anfonwch max_tokens is i neilltuo llai.

Cyfrifir shannon-coder-1 yn wahanol ar y pwynt terfyn hwn: mae pob cais yn un o alwadau Shannon Coder eich cynllun, ac ni neilltuir tokenau ar ei gyfer. Terfynau a balans

Yn ail, mae'n cyfyngu hyd yr ateb ar y modelau hyn:

Heb max_tokens na max_completion_tokens, y gwerth yw 4,096. Ar shannon-coder-1 mae'n 65,536.

Negeseuon

Mae pob neges yn wrthrych gyda role a content. Mae content yn llinyn, neu'n arae o rannau pan fo'r neges yn cario mwy na thestun.

Gydag id o deulu Shannon 3, rhowch gyfarwyddiadau y mae'n rhaid iddynt ddal yn y neges user.

Ar haenau Shannon mae cais heb destun defnyddiwr a heb tools yn dychwelyd 400 No user message provided.

Rhannau cynnwys

Mae gan feintiau, terfynau a'r rhestr lawn o ffurfiau eu tudalen eu hunain. Delweddau a ffeiliau

Gwrthrych yr ateb

Rhesymau gorffen

Mae ateb nad yw wedi'i ffrydio yn adrodd stop neu tool_calls.

Defnydd

Ar y modelau pwysau agored a gynhelir, prompt_tokens yw eich negeseuon a'ch diffiniadau offer wedi'u cyfrif â thokeneiddiwr y model ei hun, ynghyd â thokenau unrhyw ddelweddau. Mae'r pwyntiau terfyn cyfrif tokenau yn dychwelyd yr un rhif cyn i chi anfon. Cyfrif tokenau

Ar haenau Shannon, mae prompt_tokens yn cyfrif popeth a ddarllenodd y model i ysgrifennu'r ateb, felly mae'n fwy na thestun eich negeseuon yn unig.

Ffrydio

Gyda stream wedi'i osod i true mae'r ateb yn cyrraedd fel digwyddiadau chat.completion.chunk ac yn gorffen gyda data: [DONE]. Mae'r talp olaf o'i flaen yn cario finish_reason a usage; nid oes angen stream_options. Mae gan ffurfiau'r talpiau, llinellau cadw'n fyw a gwallau y tu mewn i ffrwd eu tudalen eu hunain. Ffrydio

Gwallau

Gwrthrych JSON gydag aelod error yw gwall. Mae'r gwiriadau'n rhedeg yn y drefn hon: allwedd API, corff y cais, id y model, yna balans. Mae'r tabl yn rhestru'r hyn y mae'r pwynt terfyn hwn yn ei ddychwelyd amlaf. Mae gan y rhestr lawn, gyda'r hyn i'w ailgeisio, ei thudalen ei hun. Rheoli gwallau

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