Gestructureerde outputs

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

De JSON is de tekst van het antwoord, in 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}
  }
}

De modi van response_format

response_format is een veld van /v1/chat/completions. Zonder dit veld is het antwoord gewone tekst.

De JSON-objectmodus heeft geen schema nodig. Noem de sleutels in de 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"}
}

Ondersteuning per model

GET /v1/models meldt hetzelfde per id: capabilities.json_schema bij elk model, en capabilities.response_format bij de gehoste open-weight modellen. Modellen en prijzen

Ondersteunde schematrefwoorden

Wat een model van je schema ontvangt, hangt af van het model en van het endpoint:

De subset trefwoorden van de Shannon-modellen op /v1/chat/completions:

Op /v1/responses: text.format

/v1/responses schrijft dezelfde aanvraag als text.format. Het schema staat direct in format, naast name en strict, niet onder een json_schema-sleutel. Voor de JSON-objectmodus stuur je {"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"]
      }
    }
  }
}

De JSON is de text van het output_text-deel van het message-item:

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

De ondersteuning per model en de fouten zijn dezelfde als op /v1/chat/completions. Responses API

Op /v1/messages: een tool als schema

Het Messages-formaat heeft geen veld voor gestructureerde output. Voor JSON van dezelfde modellen roep je /v1/chat/completions of /v1/responses aan met dezelfde sleutel.

Om op /v1/messages te blijven, beschrijf je het object als tool: zet je schema in input_schema en noem de tool in tool_choice. De input van het tool_use-blok is dan je object, al geparseerd. Een benoemde tool_choice wordt toegepast door de gehoste open-weight modellen.

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

Controleer of stop_reason tool_use is voordat je het blok leest. Function calling

Hoe de JSON binnenkomt

• De JSON is een string. Het antwoord bevat er geen geparseerd object naast: laat je JSON-parser los op message.content.
• Met stream: true komt de JSON binnen in stukjes van delta.content. Voeg ze samen en parse pas als de stream is geëindigd; een los stukje is geen geldige JSON.
• Een gehost open-weight model beantwoordt een response_format-aanvraag zonder redeneertekst: reasoning_content is null.

Controleer wat je ontvangt

Het schema stuurt hoe het model schrijft. De API vergelijkt het voltooide antwoord niet met je schema, dus je code doet de eindcontrole:

• Parse binnen een foutafhandelaar, zoals het voorbeeld bovenaan doet.
• Valideer het geparseerde object in je eigen code met hetzelfde schema, bijvoorbeeld met een JSON Schema-bibliotheek, Pydantic of Zod.
• Een lang antwoord kan eindigen voordat de JSON compleet is. Een antwoord zonder streaming meldt finish_reason alleen als stop of tool_calls, dus een parsefout is het signaal. Vraag opnieuw, of vraag om een kleiner object.

Fouten

De twee 400-antwoorden worden verstuurd voordat er iets van je saldo wordt afgeschreven. Foutafhandeling