Chat Completions

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

ഏറ്റവും ചെറിയ റിക്വസ്റ്റ് ഒരു മോഡൽ ഐഡിയും ഒരു യൂസർ മെസേജും മാത്രമാണ്.

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

മറുപടി ഒരു JSON ഒബ്ജക്റ്റ് ആണ്:

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

ഹെഡറുകൾ

റിക്വസ്റ്റ് ഹെഡറുകൾ

മറുപടി ഹെഡറുകൾ

റിക്വസ്റ്റ് ഫീൽഡുകൾ

messages മാത്രമാണ് നിർബന്ധം. ഒരു ഫീൽഡ് മറുപടിയെ മാറ്റുന്ന മോഡലുകളുടെ പേര് ബാധകമാക്കുന്നത് കോളം നൽകുന്നു. ഹോസ്റ്റ് ചെയ്ത ഓപ്പൺ-വെയിറ്റ് മോഡലുകൾ എന്നത് മോഡൽ പട്ടികയിലെ പന്ത്രണ്ട് ഐഡികളാണ്; Shannon 3 കുടുംബം shannon-3, shannon-3-pro, shannon-3.1, shannon-3.1-pro എന്നിവയാണ്. മോഡലുകളും വിലയും

n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store, prompt_cache_key പോലുള്ള മറ്റ് OpenAI ഫീൽഡുകൾ, നിലവിലുള്ള ക്ലയന്റ് കോഡ് മാറ്റമില്ലാതെ പ്രവർത്തിക്കാൻ സ്വീകരിക്കുന്നു. അവ മറുപടിയെ മാറ്റില്ല: എപ്പോഴും ഒരു choice മാത്രമേ ഉണ്ടാകൂ, സ്ട്രീം എപ്പോഴും ഉപയോഗ വിവരത്തോടെ അവസാനിക്കും.

തെറ്റായ JSON ടൈപ്പുള്ള ഫീൽഡ്, ഉദാഹരണത്തിന് "max_tokens": "100", 422 നൽകും. messages ഇല്ലാത്ത റിക്വസ്റ്റും അങ്ങനെ തന്നെ.

ടൂളുകൾ, ഘടനയുള്ള ഔട്ട്പുട്ട്, റീസണിംഗ്, വെബ് സെർച്ച് എന്നിവയ്ക്ക് ഓരോന്നിനും സ്വന്തം പേജ് ഉണ്ട്: ഫംഗ്ഷൻ കോളിംഗ്, ഘടനയുള്ള ഔട്ട്പുട്ടുകൾ, റീസണിംഗ് എഫർട്ട്, വെബ് തിരയൽ.

ഓപ്ഷനുകളുള്ള ഒരു റിക്വസ്റ്റ്

ഈ റിക്വസ്റ്റ് ഒരു സിസ്റ്റം മെസേജും സാമ്പ്ലിംഗ് ഫീൽഡുകളും റീസണിംഗ് എഫർട്ടും സജ്ജമാക്കുന്നു. ഇത് ഹോസ്റ്റ് ചെയ്ത ഓപ്പൺ-വെയിറ്റ് മോഡൽ ഉപയോഗിക്കുന്നു, അത് ഇവയെല്ലാം പ്രയോഗിക്കുന്നു.

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

മറുപടിക്ക് മുകളിലുള്ളതിന്റെ അതേ ഘടനയാണ്. ഹോസ്റ്റ് ചെയ്ത ഓപ്പൺ-വെയിറ്റ് മോഡലുകളിൽ ഇതിന്റെ usage രണ്ട് വിശദാംശങ്ങൾ കൂടി ചേർക്കുന്നു: കാഷിൽ നിന്ന് വായിച്ച പ്രോംപ്റ്റ് ടോക്കണുകളും റീസണിംഗിനായി ചെലവായ ടോക്കണുകളും.

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

ഔട്ട്പുട്ട് ദൈർഘ്യം

max_tokens രണ്ട് കാര്യങ്ങൾ ചെയ്യുന്നു. ഒന്നാമതായി, റിക്വസ്റ്റ് തുടങ്ങുമ്പോൾ നിങ്ങളുടെ ബാലൻസിൽ നിന്ന് മാറ്റിവയ്ക്കുന്ന ടോക്കണുകളുടെ എണ്ണമാണിത്. മറുപടി പൂർത്തിയാകുമ്പോൾ, ആ തുകയ്ക്ക് പകരം റിക്വസ്റ്റ് ഉപയോഗിച്ച ടോക്കണുകൾ കണക്കാക്കും. max_tokens നിങ്ങളുടെ ബാക്കി ബാലൻസിനേക്കാൾ വലുതാണെങ്കിൽ, മറുപടി സ്വയം ഒതുങ്ങുമായിരുന്നെങ്കിലും റിക്വസ്റ്റ് 429 Quota exceeded നൽകും. കുറച്ച് മാറ്റിവയ്ക്കാൻ കുറഞ്ഞ max_tokens അയയ്ക്കുക.

