Responses API

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

Is e id modail agus teacsa an t-iarrtas as lugha. Chan eil am freagairt air a shruthadh mura h-iarr thu e.

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

Is e nì freagairt a th’ anns an fhreagairt. Tha an reasoning ann an output, nuair a rinn am modail reasoning, agus an teachdaireachd:

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

Raointean iarrtais

Is e model agus input na tha a dhìth air iarrtas. Tha an colbh Applied by ag ainmeachadh nam modailean air a bheil raon ag atharrachadh an fhreagairt. Is e na modailean open-weight hosted an dusan id air liosta nam modailean; is e teaghlach Shannon 3 shannon-3, shannon-3-pro, shannon-3.1 agus shannon-3.1-pro. Modailean & prìsean

Thèid previous_response_id, store, metadata, parallel_tool_calls, truncation, include, user agus prompt_cache_key a ghabhail gus am bi còd client a th’ ann a’ ruith gun atharrachadh. Chan atharraich iad am freagairt. Leis nach eil còmhradh air a stòradh, bidh na turns na bu tràithe ann an input ann an iarrtas leantainneach.

Nithean cuir-a-steach

Is e teachdaireachd, le role agus content, no nì le seòrsa a tha a’ giùlan gairm inneal no a thoradh a th’ ann an nì cuir-a-steach. Is e sreang no raon de phàirtean a th’ ann an content.

Cuir stiùireadh san raon instructions. Le id de theaghlach Shannon 3, cuir stiùireadh a dh’fheumas a bhith ann san teachdaireachd user.

Faodaidh nithean output freagairt a dhol air ais dhan input mar a tha iad: thèid nithean message agus function_call a leughadh, thèid nithean reasoning a leum thairis.

Pàirtean susbaint

Air ìrean Shannon thèid dealbhan agus faidhlichean a leughadh bhon nì user mu dheireadh ann an input. Tha duilleag fhèin aig meudan is crìochan. Dealbhan agus faidhlichean

Iarrtas le stiùireadh agus roghainnean

Cuiridh an t-iarrtas seo stiùireadh, còmhradh mar nithean cuir-a-steach, crìoch cuir-a-mach, temperature agus oidhirp reasoning. Cleachdaidh e modail open-weight hosted, a chuireas uile an gnìomh.

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

Tha id, object, model, created_at, status, output agus usage ann am freagairt modail open-weight hosted. Cuiridh usage aige ris na tokens a chaidh a leughadh bho cache agus na tokens a chaidh air reasoning:

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

An nì freagairt

Tha id, object, status, output agus usage air gach freagairt. Tog do chòd orra sin.

Nithean cuir-a-mach

Cuiridh na OpenAI SDKan teacsa na teachdaireachd còmhla dhut ann an response.output_text.

Streaming

Suidhich stream gu true airson server-sent events. Tha loidhne event: aig gach frèam le ainm an tachartais agus loidhne data: le nì JSON; bidh an nì ag ath-aithris an ainm ann an type. Maidsich deltas ris an nì aca le output_index.

Leis an OpenAI SDK, leugh na tachartasan a-rèir an 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
  }'

Bidh na tachartasan a’ ruighinn san òrdugh seo. Chan eil buidhnean reasoning, na teachdaireachd is gairmean inneal ann ach nuair a tha iad san fhreagairt.

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

Stream a dh’fhàilligeas

Air ìrean Shannon crìochnaichidh freagairt a dh’fhàillig le response.failed an àite response.completed. Is e failed an response.status aige agus tha code (rate_limit_exceeded no server_error) agus message ann an response.error.

Air na modailean open-weight hosted is e tachartas error le code api_error agus message a th’ ann am fàillinn. Thig response.completed às a dhèidh fhathast.

Gabh ri stream mar fhàillinn nuair a tha tachartas response.failed no error ann, agus cuir an t-iarrtas a-rithist.

Innealan

Is e inneal gnìomh a ruitheas do chòd. Mìnich e ann an tools; nuair a tha am modail ga iarraidh, tha nì function_call san fhreagairt an àite na teachdaireachd, no ri a taobh.

Mìneachadh inneil ann an tools:

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

An output aig freagairt a ghairmeas e:

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

Ruith an gnìomh, an uair sin cuir an t-iarrtas a-rithist leis a’ ghairm agus an toradh aice air an cur ri 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\"}"
  }
]

Thèid dìreach innealan de sheòrsa function a leughadh. Air shannon-1.6-*, shannon-2-* agus shannon-coder-1 thèid an sgeama parameters a lùghdachadh gu na h-iuchraichean cumanta JSON Schema: thèid oneOf a leughadh mar anyOf, agus chan eilear a’ cur iuchraichean leithid $ref, additionalProperties, const, default agus title chun a’ mhodail.

Cuiridh na modailean open-weight hosted luachan tool_choice required agus gnìomh air ainm an gnìomh.

Tha lùb nan innealan air a mhìneachadh gu h-iomlan air duilleag fhèin. Call gnìomh

Toradh structaraichte

Tha an cruth seo a’ sgrìobhadh toradh structaraichte mar text.format. Tha an sgeama dìreach ann an format, ri taobh name agus strict, chan ann fo bhall json_schema mar air Chat Completions.

• Iarraidh {"type": "json_object"} nì JSON sam bith.
• Iarraidh {"type": "json_schema", "name", "schema", "strict"} JSON a leanas an sgeama agad. Tha strict true nuair a dh’fhàgas tu às e.

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

Thig an JSON mar theacsa ann am pàirt output_text na teachdaireachd; parsaich thu fhèin e. Tillidh modail open-weight hosted gun toradh structaraichte 400.

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

Tha an cruth a ghabhas gach modail air a liostadh air duilleag fhèin. Toraidhean structarail

Reasoning

Tillidh modail a nì reasoning a reasoning mar nì cuir-a-mach de sheòrsa reasoning, ron teachdaireachd. Ann an stream thig e mar thachartasan response.reasoning_summary_text.delta.

Cuiridh na modailean open-weight hosted reasoning.effort an gnìomh: off, low, medium no high, le high nuair nach cuir thu dad. Chan eil off a’ tilleadh nì reasoning. Cuir e mar nì; chan eilear a’ leughadh sreang lom air an endpoint seo.

Tha na h-oidhirpean air am mìneachadh air duilleag fhèin. Oidhirp reusanachaidh

Crìoch cuir-a-mach

Tha max_output_tokens 4,096 nuair nach cuir thu e. Is e an àireamh de tokens a thèid a chuir an dàrna taobh bho do balance nuair a thòisicheas an t-iarrtas; nuair a tha am freagairt coileanta, thèid an t-suim sin a chur an àite na chleachd an t-iarrtas. Tillidh luach nach freagair ris a’ balance a tha air fhàgail agad 429 Quota exceeded.

Cuingichidh e fad an fhreagairt air shannon-1.6-*, shannon-2-* agus shannon-coder-1, agus fad teacsa an fhreagairt air na modailean open-weight hosted.

Air an endpoint seo thèid shannon-coder-1 a chosgadh ann an tokens bho do balance, mar gach modail eile.

Faodaidh bodhaig iarrtais a bhith suas gu 32 MiB. Crìochan agus balance

Mearachdan

Bidh mearachdan a’ cleachdadh bodhaig mearachd OpenAI: nì error le type agus message; tha code agus param le luach null aig cuid cuideachd. Tha an clàr a’ liostadh na tha an endpoint seo a’ tilleadh as trice. Tha duilleag fhèin aig an liosta iomlan, le dè a dh’fheumar ath-fheuchainn. Làimhseachadh mearachd