Uphendlo lwewebhu olwakhelwe ngaphakathi

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 yi-chat completion eqhelekileyo enezongezo ezimbini. Impendulo ikhomba kwiziphumo zokukhangela ngamanani ase-square brackets, i-sources ichaza ukuba inani ngalinye limele ntoni, kwaye i-annotations ibonisa apho nganye icatshulwa 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 ukukhangela

Ukukhangela yintsimi yesicelo, ivaliwe ngokuzenzekelayo. Akukho nto ikhangelwayo ngaphandle kokuba isicelo siyithumela.

Kwi-/v1/messages intsimi ihlala kwinqanaba eliphezulu lomzimba, ecaleni kwe-model kunye ne-messages:

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

Oko isicelo esikhangelweyo sikwenzayo

• I-API ikhangela kwiwebhu umyalezo wokugqibela womsebenzisi. Imijikelo yangaphambili yencoko inika ukukhangela i-context yako.
• Ukukhangela kuqhuba kuso sonke isicelo esithumela i-web_search: true. Imodeli ayikhethi ukuba ikhangele okanye hayi.
• Iziphumo zibekwa phambi kwemodeli njengemithombo enamanani, kwaye imodeli ibhala impendulo yayo kuzo.
• Impendulo iqala xa ukukhangela kugqityiwe. Isicelo esine-stream asithumeli nto, nee-header nemisitho, de kube ngoko, ngoko lindela ixesha elide ngaphambi kwe-chunk yokuqala.

Oko impendulo iqulathe

• Impendulo inesimo esiqhelekileyo se-endpoint yayo. Impendulo ikwi-choices[0].message.content (ibhloko ye-text kwi-/v1/messages).
• Umbhalo unokuthwala iimpawu ezinjenge-[1] kunye ne-[2] emva kwezitatimenti eziyixhasayo. Inani ngalinye limele esinye seziphumo imodeli ezifundileyo.
• I-sources ibhekisa kuzo ezo ziphumo: into enye kwisiphumo ngasinye esinikwe imodeli, kunye ne-index, i-title kunye ne-url. Uphawu olu-[1] yiyo into ene-index 1. Iziphumo ezingacatshulwanga yimpendulo nazo ziyaliswa.
• Kwi-/v1/chat/completions umyalezo unayo ne-annotations, ngesimo se-OpenAI: i-url_citation enye kumthombo ngamnye obhekiselwa kuwo luphawu, kunye ne-url, i-title, kunye ne-start_index ne-end_index, indawo yophawu kwi-content ebalwa ngoonobumba (isiphelo asibandakanywa).
• Kwi-stream i-sources ifika kunye ne-chunk yokugqibela, kwaye kwi-/v1/messages kunye nomsitho we-message_delta. I-annotations zifika kwi-chunk enye ngaphambi kokugqibela, njenge-delta.annotations.
• I-sources ikhona kuphela xa ukukhangela kwesi sicelo kufumene into. Impendulo engenayo ibhalwe ngaphandle kweziphumo zokukhangela.

Indlela ukukhangela okubalwa ngayo

Yonke iplani iquka inani lokukhangela ngosuku:

• Isicelo esifumene into ekukhangeleni sisebenzisa ukukhangela okunye kwisabelo sosuku. Ukukhangela okungafumananga nto akusebenzisi nanye.
• Incoko ne-API ziyabelana ngesabelo seakhawunti enesitshixo.
• Inani liqala kwakhona yonke imihla ngentsimbi ye-00:00 UTC.
• Iziphumo zokukhangela zii-token zegalelo zesicelo kwaye zihlawulwa kunye nenye i-prompt.

Thelekisa iiplani

Xa ukukhangela kosuku kuphelile

Isicelo esithumela i-web_search: true emva kokukhangela kokugqibela kosuku asiliwa. Siphendulwa ngaphandle kokukhangela: isimo si-200 kwaye impendulo ayinayo i-sources.

Ukukhangela njenge-tool yakho

I-web_search: true yeyona swithshi inye yokukhangela okuchazwe apha. Umsebenzi owuchazayo kwi-tools kwaye uwubize ngokuthi web_search yenye yee-tool zakho: imodeli ibuyisa ubizo, kwaye ikhowudi yakho iqhuba ukukhangela ithumele isiphumo emva.

Iintlobo zee-tool zokukhangela zezinye iiplatifomu, ezinjenge-web_search_20250305 kwi-/v1/messages okanye i-{"type": "web_search"} kwi-/v1/responses, aziqalisi kukhangela apha.

Iimpazamo

Ukukhangela kwiwebhu akwongezi khowudi yesimo okanye uhlobo lwempazamo. Ukukhangela okungafumananga nto, okanye usuku olungenakho ukukhangela okusele, kunika impendulo eqhelekileyo ngaphandle kweziphumo zokukhangela. Zonke ezinye iimpazamo zifana nezesicelo esingenakukhangela. Ukuphatha imposiso