ಒಳನಿರ್ಮಿತ ವೆಬ್ ಹುಡುಕಾಟ

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

ಉತ್ತರ ಸಾಮಾನ್ಯ ಚಾಟ್ ಕಂಪ್ಲೀಶನ್, ಎರಡು ಸೇರ್ಪಡೆಗಳೊಂದಿಗೆ. ಉತ್ತರ ಚೌಕ ಆವರಣಗಳಲ್ಲಿನ ಸಂಖ್ಯೆಗಳಿಂದ ಹುಡುಕಾಟ ಫಲಿತಾಂಶಗಳನ್ನು ಸೂಚಿಸುತ್ತದೆ, 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 ಕೊನೆಯ user ಸಂದೇಶಕ್ಕಾಗಿ ವೆಬ್‌ನಲ್ಲಿ ಹುಡುಕುತ್ತದೆ. ಸಂಭಾಷಣೆಯ ಹಿಂದಿನ ಟರ್ನ್‌ಗಳು ಹುಡುಕಾಟಕ್ಕೆ ಅದರ ಸಂದರ್ಭವನ್ನು ನೀಡುತ್ತವೆ.
• web_search: true ಕಳುಹಿಸುವ ಪ್ರತಿ ವಿನಂತಿಯಲ್ಲೂ ಹುಡುಕಾಟ ನಡೆಯುತ್ತದೆ. ಹುಡುಕಬೇಕೇ ಎಂದು ಮಾಡೆಲ್ ಆರಿಸುವುದಿಲ್ಲ.
• ಫಲಿತಾಂಶಗಳನ್ನು ಸಂಖ್ಯೆ ಹಾಕಿದ ಮೂಲಗಳಾಗಿ ಮಾಡೆಲ್ ಮುಂದೆ ಇಡಲಾಗುತ್ತದೆ, ಮತ್ತು ಮಾಡೆಲ್ ಅವುಗಳಿಂದ ತನ್ನ ಉತ್ತರವನ್ನು ಬರೆಯುತ್ತದೆ.
• ಹುಡುಕಾಟ ಮುಗಿದಾಗ ಉತ್ತರ ಆರಂಭವಾಗುತ್ತದೆ. stream ಮಾಡಿದ ವಿನಂತಿ ಅಲ್ಲಿಯವರೆಗೆ ಹೆಡರ್‌ಗಳನ್ನೂ ಈವೆಂಟ್‌ಗಳನ್ನೂ ಕಳುಹಿಸುವುದಿಲ್ಲ, ಆದ್ದರಿಂದ ಮೊದಲ chunk ಮೊದಲು ಹೆಚ್ಚು ಕಾಯುವಿಕೆಗೆ ಅವಕಾಶ ನೀಡಿ.

ಉತ್ತರ ಏನನ್ನು ಹೊಂದಿದೆ

