Kutsvaga pawebhu

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

Mhinduro i-chat completion yakajairika ine zvimwe zviviri zvakawedzerwa. Mhinduro inonongedzera kuma-search results nenhamba dziri mu-square brackets, sources inoti nhamba imwe neimwe inomirira chii, uye annotations inoratidza pane imwe neimwe yakataurwa:

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

Kuvhura search

Search i-field ye-request, yakadzimwa nge-default. Hapana chinotsvagwa kunze kwekunge request ichitumira.

Pa-/v1/messages field iri pa-top level ye-body, padivi pe-model ne-messages:

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

Zvinoitwa ne-request ine search

• API inotsvaga pa-web nezve user message yekupedzisira. Ma-turn ekare ehurukuro anopa search context yayo.
• Search inomhanya pa-request imwe neimwe inotumira web_search: true. Model haisarudze kuti itsvage here.
• Mhedzisiro inoiswa pamberi pe-model se-numbered sources, uye model inonyora mhinduro yayo kubva padzo.
• Mhinduro inotanga kana search yapera. Request ye-stream haitumire chinhu, kunyange headers kana events, kusvikira zvaitika, saka rega nguva yakareba yekumirira usati wawana chunk yekutanga.

Zviri mumhinduro

• Mhinduro ine chimiro chakajairika che-endpoint yayo. Mhinduro iri mu-choices[0].message.content (text block pa-/v1/messages).
• Text inogona kutakura markers sa-[1] ne-[2] mushure mezvirevo zvavanotsigira. Nhamba imwe neimwe inomirira imwe yemhedzisiro yakaverengwa ne-model.
• sources inotaura mazita emhedzisiro iyoyo: entry imwe pamhedzisiro imwe neimwe yakapiwa model, ine index, title ne-url. Marker [1] ndiyo entry ine index 1. Mhedzisiro isingatarwi nemhinduro inoratidzwawo.
• Pa-/v1/chat/completions message inewo annotations, mu-OpenAI shape: url_citation imwe pa-source imwe neimwe yatumidzwa ne-marker, ine url, title, ne-start_index ne-end_index, iko ndipo pari marker mu-content painoverengwa mu-characters (kupera hakuverengwi).
• Mu-stream sources inouya ne-chunk yekupedzisira, uye pa-/v1/messages ne-message_delta event. Annotations dzinouya mu-chunk imwe pamberi pekupedzisira, se-delta.annotations.
• sources iripo chete kana search ye-request iyi yawana chimwe chinhu. Mhinduro isina yakanyorwa pasina search results.

Kuti searches dzinoverengwa sei

Plan imwe neimwe ine huwandu hwe-searches pazuva:

• Request ine search yakawana chinhu inoshandisa search imwe ye-allowance yezuva. Search isina kuwana chinhu haishandise chinhu.
• Chat ne-API zvinogovana allowance ye-account ine key.
• Kuverenga kunotanga zvakare zuva rega rega pa-00:00 UTC.
• Mhedzisiro ye-search i-input tokens dze-request uye inobhadharwa pamwe chete nezvimwe zve-prompt.

Enzanisa ma-plan

Kana searches dzezuva dzapera

Request inotumira web_search: true mushure me-search yekupedzisira yezuva hairambwi. Inopindurwa pasina search: status i-200 uye mhinduro haina sources.

Search se-tool yako pachako

web_search: true ndiyo switch imwe chete ye-search inotsanangurwa pano. Function yaunotsanangura mu-tools ukayitumidza web_search imwe ye-tools dzako pachako: model inodzosa call, uye code yako inomhanyisa search ndokutumira mhedzisiro.

Search tool types dze-platforms dzimwe, sa-web_search_20250305 pa-/v1/messages kana {"type": "web_search"} pa-/v1/responses, hadzitange search pano.

Errors

Web search haiwedzere status code kana error type. Search isingawani chinhu, kana zuva risina searches dzasara, inopa mhinduro yakajairika isina search results. Error imwe neimwe yakasara yakafanana ne-request isina search. Zvikanganiso