Usesho lwewebhu

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

Impendulo iyi-chat completion ejwayelekile enezengezo ezimbili. Impendulo ikhomba emiphumeleni yokusesha ngezinombolo ezibakaweni eziyisikwele, i-sources ithi inombolo ngayinye imelelani, futhi i-annotations iphawula lapho ngayinye icashunwa khona:

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

Ukuvula ukusesha

Ukusesha yi-field yesicelo, evaliwe ngokuzenzakalelayo. Akukho okuseshwayo ngaphandle kokuba isicelo siyithumele.

Ku-/v1/messages i-field ihlala esezingeni eliphezulu lomzimba, eduze kwe-model ne-messages:

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

Okwenziwa yisicelo esesheliwe

• I-API isesha kuwebhu ngomlayezo wokugcina womsebenzisi. Izikhathi zangaphambilini zengxoxo zinika ukusesha umongo waso.
• Ukusesha kuqhubeka kuso sonke isicelo esithumela i-web_search: true. I-model ayikhethi ukuthi isesha noma cha.
• Imiphumela ibekwa phambi kwe-model njengemithombo enezinombolo, futhi i-model ibhala impendulo yayo kuyo.
• Impendulo iqala lapho ukusesha sekuphelile. Isicelo se-stream asithumeli lutho, hhayi ama-header noma imicimbi, kuze kube yilapho, ngakho vumela ukulinda okude ngaphambi kwe-chunk yokuqala.

Okuqukethwe yimpendulo

• Impendulo inesimo esijwayelekile se-endpoint yayo. Impendulo ise-choices[0].message.content (ibhlokhi ye-text ku-/v1/messages).
• Umbhalo ungaphatha izimpawu ezinjenge-[1] ne-[2] ngemuva kwamazwi ezisekela. Inombolo ngayinye imele eyodwa yemiphumela i-model eyifundile.
• I-sources ibiza leyo miphumela: okufakiwe okukodwa kumphumela ngamunye i-model eyinikezwe wona, ne-index, title ne-url. Uphawu [1] yilokho okufakiwe okune-index 1. Imiphumela empendulo engayicashunwa nayo ifakweohlwini.
• Ku-/v1/chat/completions umyalezo uphinde ube ne-annotations, ngesimo se-OpenAI: i-url_citation eyodwa emthonjeni ngamunye obizwa uphawu, ne-url, title, kanye ne-start_index ne-end_index, isikhundla sophawu ku-content esibalwa ngezinhlamvu (isiphetho asifakwanga).
• Ku-stream i-sources ifika ne-chunk yokugcina, ku-/v1/messages ifika nomcimbi we-message_delta. Ama-annotation afika ku-chunk eyodwa ngaphambi kokugcina nje, njenge-delta.annotations.
• I-sources ikhona kuphela uma ukusesha kwalesi sicelo kuthole okuthile. Impendulo engenayo ibhalwe ngaphandle kwemiphumela yokusesha.

Ukuthi ukusesha kubalwa kanjani

Uhlelo ngalunye lufaka inani lokusesha ngosuku:

• Isicelo esitholile okuthile ekusesheni kwaso sisebenzisa ukusesha okukodwa ku-allowance yosuku. Ukusesha okungatholanga lutho akusebenzisi lutho.
• Ingxoxo ne-API kwabelana nge-allowance ye-akhawunti ephethe i-key.
• Ukubala kuqala kabusha nsuku zonke ngo-00:00 UTC.
• Imiphumela yokusesha ingama-token okufakwayo esicelo futhi ikhokhiswa kanye nayo yonke i-prompt.

Qhathanisa izinhlelo

Lapho ukusesha kosuku kuphelile

Isicelo esithumela i-web_search: true ngemuva kokusesha kokugcina kosuku asenqatshwa. Siphendulwa ngaphandle kokusesha: isimo siyi-200 futhi impendulo ayinayo i-sources.

Ukusesha njengethuluzi lakho

I-web_search: true iyiswishi eyodwa kuphela yokusesha okuchazwe lapha. Umsebenzi owuchaza ku-tools futhi uwuqambe ngokuthi web_search uyithuluzi lakho: i-model ibuyisa isicelo, ikhodi yakho iqhuba ukusesha bese ibuyisela umphumela.

Izinhlobo zamathuluzi okusesha zamanye amapulatifomu, njenge-web_search_20250305 ku-/v1/messages noma i-{"type": "web_search"} ku-/v1/responses, aziqali ukusesha lapha.

Amaphutha

Ukusesha kuwebhu akwengezi khodi yesimo noma uhlobo lwephutha. Ukusesha okungatholi lutho, noma usuku olungenakho ukusesha okusele, kunikeza impendulo ejwayelekile ngaphandle kwemiphumela yokusesha. Wonke amanye amaphutha afana nawesicelo esingenakho ukusesha. Ukuphathwa kwamaphutha