• ಉತ್ತರ ತನ್ನ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ನ ಸಾಮಾನ್ಯ ರೂಪವನ್ನು ಹೊಂದಿದೆ. ಉತ್ತರ choices[0].message.content ನಲ್ಲಿದೆ (/v1/messages ನಲ್ಲಿ text ಬ್ಲಾಕ್).
• ಪಠ್ಯ [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 ಈವೆಂಟ್ ಜೊತೆ ಬರುತ್ತದೆ. ಟಿಪ್ಪಣಿಗಳು ಕೊನೆಯದರ ಮುಂಚಿನ ಒಂದು chunk ನಲ್ಲಿ delta.annotations ಆಗಿ ಬರುತ್ತವೆ.
• ಈ ವಿನಂತಿಯ ಹುಡುಕಾಟ ಏನನ್ನಾದರೂ ಕಂಡರೆ ಮಾತ್ರ sources ಇರುತ್ತದೆ. ಅದಿಲ್ಲದ ಉತ್ತರವನ್ನು ಹುಡುಕಾಟ ಫಲಿತಾಂಶಗಳಿಲ್ಲದೆ ಬರೆಯಲಾಗಿದೆ.

ಹುಡುಕಾಟಗಳನ್ನು ಹೇಗೆ ಎಣಿಸಲಾಗುತ್ತದೆ

ಪ್ರತಿ ಪ್ಲ್ಯಾನ್ ದಿನಕ್ಕೆ ಇಷ್ಟು ಹುಡುಕಾಟಗಳನ್ನು ಒಳಗೊಂಡಿದೆ:

• ಹುಡುಕಾಟ ಏನನ್ನಾದರೂ ಕಂಡ ವಿನಂತಿ ದಿನದ ಭತ್ಯೆಯ ಒಂದು ಹುಡುಕಾಟವನ್ನು ಬಳಸುತ್ತದೆ. ಏನೂ ಕಾಣದ ಹುಡುಕಾಟ ಯಾವುದನ್ನೂ ಬಳಸುವುದಿಲ್ಲ.
• ಚಾಟ್ ಮತ್ತು API ಕೀಯನ್ನು ಹೊಂದಿರುವ ಖಾತೆಯ ಭತ್ಯೆಯನ್ನು ಹಂಚಿಕೊಳ್ಳುತ್ತವೆ.
• ಎಣಿಕೆ ಪ್ರತಿದಿನ 00:00 UTC ಗೆ ಮತ್ತೆ ಆರಂಭವಾಗುತ್ತದೆ.
• ಹುಡುಕಾಟ ಫಲಿತಾಂಶಗಳು ವಿನಂತಿಯ ಇನ್‌ಪುಟ್ ಟೋಕನ್‌ಗಳು ಮತ್ತು ಪ್ರಾಂಪ್ಟ್‌ನ ಉಳಿದ ಭಾಗದೊಂದಿಗೆ ಬಿಲ್ ಮಾಡಲಾಗುತ್ತವೆ.

ಪ್ಲ್ಯಾನ್‌ಗಳನ್ನು ಹೋಲಿಸಿ

ದಿನದ ಹುಡುಕಾಟಗಳು ಮುಗಿದಾಗ

ದಿನದ ಕೊನೆಯ ಹುಡುಕಾಟದ ನಂತರ web_search: true ಕಳುಹಿಸುವ ವಿನಂತಿಯನ್ನು ನಿರಾಕರಿಸಲಾಗುವುದಿಲ್ಲ. ಅದಕ್ಕೆ ಹುಡುಕಾಟವಿಲ್ಲದೆ ಉತ್ತರಿಸಲಾಗುತ್ತದೆ: ಸ್ಥಿತಿ 200 ಮತ್ತು ಉತ್ತರದಲ್ಲಿ sources ಇರುವುದಿಲ್ಲ.

ನಿಮ್ಮದೇ ಟೂಲ್ ಆಗಿ ಹುಡುಕಾಟ

web_search: true ಇಲ್ಲಿ ವಿವರಿಸಿದ ಹುಡುಕಾಟದ ಏಕೈಕ ಸ್ವಿಚ್. ನೀವು tools ನಲ್ಲಿ ವ್ಯಾಖ್ಯಾನಿಸಿ web_search ಎಂದು ಹೆಸರಿಸುವ ಫಂಕ್ಷನ್ ನಿಮ್ಮದೇ ಟೂಲ್‌ಗಳಲ್ಲಿ ಒಂದು: ಮಾಡೆಲ್ ಕರೆಯನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ, ಮತ್ತು ನಿಮ್ಮ ಕೋಡ್ ಹುಡುಕಾಟ ನಡೆಸಿ ಫಲಿತಾಂಶವನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ.

/v1/messages ನಲ್ಲಿ web_search_20250305 ಅಥವಾ /v1/responses ನಲ್ಲಿ {"type": "web_search"} ನಂತಹ ಇತರ ಪ್ಲಾಟ್‌ಫಾರ್ಮ್‌ಗಳ ಹುಡುಕಾಟ ಟೂಲ್ ವಿಧಗಳು ಇಲ್ಲಿ ಹುಡುಕಾಟವನ್ನು ಆರಂಭಿಸುವುದಿಲ್ಲ.

ದೋಷಗಳು

ವೆಬ್ ಹುಡುಕಾಟ ಯಾವುದೇ ಹೊಸ ಸ್ಥಿತಿ ಕೋಡ್ ಅಥವಾ ದೋಷ ವಿಧವನ್ನು ಸೇರಿಸುವುದಿಲ್ಲ. ಏನನ್ನೂ ಕಾಣದ ಹುಡುಕಾಟ, ಅಥವಾ ಹುಡುಕಾಟಗಳು ಉಳಿಯದ ದಿನ, ಹುಡುಕಾಟ ಫಲಿತಾಂಶಗಳಿಲ್ಲದ ಸಾಮಾನ್ಯ ಉತ್ತರವನ್ನು ನೀಡುತ್ತದೆ. ಉಳಿದ ಪ್ರತಿ ದೋಷ ಹುಡುಕಾಟವಿಲ್ಲದ ವಿನಂತಿಯಂತೆಯೇ ಇದೆ. ದೋಷ ನಿರ್ವಹಣೆ