Құрылымдалған нәтижелер
Жауапты JSON ретінде сұраңыз: кез келген JSON нысаны, немесе жіберген схемаңызға сәйкес JSON. Жауапты адам емес, бағдарлама оқитын кезде қолданыңыз.
POST https://api.shannon-ai.com/v1/chat/completions
import json
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="Kimi-K3-3BIT-REAP",
messages=[
{"role": "user", "content": "Extract the person: John Doe, 30 years old, engineer."}
],
response_format={
"type": "json_schema",
"json_schema": {
"name": "person",
"strict": True,
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"age": {"type": "integer"},
"occupation": {"type": "string"},
},
"required": ["name", "age", "occupation"],
},
},
},
)
# The JSON arrives as text in message.content: parse it, then check it.
try:
person = json.loads(response.choices[0].message.content)
except json.JSONDecodeError:
person = None # ask again, or report the failure
print(person) 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: "Kimi-K3-3BIT-REAP",
messages: [
{ role: "user", content: "Extract the person: John Doe, 30 years old, engineer." },
],
response_format: {
type: "json_schema",
json_schema: {
name: "person",
strict: true,
schema: {
type: "object",
properties: {
name: { type: "string" },
age: { type: "integer" },
occupation: { type: "string" },
},
required: ["name", "age", "occupation"],
},
},
},
});
// The JSON arrives as text in message.content: parse it, then check it.
let person = null;
try {
person = JSON.parse(response.choices[0].message.content);
} catch {
// ask again, or report the failure
}
console.log(person); curl https://api.shannon-ai.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "Kimi-K3-3BIT-REAP",
"messages": [
{"role": "user", "content": "Extract the person: John Doe, 30 years old, engineer."}
],
"response_format": {
"type": "json_schema",
"json_schema": {
"name": "person",
"strict": true,
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"age": {"type": "integer"},
"occupation": {"type": "string"}
},
"required": ["name", "age", "occupation"]
}
}
}
}' JSON — жауап мәтіні, choices[0].message.content ішінде:
{
"id": "chatcmpl-0c4e7a1b9d2f4e6a8b3c5d7e9f1a2b3c",
"object": "chat.completion",
"created": 1791590400,
"model": "Kimi-K3-3BIT-REAP",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "{\"name\":\"John Doe\",\"age\":30,\"occupation\":\"engineer\"}",
"reasoning_content": null
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 96,
"completion_tokens": 19,
"total_tokens": 115,
"prompt_tokens_details": {"cached_tokens": 0},
"completion_tokens_details": {"reasoning_tokens": 0}
}
} response_format режимдері
response_format — /v1/chat/completions өрісі. Онсыз жауап кәдімгі мәтін болады.
| Режим | Мәні | Не аласыз |
|---|---|---|
| JSON нысаны | {"type": "json_object"} | Жауап белгіленген пішінсіз JSON болады. Қандай кілттер керегін prompt-та айтыңыз. |
| JSON схемасы | {"type": "json_schema", "json_schema": {"name": "…", "schema": {…}}} | Жауап жіберген схемаңызды ұстанады: оның кілттерін, түрлерін және міндетті өрістерін. |
| Strict | "strict": true | json_schema өрісі, үшінші режим емес. false жібермесеңіз, ол true. |
| Өріс | Түрі | Әдепкі | Сипаттама | Қолданады |
|---|---|---|---|---|
type | string | json_object немесе json_schema. response_format ішінде міндетті. text қабылданады және кәдімгі мәтін жауабын береді. | Режимді қабылдайтын әр модель | |
json_schema.schema | object | Жауап ұстанатын JSON Schema. type мәні json_schema болған сайын оны жіберіңіз. | Режимді қабылдайтын әр модель | |
json_schema.name | string | Схема белгісі, OpenAI форматындағыдай. | Hosted open-weight модельдер | |
json_schema.strict | boolean | true | Жауап схеманы дәл ұстануы керек пе. Shannon модельдері әр схеманы strict ретінде қолданады. | Hosted open-weight модельдер |
JSON нысаны режиміне схема қажет емес. Кілттерді prompt-та атаңыз:
{
"model": "shannon-3",
"messages": [
{
"role": "user",
"content": "Name the capital of France. Answer as JSON with the keys city and country."
}
],
"response_format": {"type": "json_object"}
} Модель бойынша қолдау
| Модель | json_object | json_schema |
|---|---|---|
Әр Shannon моделі (shannon-*) | Иә | Иә |
| Hosted open-weight модельдер, төменде аталғандардан басқасы | Иә | Иә |
Laguna-S-2.1-W4A16-AUTOROUND-REAP | — | — |
inkling-W4A16-AUTOROUND-REAP | Иә | — |
GET /v1/models сол мәліметті әр id бойынша көрсетеді: әр модельде capabilities.json_schema және hosted open-weight модельдерде capabilities.response_format. Модельдер және бағалар
Қолдау көрсетілетін схема кілт сөздері
Модельдің схемаңыздан не алатыны модельге және endpoint-ке байланысты:
| Модельдер | /v1/chat/completions | /v1/responses |
|---|---|---|
| Shannon модельдері | Төмендегі кілт сөздер жиыны, strict ретінде қолданылады. | Схема өзіңіз жіберген күйінде, strict ретінде қолданылады. |
| Hosted open-weight модельдер | Схема өзіңіз жіберген күйінде. Жібермесеңіз, strict — true. | Схема өзіңіз жіберген күйінде. Жібермесеңіз, strict — true. |
/v1/chat/completions бойынша Shannon модельдерінің кілт сөздер жиыны:
| Кілт сөз | Қалай оқылады |
|---|---|
| Оқылатын кілт сөздер | type, format, title, description, nullable, enum, items, properties, required, minItems, maxItems, minimum, maximum, minLength, maxLength, pattern, anyOf, default |
$ref | Схеманың жоғарғы деңгейіндегі $defs немесе definitions ішінен шешіледі. $ref қасына жазылған description сияқты кілт сөздер сақталады. Сәйкес анықтамасы жоқ сілтеме {"type": "object"} ретінде оқылады. |
allOf | Мүшелер бір схемаға біріктіріледі. Екі мүше бірдей кілт сөзді орнатса, соңғысы есептеледі. |
oneOf | anyOf ретінде оқылады. |
| Өздеріне сілтейтін схемалар | 24 деңгейге дейін жайылады. Тереңірек деңгей {"type": "object"} ретінде оқылады. |
| Жиыннан тыс | Барлық басқа кілт сөздер, мысалы additionalProperties, const, multipleOf, uniqueItems, exclusiveMinimum, exclusiveMaximum, patternProperties, prefixItems, minProperties, maxProperties, not және if / then / else. Олар модель алатын схеманың бөлігі емес. |
/v1/responses бойынша: text.format өрісі арқылы
/v1/responses сол сұрауды text.format ретінде жазады. Схема json_schema кілтінің астында емес, format ішінде тікелей, name және strict қасында тұрады. JSON нысаны режимі үшін {"format": {"type": "json_object"}} жіберіңіз.
{
"model": "Kimi-K3-3BIT-REAP",
"input": "Extract the person: John Doe, 30 years old, engineer.",
"text": {
"format": {
"type": "json_schema",
"name": "person",
"strict": true,
"schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"age": {"type": "integer"},
"occupation": {"type": "string"}
},
"required": ["name", "age", "occupation"]
}
}
}
} JSON — message элементінің output_text бөлігінің text мәні:
{
"output": [
{
"id": "msg_7e1d3c5b9a2f4d6e8c0b1a3f5e7d9c2b",
"type": "message",
"role": "assistant",
"status": "completed",
"content": [
{
"type": "output_text",
"text": "{\"name\":\"John Doe\",\"age\":30,\"occupation\":\"engineer\"}",
"annotations": []
}
]
}
]
} Модель бойынша қолдау және қателер /v1/chat/completions бойынша сияқты. Responses API
/v1/messages бойынша: схема ретінде құрал
Messages форматында құрылымдалған шығыс өрісі жоқ. Сол модельдерден JSON алу үшін сол кілтпен /v1/chat/completions немесе /v1/responses шақырыңыз.
/v1/messages бойынша қалу үшін нысанды құрал ретінде сипаттаңыз: схемаңызды input_schema ішіне қойыңыз және құралды tool_choice ішінде атаңыз. Сонда tool_use блогының input мәні — парсинг жасалған нысаныңыз. Атаулы tool_choice мәнін hosted open-weight модельдер қолданады.
{
"model": "Kimi-K3-3BIT-REAP",
"max_tokens": 1024,
"messages": [
{
"role": "user",
"content": "Extract the person: John Doe, 30 years old, engineer."
}
],
"tools": [
{
"name": "record_person",
"description": "Record the extracted person.",
"input_schema": {
"type": "object",
"properties": {
"name": {"type": "string"},
"age": {"type": "integer"},
"occupation": {"type": "string"}
},
"required": ["name", "age", "occupation"]
}
}
],
"tool_choice": {"type": "tool", "name": "record_person"}
} {
"stop_reason": "tool_use",
"content": [
{
"type": "tool_use",
"id": "toolu_4b8d2f6a1c3e4a5b9d7f0e2c4a6b8d1f",
"name": "record_person",
"input": {"name": "John Doe", "age": 30, "occupation": "engineer"}
}
]
} Блокты оқымас бұрын stop_reason мәнінің tool_use екенін тексеріңіз. Функция шақыру
JSON қалай келеді
- JSON — жол. Жауаптың қасында парсинг жасалған нысан жоқ: JSON парсеріңізді
message.contentмәніне қолданыңыз. stream: trueболғанда JSONdelta.contentбөліктерімен келеді. Оларды біріктіріңіз және стрим аяқталғаннан кейін бір рет парсинг жасаңыз; жеке бөлік жарамды JSON емес.- Hosted open-weight модель
response_formatсұрауына пайымдау мәтінінсіз жауап береді:reasoning_content—null.
Алғаныңызды тексеріңіз
Схема модельдің қалай жазатынын бағыттайды. API дайын жауапты схемаңызбен салыстырмайды, сондықтан соңғы тексеруді кодыңыз жасайды:
- Жоғарыдағы мысалдағыдай қателерді өңдегіш ішінде парсинг жасаңыз.
- Парсинг жасалған нысанды өз кодыңызда сол схемамен тексеріңіз, мысалы JSON Schema кітапханасымен, Pydantic немесе Zod арқылы.
- Ұзақ жауап JSON толық болмай тұрып аяқталуы мүмкін. Стримделмеген жауап
finish_reasonмәнін текstopнемесеtool_callsдеп көрсетеді, сондықтан парсинг қатесі — белгі. Қайта сұраңыз немесе кішірек нысан сұраңыз.
Қателер
| Мәртебе | Түрі | Хабарлама | Қашан |
|---|---|---|---|
400 | invalid_request_error | <id> does not accept response_format | Модель екі режимді де қабылдамайды. |
400 | invalid_request_error | <id> does not accept response_format json_schema; use json_object | Модель json_object қабылдайды, ал сіз json_schema жібердіңіз. |
422 | invalid_request_error | Failed to deserialize the JSON body into the target type: … | response_format ішінде type жоқ, немесе ол JSON нысаны емес. |
Екі 400 жауабы балансыңыздан ештеңе алынбай тұрып жіберіледі. Қателерді өңдеу