Rannsachadh Lìn air a thoirt a-steach

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

Is e chat completion àbhaisteach a th’ anns an fhreagairt le dà chur-ris. Bheir am freagairt iomradh air na toraidhean rannsachaidh le àireamhan ann am bracaidean ceàrnagach, tha sources ag innse dè a tha gach àireamh a’ seasamh air a shon, agus tha annotations a’ comharrachadh càite a bheil gach tè air a h-iomradh:

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

A’ cur rannsachadh air

Tha rannsachadh na raon dhen iarrtas, dheth a ghnàth. Chan eilear a’ rannsachadh dad mura cuir iarrtas e.

Air /v1/messages tha an raon aig àrd-ìre a’ bhodhaig, ri taobh model agus messages:

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

Dè a nì iarrtas le rannsachadh

• Rannsaichidh an API an lìon airson an teachdaireachd neach-cleachdaidh mu dheireadh. Bheir turns na bu tràithe dhen chòmhradh co-theacsa dhan rannsachadh.
• Ruithidh an rannsachadh air gach iarrtas a chuireas web_search: true. Chan eil am modail a’ roghnachadh am rannsaich e.
• Thèid na toraidhean a chur air beulaibh a’ mhodail mar thùsan àireamhaichte, agus sgrìobhaidh am modail a fhreagairt leotha.
• Tòisichidh am freagairt nuair a tha an rannsachadh deiseil. Chan eil iarrtas le streaming a’ cur dad, headers no tachartasan, gus an uair sin, agus mar sin thoir cead do dhàil nas fhaide ron chiad chunk.

Dè a tha san fhreagairt

• Tha cumadh àbhaisteach an endpoint aig an fhreagairt. Tha am freagairt ann an choices[0].message.content (bloc text air /v1/messages).
• Faodaidh an teacsa comharran leithid [1] agus [2] a ghiùlan às dèidh nan aithrisean a tha iad a’ toirt taic dhaibh. Tha gach àireamh a’ seasamh airson aon dhe na toraidhean a leugh am modail.
• Tha sources ag ainmeachadh nan toraidhean sin: aon inntrigeadh airson gach toraidh a fhuair am modail, le index, title agus url. Is e [1] an inntrigeadh aig a bheil index 1. Tha na toraidhean nach eil am freagairt ag iomradh orra air an liostadh cuideachd.
• Air /v1/chat/completions tha annotations air an teachdaireachd cuideachd, ann an cumadh OpenAI: aon url_citation airson gach stòr a tha comharra ag ainmeachadh, le url, title, agus start_index agus end_index, àite a’ chomharra ann an content air a chunntadh ann an caractaran (chan eil an deireadh air a ghabhail a-steach).
• Ann an stream thig sources leis a’ chunk mu dheireadh, agus air /v1/messages leis an tachartas message_delta. Thig na h-annotations ann an aon chunk dìreach ron fhear mu dheireadh, mar delta.annotations.
• Chan eil sources ann ach ma lorg rannsachadh an iarrtais seo rudeigin. Chaidh freagairt às aonais a sgrìobhadh gun toraidhean rannsachaidh.

Mar a thèid rannsachaidhean a chunntadh

Tha àireamh de rannsachaidhean gach latha ann am gach plana:

• Cleachdaidh iarrtas a lorg rudeigin leis an rannsachadh aon rannsachadh dhe chuibhreann an latha. Chan eil rannsachadh nach do lorg dad a’ cleachdadh gin.
• Bidh còmhradh agus API a’ roinn cuibhreann a’ chunntais aig a bheil an iuchair.
• Tòisichidh an cunntas a-rithist gach latha aig 00:00 UTC.
• Is e tokens cuir-a-steach an iarrtais na toraidhean rannsachaidh agus thèid am billeadh leis a’ chòrr dhen phrompt.

Dèan coimeas eadar na planaichean

Nuair a tha rannsachaidhean an latha air an cleachdadh

Chan eil iarrtas a chuireas web_search: true às dèidh rannsachadh mu dheireadh an latha air a dhiùltadh. Thèid a fhreagairt gun rannsachadh: is e 200 an staid agus chan eil sources san fhreagairt.

Rannsachadh mar inneal dhutsa fhèin

Is e web_search: true an aon suidse dhen rannsachadh air a bheil sinn a’ bruidhinn an seo. Is e inneal dhutsa fhèin a th’ ann an gnìomh a mhìnicheas tu ann an tools agus ainmicheas tu web_search: tillidh am modail gairm, agus ruithidh do chòd an rannsachadh agus cuiridh e an toradh air ais.

Chan eil seòrsaichean inneal rannsachaidh àrd-ùrlaran eile, leithid web_search_20250305 air /v1/messages no {"type": "web_search"} air /v1/responses, a’ tòiseachadh rannsachadh an seo.

Mearachdan

Chan eil rannsachadh lìn a’ cur còd staid no seòrsa mearachd ris. Bheir rannsachadh nach lorg dad, no latha gun rannsachaidhean air fhàgail, freagairt àbhaisteach gun toraidhean rannsachaidh. Tha a h-uile mearachd eile mar a tha i airson iarrtas gun rannsachadh. Làimhseachadh mearachd