Chat Completions

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

ಅತಿ ಚಿಕ್ಕ ವಿನಂತಿ ಎಂದರೆ ಒಂದು ಮಾಡೆಲ್ id ಮತ್ತು ಒಂದು user ಸಂದೇಶ.

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 ಮಾತ್ರ ಅಗತ್ಯ. ಅನ್ವಯಿಸುವವರು ಕಾಲಮ್ ಒಂದು ಫೀಲ್ಡ್ ಪ್ರತಿಕ್ರಿಯೆಯನ್ನು ಬದಲಾಯಿಸುವ ಮಾಡೆಲ್‌ಗಳನ್ನು ಹೆಸರಿಸುತ್ತದೆ. ಹೋಸ್ಟ್ ಮಾಡಲಾದ ಓಪನ್-ವೇಟ್ ಮಾಡೆಲ್‌ಗಳು ಮಾಡೆಲ್ ಪಟ್ಟಿಯ ಹನ್ನೆರಡು 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 ಇರುತ್ತದೆ, ಮತ್ತು ಸ್ಟ್ರೀಮ್ ಯಾವಾಗಲೂ ಬಳಕೆಯೊಂದಿಗೆ ಕೊನೆಗೊಳ್ಳುತ್ತದೆ.

ತಪ್ಪಾದ JSON ಪ್ರಕಾರದ ಫೀಲ್ಡ್, ಉದಾಹರಣೆಗೆ "max_tokens": "100", 422 ಹಿಂತಿರುಗಿಸುತ್ತದೆ. messages ಇಲ್ಲದ ವಿನಂತಿಗೂ ಇದೇ ಆಗುತ್ತದೆ.

ಟೂಲ್‌ಗಳು, ರಚಿತ ಔಟ್‌ಪುಟ್, ರೀಸನಿಂಗ್ ಮತ್ತು ವೆಬ್ ಹುಡುಕಾಟ ಪ್ರತಿಯೊಂದಕ್ಕೂ ತನ್ನದೇ ಪುಟವಿದೆ: ಫಂಕ್ಷನ್ ಕಾಲಿಂಗ್, ರಚಿತ ಔಟ್‌ಪುಟ್‌ಗಳು, ರೀಸನಿಂಗ್ ಪ್ರಯತ್ನ, ಒಳನಿರ್ಮಿತ ವೆಬ್ ಹುಡುಕಾಟ.

ಆಯ್ಕೆಗಳೊಂದಿಗೆ ವಿನಂತಿ

ಈ ವಿನಂತಿ system ಸಂದೇಶ, ಸ್ಯಾಂಪ್ಲಿಂಗ್ ಫೀಲ್ಡ್‌ಗಳು ಮತ್ತು ರೀಸನಿಂಗ್ effort ಅನ್ನು ಹೊಂದಿಸುತ್ತದೆ. ಇದು ಹೋಸ್ಟ್ ಮಾಡಿದ ಓಪನ್-ವೇಟ್ ಮಾಡೆಲ್ ಅನ್ನು ಬಳಸುತ್ತದೆ, ಅದು ಇವೆಲ್ಲವನ್ನೂ ಅನ್ವಯಿಸುತ್ತದೆ.

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 ಒಂದು string, ಅಥವಾ ಸಂದೇಶವು ಪಠ್ಯಕ್ಕಿಂತ ಹೆಚ್ಚನ್ನು ಹೊತ್ತಿರುವಾಗ ಭಾಗಗಳ array ಆಗಿರುತ್ತದೆ.

Shannon 3 ಕುಟುಂಬದ id ಯೊಂದಿಗೆ, ಪಾಲಿಸಲೇಬೇಕಾದ ಸೂಚನೆಗಳನ್ನು user ಸಂದೇಶದಲ್ಲಿ ಇಡಿ.

Shannon ಟಿಯರ್‌ಗಳಲ್ಲಿ user ಪಠ್ಯವೂ tools ಸಹ ಇಲ್ಲದ ವಿನಂತಿಗೆ 400 No user message provided ಹಿಂತಿರುಗುತ್ತದೆ.

ವಿಷಯ ಭಾಗಗಳು

ಗಾತ್ರಗಳು, ಮಿತಿಗಳು ಮತ್ತು ರೂಪಗಳ ಪೂರ್ಣ ಪಟ್ಟಿಗೆ ತನ್ನದೇ ಪುಟವಿದೆ. ಚಿತ್ರಗಳು ಮತ್ತು ಫೈಲ್‌ಗಳು

