Vefleit

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

Svarið er venjuleg chat completion með tveimur viðbótum. Svarið vísar í leitarniðurstöðurnar með tölum í hornklofum, sources segir fyrir hvað hver tala stendur og annotations merkir hvar hver þeirra er nefnd:

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

Kveikt á leit

Leit er reitur í beiðninni, sjálfgefið slökkt. Ekkert er leitað nema beiðni sendi hann.

Á /v1/messages situr reiturinn á efsta stigi meginmálsins, við hlið model og messages:

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

Hvað beiðni með leit gerir

• API leitar á vefnum að síðustu notendaskilaboðum. Fyrri umferðir samtalsins gefa leitinni samhengi.
• Leitin keyrir í hverri beiðni sem sendir web_search: true. Líkanið velur ekki hvort leitað er.
• Niðurstöðurnar eru lagðar fyrir líkanið sem númeraðar heimildir, og líkanið skrifar svarið út frá þeim.
• Svarið hefst þegar leitinni er lokið. Streymd beiðni sendir ekkert, hvorki hausa né atburði, fyrr en þá, svo gerðu ráð fyrir lengri bið fyrir fyrsta bútinn.

Hvað svarið inniheldur

• Svarið hefur venjulega lögun endapunktsins. Svarið er í choices[0].message.content (text blokk á /v1/messages).
• Textinn getur borið merki eins og [1] og [2] á eftir fullyrðingunum sem þau styðja. Hver tala stendur fyrir eina af niðurstöðunum sem líkanið las.
• sources nefnir þessar niðurstöður: ein færsla fyrir hverja niðurstöðu sem líkanið fékk, með index, title og url. Merkið [1] er færslan með index 1. Niðurstöður sem svarið vísar ekki í eru einnig á listanum.
• Á /v1/chat/completions hefur skilaboðin einnig annotations, á OpenAI-sniði: eitt url_citation fyrir hverja heimild sem merki nefnir, með url, title, og start_index og end_index, stöðu merkisins í content talda í stöfum (endirinn er ekki með).
• Í streymi kemur sources með síðasta bútnum, og á /v1/messages með message_delta atburðinum. Skýringarnar koma í einum bút rétt á undan þeim síðasta, sem delta.annotations.
• sources er aðeins til staðar ef leit þessarar beiðni fann eitthvað. Svar án þess var skrifað án leitarniðurstaðna.

Hvernig leitir eru taldar

Hver áskrift inniheldur ákveðinn fjölda leita á dag:

• Beiðni þar sem leitin fann eitthvað notar eina leit af úthlutun dagsins. Leit sem fann ekkert notar enga.
• Spjall og API deila úthlutuninni á reikningnum sem á lykilinn.
• Talningin byrjar aftur á hverjum degi kl. 00:00 UTC.
• Leitarniðurstöðurnar eru inntakstókar beiðninnar og eru gjaldfærðar með restinni af prompt.

Bera saman áskriftir

Þegar leitir dagsins eru uppurnar

Beiðni sem sendir web_search: true eftir síðustu leit dagsins er ekki hafnað. Henni er svarað án leitar: staðan er 200 og svarið hefur engin sources.

Leit sem þitt eigið tól

web_search: true er eini rofinn fyrir leitina sem er lýst hér. Fall sem þú skilgreinir í tools og nefnir web_search er eitt af þínum eigin tólum: líkanið skilar kalli og kóðinn þinn keyrir leitina og sendir niðurstöðuna til baka.

Leitartólagerðir annarra kerfa, eins og web_search_20250305 á /v1/messages eða {"type": "web_search"} á /v1/responses, hefja ekki leit hér.

Villur

Vefleit bætir við engum stöðukóða og engri villugerð. Leit sem finnur ekkert, eða dagur án leita eftir, gefur venjulegt svar án leitarniðurstaðna. Allar aðrar villur eru eins og fyrir beiðni án leitar. Villumeðhöndlun