Responses API

POST https://api.shannon-ai.com/v1/responses

A legkisebb kérés egy modellazonosító és egy szöveg. A válasz nem streamelt, hacsak nem kéred.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.responses.create(
    model="shannon-3",
    input="Say hello in one sentence.",
)

print(response.output_text)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.responses.create({
  model: "shannon-3",
  input: "Say hello in one sentence.",
});

console.log(response.output_text);

curl https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "input": "Say hello in one sentence."
  }'

A válasz egy response objektum. Az output mezője a gondolkodást, ha a modell gondolkodott, és az üzenetet tartalmazza:

{
  "id": "resp_5f0c1e7a9b3d4c62a8e1f07d2b46c9a3",
  "object": "response",
  "created_at": 1791625200,
  "model": "shannon-3",
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "metadata": {},
  "parallel_tool_calls": true,
  "temperature": null,
  "tool_choice": "auto",
  "tools": [],
  "top_p": null,
  "output": [
    {
      "id": "rs_8a2e6c1f4b7d4e03b9c5a1d70f3e2b64",
      "type": "reasoning",
      "summary": [
        {
          "type": "summary_text",
          "text": "The user wants a greeting in one sentence. Keep it short and friendly."
        }
      ]
    },
    {
      "id": "msg_1c7b9e3a5d2f4a86b0e4c8d19a6f7e25",
      "type": "message",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "Hello, it is good to meet you.",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 1184,
    "output_tokens": 46,
    "total_tokens": 1230
  }
}

Kérésmezők

A kéréshez a model és az input kell. Az Érvényesíti oszlop megnevezi azokat a modelleket, amelyeken egy mező módosítja a választ. A hosztolt nyílt súlyú modellek a modellista tizenkét azonosítója; a Shannon 3 család a shannon-3, shannon-3-pro, shannon-3.1 és shannon-3.1-pro. Modellek és árak

A previous_response_id, store, metadata, parallel_tool_calls, truncation, include, user és prompt_cache_key mezőt elfogadja, hogy a meglévő kliensprogram változtatás nélkül fusson. Nem módosítják a választ. Mivel nem tárol beszélgetést, a követő kérés a korábbi fordulókat az input mezőben hordozza.

Bemeneti elemek

A bemeneti elem vagy üzenet, role és content mezővel, vagy típusos elem, amely eszközhívást vagy annak eredményét hordozza. A content string vagy részek tömbje.

Az utasításokat az instructions mezőbe írd. Shannon 3 családbeli azonosítónál a kötelezően betartandó utasításokat a user üzenetbe tedd.

A válasz output elemei változtatás nélkül mehetnek vissza az input mezőbe: a message és function_call elemeket olvassa, a reasoning elemeket átugorja.

Tartalmi részek

A Shannon szinteken a képeket és fájlokat az input utolsó user eleméből olvassa. A méretek és korlátok külön oldalon vannak. Képek és fájlok

Kérés utasításokkal és beállításokkal

Ez a kérés utasításokat, bemeneti elemekként megadott beszélgetést, kimeneti korlátot, hőmérsékletet és gondolkodási effortot küld. Hosztolt nyílt súlyú modellt használ, amely mindegyiket érvényesíti.

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.responses.create(
    model="DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    instructions="You are a physics teacher. Answer in two sentences.",
    input=[
        {"role": "user", "content": "Why is the sky blue?"},
        {"role": "assistant", "content": "Air scatters blue light more than red light."},
        {"role": "user", "content": "And why are sunsets red?"},
    ],
    max_output_tokens=512,
    temperature=0.3,
    reasoning={"effort": "low"},
)

for item in response.output:
    if item.type == "reasoning":
        print("reasoning:", item.summary[0].text)
    elif item.type == "message":
        print("answer:", item.content[0].text)
print(response.usage)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const response = await client.responses.create({
  model: "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
  instructions: "You are a physics teacher. Answer in two sentences.",
  input: [
    { role: "user", content: "Why is the sky blue?" },
    { role: "assistant", content: "Air scatters blue light more than red light." },
    { role: "user", content: "And why are sunsets red?" },
  ],
  max_output_tokens: 512,
  temperature: 0.3,
  reasoning: { effort: "low" },
});

for (const item of response.output) {
  if (item.type === "reasoning") console.log("reasoning:", item.summary[0].text);
  if (item.type === "message") console.log("answer:", item.content[0].text);
}
console.log(response.usage);

curl https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "DeepSeek-V4-Flash-0731-W4A16-AUTOROUND-REAP",
    "instructions": "You are a physics teacher. Answer in two sentences.",
    "input": [
      {"role": "user", "content": "Why is the sky blue?"},
      {"role": "assistant", "content": "Air scatters blue light more than red light."},
      {"role": "user", "content": "And why are sunsets red?"}
    ],
    "max_output_tokens": 512,
    "temperature": 0.3,
    "reasoning": {"effort": "low"}
  }'

