Output Berstruktur

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 ialah teks jawapan, dalam 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}
  }
}

Mod response_format

response_format ialah medan /v1/chat/completions. Tanpanya, jawapan ialah teks biasa.

Mod objek JSON tidak memerlukan skema. Namakan kunci dalam 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"}
}

Sokongan bagi setiap model

GET /v1/models melaporkan perkara yang sama bagi setiap id: capabilities.json_schema pada setiap model, dan capabilities.response_format pada model open-weight yang dihoskan. Model & harga

Kata kunci skema yang disokong

Apa yang diterima model daripada skema anda bergantung pada model dan endpoint:

Subset kata kunci model Shannon pada /v1/chat/completions:

Pada /v1/responses: text.format

/v1/responses mengeja permintaan yang sama sebagai text.format. Skema terletak terus dalam format, di sebelah name dan strict, bukan di bawah kunci json_schema. Untuk mod objek JSON, hantar {"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 ialah text bahagian output_text dalam item message:

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

Sokongan bagi setiap model dan ralat adalah sama seperti pada /v1/chat/completions. API Responses

Pada /v1/messages: alat sebagai skema

Format Messages tidak mempunyai medan output berstruktur. Untuk JSON daripada model yang sama, panggil /v1/chat/completions atau /v1/responses dengan kunci yang sama.

Untuk kekal pada /v1/messages, huraikan objek sebagai alat: letakkan skema anda dalam input_schema dan namakan alat dalam tool_choice. input blok tool_use kemudian ialah objek anda, yang sudah dihuraikan. tool_choice yang dinamakan dikenakan oleh model open-weight yang dihoskan.

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

Semak bahawa stop_reason ialah tool_use sebelum anda membaca blok itu. Panggilan Fungsi

Cara JSON tiba

• JSON ialah rentetan. Balasan tidak mempunyai objek yang telah dihuraikan di sebelahnya: jalankan penghurai JSON anda pada message.content.
• Dengan stream: true, JSON tiba dalam bahagian delta.content. Gabungkannya dan huraikan sekali selepas stream tamat; satu bahagian sahaja bukan JSON yang sah.
• Model open-weight yang dihoskan menjawab permintaan response_format tanpa teks penaakulan: reasoning_content ialah null.

Semak apa yang anda terima

Skema membimbing cara model menulis. API tidak membandingkan jawapan yang siap dengan skema anda, jadi kod anda membuat semakan akhir:

• Huraikan di dalam pengendali ralat, seperti sampel di bahagian atas.
• Sahkan objek yang dihuraikan dengan skema yang sama dalam kod anda sendiri, contohnya dengan pustaka JSON Schema, Pydantic atau Zod.
• Jawapan yang panjang boleh berakhir sebelum JSON lengkap. Balasan yang tidak di-stream melaporkan finish_reason sebagai stop atau tool_calls sahaja, jadi ralat penghuraian ialah isyaratnya. Tanya semula, atau minta objek yang lebih kecil.

Ralat

Kedua-dua balasan 400 dihantar sebelum apa-apa ditolak daripada baki anda. Pengendalian Ralat