Ҷустуҷӯи веб

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

Ҷавоб chat completion-и одӣ бо ду иловаест. Ҷавоб ба натиҷаҳои ҷустуҷӯ бо рақамҳо дар қавсайн ишора мекунад, sources мегӯяд, ки ҳар рақам чиро ифода мекунад, ва annotations ҷойеро, ки ҳар кадом иқтибос шудааст, қайд мекунад:

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

Фаъол кардани ҷустуҷӯ

Ҷустуҷӯ майдони дархост аст, бо пешфарз хомӯш. Ҳеҷ чиз ҷустуҷӯ намешавад, магар ин ки дархост онро фиристад.

Дар /v1/messages майдон дар сатҳи болоии ҷисм, дар паҳлӯи model ва messages меистад:

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

Дархости бо ҷустуҷӯ чӣ мекунад

• API барои паёми охирини корбар дар веб ҷустуҷӯ мекунад. Навбатҳои қаблии гуфтугӯ ба ҷустуҷӯ контекст медиҳанд.
• Ҷустуҷӯ дар ҳар дархосте, ки web_search: true мефиристад, иҷро мешавад. Модел интихоб намекунад, ки ҷустуҷӯ кунад ё не.
• Натиҷаҳо ҳамчун манбаъҳои рақамдор дар назди модел гузошта мешаванд ва модел ҷавоби худро аз онҳо менависад.
• Ҷавоб вақте оғоз мешавад, ки ҷустуҷӯ анҷом ёфт. Дархости бо streaming то он вақт чизе, на сарлавҳа ва на рӯйдод, намефиристад, бинобар ин пеш аз чанки аввал интизории дарозтарро ба ҳисоб гиред.

Ҷавоб чиро дорад

• Ҷавоб шакли маъмулии endpoint-и худро дорад. Ҷавоб дар choices[0].message.content аст (блоки text дар /v1/messages).
• Матн метавонад нишонаҳое мисли [1] ва [2]-ро пас аз изҳороте, ки онҳо дастгирӣ мекунанд, дошта бошад. Ҳар рақам яке аз натиҷаҳоеро, ки модел хондааст, ифода мекунад.
• sources ин натиҷаҳоро номбар мекунад: барои ҳар натиҷае, ки ба модел дода шудааст, як сабт, бо index, title ва url. Нишонаи [1] сабти бо index 1 аст. Натиҷаҳое, ки ҷавоб онҳоро иқтибос намекунад, низ дар рӯйхатанд.
• Дар /v1/chat/completions паём ҳамчунин annotations дорад, дар шакли OpenAI: барои ҳар манбаъе, ки нишона номбар мекунад, як url_citation, бо url, title, ва start_index ва end_index, яъне мавқеи нишона дар content, ки бо аломатҳо ҳисоб шудааст (анҷом дохил намешавад).
• Дар ҷараён sources бо чанки охирин меояд, ва дар /v1/messages бо рӯйдоди message_delta. Annotations дар як чанк каме пеш аз охирин, ҳамчун delta.annotations меоянд.
• sources танҳо дар сурате ҳаст, ки ҷустуҷӯи ин дархост чизе ёфта бошад. Ҷавоби бидуни он бе натиҷаҳои ҷустуҷӯ навишта шудааст.

Ҷустуҷӯҳо чӣ гуна ҳисоб карда мешаванд

Ҳар нақша шумораи ҷустуҷӯро дар як рӯз дар бар мегирад:

• Дархосте, ки ҷустуҷӯи он чизе ёфт, як ҷустуҷӯро аз маҳдудияти рӯз истифода мебарад. Ҷустуҷӯе, ки чизе наёфт, ҳеҷ чизро истифода намебарад.
• Чат ва API маҳдудияти ҳисоберо, ки соҳиби калид аст, байни худ тақсим мекунанд.
• Ҳисоб ҳар рӯз дар 00:00 UTC аз нав оғоз мешавад.
• Натиҷаҳои ҷустуҷӯ токенҳои вуруди дархост мебошанд ва бо боқимондаи prompt ҳисоб карда мешаванд.

Нақшаҳоро муқоиса кунед

Вақте ки ҷустуҷӯҳои рӯз тамом шуданд

Дархосте, ки web_search: true-ро пас аз ҷустуҷӯи охирини рӯз мефиристад, рад карда намешавад. Он бе ҷустуҷӯ ҷавоб дода мешавад: ҳолат 200 аст ва ҷавоб sources надорад.

Ҷустуҷӯ ҳамчун абзори худатон

web_search: true ягона калиди ҷустуҷӯест, ки дар ин ҷо тавсиф шудааст. Функсияе, ки шумо дар tools муайян мекунед ва web_search ном мегузоред, абзори худи шумост: модел даъват бармегардонад ва рамзи шумо ҷустуҷӯро иҷро мекунад ва натиҷаро бозмефиристад.

Навъҳои абзори ҷустуҷӯи платформаҳои дигар, масалан web_search_20250305 дар /v1/messages ё {"type": "web_search"} дар /v1/responses, дар ин ҷо ҷустуҷӯро оғоз намекунанд.

Хатогиҳо

Ҷустуҷӯи веб рамзи ҳолат ва навъи хатогии нав илова намекунад. Ҷустуҷӯе, ки чизе намеёбад, ё рӯзе бе ҷустуҷӯи боқимонда, ҷавоби оддиро бе натиҷаҳои ҷустуҷӯ медиҳад. Ҳар хатогии дигар мисли дархости бе ҷустуҷӯ аст. Идораи хатогиҳо