Strukturált kimenetek

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"]
        }
      }
    }
  }'

A JSON a válasz szövege, a choices[0].message.content mezőben:

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

A response_format módjai

A response_format a /v1/chat/completions egyik mezője. Nélküle a válasz közönséges szöveg.

A JSON-objektum mód nem kér sémát. Nevezd meg a kulcsokat a promptban:

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

Támogatás modellenként

A GET /v1/models ugyanezt jelenti azonosítónként: capabilities.json_schema minden modellnél, és capabilities.response_format a hosztolt nyílt súlyú modelleknél. Modellek és árak

Támogatott sémakulcsszavak

Hogy a modell mit kap a sémádból, a modelltől és a végponttól függ:

A Shannon modellek kulcsszó-részhalmaza a /v1/chat/completions végponton:

A /v1/responses végponton: text.format

A /v1/responses ugyanezt a kérést text.format néven írja. A séma közvetlenül a format mezőben áll, a name és a strict mellett, nem json_schema kulcs alatt. JSON-objektum módhoz küldd a {"format": {"type": "json_object"}} értéket.

{
  "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"]
      }
    }
  }
}

A JSON a message elem output_text részének text mezője:

{
  "output": [
    {
      "id": "msg_7e1d3c5b9a2f4d6e8c0b1a3f5e7d9c2b",
      "type": "message",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "{\"name\":\"John Doe\",\"age\":30,\"occupation\":\"engineer\"}",
          "annotations": []
        }
      ]
    }
  ]
}

A modellenkénti támogatás és a hibák ugyanazok, mint a /v1/chat/completions végponton. Responses API

A /v1/messages végponton: eszköz mint séma

A Messages formátumnak nincs strukturált kimeneti mezője. Ugyanezen modellek JSON-jához hívd a /v1/chat/completions vagy a /v1/responses végpontot ugyanazzal a kulccsal.

Ha a /v1/messages végponton akarsz maradni, írd le az objektumot eszközként: tedd a sémádat az input_schema mezőbe, és nevezd meg az eszközt a tool_choice mezőben. A tool_use blokk input mezője ekkor a te objektumod, már értelmezve. A megnevezett tool_choice értéket a hosztolt nyílt súlyú modellek érvényesítik.

{
  "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"}
    }
  ]
}

A blokk olvasása előtt ellenőrizd, hogy a stop_reason értéke tool_use. Funkcióhívás

Hogyan érkezik a JSON

• A JSON string. A válasz mellett nincs értelmezett objektum: futtasd a JSON-értelmezőt a message.content mezőn.
• stream: true esetén a JSON delta.content darabokban érkezik. Fűzd össze őket, és a stream befejezése után értelmezd egyszer; egy darab önmagában nem érvényes JSON.
• A hosztolt nyílt súlyú modell a response_format kérésre gondolkodási szöveg nélkül válaszol: a reasoning_content értéke null.

Ellenőrizd, amit kapsz

A séma az írás módját irányítja. Az API nem veti össze a kész választ a sémáddal, ezért a végső ellenőrzést a kódod végzi:

• Értelmezz (parse) hibakezelőn belül, ahogy a legfelső minta teszi.
• Validáld az értelmezett objektumot ugyanazzal a sémával a saját kódodban, például egy JSON Schema könyvtárral, Pydantic vagy Zod segítségével.
• A hosszú válasz véget érhet, mielőtt a JSON teljes lenne. A nem streamelt válasz a finish_reason értékét csak stop vagy tool_calls formában jelzi, ezért az értelmezési hiba a jel. Kérdezz újra, vagy kérj kisebb objektumot.

Hibák

A két 400 választ még azelőtt küldi, hogy bármi levonódna az egyenlegedből. Hibakezelés