Insuite i Cuardach Gréasáin

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 gnáth-chomhlánú comhrá é an freagra le dhá bhreisiú. Tagraíonn an freagra do thorthaí an chuardaigh le huimhreacha idir lúibíní cearnacha, deir sources cad a sheasann gach uimhir dó, agus marcálann annotations an áit a luaitear gach ceann acu:

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

Cuardach a chur ar siúl

Is réimse den iarratas é cuardach, as de réir réamhshocraithe. Ní chuardaítear faic mura seolann iarratas é.

Ar /v1/messages suíonn an réimse ag barrleibhéal an choirp, in aice le model agus messages:

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

Cad a dhéanann iarratas cuardaithe

• Cuardaíonn an API an gréasán don teachtaireacht úsáideora dheireanach. Tugann casadh níos luaithe den chomhrá comhthéacs don chuardach.
• Ritheann an cuardach ar gach iarratas a sheolann web_search: true. Ní roghnaíonn an múnla an gcuardaíonn sé.
• Cuirtear na torthaí os comhair an mhúnla mar fhoinsí uimhrithe, agus scríobhann an múnla a fhreagra uathu.
• Tosaíonn an freagra nuair a bhíonn an cuardach déanta. Ní sheolann iarratas sruthaithe faic, ceanntásca ná imeachtaí, go dtí sin, mar sin lig do fhanacht níos faide roimh an gcéad bhlúire.

Cad atá sa fhreagra

• Tá gnáthchruth a chríochphointe ar an bhfreagra. Tá an freagra i choices[0].message.content (bloc text ar /v1/messages).
• Is féidir marcóirí mar [1] agus [2] a bheith sa téacs i ndiaidh na ráiteas a thacaíonn siad leo. Seasann gach uimhir do cheann de na torthaí a léigh an múnla.
• Ainmníonn sources na torthaí sin: iontráil amháin do gach toradh a tugadh don mhúnla, le index, title agus url. Is é [1] an iontráil a bhfuil index 1 aici. Liostaítear freisin na torthaí nach luann an freagra.
• Ar /v1/chat/completions tá annotations ar an teachtaireacht freisin, i gcruth OpenAI: url_citation amháin do gach foinse a ainmníonn marcóir, le url, title, agus start_index agus end_index, suíomh an mharcóra i content arna chomhaireamh i gcarachtair (ní chuimsítear an deireadh).
• I sruth tagann sources leis an mblúire dheireanach, agus ar /v1/messages leis an imeacht message_delta. Tagann na nótaí anótála i mblúire amháin díreach roimh an gceann deireanach, mar delta.annotations.
• Ní bhíonn sources ann ach amháin má d'aimsigh cuardach an iarratais seo rud éigin. Scríobhadh freagra gan é gan torthaí cuardaigh.

Conas a chomhairtear cuardaigh

Cuimsíonn gach plean líon cuardach in aghaidh an lae:

• Úsáideann iarratas ar tháinig rud éigin ar a chuardach cuardach amháin de liúntas an lae. Ní úsáideann cuardach nár tháinig faic air aon cheann.
• Roinneann comhrá agus API liúntas an chuntais a bhfuil an eochair aige.
• Tosaíonn an comhaireamh arís gach lá ag 00:00 UTC.
• Is tokens ionchuir de chuid an iarratais iad na torthaí cuardaigh agus billeáiltear iad leis an gcuid eile den prompt.

Cuir na pleananna i gcomparáid

Nuair a úsáidtear cuardaigh an lae

Ní dhiúltaítear d'iarratas a sheolann web_search: true tar éis an chuardaigh dheireanaigh den lá. Freagraítear é gan cuardach: is 200 an stádas agus níl aon sources sa fhreagra.

Cuardach mar uirlis de do chuid féin

Is é web_search: true an t-aon lasc den chuardach a ndéantar cur síos air anseo. Is ceann de d'uirlisí féin é feidhm a shainmhíníonn tú in tools agus a ainmníonn tú web_search: filleann an múnla glao, agus ritheann do chód an cuardach agus seolann sé an toradh ar ais.

Ní thosaíonn cineálacha uirlisí cuardaigh ó ardáin eile, mar web_search_20250305 ar /v1/messages nó {"type": "web_search"} ar /v1/responses, cuardach anseo.

Earráidí

Ní chuireann cuardach gréasáin cód stádais ná cineál earráide leis. Tugann cuardach nach bhfaigheann faic, nó lá gan cuardaigh fágtha, gnáthfhreagra gan torthaí cuardaigh. Tá gach earráid eile mar a chéile le hiarratas gan cuardach. Láimhseáil Earráide