உள்ளமைக்கப்பட்ட இணைய தேடல்

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-ல் இந்தப் புலம் body-ன் மேல்மட்டத்தில், 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 அனுப்பும் ஒவ்வொரு கோரிக்கையிலும் தேடல் இயங்கும். தேடலாமா வேண்டாமா என்பதை மாடல் தேர்வு செய்யாது.
• முடிவுகள் எண்ணிடப்பட்ட ஆதாரங்களாக மாடலின் முன் வைக்கப்படும்; மாடல் அவற்றிலிருந்து தனது பதிலை எழுதும்.
• தேடல் முடிந்ததும் பதில் தொடங்கும். stream செய்யப்படும் கோரிக்கை அதுவரை headers உட்பட எதையும் அனுப்பாது; எனவே முதல் chunk வருவதற்கு அதிக நேரம் காத்திருக்கத் தயாராக இருக்கவும்.

பதிலில் என்ன இருக்கும்

• பதில் அதன் endpoint-ன் வழக்கமான வடிவத்தில் இருக்கும். பதில் choices[0].message.content-ல் இருக்கும் (/v1/messages-ல் ஒரு text block).
• உரையில் [1], [2] போன்ற குறிகள் அவை ஆதரிக்கும் கூற்றுகளுக்குப் பிறகு இருக்கலாம். ஒவ்வொரு எண்ணும் மாடல் படித்த முடிவுகளில் ஒன்றைக் குறிக்கும்.
• sources அந்த முடிவுகளைப் பெயரிடும்: மாடலுக்குத் தரப்பட்ட ஒவ்வொரு முடிவுக்கும் ஒரு உள்ளீடு, index, title மற்றும் url உடன். [1] குறி என்பது index 1 கொண்ட உள்ளீடு. பதில் மேற்கோள் காட்டாத முடிவுகளும் பட்டியலில் இருக்கும்.
• /v1/chat/completions-ல் செய்தியில் annotations-ம் இருக்கும், OpenAI வடிவில்: ஒரு குறி பெயரிடும் ஒவ்வொரு மூலத்துக்கும் ஒரு url_citation, url, title, மற்றும் start_index, end_index உடன்; அவை content-ல் குறியின் நிலையை எழுத்துகளில் எண்ணிக் காட்டுகின்றன (முடிவு சேராது).
• stream-ல் sources கடைசி chunk-உடன் வரும்; /v1/messages-ல் message_delta நிகழ்வுடன் வரும். Annotations கடைசிக்கு சற்று முந்தைய ஒரு chunk-ல் delta.annotations ஆக வரும்.
• இந்தக் கோரிக்கையின் தேடல் ஏதேனும் கண்டுபிடித்தால் மட்டுமே sources இருக்கும். அது இல்லாத பதில் தேடல் முடிவுகள் இல்லாமல் எழுதப்பட்டது.

தேடல்கள் எவ்வாறு எண்ணப்படுகின்றன

ஒவ்வொரு திட்டமும் ஒரு நாளைக்குச் சில தேடல்களை உள்ளடக்கும்:

• தேடல் ஏதேனும் கண்டுபிடித்த கோரிக்கை, அன்றைய ஒதுக்கீட்டில் ஒரு தேடலைப் பயன்படுத்தும். எதுவும் கிடைக்காத தேடல் எதையும் பயன்படுத்தாது.
• Chat-ம் API-யும் key-ஐ வைத்திருக்கும் கணக்கின் ஒதுக்கீட்டைப் பகிர்ந்துகொள்கின்றன.
• எண்ணிக்கை ஒவ்வொரு நாளும் 00:00 UTC-ல் மீண்டும் தொடங்கும்.
• தேடல் முடிவுகள் கோரிக்கையின் உள்ளீட்டு tokens ஆகும்; prompt-ன் மற்ற பகுதிகளுடன் சேர்த்து அவற்றுக்குக் கட்டணம் விதிக்கப்படும்.

திட்டங்களை ஒப்பிடுக

அன்றைய தேடல்கள் தீர்ந்துவிட்டால்

அன்றைய கடைசித் தேடலுக்குப் பிறகு web_search: true அனுப்பும் கோரிக்கை மறுக்கப்படாது. அது தேடல் இல்லாமல் பதிலளிக்கப்படும்: நிலை 200, பதிலில் sources இருக்காது.

உங்கள் சொந்த tool ஆகத் தேடல்

web_search: true என்பதே இங்கு விவரிக்கப்பட்ட தேடலுக்கான ஒரே சுவிட்ச். நீங்கள் tools-ல் வரையறுத்து web_search எனப் பெயரிடும் function உங்கள் சொந்த tool-களில் ஒன்று: மாடல் ஒரு அழைப்பைத் திருப்பித் தரும்; உங்கள் குறியீடு தேடலை இயக்கி முடிவை அனுப்பும்.

/v1/messages-ல் web_search_20250305 அல்லது /v1/responses-ல் {"type": "web_search"} போன்ற பிற தளங்களின் தேடல் tool வகைகள் இங்கு தேடலைத் தொடங்காது.

பிழைகள்

வலைத் தேடல் புதிய நிலைக் குறியீட்டையோ பிழை வகையையோ சேர்ப்பதில்லை. எதுவும் கிடைக்காத தேடல், அல்லது தேடல்கள் மீதமில்லாத நாள், தேடல் முடிவுகள் இல்லாத சாதாரண பதிலைத் தரும். மற்ற ஒவ்வொரு பிழையும் தேடல் இல்லாத கோரிக்கைக்கு உள்ளதைப் போலவே. கையாளுவதில் பிழை