ಉತ್ತರ ಆಬ್ಜೆಕ್ಟ್

ಮುಕ್ತಾಯದ ಕಾರಣಗಳು

stream ಮಾಡದ ಉತ್ತರವು stop ಅಥವಾ tool_calls ಎಂದು ವರದಿ ಮಾಡುತ್ತದೆ.

ಬಳಕೆ

ಹೋಸ್ಟ್ ಮಾಡಿದ ಓಪನ್-ವೇಟ್ ಮಾಡೆಲ್‌ಗಳಲ್ಲಿ, prompt_tokens ಎಂದರೆ ನಿಮ್ಮ ಸಂದೇಶಗಳು ಮತ್ತು ಟೂಲ್ ವ್ಯಾಖ್ಯಾನಗಳನ್ನು ಮಾಡೆಲ್‌ನ ಸ್ವಂತ tokenizer ನಿಂದ ಎಣಿಸಿದ್ದು, ಜೊತೆಗೆ ಯಾವುದೇ ಚಿತ್ರಗಳ ಟೋಕನ್‌ಗಳು. ಟೋಕನ್ ಎಣಿಕೆ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳು ನೀವು ಕಳುಹಿಸುವ ಮೊದಲೇ ಅದೇ ಸಂಖ್ಯೆಯನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತವೆ. ಟೋಕನ್ ಎಣಿಕೆ

Shannon ಟಿಯರ್‌ಗಳಲ್ಲಿ, prompt_tokens ಉತ್ತರ ಬರೆಯಲು ಮಾಡೆಲ್ ಓದಿದ ಎಲ್ಲವನ್ನೂ ಎಣಿಸುತ್ತದೆ, ಆದ್ದರಿಂದ ಅದು ನಿಮ್ಮ ಸಂದೇಶಗಳ ಪಠ್ಯಕ್ಕಿಂತ ದೊಡ್ಡದಾಗಿರುತ್ತದೆ.

ಸ್ಟ್ರೀಮಿಂಗ್

stream ಅನ್ನು true ಗೆ ಹೊಂದಿಸಿದರೆ ಉತ್ತರ chat.completion.chunk ಈವೆಂಟ್‌ಗಳಾಗಿ ಬರುತ್ತದೆ ಮತ್ತು data: [DONE] ನೊಂದಿಗೆ ಕೊನೆಗೊಳ್ಳುತ್ತದೆ. ಅದರ ಮೊದಲಿನ ಕೊನೆಯ chunk finish_reason ಮತ್ತು usage ಅನ್ನು ಹೊತ್ತಿರುತ್ತದೆ; stream_options ಬೇಕಿಲ್ಲ. chunk ರೂಪಗಳು, keep-alive ಸಾಲುಗಳು ಮತ್ತು stream ಒಳಗಿನ ದೋಷಗಳಿಗೆ ತನ್ನದೇ ಪುಟವಿದೆ. ಸ್ಟ್ರೀಮಿಂಗ್

ದೋಷಗಳು

ದೋಷ ಎಂದರೆ error ಸದಸ್ಯ ಇರುವ JSON ಆಬ್ಜೆಕ್ಟ್. ಪರಿಶೀಲನೆಗಳು ಈ ಕ್ರಮದಲ್ಲಿ ನಡೆಯುತ್ತವೆ: API ಕೀ, ವಿನಂತಿ ಬಾಡಿ, ಮಾಡೆಲ್ id, ನಂತರ ಬ್ಯಾಲೆನ್ಸ್. ಈ ಎಂಡ್‌ಪಾಯಿಂಟ್ ಹೆಚ್ಚಾಗಿ ಹಿಂತಿರುಗಿಸುವುದನ್ನು ಕೋಷ್ಟಕ ಪಟ್ಟಿ ಮಾಡುತ್ತದೆ. ಯಾವುದನ್ನು ಮರುಪ್ರಯತ್ನಿಸಬೇಕು ಎಂಬುದರೊಂದಿಗೆ ಪೂರ್ಣ ಪಟ್ಟಿಗೆ ತನ್ನದೇ ಪುಟವಿದೆ. ದೋಷ ನಿರ್ವಹಣೆ

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