A hosztolt nyílt súlyú modell válasza tartalmazza az id, object, model, created_at, status, output és usage mezőt. A usage kiegészül a gyorsítványból olvasott és a gondolkodásra fordított tokenekkel:

{
  "usage": {
    "input_tokens": 58,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 67,
    "output_tokens_details": {
      "reasoning_tokens": 19
    },
    "total_tokens": 125
  }
}

A response objektum

Az id, object, status, output és usage minden válaszban megvan. A kódodat ezekre építsd.

Kimeneti elemek

Az OpenAI SDK-k összefűzik helyetted az üzenet szövegét a response.output_text mezőben.

Streaming

Állítsd a stream mezőt true értékre a server-sent eventekhez. Minden frame tartalmaz egy event: sort az esemény nevével és egy data: sort JSON-objektummal; az objektum a nevet megismétli a type mezőben. A deltákat az output_index alapján párosítsd az elemükhöz.

Az OpenAI SDK-val az eseményeket a type alapján olvasd:

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

stream = client.responses.create(
    model="shannon-3",
    input="Explain server-sent events in three sentences.",
    stream=True,
)

for event in stream:
    kind = getattr(event, "type", "error")     # an event without a type is an error event
    if kind == "response.reasoning_summary_text.delta":
        pass                                   # a piece of reasoning: event.delta
    elif kind == "response.output_text.delta":
        print(event.delta, end="", flush=True)
    elif kind == "response.output_item.done" and event.item.type == "function_call":
        print("\ntool call:", event.item.name, event.item.arguments)
    elif kind == "response.completed":
        print("\n", event.response.usage)
    elif kind in ("response.failed", "error"):
        raise RuntimeError("the stream failed, send the request again")

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.shannon-ai.com/v1",
});

const stream = await client.responses.create({
  model: "shannon-3",
  input: "Explain server-sent events in three sentences.",
  stream: true,
});

for await (const event of stream) {
  if (event.type === "response.reasoning_summary_text.delta") {
    // a piece of reasoning: event.delta
  } else if (event.type === "response.output_text.delta") {
    process.stdout.write(event.delta);
  } else if (event.type === "response.output_item.done" && event.item.type === "function_call") {
    console.log("\ntool call:", event.item.name, event.item.arguments);
  } else if (event.type === "response.completed") {
    console.log("\n", event.response.usage);
  } else if (event.type === "response.failed" || event.type === "error") {
    throw new Error("the stream failed, send the request again");
  }
}

curl -N https://api.shannon-ai.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "input": "Explain server-sent events in three sentences.",
    "stream": true
  }'

Az események ebben a sorrendben érkeznek. A gondolkodás, az üzenet és az eszközhívások csoportjai csak akkor jelennek meg, ha a válasz tartalmazza őket.

event: response.created
data: {"type":"response.created","response":{"id":"resp_5f0c…","object":"response","status":"in_progress","output":[], …}}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_5f0c…","object":"response","status":"in_progress","output":[], …}}

event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"id":"msg_1c7b…","type":"message","role":"assistant","status":"in_progress","content":[]}}

event: response.content_part.added
data: {"type":"response.content_part.added","output_index":0,"content_index":0,"part":{"type":"output_text","text":""}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":"Server-sent"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","output_index":0,"content_index":0,"delta":" events let a server push text over one HTTP reply."}

event: response.output_text.done
data: {"type":"response.output_text.done","output_index":0,"content_index":0,"text":"Server-sent events let a server push text over one HTTP reply."}

event: response.content_part.done
data: {"type":"response.content_part.done","output_index":0,"content_index":0,"part":{"type":"output_text","text":"Server-sent events let a server push text over one HTTP reply."}}

event: response.output_item.done
data: {"type":"response.output_item.done","output_index":0,"item":{"id":"msg_1c7b…","type":"message","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Server-sent events let a server push text over one HTTP reply.","annotations":[]}]}}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_5f0c…","object":"response","status":"completed","output":[…],"usage":{"input_tokens":1190,"output_tokens":18,"total_tokens":1208}, …}}

Hibázó stream

A Shannon szinteken a sikertelen válasz a response.completed helyett response.failed eseménnyel végződik. A response.status értéke failed, a response.error pedig code (rate_limit_exceeded vagy server_error) és message mezőt tartalmaz.

A hosztolt nyílt súlyú modelleknél a hiba egy error esemény api_error code értékkel és egy message mezővel. Ezt még követi a response.completed.

Tekints hibásnak egy streamet, ha response.failed vagy error eseményt tartalmaz, és küldd el újra a kérést.

