Responses API

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

Ամենափոքր հարցումը մոդելի id-ն է և տեքստը։ Պատասխանը streaming չի լինի, եթե չխնդրեք։

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

Պատասխանը response օբյեկտ է։ Դրա output-ը պարունակում է reasoning-ը, երբ մոդելը տրամաբանել է, և հաղորդագրությունը.

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

Հարցման դաշտեր

Հարցման համար պետք են model և input։ Կիրառվում է սյունակը նշում է այն մոդելները, որոնց վրա դաշտը փոխում է պատասխանը։ Hosted open-weight մոդելները մոդելների ցանկի տասներկու id-ներն են. Shannon 3 ընտանիքը shannon-3, shannon-3-pro, shannon-3.1 և shannon-3.1-pro են։ Մոդելներ և գներ

previous_response_id, store, metadata, parallel_tool_calls, truncation, include, user և prompt_cache_key ընդունվում են, որպեսզի առկա կլիենտային կոդն աշխատի առանց փոփոխության։ Դրանք պատասխանը չեն փոխում։ Քանի որ զրույցը չի պահվում, հաջորդ հարցումը նախորդ փուլերը կրում է input-ում։

Մուտքի տարրեր

Մուտքի տարրը կամ հաղորդագրություն է՝ role-ով և content-ով, կամ տիպավորված տարր, որը կրում է գործիքի կանչ կամ դրա արդյունքը։ content-ը տող է կամ մասերի զանգված։

Հրահանգները դրեք instructions դաշտում։ Shannon 3 ընտանիքի id-ի դեպքում այն հրահանգները, որոնք պետք է պահպանվեն, դրեք user հաղորդագրության մեջ։

Պատասխանի output-ի տարրերը կարող են հետ գնալ input-ի մեջ այնպես, ինչպես կան. message և function_call տարրերը կարդացվում են, reasoning տարրերը բաց են թողնվում։

Content մասեր

Shannon մակարդակներում պատկերներն ու ֆայլերը կարդացվում են input-ի վերջին user տարրից։ Չափերն ու սահմանները ունեն իրենց էջը։ Պատկերներ և ֆայլեր

Հարցում հրահանգներով և ընտրանքներով

Այս հարցումն ուղարկում է հրահանգներ, զրույց՝ որպես մուտքի տարրեր, ելքի սահման, temperature և reasoning effort։ Այն օգտագործում է hosted open-weight մոդել, որը կիրառում է դրանք բոլորը։

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

Hosted open-weight մոդելի պատասխանն ունի id, object, model, created_at, status, output և usage։ Դրա usage-ը ավելացնում է cache-ից կարդացված թոքենները և reasoning-ի վրա ծախսված թոքենները.

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

Response օբյեկտը

id, object, status, output և usage առկա են յուրաքանչյուր պատասխանում։ Ձեր կոդը կառուցեք դրանց վրա։

Ելքի տարրեր

OpenAI SDK-ները հաղորդագրության տեքստը ձեր փոխարեն միացնում են response.output_text-ում։

Streaming

Սահմանեք stream-ը true՝ server-sent events ստանալու համար։ Յուրաքանչյուր շրջանակ ունի event: տող՝ իրադարձության անունով, և data: տող՝ JSON օբյեկտով. օբյեկտը կրկնում է անունը type-ում։ Delta-ները կապեք իրենց տարրին ըստ output_index-ի։

OpenAI SDK-ով իրադարձությունները կարդացեք ըստ 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
  }'

Իրադարձությունները գալիս են այս հերթականությամբ։ Reasoning-ի, հաղորդագրության և գործիքի կանչերի խմբերը հայտնվում են միայն այն դեպքում, երբ պատասխանն ունի դրանք։

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

Ձախողվող հոսք

Shannon մակարդակներում ձախողված պատասխանն ավարտվում է response.failed-ով՝ response.completed-ի փոխարեն։ Դրա response.status-ը failed է, իսկ response.error-ը պարունակում է code (rate_limit_exceeded կամ server_error) և message։

Hosted open-weight մոդելների վրա ձախողումը error իրադարձություն է՝ code api_error-ով և message-ով։ response.completed-ը դրանից հետո, այնուամենայնիվ, հաջորդում է։

Հոսքը համարեք ձախողված, երբ այն պարունակում է response.failed կամ error իրադարձություն, և ուղարկեք հարցումը կրկին։

