Fikarohana web

POST https://api.shannon-ai.com/v1/chat/completions

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="shannon-3",
    messages=[{"role": "user", "content": "What is the weather forecast for Lisbon this weekend?"}],
    extra_body={"web_search": True},  # a Shannon field, so it goes in extra_body
)

print(response.choices[0].message.content)

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: "shannon-3",
  messages: [{ role: "user", content: "What is the weather forecast for Lisbon this weekend?" }],
  web_search: true,
});

console.log(response.choices[0].message.content);

curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [
      {"role": "user", "content": "What is the weather forecast for Lisbon this weekend?"}
    ],
    "web_search": true
  }'

Ny valiny dia chat completion mahazatra miaraka amin'ny fanampiana roa. Ny valiny dia manondro ny vokatry ny fikarohana amin'ny isa ao anaty fononteny efa-joro, ny sources milaza izay lazain'ny isa tsirairay, ary ny annotations mamaritra izay misy ny fanonona tsirairay:

{
  "id": "chatcmpl-3e5a7c9b1d2f4a6c8e0b2d4f6a8c1e3b",
  "object": "chat.completion",
  "created": 1791590400,
  "model": "shannon-3",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Saturday in Lisbon is forecast to be sunny with a high near 24 °C [1]. Sunday turns cloudy, with a chance of light rain in the afternoon [2].",
        "reasoning_content": null,
        "annotations": [
          {
            "type": "url_citation",
            "url_citation": {
              "start_index": 66,
              "end_index": 69,
              "url": "https://weather.example/lisbon/weekend",
              "title": "Lisbon weather: weekend outlook"
            }
          },
          {
            "type": "url_citation",
            "url_citation": {
              "start_index": 137,
              "end_index": 140,
              "url": "https://forecast.example/pt/lisbon/sunday",
              "title": "Sunday forecast for Lisbon"
            }
          }
        ]
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 2874,
    "completion_tokens": 41,
    "total_tokens": 2915
  },
  "sources": [
    {
      "index": 1,
      "title": "Lisbon weather: weekend outlook",
      "url": "https://weather.example/lisbon/weekend"
    },
    {
      "index": 2,
      "title": "Sunday forecast for Lisbon",
      "url": "https://forecast.example/pt/lisbon/sunday"
    },
    {
      "index": 3,
      "title": "Portugal: the week ahead",
      "url": "https://news.example/portugal/weather-week"
    }
  ]
}

Fampandehanana ny fikarohana

Ny fikarohana dia saha amin'ny fangatahana, atsahatra ho default. Tsy misy karohina raha tsy alefan'ny fangatahana.

Amin'ny /v1/messages ny saha dia mipetraka eo amin'ny ambaratonga ambony indrindra amin'ny body, eo anilan'ny model sy messages:

{
  "model": "shannon-3",
  "web_search": true,
  "messages": [
    {
      "role": "user",
      "content": "What is the weather forecast for Lisbon this weekend?"
    }
  ]
}

Izay ataon'ny fangatahana misy fikarohana

• Ny API dia mikaroka ao amin'ny web ho an'ny hafatry ny mpampiasa farany. Ny fihodinana teo aloha amin'ny resaka no manome ny fikarohana ny contextany.
• Mandeha ny fikarohana amin'ny fangatahana rehetra mandefa web_search: true. Ny model dia tsy mifidy raha hikaroka.
• Ny vokatra dia apetraka eo anoloan'ny model ho loharano misy isa, ary ny model no manoratra ny valiny avy aminy.
• Manomboka ny valiny rehefa vita ny fikarohana. Ny fangatahana streamed dia tsy mandefa na inona na inona, na header na event, hatramin'izay, ka manomeza fiandrasana lavitra kokoa alohan'ny chunk voalohany.

Izay ao amin'ny valiny

• Ny valiny dia manana endrika mahazatra an'ny endpoint-ny. Ny valiny dia ao amin'ny choices[0].message.content (block text amin'ny /v1/messages).
• Ny soratra dia mety mitondra marika toy ny [1] sy [2] aorian'ny fanambarana tohanany. Ny isa tsirairay dia solon'ny iray amin'ny vokatra novakin'ny model.
• Ny sources dia manonona ireo vokatra ireo: andalana iray ho an'ny vokatra rehetra nomena ny model, miaraka amin'ny index, title ary url. Ny marika [1] dia ilay andalana manana index 1. Ny vokatra tsy notononin'ny valiny dia ao anaty lisitra koa.
• Amin'ny /v1/chat/completions ny hafatra dia manana annotations koa, amin'ny endriky ny OpenAI: url_citation iray ho an'ny loharano tsirairay notononin'ny marika, miaraka amin'ny url, title, ary start_index sy end_index, ny toeran'ny marika ao amin'ny content isaina amin'ny tarehintsoratra (tsy ampidirina ny farany).
• Ao anaty stream ny sources dia tonga miaraka amin'ny chunk farany, ary amin'ny /v1/messages miaraka amin'ny event message_delta. Ny annotations dia tonga ao anaty chunk iray alohan'ny farany, ho delta.annotations.
• Ny sources dia misy ihany rehefa nahita zavatra ny fikarohan'ity fangatahana ity. Ny valiny tsy misy azy dia nosoratana tsy nisy vokatry ny fikarohana.

Ny fomba fikajiana ny fikarohana

Ny plan rehetra dia misy fikarohana isan'andro:

• Ny fangatahana izay nahita zavatra ny fikarohana-ny dia mampiasa fikarohana iray amin'ny allowance isan'andro. Ny fikarohana tsy nahita na inona na inona dia tsy mampiasa.
• Ny chat sy ny API dia mizara ny allowance an'ny kaonty manana ny key.
• Miverina manomboka ny fanisana isan'andro amin'ny 00:00 UTC.
• Ny vokatry ny fikarohana dia input token amin'ny fangatahana ary vidiana miaraka amin'ny sisa amin'ny prompt.

Ampitahao ny plan

Rehefa lany ny fikarohana isan'andro

Ny fangatahana mandefa web_search: true aorian'ny fikarohana farany amin'ny andro dia tsy lavina. Valiana tsy misy fikarohana izy: 200 ny status ary tsy manana sources ny valiny.

Fikarohana ho tool anao manokana

Ny web_search: true no hany switch ho an'ny fikarohana voasoratra eto. Ny function faritanao ao amin'ny tools ary tononinao hoe web_search dia iray amin'ny tool anao: ny model dia mamerina antso, ary ny kaody-nao no mampandeha ny fikarohana sy mandefa ny valiny miverina.

Ny karazana tool fikarohana an'ny platform hafa, toy ny web_search_20250305 amin'ny /v1/messages na {"type": "web_search"} amin'ny /v1/responses, dia tsy manomboka fikarohana eto.

Hadisoana

Ny fikarohana web dia tsy manampy code status na karazana hadisoana. Ny fikarohana tsy nahita na inona na inona, na ny andro tsy misy fikarohana sisa, dia manome valiny mahazatra tsy misy vokatra fikarohana. Ny hadisoana hafa rehetra dia mitovy amin'ny an'ny fangatahana tsy misy fikarohana. Fitantanana hadisoana