ഈ എൻഡ്‌പോയിന്റിൽ shannon-coder-1 വ്യത്യസ്തമായാണ് കണക്കാക്കുന്നത്: ഓരോ റിക്വസ്റ്റും നിങ്ങളുടെ പ്ലാനിലെ ഒരു Shannon Coder കോൾ ആണ്, അതിനായി ടോക്കണുകളൊന്നും മാറ്റിവയ്ക്കുന്നില്ല. പരിധികളും ബാലൻസും

രണ്ടാമതായി, ഈ മോഡലുകളിൽ ഇത് മറുപടിയുടെ ദൈർഘ്യം പരിമിതപ്പെടുത്തുന്നു:

max_tokens അല്ലെങ്കിൽ max_completion_tokens ഇല്ലെങ്കിൽ മൂല്യം 4,096 ആണ്. shannon-coder-1-ൽ ഇത് 65,536 ആണ്.

മെസേജുകൾ

ഓരോ മെസേജും ഒരു role-ഉം ഒരു content-ഉം ഉള്ള ഒബ്ജക്റ്റ് ആണ്. content ഒരു സ്ട്രിംഗ് ആണ്, അല്ലെങ്കിൽ മെസേജിൽ ടെക്സ്റ്റിന് പുറമെയും ഉള്ളടക്കമുണ്ടെങ്കിൽ ഭാഗങ്ങളുടെ ഒരു അറേ.

Shannon 3 കുടുംബത്തിലെ ഐഡി ഉപയോഗിക്കുമ്പോൾ, നിർബന്ധമായും പാലിക്കേണ്ട നിർദ്ദേശങ്ങൾ user മെസേജിൽ വയ്ക്കുക.

Shannon ടിയറുകളിൽ, യൂസർ ടെക്സ്റ്റും tools-ഉം ഇല്ലാത്ത റിക്വസ്റ്റ് 400 No user message provided നൽകും.

കണ്ടന്റ് ഭാഗങ്ങൾ

വലിപ്പങ്ങൾ, പരിധികൾ, എല്ലാ രൂപങ്ങളുടെയും പൂർണ്ണ ലിസ്റ്റ് എന്നിവയ്ക്ക് സ്വന്തം പേജ് ഉണ്ട്. ചിത്രങ്ങളും ഫയലുകളും

മറുപടി ഒബ്ജക്റ്റ്

അവസാനിപ്പിക്കാനുള്ള കാരണങ്ങൾ

സ്ട്രീം ചെയ്യാത്ത മറുപടി stop അല്ലെങ്കിൽ tool_calls റിപ്പോർട്ട് ചെയ്യും.

ഉപയോഗം

ഹോസ്റ്റ് ചെയ്ത ഓപ്പൺ-വെയിറ്റ് മോഡലുകളിൽ, prompt_tokens എന്നത് നിങ്ങളുടെ മെസേജുകളും ടൂൾ നിർവചനങ്ങളും മോഡലിന്റെ സ്വന്തം ടോക്കണൈസർ ഉപയോഗിച്ച് എണ്ണിയതും, ചിത്രങ്ങളുടെ ടോക്കണുകളും ചേർന്നതാണ്. ടോക്കൺ എണ്ണൽ എൻഡ്‌പോയിന്റുകൾ അയയ്ക്കുന്നതിന് മുമ്പ് ഇതേ സംഖ്യ തിരികെ നൽകും. ടോക്കൺ എണ്ണൽ

Shannon ടിയറുകളിൽ, മറുപടി എഴുതാൻ മോഡൽ വായിച്ചതെല്ലാം prompt_tokens എണ്ണുന്നു, അതിനാൽ ഇത് നിങ്ങളുടെ മെസേജുകളുടെ ടെക്സ്റ്റിനേക്കാൾ വലുതാണ്.

സ്ട്രീമിംഗ്

stream true ആക്കിയാൽ മറുപടി chat.completion.chunk ഇവന്റുകളായി വരികയും data: [DONE] ഓടെ അവസാനിക്കുകയും ചെയ്യും. അതിന് തൊട്ടുമുമ്പുള്ള അവസാന ചങ്കിൽ finish_reason-ഉം usage-ഉം ഉണ്ടാകും; stream_options ആവശ്യമില്ല. ചങ്കുകളുടെ ഘടന, കീപ്-എലൈവ് വരികൾ, സ്ട്രീമിനുള്ളിലെ പിശകുകൾ എന്നിവയ്ക്ക് സ്വന്തം പേജ് ഉണ്ട്. സ്റ്റ്രീമിംഗ്

പിശകുകൾ

എറർ എന്നത് error അംഗമുള്ള ഒരു JSON ഒബ്ജക്റ്റാണ്. പരിശോധനകൾ ഈ ക്രമത്തിൽ നടക്കുന്നു: API കീ, റിക്വസ്റ്റ് ബോഡി, മോഡൽ ഐഡി, പിന്നെ ബാലൻസ്. ഈ എൻഡ്‌പോയിന്റ് ഏറ്റവും കൂടുതൽ തിരികെ നൽകുന്നവ പട്ടികയിലുണ്ട്. എന്തെല്ലാം വീണ്ടും ശ്രമിക്കണം എന്നതുൾപ്പെടെയുള്ള പൂർണ്ണ പട്ടികയ്ക്ക് സ്വന്തം പേജ് ഉണ്ട്. എറർ ഹാൻഡ്ലിംഗ്

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