Գործիքներ

Գործիքը ֆունկցիա է, որը կատարում է ձեր կոդը։ Նկարագրեք այն tools-ում. երբ մոդելը ուզում է այն, պատասխանը պարունակում է function_call տարր՝ հաղորդագրության փոխարեն կամ նրա կողքին։

Գործիքի սահմանում tools-ում.

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

Այն կանչող պատասխանի output-ը.

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

Կատարեք ֆունկցիան, ապա ուղարկեք հարցումը կրկին՝ կանչը և դրա արդյունքը ավելացնելով 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\"}"
  }
]

Կարդացվում են միայն function տեսակի գործիքները։ shannon-1.6-*, shannon-2-* և shannon-coder-1 մոդելների վրա parameters սխեման կրճատվում է մինչև JSON Schema-ի ընդհանուր հիմնաբառերը. oneOf-ը կարդացվում է որպես anyOf, իսկ $ref, additionalProperties, const, default և title հիմնաբառերը մոդելին չեն փոխանցվում։

tool_choice-ի required արժեքը և անվանված ֆունկցիան կիրառում են hosted open-weight մոդելները։

Գործիքների ցիկլը ամբողջությամբ նկարագրված է իր էջում։ Ֆունկցիայի կանչ

Structured output

Այս ձևաչափը structured output-ը գրում է որպես text.format։ Սխեման գտնվում է անմիջապես format-ում՝ name-ի և strict-ի կողքին, ոչ թե json_schema անդամի տակ, ինչպես Chat Completions-ում։

• {"type": "json_object"} խնդրում է ցանկացած JSON օբյեկտ։
• {"type": "json_schema", "name", "schema", "strict"} խնդրում է ձեր սխեմային համապատասխանող JSON։ Երբ strict-ը բաց եք թողնում, այն true է։

{
  "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-ը գալիս է որպես տեքստ հաղորդագրության output_text մասում. վերլուծեք (parse) այն ինքներդ։ Structured output չունեցող hosted open-weight մոդելը վերադարձնում է 400։

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

Ո՞ր մոդելն ընդունում է որ ձևը, նշված է իր էջում։ Կառուցվածքային արդյունքներ

Reasoning

Տրամաբանող մոդելը վերադարձնում է իր reasoning-ը որպես reasoning տեսակի ելքի տարր՝ հաղորդագրությունից առաջ։ Հոսքում այն գալիս է որպես response.reasoning_summary_text.delta իրադարձություններ։

Hosted open-weight մոդելները կիրառում են reasoning.effort՝ off, low, medium կամ high, իսկ երբ ոչինչ չեք ուղարկում՝ high։ off-ը reasoning տարր չի վերադարձնում։ Ուղարկեք այն որպես օբյեկտ. պարզ տողը այս endpoint-ում չի կարդացվում։

Effort-ները նկարագրված են իրենց էջում։ Reasoning effort

Ելքի սահման

max_output_tokens-ը 4,096 է, երբ չեք ուղարկում այն։ Սա այն թոքենների քանակն է, որն առանձնացվում է ձեր մնացորդից հարցման սկզբում. երբ պատասխանը ավարտվում է, այդ քանակը փոխարինվում է հարցման օգտագործածով։ Արժեքը, որը չի տեղավորվում ձեր մնացորդի մեջ, վերադարձնում է 429 Quota exceeded։

Այն սահմանափակում է պատասխանի երկարությունը shannon-1.6-*, shannon-2-* և shannon-coder-1 մոդելների վրա, և պատասխանի տեքստի երկարությունը՝ hosted open-weight մոդելների վրա։

Այս endpoint-ում shannon-coder-1-ը գանձվում է թոքեններով ձեր մնացորդից, ինչպես մյուս բոլոր մոդելները։

Հարցման մարմինը կարող է լինել մինչև 32 MiB։ Սահմանաչափեր և մնացորդ

Սխալներ

Սխալները օգտագործում են OpenAI-ի սխալի մարմինը՝ error օբյեկտ type-ով և message-ով. ոմանք կրում են նաև code և param null արժեքով։ Աղյուսակը թվարկում է այն, ինչ այս endpoint-ը վերադարձնում է ամենահաճախ։ Լրիվ ցանկը՝ ինչը կրկնել, ունի իր էջը։ Սխալների մշակում