Chat Completions

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

ਸਭ ਤੋਂ ਛੋਟੀ ਰਿਕੁਐਸਟ ਵਿੱਚ ਇੱਕ ਮਾਡਲ id ਅਤੇ ਇੱਕ user message ਹੁੰਦਾ ਹੈ।

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 object ਹੈ:

{
  "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 ਲਾਜ਼ਮੀ ਹੈ। Applied by ਕਾਲਮ ਉਹ ਮਾਡਲ ਦੱਸਦਾ ਹੈ ਜਿਨ੍ਹਾਂ ਉੱਤੇ ਕੋਈ ਫੀਲਡ ਜਵਾਬ ਬਦਲਦਾ ਹੈ। ਹੋਸਟ ਕੀਤੇ open-weight ਮਾਡਲ ਮਾਡਲ ਸੂਚੀ ਦੀਆਂ ਬਾਰਾਂ ids ਹਨ; Shannon 3 ਪਰਿਵਾਰ shannon-3, shannon-3-pro, shannon-3.1 ਅਤੇ shannon-3.1-pro ਹੈ। ਮਾਡਲ ਅਤੇ ਕੀਮਤਾਂ

OpenAI ਦੇ ਹੋਰ ਫੀਲਡ, ਜਿਵੇਂ n, user, stream_options, parallel_tool_calls, presence_penalty, frequency_penalty, logit_bias, logprobs, metadata, store ਅਤੇ prompt_cache_key, ਇਸ ਲਈ ਸਵੀਕਾਰ ਕੀਤੇ ਜਾਂਦੇ ਹਨ ਕਿ ਮੌਜੂਦਾ ਕਲਾਇੰਟ ਕੋਡ ਬਿਨਾਂ ਬਦਲਾਅ ਦੇ ਚੱਲੇ। ਉਹ ਜਵਾਬ ਨਹੀਂ ਬਦਲਦੇ: ਹਮੇਸ਼ਾ ਇੱਕ ਹੀ choice ਹੁੰਦੀ ਹੈ, ਅਤੇ stream ਹਮੇਸ਼ਾ usage ਨਾਲ ਖਤਮ ਹੁੰਦੀ ਹੈ।

ਗਲਤ JSON ਕਿਸਮ ਵਾਲਾ ਫੀਲਡ, ਉਦਾਹਰਣ ਵਜੋਂ "max_tokens": "100", 422 ਵਾਪਸ ਕਰਦਾ ਹੈ। messages ਤੋਂ ਬਿਨਾਂ ਰਿਕੁਐਸਟ ਵੀ ਇਹੀ ਕਰਦੀ ਹੈ।

ਟੂਲ, ਸੰਗਠਿਤ ਆਉਟਪੁੱਟ, ਰੀਜ਼ਨਿੰਗ ਅਤੇ ਵੈੱਬ ਸਰਚ ਦਾ ਹਰ ਇੱਕ ਦਾ ਆਪਣਾ ਪੰਨਾ ਹੈ: ਫੰਕਸ਼ਨ ਕਾਲਿੰਗ, ਸਟ੍ਰਕਚਰਡ ਆਉਟਪੁੱਟਸ, ਰੀਜ਼ਨਿੰਗ effort, ਵੈੱਬ ਖੋਜ.

ਵਿਕਲਪਾਂ ਵਾਲੀ ਰਿਕੁਐਸਟ

ਇਹ ਰਿਕੁਐਸਟ ਇੱਕ system message, ਸੈਂਪਲਿੰਗ ਫੀਲਡ ਅਤੇ ਰੀਜ਼ਨਿੰਗ effort ਤੈਅ ਕਰਦੀ ਹੈ। ਇਹ ਹੋਸਟ ਕੀਤਾ open-weight ਮਾਡਲ ਵਰਤਦੀ ਹੈ, ਜੋ ਇਨ੍ਹਾਂ ਸਭ ਨੂੰ ਲਾਗੂ ਕਰਦਾ ਹੈ।

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

ਜਵਾਬ ਦੀ ਸ਼ਕਲ ਉੱਪਰ ਵਾਲੀ ਹੀ ਹੈ। ਹੋਸਟ ਕੀਤੇ open-weight ਮਾਡਲਾਂ ਉੱਤੇ ਇਸ ਦੀ usage ਦੋ ਵੇਰਵੇ ਹੋਰ ਜੋੜਦੀ ਹੈ: ਕੈਸ਼ ਤੋਂ ਪੜ੍ਹੇ ਪ੍ਰੋਂਪਟ tokens ਅਤੇ ਰੀਜ਼ਨਿੰਗ ਉੱਤੇ ਖਰਚ ਹੋਏ tokens।

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

ਆਉਟਪੁੱਟ ਦੀ ਲੰਬਾਈ

max_tokens ਦੋ ਕੰਮ ਕਰਦਾ ਹੈ। ਪਹਿਲਾ, ਇਹ ਉਹ tokens ਦੀ ਗਿਣਤੀ ਹੈ ਜੋ ਰਿਕੁਐਸਟ ਸ਼ੁਰੂ ਹੋਣ ਸਮੇਂ ਤੁਹਾਡੇ ਬੈਲੇਂਸ ਵਿੱਚੋਂ ਵੱਖ ਰੱਖੇ ਜਾਂਦੇ ਹਨ। ਜਵਾਬ ਪੂਰਾ ਹੋਣ ਉੱਤੇ ਉਹ ਰਕਮ ਉਨ੍ਹਾਂ tokens ਨਾਲ ਬਦਲ ਦਿੱਤੀ ਜਾਂਦੀ ਹੈ ਜੋ ਰਿਕੁਐਸਟ ਨੇ ਵਰਤੇ। ਜੇ max_tokens ਤੁਹਾਡੇ ਬੈਲੇਂਸ ਵਿੱਚ ਬਚੀ ਰਕਮ ਤੋਂ ਵੱਡਾ ਹੈ, ਤਾਂ ਰਿਕੁਐਸਟ 429 Quota exceeded ਵਾਪਸ ਕਰਦੀ ਹੈ, ਭਾਵੇਂ ਜਵਾਬ ਆਪ ਸਮਾ ਜਾਂਦਾ। ਘੱਟ ਵੱਖ ਰੱਖਣ ਲਈ ਛੋਟਾ max_tokens ਭੇਜੋ।

ਇਸ endpoint ਉੱਤੇ shannon-coder-1 ਦੀ ਗਿਣਤੀ ਵੱਖਰੇ ਤਰੀਕੇ ਨਾਲ ਹੁੰਦੀ ਹੈ: ਹਰ ਰਿਕੁਐਸਟ ਤੁਹਾਡੇ ਪਲਾਨ ਦੀ ਇੱਕ Shannon Coder ਕਾਲ ਹੈ, ਅਤੇ ਉਸ ਲਈ ਕੋਈ tokens ਵੱਖ ਨਹੀਂ ਰੱਖੇ ਜਾਂਦੇ। ਸੀਮਾਵਾਂ ਅਤੇ ਬੈਲੇਂਸ

ਦੂਜਾ, ਇਹ ਇਨ੍ਹਾਂ ਮਾਡਲਾਂ ਉੱਤੇ ਜਵਾਬ ਦੀ ਲੰਬਾਈ ਸੀਮਤ ਕਰਦਾ ਹੈ:

max_tokens ਜਾਂ max_completion_tokens ਤੋਂ ਬਿਨਾਂ ਮੁੱਲ 4,096 ਹੁੰਦਾ ਹੈ। shannon-coder-1 ਉੱਤੇ ਇਹ 65,536 ਹੈ।

Messages

ਹਰ message ਇੱਕ role ਅਤੇ ਇੱਕ content ਵਾਲਾ object ਹੁੰਦਾ ਹੈ। content ਇੱਕ string ਹੈ, ਜਾਂ parts ਦਾ array ਜਦੋਂ message ਟੈਕਸਟ ਤੋਂ ਵੱਧ ਕੁਝ ਲੈ ਕੇ ਜਾਂਦਾ ਹੈ।

Shannon 3 ਪਰਿਵਾਰ ਦੀ id ਨਾਲ, ਜੋ ਹਦਾਇਤਾਂ ਲਾਜ਼ਮੀ ਹਨ ਉਨ੍ਹਾਂ ਨੂੰ user message ਵਿੱਚ ਪਾਓ।

Shannon ਟੀਅਰਾਂ ਉੱਤੇ user ਟੈਕਸਟ ਅਤੇ tools ਤੋਂ ਬਿਨਾਂ ਰਿਕੁਐਸਟ 400 No user message provided ਵਾਪਸ ਕਰਦੀ ਹੈ।

Content parts

ਆਕਾਰ, ਸੀਮਾਵਾਂ ਅਤੇ ਰੂਪਾਂ ਦੀ ਪੂਰੀ ਸੂਚੀ ਦਾ ਆਪਣਾ ਪੰਨਾ ਹੈ। ਇਮੇਜਾਂ ਅਤੇ ਫਾਈਲਾਂ

ਜਵਾਬ ਦਾ object

ਸਮਾਪਤੀ ਦੇ ਕਾਰਨ

ਜੋ ਜਵਾਬ stream ਨਹੀਂ ਹੁੰਦਾ, ਉਹ stop ਜਾਂ tool_calls ਦੱਸਦਾ ਹੈ।

ਵਰਤੋਂ

ਹੋਸਟ ਕੀਤੇ open-weight ਮਾਡਲਾਂ ਉੱਤੇ prompt_tokens ਤੁਹਾਡੇ messages ਅਤੇ ਟੂਲ ਪਰਿਭਾਸ਼ਾਵਾਂ ਨੂੰ ਮਾਡਲ ਦੇ ਆਪਣੇ tokenizer ਨਾਲ ਗਿਣ ਕੇ, ਨਾਲ ਕਿਸੇ ਵੀ ਇਮੇਜ ਦੇ tokens ਜੋੜ ਕੇ ਬਣਦਾ ਹੈ। token ਗਿਣਤੀ ਵਾਲੇ endpoints ਤੁਹਾਡੇ ਭੇਜਣ ਤੋਂ ਪਹਿਲਾਂ ਇਹੀ ਸੰਖਿਆ ਵਾਪਸ ਕਰਦੇ ਹਨ। ਟੋਕਨ ਗਿਣਤੀ

Shannon ਟੀਅਰਾਂ ਉੱਤੇ prompt_tokens ਉਹ ਸਭ ਗਿਣਦਾ ਹੈ ਜੋ ਮਾਡਲ ਨੇ ਜਵਾਬ ਲਿਖਣ ਲਈ ਪੜ੍ਹਿਆ, ਇਸ ਲਈ ਇਹ ਸਿਰਫ਼ ਤੁਹਾਡੇ messages ਦੇ ਟੈਕਸਟ ਤੋਂ ਵੱਡਾ ਹੁੰਦਾ ਹੈ।

ਸਟ੍ਰੀਮਿੰਗ

stream ਨੂੰ true ਕਰਨ ਨਾਲ ਜਵਾਬ chat.completion.chunk events ਵਜੋਂ ਪਹੁੰਚਦਾ ਹੈ ਅਤੇ data: [DONE] ਨਾਲ ਖਤਮ ਹੁੰਦਾ ਹੈ। ਉਸ ਤੋਂ ਪਹਿਲਾਂ ਵਾਲੇ ਆਖਰੀ chunk ਵਿੱਚ finish_reason ਅਤੇ usage ਹੁੰਦੇ ਹਨ; ਕਿਸੇ stream_options ਦੀ ਲੋੜ ਨਹੀਂ। chunk ਦੀਆਂ ਸ਼ਕਲਾਂ, keep-alive ਲਾਈਨਾਂ ਅਤੇ stream ਦੇ ਅੰਦਰ ਦੀਆਂ ਗਲਤੀਆਂ ਦਾ ਆਪਣਾ ਪੰਨਾ ਹੈ। ਸਟ੍ਰੀਮਿੰਗ

ਗਲਤੀਆਂ

ਗਲਤੀ error ਮੈਂਬਰ ਵਾਲਾ ਇੱਕ JSON object ਹੁੰਦੀ ਹੈ। ਜਾਂਚਾਂ ਇਸ ਕ੍ਰਮ ਵਿੱਚ ਚੱਲਦੀਆਂ ਹਨ: API key, ਰਿਕੁਐਸਟ body, ਮਾਡਲ id, ਫਿਰ ਬੈਲੇਂਸ। ਟੇਬਲ ਉਹ ਸੂਚੀਬੱਧ ਕਰਦਾ ਹੈ ਜੋ ਇਹ endpoint ਸਭ ਤੋਂ ਵੱਧ ਵਾਰ ਵਾਪਸ ਕਰਦਾ ਹੈ। ਪੂਰੀ ਸੂਚੀ, ਇਸ ਸਮੇਤ ਕਿ ਕੀ ਦੁਬਾਰਾ ਅਜ਼ਮਾਉਣਾ ਹੈ, ਦਾ ਆਪਣਾ ਪੰਨਾ ਹੈ। ਗਲਤੀਆਂ

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