Responses API

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

Minnsta beiðnin er auðkenni líkans og texti. Svarið er ekki streymt nema þú biðjir um það.

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

Svarið er response hlutur. output hans geymir rökhugsunina, þegar líkanið rökhugsaði, og skilaboðin:

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

Beiðnireitir

model og input er það sem beiðni þarf. Dálkurinn Notað af nefnir líkönin þar sem reitur breytir svarinu. Hýstu líkönin með opnum þyngdum eru auðkennin tólf á líkanalistanum; Shannon 3 fjölskyldan er shannon-3, shannon-3-pro, shannon-3.1 og shannon-3.1-pro. Líkön og verð

previous_response_id, store, metadata, parallel_tool_calls, truncation, include, user og prompt_cache_key eru samþykkt svo að núverandi biðlarakóði keyri óbreyttur. Þau breyta ekki svarinu. Þar sem ekkert samtal er geymt ber eftirfylgnibeiðni fyrri lotur í input.

Inntaksfærslur

Inntaksfærsla er annaðhvort skilaboð, með role og content, eða færsla með gerð sem ber tólakall eða niðurstöðu þess. content er strengur eða fylki af hlutum.

Settu fyrirmæli í instructions reitinn. Með auðkenni úr Shannon 3 fjölskyldunni skaltu setja fyrirmæli sem verða að gilda inn í user skilaboðin.

Færslur í output svars mega fara aftur inn í input eins og þær eru: message og function_call færslur eru lesnar, reasoning færslum er sleppt.

Efnishlutar

Á Shannon-þrepunum eru myndir og skrár lesnar úr síðustu user færslu í input. Stærðir og mörk hafa sína eigin síðu. Myndir og skrár

Beiðni með fyrirmælum og valkostum

Þessi beiðni sendir fyrirmæli, samtal sem inntaksfærslur, úttakshámark, hitastig og rökhugsunarstig. Hún notar hýst líkan með opnum þyngdum, sem tekur tillit til þeirra allra.

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

Svar hýsts líkans með opnum þyngdum hefur id, object, model, created_at, status, output og usage. usage þess bætir við tókum lesnum úr skyndiminni og tókum sem fóru í rökhugsun:

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

Svarhluturinn

id, object, status, output og usage eru í hverju svari. Byggðu kóðann þinn á þeim.

Úttaksfærslur

OpenAI SDK safnsöfnin sameina texta skilaboðanna fyrir þig í response.output_text.

Streymi

Stilltu stream á true til að fá server-sent events. Hver rammi hefur event: línu með nafni atburðarins og data: línu með JSON-hlut; hluturinn endurtekur nafnið í type. Paraðu delta við færslu þeirra með output_index.

Með OpenAI SDK skaltu lesa atburðina eftir type:

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

Atburðirnir berast í þessari röð. Hóparnir fyrir rökhugsun, skilaboð og tólakall birtast aðeins þegar svarið hefur þá.

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}, …}}

Streymi sem mistekst

Hjá Shannon stigunum lýkur misheppnuðu svari með response.failed í stað response.completed. response.status þess er failed og response.error geymir code, rate_limit_exceeded eða server_error, og message.

Hjá hýstu líkönunum með opnum þyngdum er bilun error atburður með code api_error og message. response.completed fylgir samt á eftir.

Líttu á streymi sem misheppnað þegar það inniheldur response.failed eða error atburð, og sendu beiðnina aftur.

Tól

Tól er fall sem kóðinn þinn keyrir. Lýstu því í tools; þegar líkanið vill nota það inniheldur svarið function_call færslu í stað skilaboðanna, eða við hlið þeirra.

Tólaskilgreining í tools:

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

output svars sem kallar á það:

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

Keyrðu fallið og sendu síðan beiðnina aftur með kallinu og niðurstöðu þess bættum við input:

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

Aðeins tól af gerðinni function eru lesin. Á shannon-1.6-*, shannon-2-* og shannon-coder-1 er parameters skemað minnkað í algeng JSON Schema lykilorð: oneOf er lesið sem anyOf, og lykilorð eins og $ref, additionalProperties, const, default og title eru ekki send áfram til líkansins.

tool_choice gildin required og nefnt fall eru notuð af hýstu líkönunum með opnum þyngdum.

Tólalykkjan er lýst í heild á sinni eigin síðu. Aðgerðaköll

Skipulagt úttak

Þetta snið skrifar skipulagt úttak sem text.format. Skemað situr beint í format, við hlið name og strict, ekki undir json_schema meðlimi eins og í Chat Completions.

• {"type": "json_object"} biður um hvaða JSON-hlut sem er.
• {"type": "json_schema", "name", "schema", "strict"} biður um JSON sem fylgir skemanu þínu. strict er true þegar þú sleppir því.

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

JSON-ið berst sem texti í output_text hluta skilaboðanna; þáttaðu það sjálf(ur). Hýst líkan með opnum þyngdum án skipulags úttaks skilar 400.

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

Hvaða líkan tekur hvaða form er skráð á sinni eigin síðu. Skipulögð úttök

Rökhugsun

Líkan sem rökhugsar skilar rökhugsun sinni sem úttaksfærslu af gerðinni reasoning, á undan skilaboðunum. Í streymi berst hún sem response.reasoning_summary_text.delta atburðir.

Hýstu líkönin með opnum þyngdum nota reasoning.effort: off, low, medium eða high, og high þegar þú sendir ekkert. off skilar engri rökhugsunarfærslu. Sendu það sem hlut; hrár strengur er ekki lesinn á þessum endapunkti.

Stigin eru útskýrð á sinni eigin síðu. Rökhugsunarátak

Úttaksmörk

max_output_tokens er 4,096 þegar þú sendir það ekki. Það er fjöldi tókna sem tekinn er frá af stöðunni þinni þegar beiðnin hefst; þegar svarinu er lokið kemur það sem beiðnin notaði í stað þeirrar upphæðar. Gildi sem rúmast ekki innan stöðunnar sem eftir er skilar 429 Quota exceeded.

Það takmarkar lengd svarsins á shannon-1.6-*, shannon-2-* og shannon-coder-1, og lengd svartextans á hýstum líkönum með opnum þyngdum.

Á þessum endapunkti er shannon-coder-1 gjaldfært í táknum af stöðunni þinni, eins og hvert annað líkan.

Beiðnameginmál getur verið allt að 32 MiB. Mörk og staða

Villur

Villur nota OpenAI-villumeginmálið: error hlut með type og message; sumar bera einnig code og param með gildið null. Taflan sýnir það sem þessi endapunktur skilar oftast. Heildarlistinn, með því hvað á að endurreyna, hefur sína eigin síðu. Villumeðhöndlun