Ku-dhismay Raadinta Shabakadda

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

Jawaabtu waa chat completion caadi ah oo laba wax lagu daray. Jawaabtu waxay u tilmaamaysaa natiijooyinka raadinta iyadoo isticmaalaysa lambarro xidhmooyin laba-gees ah dhexdooda, sources waxay sheegtaa waxa lambar kastaa u taagan yahay, annotations na waxay calaamadeysaa halka mid kasta lagu xusay:

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

Daraynta raadinta

Raadintu waa field codsi, default ahaan wuu damsan yahay. Waxba lama raadiyo ilaa codsi diro.

/v1/messages field-ku wuxuu ku yaal heerka sare ee jidhka, model iyo messages agtooda:

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

Waxa codsi la raadiyay sameeyo

• API-gu wuxuu webka u raadiyaa fariinta isticmaalaha ee ugu dambeysay. Wareegyada hore ee wada-hadalku waxay raadinta siiyaan context.
• Raadintu waxay ku shaqeysaa codsi kasta oo diraya web_search: true. Model-ku ma doorto inuu raadiyo iyo in kale.
• Natiijooyinka waxaa model-ka hortiisa la dhigaa sida ilo tiro leh, model-kuna jawaabtiisa ayuu ka qoraa.
• Jawaabtu waxay bilaabmaan marka raadinta la dhammeeyo. Codsi stream ah waxba ma diro, header-yo ama events midna, ilaa markaas, sidaas darteed u oggolow sugid dheer ka hor chunk-ga ugu horreeya.

Waxa jawaabtu ka kooban tahay

• Jawaabtu waxay leedahay qaabka caadiga ah ee endpoint-ka. Jawaabtu waxay ku jirtaa choices[0].message.content (block text /v1/messages).
• Qoraalku wuxuu sidi karaa calaamado sida [1] iyo [2] hadalada ay taageeraan ka dib. Lambar kastaa wuxuu u taagan yahay mid ka mid ah natiijooyinka model-ku akhriyay.
• sources waxay magacaabtaa natiijooyinkaas: hal gelin natiijo kasta oo model-ka la siiyay, oo leh index, title iyo url. Calaamadda [1] waa gelinta leh index 1. Natiijooyinka jawaabtu aanay xusin sidoo kale waa lagu qoray liiska.
• Marka ay tahay /v1/chat/completions farriintu waxay leedahay sidoo kale annotations, qaabka OpenAI: hal url_citation ilo kasta oo calaamad magacaabto, oo leh url, title, iyo start_index iyo end_index, kaas oo ah booska calaamadda ee content oo lagu tiriyay xarfo (dhammaadka lagu darin).
• Stream-ka sources waxay la timaaddaa chunk-ga ugu dambeeya, /v1/messages na waxay la timaaddaa event-ka message_delta. Annotations waxay yimaadaan hal chunk oo ka hor kan ugu dambeeya, sida delta.annotations.
• sources waxay jirtaa oo keliya marka raadinta codsigan wax helay. Jawaab aan lahayn waxaa la qoray raadin natiijo ah la'aan.

Sida raadinta loo tiriyo

Qorshe kastaa wuxuu leeyahay tiro raadin ah maalintii:

• Codsi raadintiisu wax heshay wuxuu isticmaalaa hal raadin ee allowance-ka maalinta. Raadin waxba heli weyday midna ma isticmaasho.
• Chat-ka iyo API-gu waxay wadaagaan allowance-ka akoonka leh furaha.
• Tirintu maalin kasta saacadda 00:00 UTC ayay dib u bilaabmaysaa.
• Natiijooyinka raadinta waa input token-yada codsiga waxaana lagu dallacaa prompt-ka inta kale.

Barbar dhig qorshayaasha

Marka raadinta maalinta la isticmaalo

Codsi diraya web_search: true raadinta maalinta ugu dambeysay ka dib lama diido. Waxaa lagu jawaabaa raadin la'aan: xaaladdu waa 200 jawaabtuna ma laha sources.

Raadinta sida tool adiga ku saabsan

web_search: true waa furfurka keliya ee raadinta halkan lagu sharaxay. Function aad ku qeexdo tools oo aad u magacawdo web_search waa mid ka mid ah tools-kaaga: model-ku wuxuu soo celiyaa wicitaan, code-kaaguna wuxuu orodsiiyaa raadinta oo natiijada dib u diraa.

Noocyada tool-ka raadinta ee madasha kale, sida web_search_20250305 /v1/messages ama {"type": "web_search"} /v1/responses, halkan raadin ma bilaabaan.

Khaladaad

Raadinta webka ma ku darto koodh xaalad iyo nooc khalad. Raadin waxba heli weyday, ama maalin aan lahayn raadin hadhay, waxay siisaa jawaab caadi ah natiijooyin raadin la'aan. Khalad kasta oo kale wuxuu la mid yahay codsi raadin la'aan ah. Khaladaadka Maareynta