Strukturirani izhodi
Zahtevajte odgovor kot JSON: poljuben objekt JSON ali JSON, ki sledi shemi, ki jo pošljete. Uporabite, kadar odgovor bere program, ne oseba.
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 je besedilo odgovora, v 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}
}
}Načini response_format
response_format je polje /v1/chat/completions. Brez njega je odgovor običajno besedilo.
| Način | Vrednost | Kaj dobite |
|---|---|---|
| Objekt JSON | {"type": "json_object"} | Odgovor je JSON brez predpisane oblike. V promptu navedite, katere ključe želite. |
| Shema JSON | {"type": "json_schema", "json_schema": {"name": "…", "schema": {…}}} | Odgovor sledi shemi, ki jo pošljete: njenim ključem, tipom in obveznim poljem. |
| Strogo | "strict": true | Polje json_schema, ne tretji način. Je true, razen če pošljete false. |
| Polje | Tip | Privzeto | Opis | Uporabljajo |
|---|---|---|---|---|
type | string | json_object ali json_schema. Obvezno znotraj response_format. text je sprejet in da običajen besedilni odgovor. | Vsak model, ki sprejema ta način | |
json_schema.schema | object | JSON Schema, ki ji odgovor sledi. Pošljite jo vedno, kadar je type json_schema. | Vsak model, ki sprejema ta način | |
json_schema.name | string | Oznaka sheme, kot v formatu OpenAI. | Gostovani modeli z odprtimi utežmi | |
json_schema.strict | boolean | true | Ali mora odgovor shemi slediti natančno. Modeli Shannon vsako shemo upoštevajo kot strogo. | Gostovani modeli z odprtimi utežmi |
Način objekta JSON ne potrebuje sheme. Ključe navedite v promptu:
Telo zahtevka
{
"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"}
}Podpora po modelih
| Model | json_object | json_schema |
|---|---|---|
Vsak model Shannon (shannon-*) | Da | Da |
| Gostovani modeli z odprtimi utežmi, razen spodaj navedenih | Da | Da |
Laguna-S-2.1-W4A16-AUTOROUND-REAP | — | — |
inkling-W4A16-AUTOROUND-REAP | Da | — |
GET /v1/models isto sporoča po id: capabilities.json_schema pri vsakem modelu in capabilities.response_format pri gostovanih modelih z odprtimi utežmi. Modeli in cene
Podprte ključne besede sheme
Kaj model prejme od vaše sheme, je odvisno od modela in od končne točke:
| Modeli | /v1/chat/completions | /v1/responses |
|---|---|---|
| Modeli Shannon | Spodnja podmnožica ključnih besed, upoštevana kot stroga. | Shema, kot jo pošljete, upoštevana kot stroga. |
| Gostovani modeli z odprtimi utežmi | Shema, kot jo pošljete. strict je true, razen če ga pošljete. | Shema, kot jo pošljete. strict je true, razen če ga pošljete. |
Podmnožica ključnih besed modelov Shannon na /v1/chat/completions:
| Ključna beseda | Kako se bere |
|---|---|
| Prebrane ključne besede | type, format, title, description, nullable, enum, items, properties, required, minItems, maxItems, minimum, maximum, minLength, maxLength, pattern, anyOf, default |
$ref | Razrešen iz $defs ali definitions na vrhnji ravni sheme. Ključne besede, zapisane ob $ref, kot je description, se ohranijo. Sklic brez ustrezne definicije se bere kot {"type": "object"}. |
allOf | Člani se združijo v eno shemo. Kjer dva člana nastavita isto ključno besedo, velja poznejši. |
oneOf | Bere se kot anyOf. |
| Sheme, ki se sklicujejo nase | Razširjene do 24 ravni. Globlja raven se bere kot {"type": "object"}. |
| Zunaj podmnožice | Vsaka druga ključna beseda, na primer additionalProperties, const, multipleOf, uniqueItems, exclusiveMinimum, exclusiveMaximum, patternProperties, prefixItems, minProperties, maxProperties, not in if / then / else. Te niso del sheme, ki jo model prejme. |
Na /v1/responses: text.format
/v1/responses isti zahtevek zapiše kot text.format. Shema je neposredno v format, ob name in strict, ne pod ključem json_schema. Za način objekta JSON pošljite {"format": {"type": "json_object"}}.
Telo zahtevka
{
"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 je text dela output_text elementa 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": []
}
]
}
]
}Podpora po modelih in napake so enake kot na /v1/chat/completions. API Responses
Na /v1/messages: orodje kot shema
Format Messages nima polja za strukturiran izhod. Za JSON iz istih modelov kličite /v1/chat/completions ali /v1/responses z istim ključem.
Če želite ostati na /v1/messages, objekt opišite kot orodje: svojo shemo vstavite v input_schema in orodje poimenujte v tool_choice. input bloka tool_use je potem vaš objekt, že razčlenjen. Poimenovani tool_choice upoštevajo gostovani modeli z odprtimi utežmi.
Telo zahtevka
{
"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"}
}
]
}Preden preberete blok, preverite, da je stop_reason enak tool_use. Klicanje funkcij
Kako prispe JSON
- JSON je niz. Ob odgovoru ni razčlenjenega objekta: nad
message.contentzaženite svoj razčlenjevalnik JSON. - Z
stream: trueJSON prispe v koščkihdelta.content. Združite jih in razčlenite, ko se tok konča; košček sam po sebi ni veljaven JSON. - Gostovani model z odprtimi utežmi na zahtevek z
response_formatodgovori brez besedila razmišljanja:reasoning_contentjenull.
Preverite, kar prejmete
Shema vodi, kako model piše. API končnega odgovora ne primerja z vašo shemo, zato končno preverjanje opravi vaša koda:
- Razčlenjujte znotraj obravnavalnika napak, kot to dela primer na vrhu.
- Razčlenjeni objekt preverite z isto shemo v svoji kodi, na primer s knjižnico JSON Schema, Pydantic ali Zod.
- Dolg odgovor se lahko konča, preden je JSON popoln. Odgovor brez pretakanja kot
finish_reasonsporoča samostopalitool_calls, zato je znak napaka pri razčlenjevanju. Vprašajte znova ali zahtevajte manjši objekt.
Napake
| Stanje | Vrsta | Sporočilo | Kdaj |
|---|---|---|---|
400 | invalid_request_error | <id> does not accept response_format | Model ne sprejema nobenega načina. |
400 | invalid_request_error | <id> does not accept response_format json_schema; use json_object | Model sprejema json_object, vi pa ste poslali json_schema. |
422 | invalid_request_error | Failed to deserialize the JSON body into the target type: … | response_format nima type ali pa ni objekt JSON. |
Obe odgovora 400 se pošljeta, preden se z vašega stanja odšteje karkoli. Obravnava napak