Chwilio gwe

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

Cwblhad sgwrs cyffredin yw'r ateb, gyda dau ychwanegiad. Mae'r ateb yn pwyntio at ganlyniadau'r chwiliad gyda rhifau mewn cromfachau sgwâr, mae sources yn dweud beth mae pob rhif yn ei gynrychioli, ac mae annotations yn nodi lle mae pob un yn cael ei ddyfynnu:

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

Troi chwilio ymlaen

Maes o'r cais yw chwilio, wedi'i ddiffodd yn ddiofyn. Ni chwilir dim oni bai bod cais yn ei anfon.

Ar /v1/messages mae'r maes ar lefel uchaf y corff, wrth ymyl model a messages:

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

Beth mae cais wedi'i chwilio yn ei wneud

• Mae'r API yn chwilio'r we am neges ddiwethaf y defnyddiwr. Mae troeon cynharach y sgwrs yn rhoi ei gyd-destun i'r chwiliad.
• Mae'r chwiliad yn rhedeg ar bob cais sy'n anfon web_search: true. Nid yw'r model yn dewis a yw'n chwilio.
• Gosodir y canlyniadau o flaen y model fel ffynonellau wedi'u rhifo, ac mae'r model yn ysgrifennu ei ateb ohonynt.
• Mae'r ateb yn dechrau pan fo'r chwiliad wedi'i wneud. Nid yw cais wedi'i ffrydio yn anfon dim, na phenawdau na digwyddiadau, tan hynny, felly caniatewch aros hirach cyn y darn cyntaf.

Beth mae'r ateb yn ei gynnwys

• Mae gan yr ateb siâp arferol ei bwynt terfyn. Mae'r ateb yn choices[0].message.content (bloc text ar /v1/messages).
• Gall y testun gario marcwyr fel [1] a [2] ar ôl y datganiadau y maent yn eu cefnogi. Mae pob rhif yn sefyll am un o'r canlyniadau a ddarllenodd y model.
• Mae sources yn enwi'r canlyniadau hynny: un cofnod ar gyfer pob canlyniad a roddwyd i'r model, gydag index, title ac url. Y marciwr [1] yw'r cofnod gyda index 1. Rhestrir hefyd y canlyniadau nad yw'r ateb yn eu dyfynnu.
• Ar /v1/chat/completions mae gan y neges annotations hefyd, yn ffurf OpenAI: un url_citation ar gyfer pob ffynhonnell y mae marciwr yn ei henwi, gydag url, title, a start_index ac end_index, sef safle'r marciwr yn content wedi'i gyfrif mewn nodau (ni chynhwysir y diwedd).
• Mewn ffrwd daw sources gyda'r darn olaf, ac ar /v1/messages gyda'r digwyddiad message_delta. Daw'r anodiadau mewn un darn ychydig cyn yr olaf, fel delta.annotations.
• Mae sources yno dim ond os daeth chwiliad y cais hwn o hyd i rywbeth. Ysgrifennwyd ateb hebddo heb ganlyniadau chwilio.

Sut mae chwiliadau'n cael eu cyfrif

Mae pob cynllun yn cynnwys nifer o chwiliadau y dydd:

• Mae cais y daeth ei chwiliad o hyd i rywbeth yn defnyddio un chwiliad o lwfans y dydd. Nid yw chwiliad na ddaeth o hyd i ddim yn defnyddio dim.
• Mae sgwrs a'r API yn rhannu lwfans y cyfrif sy'n berchen ar yr allwedd.
• Mae'r cyfrif yn dechrau eto bob dydd am 00:00 UTC.
• Tokenau mewnbwn y cais yw canlyniadau'r chwiliad a chânt eu codi gyda gweddill y prompt.

Cymharu'r cynlluniau

Pan fo chwiliadau'r dydd wedi'u defnyddio

Ni wrthodir cais sy'n anfon web_search: true ar ôl chwiliad olaf y dydd. Fe'i hatebir heb chwiliad: mae'r statws yn 200 ac nid oes gan yr ateb sources.

Chwilio fel offeryn eich hun

web_search: true yw unig switsh y chwilio a ddisgrifir yma. Mae ffwythiant a ddiffiniwch yn tools ac a enwch yn web_search yn un o'ch offer eich hun: mae'r model yn dychwelyd galwad, ac mae eich cod yn rhedeg y chwiliad ac yn anfon y canlyniad yn ôl.

Nid yw mathau offer chwilio llwyfannau eraill, fel web_search_20250305 ar /v1/messages neu {"type": "web_search"} ar /v1/responses, yn cychwyn chwiliad yma.

Gwallau

Nid yw chwilio'r we yn ychwanegu cod statws na math o wall. Mae chwiliad sy'n dod o hyd i ddim, neu ddiwrnod heb chwiliadau ar ôl, yn rhoi ateb arferol heb ganlyniadau chwilio. Mae pob gwall arall yr un fath ag ar gyfer cais heb chwilio. Rheoli gwallau