Tfittxija Web inkorporata

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

It-tweġiba hija chat completion ordinarja b'żewġ żidiet. It-tweġiba tirreferi għar-riżultati tat-tiftix b'numri fil-parentesi kwadri, sources tgħid x'jirrappreżenta kull numru, u annotations timmarka fejn kull wieħed jissemma:

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

Kif iddawwal it-tiftix

It-tiftix huwa qasam tat-talba, mitfi b'default. Ma jitfittex xejn sakemm talba ma tibgħatux.

Fuq /v1/messages il-qasam jinsab fil-livell ta' fuq tal-body, maġenb model u messages:

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

X'jagħmel talba bit-tiftix

• L-API tfittex fuq il-web għall-aħħar messaġġ tal-utent. It-turns preċedenti tal-konversazzjoni jagħtu l-kuntest lit-tiftix.
• It-tiftix jaħdem fuq kull talba li tibgħat web_search: true. Il-mudell ma jiddeċiedix jekk jiftixx.
• Ir-riżultati jitqiegħdu quddiem il-mudell bħala sorsi mnumerati, u l-mudell jikteb it-tweġiba tiegħu minnhom.
• It-tweġiba tibda meta jintemm it-tiftix. Talba fi stream ma tibgħat xejn, la headers u lanqas avvenimenti, sa dakinhar, għalhekk ippjana stennija itwal qabel l-ewwel chunk.

X'fiha t-tweġiba

• It-tweġiba għandha l-forma tas-soltu tal-endpoint tagħha. It-tweġiba tinsab f'choices[0].message.content (blokk text fuq /v1/messages).
• It-test jista' jġorr markaturi bħal [1] u [2] wara d-dikjarazzjonijiet li jappoġġjaw. Kull numru jirrappreżenta wieħed mir-riżultati li qara l-mudell.
• sources isemmi dawk ir-riżultati: daħla waħda għal kull riżultat mogħti lill-mudell, b'index, title u url. Il-markatur [1] huwa d-daħla b'index 1. Ir-riżultati li t-tweġiba ma semmietx huma elenkati wkoll.
• Fuq /v1/chat/completions il-messaġġ għandu wkoll annotations, fil-forma tal-OpenAI: url_citation waħda għal kull sors li markatur isemmi, b'url, title, u start_index u end_index, il-pożizzjoni tal-markatur f'content magħduda f'karattri (it-tmiem mhuwiex inkluż).
• F'stream sources jiġi mal-aħħar chunk, u fuq /v1/messages mal-avveniment message_delta. L-annotazzjonijiet jiġu f'chunk wieħed eżatt qabel l-aħħar, bħala delta.annotations.
• sources hemm biss meta t-tiftix ta' din it-talba sab xi ħaġa. Tweġiba mingħajru nkitbet mingħajr riżultati tat-tiftix.

Kif jingħaddu t-tiftix

Kull pjan jinkludi numru ta' tiftix kuljum:

• Talba li t-tiftix tagħha sab xi ħaġa tuża tiftix wieħed mill-kwota tal-jum. Tiftix li ma sab xejn ma juża xejn.
• Il-chat u l-API jaqsmu l-kwota tal-kont li huwa sid iċ-ċavetta.
• L-għadd jibda mill-ġdid kuljum fi 00:00 UTC.
• Ir-riżultati tat-tiftix huma tokens tal-input tat-talba u jitħallsu mal-bqija tal-prompt.

Qabbel il-pjanijiet

Meta jintużaw it-tiftix tal-jum

Talba li tibgħat web_search: true wara l-aħħar tiftix tal-jum ma tiġix miċħuda. Titwieġeb mingħajr tiftix: l-istatus huwa 200 u t-tweġiba m'għandhiex sources.

Tiftix bħala tool tiegħek stess

web_search: true huwa l-uniku swiċċ tat-tiftix deskritt hawn. Funzjoni li tiddefinixxi f'tools u tisimha web_search hija waħda mit-tools tiegħek stess: il-mudell jagħti lura sejħa, u l-kodiċi tiegħek iħaddem it-tiftix u jibgħat ir-riżultat lura.

Tipi ta' tools tat-tiftix ta' pjattaformi oħra, bħal web_search_20250305 fuq /v1/messages jew {"type": "web_search"} fuq /v1/responses, ma jibdewx tiftix hawn.

Żbalji

It-tiftix fuq il-web ma jżid l-ebda kodiċi ta' status u l-ebda tip ta' żball. Tiftix li ma jsib xejn, jew jum mingħajr tiftix li fadal, jagħti tweġiba normali mingħajr riżultati tat-tiftix. Kull żball ieħor huwa l-istess bħal għal talba mingħajr tiftix. Ġestjoni tal-iżbalji