Ülevaade

Lõpp-punktid

Iga lõpp-punkt asub ühe base URL-i all ja seda teenindatakse HTTPS-i kaudu.

https://api.shannon-ai.com

Kolm lõpp-punkti, mis teksti toodavad, jõuavad samade mudeliteni. Vali see, mille formaati sinu kood juba kasutab.

Päringu alused

• Iga POST sisu on üks JSON-objekt, kuni 32 MiB.
• Väli, mida API ei tunne, ei põhjusta viga ja sellel ei ole mõju. Teise pakkuja jaoks kirjutatud päring ei ebaõnnestu lisavälja tõttu.
• Tuntud väljale vale JSON-tüübiga või puuduvale kohustuslikule väljale vastatakse 422. Sisule, mis ei ole kehtiv JSON, vastatakse 400.
• model on üks lehel Mudelid ja hinnad olevatest id-dest. Suur- ja väiketähtedel vahet ei ole.

Vastus on JSON või server-sent events voog, kui päring määrab stream väärtuseks true. Iga lõpp-punkt vastab oma formaadis. Igal vastusel on päis x-request-id.

Mida päring läbib

Päringut kontrollitakse kindlas järjekorras enne mudeli käivitumist. Esimene ebaõnnestuv kontroll vastab, seega 401 ei ütle sulle sisu kohta veel midagi.

Vea kuju

Viga on JSON-objekt, mille error sisaldab type ja message. /v1/messages mähib selle nii, nagu Anthropic SDK-d ootavad; iga teine tee kasutab OpenAI kuju.

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Loe type ja message. code ja param on olemas ainult mõnel veal: käsitle neid valikulistena. param on alati null.
• Pärast voo algust on olek juba 200. Tõrge saabub siis veakaadrina voo sees.
• Iga veavastus kannab päist x-request-id.

Vigade käsitlus

Arveldus ja saldo

• Konto kohta on üks saldo ning vestlus ja API jagavad seda: kõigepealt tänane paketi päevalimiit, seejärel ostetud krediit. API-l oma kvooti ei ole.
• Päring reserveerib oma väljundi eelarve (max_tokens, vaikeväärtus 4,096) ja selle eest arveldatakse seejärel tegelikult kasutatud tokenid mudeli hinnaga.
• Iga vastus teatab oma tokenite arvu väljas usage. Leht Võtmed ja kasutus näitab saldot ja seda, mis iga päring maksis.
• Iga päringut teenindatakse võrdselt. Ainus päringute sageduse piirang on kiirusepiirang: 120 päringut minutis konto kohta. Paralleelselt saadetud päringud ootavad järjekorras.

Piirangud ja saldo Mudelid ja hinnad Võtmed ja kasutus

Väljad, mis sõltuvad mudelist

Iga mudel võtab sama päringu. Mõned väljad mõjuvad ainult mõnel mudelil; tabel nimetab, kus. Lõpp-punktide lehed loetlevad iga välja.

Chat Completions

Tuled OpenAI SDK-st

• Määra base URL väärtuseks https://api.shannon-ai.com/v1 ja võti oma Shannoni võtmeks. Chat Completions ja Responses kõned töötavad siis SDK-ga nii, nagu see on.
• model peab olema Shannoni id. Teise pakkuja mudeli nimele, näiteks gpt-4o, vastatakse 400 ja unknown model.
• Arutlus tuleb eraldi väljal: reasoning_content välja content kõrval, sõnumis ja voo deltades.
• Voog kannab alati usage oma viimases chunkis, koos finish_reason.
• Tööriistakutse voos saabub ühe chunkina, kus on täielik arguments string.
• Vastusel on üks valik.
• OpenAI API teedele, mida ülaltoodud tabelis ei ole, näiteks /v1/embeddings, vastatakse 404.

Tuled Anthropic SDK-st

• Määra base URL väärtuseks https://api.shannon-ai.com, ilma /v1, ja võti oma Shannoni võtmeks. SDK saadab selle kui x-api-key.
• model peab olema Shannoni id.
• max_tokens on selles API-s valikuline. Selle vaikeväärtus on 4,096.
• Vastus sisaldab sisuplokke tüüpidest thinking, text ja tool_use. Esimene plokk ei ole alati tekst: vali plokid type järgi.
• stop_reason on end_turn või tool_use. Shannoni mudeli voog võib lõppeda ka väärtusega max_tokens.
• anthropic-version ja anthropic-beta võetakse vastu, nii et SDK töötab muutmata kujul. Päring neid ei vaja.
• Vead lõpp-punktis /v1/messages on Anthropic kujuga: {"type": "error", "error": {…}}.

Kodeerimistööriistad, mis neid formaate kõnelevad, seadistatakse samamoodi: base URL, võti ja Shannoni id mudelina. CLI kodeerimistööriistad