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

Yankho ndi chat completion yanthawi zonse yokhala ndi zowonjezera ziwiri. Yankho limaloza ku zotsatira za kusaka ndi manambala mu mabulaketi apakati, sources imanena chomwe nambala iliyonse imaimira, ndipo annotations imasonyeza pomwe chilichonse chatchulidwa:

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

Kuyatsa kusaka

Kusaka ndi field ya pempho, yozimitsidwa mwa default. Palibe chomwe chimasakidwa pokhapokha pempho litatumiza.

Pa /v1/messages field ili pa mlingo wapamwamba wa body, pambali pa model ndi messages:

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

Zomwe pempho lokhala ndi kusaka limachita

• API imasaka pa web pa message yomaliza ya user. Ma turn akale a zokambirana amapatsa kusaka context yake.
• Kusaka kumayenda pa pempho lililonse lotumiza web_search: true. Model siisankha ngati isake.
• Zotsatira zimaikidwa patsogolo pa model ngati magwero owerengedwa, ndipo model imalemba yankho lake kuchokera ku izo.
• Yankho limayamba kusaka kukatha. Pempho la stream silitumiza kanthu, ngakhale ma header kapena ma event, mpaka pamenepo, choncho lolani kudikira kwakutali musanalandire chunk yoyamba.

Zomwe yankho lili nazo

• Yankho lili ndi mawonekedwe anthawi zonse a endpoint yake. Yankho lili mu choices[0].message.content (block ya text pa /v1/messages).
• Text ikhoza kunyamula zizindikiro monga [1] ndi [2] pambuyo pa mawu omwe zimawathandizira. Nambala iliyonse imaimira imodzi mwa zotsatira zomwe model idawerenga.
• sources imatchula zotsatira zimenezo: cholowa chimodzi pa zotsatira zilizonse zomwe model idapatsidwa, ndi index, title ndi url. Chizindikiro [1] ndi cholowa chokhala ndi index 1. Zotsatira zomwe yankho silinazitchule zalembedwanso.
• Pa /v1/chat/completions uthengawo umakhalanso ndi annotations, mu mawonekedwe a OpenAI: url_citation imodzi pa gwero lililonse lomwe chizindikiro chatchula, ndi url, title, ndi start_index ndi end_index, malo a chizindikiro mu content owerengedwa m'zilembo (mapeto sakuphatikizidwa).
• Mu stream sources imabwera ndi chunk yomaliza, ndipo pa /v1/messages imabwera ndi event ya message_delta. Ma annotation amabwera mu chunk imodzi isanafike yomaliza, ngati delta.annotations.
• sources imakhalapo pokhapokha kusaka kwa pempho ili kutapeza kanthu. Yankho lopanda iyo lidalembedwa popanda zotsatira za kusaka.

Momwe kusaka kumawerengedwera

Plan iliyonse imaphatikizapo chiwerengero cha kusaka pa tsiku:

• Pempho lomwe kusaka kwake kwapeza kanthu limagwiritsa ntchito kusaka kumodzi kwa allowance ya tsiku. Kusaka kopanda zotsatira sikugwiritsa ntchito kanthu.
• Chat ndi API zimagawana allowance ya akaunti yomwe ili ndi kiyi.
• Kuwerenga kumayambanso tsiku lililonse pa 00:00 UTC.
• Zotsatira za kusaka ndi ma input token a pempho ndipo zimaperekedwa mtengo pamodzi ndi prompt yonse.

Fananizani ma plan

Kusaka kwa tsiku kukatha

Pempho lotumiza web_search: true pambuyo pa kusaka komaliza kwa tsiku silikanidwa. Limayankhidwa popanda kusaka: status ndi 200 ndipo yankho lilibe sources.

Kusaka ngati tool yanu

web_search: true ndi switch yokha ya kusaka komwe kwafotokozedwa pano. Function yomwe mumafotokoza mu tools ndikuitcha web_search ndi imodzi mwa ma tool anu: model imabweza call, ndipo code yanu imayendetsa kusaka ndikubweza zotsatira.

Ma type a search tool a ma platform ena, monga web_search_20250305 pa /v1/messages kapena {"type": "web_search"} pa /v1/responses, sayamba kusaka pano.

Zolakwika

Web search siiwonjezera status code kapena type ya cholakwika. Kusaka kopanda zotsatira, kapena tsiku lopanda kusaka kotsala, kumapereka yankho labwinobwino popanda zotsatira za kusaka. Cholakwika china chilichonse ndi chofanana ndi cha pempho lopanda kusaka. Zolakwika