Binciken Yanar Gizon da aka Gina

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

Amsar chat completion ce ta yau da kullun tare da ƙari biyu. Amsar tana nuna sakamakon bincike da lambobi a cikin ƙaramin akwati mai kusurwa, sources yana faɗin abin da kowace lamba take wakilta, kuma annotations yana nuna inda aka ambaci kowanne:

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

Kunna bincike

Bincike field ne na request, a kashe a asali. Ba a bincika komai sai request ya aika shi.

A /v1/messages field yana a matakin sama na body, kusa da model da messages:

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

Abin da request mai bincike ke yi

• API yana bincika yanar gizo don saƙon mai amfani na ƙarshe. Turns na tattaunawa na baya suna ba binciken mahallinsa.
• Binciken yana gudana a kowane request da ya aika web_search: true. Model ba ya zaɓar ko zai yi bincike.
• Ana sa sakamakon a gaban model a matsayin tushe masu lamba, kuma model yana rubuta amsarsa daga gare su.
• Amsar tana farawa idan an gama bincike. Request na streaming ba ya aika komai, ba headers ba, ba events ba, har sai lokacin, don haka ku yi tsammanin jira mai tsawo kafin chunk na farko.

Abin da amsar ke ɗauke da shi

• Amsar tana da siffar da endpoint ɗinta ke da ita ta yau da kullun. Amsar tana a choices[0].message.content (block na text a /v1/messages).
• Rubutun na iya ɗaukar alamomi kamar [1] da [2] bayan maganganun da suke goyon baya. Kowace lamba tana wakiltar ɗaya daga cikin sakamakon da model ya karanta.
• sources yana ambaton waɗannan sakamako: shigarwa ɗaya ga kowane sakamakon da aka ba model, tare da index, title da url. Alamar [1] ita ce shigarwar da ke da index 1. Ana jera sakamakon da amsar ba ta ambata ba ma.
• A /v1/chat/completions saƙon yana kuma da annotations, a siffar OpenAI: url_citation ɗaya ga kowane tushen da alama ta ambata, tare da url, title, da start_index da end_index, wato matsayin alamar a cikin content da aka ƙidaya da haruffa (ba a haɗa ƙarshen ba).
• A cikin stream sources yana zuwa da chunk na ƙarshe, kuma a /v1/messages da event ɗin message_delta. Annotations suna zuwa a chunk ɗaya kafin na ƙarshe, a matsayin delta.annotations.
• sources yana nan ne kawai idan binciken wannan request ya sami wani abu. An rubuta amsar da ba ta da shi ba tare da sakamakon bincike ba.

Yadda ake ƙidaya bincike

Kowane plan yana ɗauke da adadin bincike a kowace rana:

• Request wanda bincikensa ya sami wani abu yana amfani da bincike ɗaya na allowance na ranar. Binciken da bai sami komai ba ba ya amfani da ko ɗaya.
• Chat da API suna raba allowance na asusun da ke da maɓallin.
• Ƙidayar tana sake farawa kowace rana da ƙarfe 00:00 UTC.
• Sakamakon bincike tokens ne na input na request kuma ana cajin su tare da sauran prompt.

Kwatanta plans

Idan binciken ranar ya ƙare

Ba a ƙin request da ya aika web_search: true bayan binciken ranar na ƙarshe. Ana amsa shi ba tare da bincike ba: status shi ne 200 kuma amsar ba ta da sources.

Bincike a matsayin tool ɗinku na kanku

web_search: true shi ne kaɗai maɓallin kunna binciken da aka bayyana a nan. Aikin da kuka bayyana a cikin tools kuma kuka sa wa suna web_search ɗaya ne daga tools ɗinku na kanku: model yana mayar da kira, kuma code ɗinku yana gudanar da binciken ya mayar da sakamakon.

Nau'ikan tools na bincike na wasu dandamali, kamar web_search_20250305 a /v1/messages ko {"type": "web_search"} a /v1/responses, ba sa fara bincike a nan.

Kurakurai

Binciken yanar gizo ba ya ƙara status code ko nau'in kuskure. Binciken da bai sami komai ba, ko ranar da babu sauran bincike, yana ba da amsa ta yau da kullun ba tare da sakamakon bincike ba. Kowane sauran kuskure iri ɗaya ne da na request ba tare da bincike ba. Kuskuren Gudanarwa