Isishwankathelo

Ii-endpoint

Yonke i-endpoint ikwi-base URL enye kwaye ikhonzwa nge-HTTPS.

https://api.shannon-ai.com

Ii-endpoint ezintathu eziveliswa umbhalo zifikelela kwiimodeli ezifanayo. Khetha leyo ifomathi yayo esele isetyenziswa yikhowudi yakho.

Iziseko zezicelo

• Umzimba we-POST nganye yi-JSON object enye, ukuya kuthi ga kwi-32 MiB.
• Intsimi i-API engayaziyo ayibangi mpazamo kwaye ayinampembelelo. Isicelo esibhalelwe omnye umboneleli asiluli ngenxa yentsimi eyongezelelweyo.
• Intsimi eyaziwayo enohlobo lwe-JSON olungalunganga, okanye intsimi efunekayo engekhoyo, iphendulwa nge-422. Umzimba ongeyiyo i-JSON esebenzayo uphendulwa nge-400.
• I-model yenye yee-id ezikwiModels & pricing. Oonobumba abakhulu nabancinci abubalulekanga.

Impendulo yi-JSON, okanye i-stream yemisitho ethunyelwe yi-server xa isicelo simisela i-stream ibe yi-true. I-endpoint nganye iphendula ngefomathi yayo. Yonke impendulo ine-header x-request-id.

Oko isicelo siqhubeka naso

Isicelo siyahlolwa ngolandelelwano oluzinzileyo phambi kokuba imodeli isebenze. Uhlolo lokuqala olungaphumeleliyo luyaphendula, ngoko i-401 ayikuxeleli nto ngomzimba okwangoku.

Isimo sempazamo

Impazamo yi-JSON object enentsimi error equlathe i-type ne-message. I-/v1/messages iyongqinela ngendlela ekulindeleke yi-Anthropic SDK; zonke ezinye iindlela zisebenzisa isimo se-OpenAI.

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

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

• Funda i-type ne-message. I-code kunye ne-param zikhona kwezinye iimpazamo kuphela: zithathe njengezingeyomfuneko. I-param ihlala i-null.
• Emva kokuba i-stream iqalile, isimo sele singu-200. Isilele ngoko sifika njenge-error frame ngaphakathi kwe-stream.
• Yonke impendulo yempazamo ithwala i-header x-request-id.

Ukuphatha imposiso

Ukuhlawula kunye nebhalansi

• Kukho ibhalansi enye ngeakhawunti, kwaye incoko ne-API ziyabelana ngayo: kuqala isabelo seplani sanamhlanje, emva koko ikhredithi ethengiweyo. I-API ayinaso isabelo sayo.
• Isicelo sigcina ibhajethi yaso yokuphuma (i-max_tokens, ixabiso elimiselweyo yi-4,096) kwaye emva koko sihlawulwa ii-token ezisetyenziswe ngokwenene, ngexabiso lemodeli.
• Yonke impendulo ibika amanani ayo ee-token kwi-usage. Iphepha leKeys & usage libonisa ibhalansi kunye nokubiza kwesicelo ngasinye.
• Zonke izicelo ziyakhonzwa ngokulinganayo. Owona mda wezicelo yi-flood protection: izicelo ezili-120 ngomzuzu ngeakhawunti. Izicelo ezithunyelwe ngaxeshanye ziyalinda kumgca.

Imida nebhalansi Iimodeli namaxabiso Izitshixo nokusetyenziswa

Iintsimi ezixhomekeke kwimodeli

Yonke imodeli yamkela isicelo esifanayo. Iintsimi ezimbalwa ziyasebenza kwezinye iimodeli kuphela; itheyibhile ibonisa ukuba phi. Amaphepha e-endpoint adwelisa yonke intsimi.

Chat Completions

Uvela kwi-OpenAI SDK

• Misela i-base URL ibe yi-https://api.shannon-ai.com/v1 kwaye isitshixo sibe sisitshixo sakho seShannon. Iminxeba ye-Chat Completions kunye ne-Responses ke isebenza ne-SDK injengoko injalo.
• I-model kufuneka ibe yi-id yeShannon. Igama lemodeli yomnye umboneleli, elinjenge-gpt-4o, liphendulwa nge-400 kunye ne-unknown model.
• Ukuqiqa kuza kwintsimi yayo: i-reasoning_content ecaleni kwe-content, kumyalezo nakwii-delta ze-stream.
• I-stream ihlala ithwala i-usage kwi-chunk yayo yokugqibela, kunye ne-finish_reason.
• Ubizo lwe-tool kwi-stream lufika njenge-chunk enye enomtya opheleleyo we-arguments.
• Impendulo inokhetho linye.
• Iindlela ze-API ye-OpenAI ezingekho kwitheyibhile engentla, ezinjenge-/v1/embeddings, ziphendulwa nge-404.

Uvela kwi-Anthropic SDK

• Misela i-base URL ibe yi-https://api.shannon-ai.com, ngaphandle kwe-/v1, kwaye isitshixo sibe sisitshixo sakho seShannon. I-SDK isithumela njenge-x-api-key.
• I-model kufuneka ibe yi-id yeShannon.
• I-max_tokens ayinyanzelekanga kule API. Ixabiso layo elimiselweyo yi-4,096.
• Impendulo iqulathe ii-content block zohlobo thinking, text kunye ne-tool_use. Ibhloko yokuqala ayisoloko ingumbhalo: khetha iibhloko ngo-type.
• I-stop_reason yi-end_turn okanye i-tool_use. I-stream yemodeli yeShannon inokuphela nge-max_tokens.
• I-anthropic-version kunye ne-anthropic-beta ziyamkelwa, ngoko i-SDK isebenza ngaphandle kotshintsho. Isicelo asizifuni.
• Iimpazamo kwi-/v1/messages zinesimo sika-Anthropic: {"type": "error", "error": {…}}.

Izixhobo zekhowudi ezithetha ezi fomathi zimiselwa ngendlela efanayo: i-base URL, isitshixo, kunye ne-id yeShannon njenge-model. Izixhobo zekhowudi ze-CLI