Eszközök

Az eszköz egy függvény, amelyet a kódod futtat. Írd le a tools mezőben; ha a modell kéri, a válasz az üzenet helyett vagy mellett egy function_call elemet tartalmaz.

Eszközdefiníció a tools mezőben:

[
  {
    "type": "function",
    "name": "get_weather",
    "description": "Current weather for a city.",
    "parameters": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string"
        }
      },
      "required": [
        "city"
      ]
    }
  }
]

A hívást tartalmazó válasz output mezője:

[
  {
    "id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "type": "function_call",
    "name": "get_weather",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "arguments": "{\"city\":\"Paris\"}"
  }
]

Futtasd a függvényt, majd küldd el újra a kérést úgy, hogy a hívás és az eredménye hozzá van adva az input mezőhöz:

[
  {
    "role": "user",
    "content": "What is the weather in Paris?"
  },
  {
    "type": "function_call",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "name": "get_weather",
    "arguments": "{\"city\":\"Paris\"}"
  },
  {
    "type": "function_call_output",
    "call_id": "call_3d9a7c1e5b2f4a60c8e1d7f09b24a6c5",
    "output": "{\"temperature_c\": 18, \"sky\": \"cloudy\"}"
  }
]

Csak a function típusú eszközöket olvassa. A shannon-1.6-*, shannon-2-* és shannon-coder-1 modelleken a parameters sémát a gyakori JSON Schema kulcsszavakra szűkíti: a oneOf értéket anyOf szerint olvassa, az olyan kulcsszavakat, mint a $ref, additionalProperties, const, default és title, nem adja át a modellnek.

A tool_choice required értékét és a megnevezett függvényt a hosztolt nyílt súlyú modellek érvényesítik.

Az eszközciklust külön oldal írja le teljes egészében. Funkcióhívás

Strukturált kimenet

Ez a formátum a strukturált kimenetet 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 tag alatt, mint a Chat Completions végponton.

• A {"type": "json_object"} tetszőleges JSON-objektumot kér.
• A {"type": "json_schema", "name", "schema", "strict"} a sémádat követő JSON-t kér. A strict értéke true, ha kihagyod.

{
  "model": "shannon-1.6-lite",
  "input": "Extract the city and the date: 'The conference opens in Lisbon on 12 May 2027.'",
  "text": {
    "format": {
      "type": "json_schema",
      "name": "event",
      "strict": true,
      "schema": {
        "type": "object",
        "properties": {
          "city": {
            "type": "string"
          },
          "date": {
            "type": "string",
            "description": "ISO 8601 date"
          }
        },
        "required": [
          "city",
          "date"
        ]
      }
    }
  }
}

A JSON szövegként érkezik az üzenet output_text részében; értelmezd (parse) magad. A strukturált kimenet nélküli hosztolt nyílt súlyú modell 400 választ ad.

{"city": "Lisbon", "date": "2027-05-12"}

Hogy melyik modell melyik formát fogadja, külön oldalon van felsorolva. Strukturált kimenetek

Gondolkodás (reasoning)

A gondolkodó modell a gondolkodását reasoning típusú kimeneti elemként adja vissza, az üzenet előtt. Streamben response.reasoning_summary_text.delta eseményekként érkezik.

A hosztolt nyílt súlyú modellek a reasoning.effort mezőt érvényesítik: off, low, medium vagy high, és high, ha semmit nem küldesz. Az off nem ad vissza gondolkodási elemet. Objektumként küldd; a sima stringet ezen a végponton nem olvassa.

Az effortokat külön oldal írja le. Reasoning effort

Kimeneti korlát

A max_output_tokens alapértéke 4,096, ha nem küldöd. Ennyi tokent tesz félre az egyenlegedből a kérés indulásakor; amikor a válasz teljes, ezt a mennyiséget a kérés tényleges felhasználása váltja fel. Az az érték, amely nem fér bele a megmaradt egyenlegedbe, 429 Quota exceeded választ ad.

A shannon-1.6-*, shannon-2-* és shannon-coder-1 modelleken a válasz hosszát, a hosztolt nyílt súlyú modelleken a válaszszöveg hosszát korlátozza.

Ezen a végponton a shannon-coder-1 tokenben számolódik az egyenlegedből, mint minden más modell.

A kérés törzse legfeljebb 32 MiB lehet. Korlátok és egyenleg

Hibák

A hibák az OpenAI hibatörzset használják: egy error objektum type és message mezővel; némelyik code és param mezőt is hordoz null értékkel. A táblázat azt sorolja fel, amit ez a végpont leggyakrabban visszaad. A teljes lista, a megismétlendő esetekkel, külön oldalon van. Hibakezelés