Chat Completions

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

மிகச் சிறிய கோரிக்கை என்பது ஒரு மாடல் id மற்றும் ஒரு பயனர் செய்தி.

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

Headers

கோரிக்கை headers

பதில் headers

கோரிக்கைப் புலங்கள்

messages மட்டுமே கட்டாயம். செயல்படுத்துவது நெடுவரிசை, ஒரு புலம் பதிலை மாற்றும் மாடல்களைக் குறிப்பிடுகிறது. ஹோஸ்ட் செய்யப்பட்ட open-weight மாடல்கள் என்பவை மாடல் பட்டியலிலுள்ள பன்னிரண்டு id-கள்; 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 இருக்கும், stream எப்போதும் usage உடன் முடியும்.

தவறான JSON வகை கொண்ட புலம், எடுத்துக்காட்டாக "max_tokens": "100", 422 தரும். messages இல்லாத கோரிக்கையும் அவ்வாறே.

Tools, கட்டமைக்கப்பட்ட வெளியீடு, reasoning மற்றும் இணையத் தேடல் ஒவ்வொன்றுக்கும் தனிப் பக்கம் உண்டு: செயல்பாடு அழைப்பு, கட்டமைக்கப்பட்ட வெளியீடுகள், Reasoning effort, உள்ளமைக்கப்பட்ட இணைய தேடல்.

விருப்பங்களுடன் ஒரு கோரிக்கை

இந்தக் கோரிக்கை ஒரு system செய்தி, sampling புலங்கள் மற்றும் reasoning 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 இரண்டு விவரங்களைச் சேர்க்கும்: cache-லிருந்து படிக்கப்பட்ட prompt டோக்கன்கள், மற்றும் reasoning-க்குச் செலவான டோக்கன்கள்.

{
  "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 அனுப்புங்கள்.

இந்த endpoint-ல் shannon-coder-1 வேறுவிதமாகக் கணக்கிடப்படுகிறது: ஒவ்வொரு கோரிக்கையும் உங்கள் திட்டத்தின் Shannon Coder அழைப்புகளில் ஒன்று, அதற்கு டோக்கன்கள் ஒதுக்கப்படுவதில்லை. வரம்புகளும் இருப்பும்

இரண்டாவதாக, இந்த மாடல்களில் அது பதிலின் நீளத்தை வரையறுக்கிறது:

max_tokens அல்லது max_completion_tokens இல்லாவிட்டால் மதிப்பு 4,096. shannon-coder-1-ல் 65,536.

செய்திகள்

ஒவ்வொரு செய்தியும் role மற்றும் content கொண்ட object. செய்தி உரையைத் தவிர வேறும் கொண்டிருந்தால் content ஒரு string அல்லது பகுதிகளின் array.

Shannon 3 குடும்ப id-யுடன், கட்டாயம் பின்பற்றப்பட வேண்டிய அறிவுறுத்தல்களை user செய்தியில் வையுங்கள்.

Shannon நிலைகளில் பயனர் உரையும் tools-ம் இல்லாத கோரிக்கை 400 No user message provided தரும்.

உள்ளடக்கப் பகுதிகள்

அளவுகள், வரம்புகள் மற்றும் வடிவங்களின் முழுப் பட்டியலுக்குத் தனிப் பக்கம் உண்டு. படங்களும் கோப்புகளும்

பதில் object

முடிவுக் காரணங்கள்

stream செய்யாத பதில் stop அல்லது tool_calls-ஐத் தெரிவிக்கும்.

Usage

ஹோஸ்ட் செய்யப்பட்ட open-weight மாடல்களில், prompt_tokens என்பது உங்கள் செய்திகளும் tool வரையறைகளும் மாடலின் சொந்த tokenizer-ஆல் எண்ணப்பட்டதுடன், படங்களின் டோக்கன்களும் சேர்ந்தது. டோக்கன் எண்ணிக்கை endpoint-கள் நீங்கள் அனுப்பும் முன்பே அதே எண்ணைத் தரும். Token எண்ணிக்கை

Shannon நிலைகளில், பதிலை எழுத மாடல் படித்த அனைத்தையும் prompt_tokens எண்ணுகிறது, எனவே அது உங்கள் செய்திகளின் உரையை மட்டும் விடப் பெரிதாக இருக்கும்.

Streaming

stream true ஆக அமைந்தால் பதில் chat.completion.chunk நிகழ்வுகளாக வந்து 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"
  }
}