Developer guide
Còdan mearachd
Riaghailtean làimhseachaidh agus ath-fheuchainn a rèir còd inbhe
Tha an duilleag seo a’ mìneachadh nan còdan inbhe a thilleas an geata agus an ciall, còmhla ris na ceumannan làimhseachaidh airson gach còd.
Ma thilleas an t-àrd-shruth 4xx·5xx, thèid an còd sin a chur air adhart mar a tha, agus anns na cùisean eile leanaidh sinn an clàr gu h-ìosal.
Tha e cuideachd a’ mìneachadh cumadh nan corp mhearachdan airson an dà shònrachadh cho-chòrdail, na riaghailtean airson error.type a tha co-chòrdail ri Anthropic, agus scrionaichean a’ chonsail airson crìochan is cleachdadh a dhearbhadh.
Còd inbhe
| Còd | Ciall | Ceumannan |
|---|---|---|
| 400 | Mearachd ann an luachan an iarrtais. Tha limit ann an liosta mhodalan a tha co-chòrdail ri Anthropic taobh a-muigh 1~1000, no chaidh oidhirp a dhèanamh air freagairt shàbhalaichte fhaighinn air ais le GET /responses/{responseId}?stream=true | Ceartaich na luachan gus am bi iad taobh a-staigh an raoin. Faigh freagairtean sàbhalaichte air ais gun stream. |
| 401 | Chan eil iuchair ann, no tha an iuchair air tighinn gu crìch no air a cur à gnìomh | Thoir sùil air inbhe na h-iuchrach air duilleag iuchraichean API, agus dearbhaich ainm a’ chinn-chinnidh agus an ro-leasachan Bearer. |
| 403 | Chan eil cead inntrigidh don mhodail, chaidh an crìoch cleachdaidh thairis, chan eil creideasan gu leòr ann, no chan eil thu nad shealbhadair a’ ghuthais | Mìnichidh error.message an t-adhbhar. Chithear na h-àireamhan air scrion na h-earrainn gu h-ìosal airson crìochan is cleachdadh. |
| 404 | Chan eil am modail ann no chan fhaighear thuige leis an iuchair seo (a’ gabhail a-steach modalan nach eil a’ faighinn taic tuilleadh), tha an t-slighe a dhìth, no tha an ùine glèidhidh 3 latha airson toradh CleviDrive air a dhol seachad | Thoir sùil an toiseach air liosta nam modalan a ghabhas gairm le GET /models. Dèan coimeas eadar an t-slighe agus an clàr air duilleag Gairm an API. |
| 408 · 409 · 413 | Ùine an àirde-shrutha air tighinn gu crìch, dùmhlachd, no meud an iarrtais air a dhol thairis. Airson slighean guth·guthais, is e 5 mionaidean an ùine chuingealaichte agus is e 28 MiB an ìre as àirde airson iarrtas | Ma tha Retry-After ann an 409, fuirich an ùine sin. Airson 413, roinn an t-iarrtas agus cuir e ann am pàirtean. |
| 429 | Tha an solaraiche àirde-shrutha air crìoch astair a chur an sàs | Ma thèid Retry-After a thoirt seachad, lean e mar a tha; mura tèid, feuch a-rithist le backoff eas-chruthach. |
| 5xx | Mearachd shealach aig a’ gheata no aig an àirde-shruth (503 nam measg) | Feuch a-rithist le backoff eas-chruthach. Ma thachras e a-rithist, innis dhuinn tro Chuideachadh agus Cuir fios thugainn, còmhla ri X-Request-Id. |
Ath-fheuchainn
Cha chruthaich an geata 429 leis fhèin, agus cha bhith e ag ath-fheuchainn freagairtean an àirde-shrutha gu dìomhair no gan cur ann an ciudha.
’S ann leis a’ chliant a tha feitheamh agus ath-fheuchainn.
| còd | ùine feitheimh | an uairsin |
|---|---|---|
| 409 | Ma tha Retry-After ann, feithidh sinn an ùine sin | Cuiridh sinn an t-iarrtas cheudna a-rithist. |
| 429 | Ma tha Retry-After ann, feithidh sinn an ùine sin; mura h-eil, cleachdaidh sinn backoff eas-chruthach | Cuiridh sinn an t-iarrtas cheudna a-rithist. |
| 5xx | backoff eas-chruthach | Ma thachras e a-rithist, cuiridh sinn fios. |
| 413 | Gun feitheamh | Roinnidh sinn an t-iarrtas. |
Bodhaig na mearachd
Tha cruth eadar-dhealaichte aig bodhaig na mearachd a rèir na sònrachaidh. Bidh sinn a’ cumail dìreach an teachdaireachd ann am mearachdan upstream agus gan cur air adhart ann an cruth glan; cha tèid an stac no na raointean a-staigh seachad.
Seo bodhaig na slighe a tha co-chòrdail ri OpenAI.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Seo bodhaig na slighe a tha co-chòrdail ri Anthropic. Tha error.type air a dhearbhadh leis a’ chòd inbhe.
{
"type": "error",
"error": {
"type": "authentication_error",
"message": "..."
},
"request_id": "rqid..."
}| Còd inbhe | error.type |
|---|---|
| 400 | invalid_request_error |
| 401 | authentication_error |
| 403 | permission_error |
| 404 | not_found_error |
| 413 | request_too_large |
| 429 | rate_limit_error |
| 529 | overloaded_error |
| Còdan eile | api_error |
Thoir sùil air na crìochan agus air cleachdadh
Tha na luachan crìche eadar-dhealaichte airson gach àite-obrach. Thoir sùil air adhbhar 403 ann an error.message, agus an uair sin coimhead air na luachan anns an sgrìn gu h-ìosal.
| Na nì thu sgrùdadh | Sgrìn a’ chonsail |
|---|---|
| A’ chrìoch a chuirear air an àite-obrach agam | Crìoch cleachdaidh ainmichte san t-sealladh fharsaing |
| An raon agus an cothromachadh a cheadaicheas am plana | Plana agus creideasan |
| Fìor chleachdadh (àireamh nan gairmean a rèir modail is iuchair, creideasan ris a bheil dùil a thèid a thoirt air falbh) | Cleachdadh |
| Inbhe na h-iuchrach (co-dhiù a tha i air tighinn gu crìch no air a cur à bith) | Iuchraichean API |