Структурирани изходи
Поискайте отговора като 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:
200 JSON
{
"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": true | Поле на json_schema, а не трети режим. То е true, освен ако не изпратите false. |
| Поле | Тип | По подразбиране | Описание | Прилага се от |
|---|---|---|---|---|
type | string | json_object или json_schema. Задължително вътре в response_format. text се приема и дава обикновен текстов отговор. | Всеки модел, който приема режима | |
json_schema.schema | object | JSON Schema, която отговорът следва. Изпращайте я, когато type е json_schema. | Всеки модел, който приема режима | |
json_schema.name | string | Етикет за схемата, както във формата на OpenAI. | Хоствани open-weight модели | |
json_schema.strict | boolean | true | Дали отговорът трябва да следва схемата точно. Моделите на Shannon прилагат всяка схема като строга. | Хоствани 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-*) | Да | Да |
| Хоствани open-weight модели, освен посочените по-долу | Да | Да |
Laguna-S-2.1-W4A16-AUTOROUND-REAP | — | — |
inkling-W4A16-AUTOROUND-REAP | Да | — |
GET /v1/models докладва същото за всяко id: capabilities.json_schema при всеки модел и capabilities.response_format при хостваните open-weight модели. Модели и цени
Поддържани ключови думи на схемата
Какво получава моделът от Вашата схема, зависи от модела и от ендпоинта:
| Модели | /v1/chat/completions | /v1/responses |
|---|---|---|
| Модели на Shannon | Подмножеството от ключови думи по-долу, прилагано като строго. | Схемата така, както я изпращате, прилагана като строга. |
| Хоствани open-weight модели | Схемата така, както я изпращате. strict е true, освен ако не го изпратите. | Схемата така, както я изпращате. strict е true, освен ако не го изпратите. |
Подмножеството от ключови думи на моделите на Shannon на /v1/chat/completions:
| Ключова дума | Как се чете |
|---|---|
| Четени ключови думи | 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. Схемата стои директно в format, до name и strict, а не под ключ json_schema. За режим 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 е text на частта output_text на елемента message:
200 JSON
{
"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. Тогава input на блока tool_use е Вашият обект, вече парсиран. Именуван tool_choice се прилага от хостваните 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"}
} 200 JSON
{
"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: trueJSON пристига на парчета вdelta.content. Съединете ги и парсирайте, когато стриймът е приключил; едно парче само по себе си не е валиден JSON. - Хостван 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 се изпращат, преди нещо да бъде взето от баланса Ви. Обработка на грешки