Developer guide
Dearbhadh le iuchair API
An bann-cinn airson an iuchair API agus an base URL airson a shuidheachadh san SDK
Tha an duilleag seo a’ mìneachadh mar a dhearbhas tu dearbh-aithne aig geata CLEVI le iuchair API.
Bidh an dà shlighe a tha co-chòrdail ri OpenAI agus Anthropic a’ cleachdadh aon iuchair airson dearbhadh,
ach tha an raon ceadaichte airson a’ bhanna-cinn anns an tèid an iuchair a chur agus an base URL a thèid a shuidheachadh san SDK eadar-dhealaichte a rèir na sònrachaidh.
Bann-cinn dearbhaidh
Bidh an dà shònrachadh cho-chòrdail a’ cleachdadh aon iuchair API airson dearbhadh. Thèid an iuchair a chruthachadh air sgrìn iuchraichean API a’ chonsail, agus faodar a cur dheth agus an raon cleachdaidh a riaghladh air an aon sgrìn.
| Bann-cinn | Co-chòrdail ri OpenAI | Co-chòrdail ri Anthropic |
|---|---|---|
| X-API-Key: <키> | Ri fhaighinn | Ri fhaighinn |
| Authorization: Bearer <키> | Ri fhaighinn | Ri fhaighinn |
| Authorization: <키> (gun Bearer) | Air a dhiùltadh | Ri fhaighinn |
Chan eil ainm a’ bhanna-chinn mothachail air litrichean mòra no beaga. Bidh x-api-key a chuireas an Anthropic SDK a’ dol ag obair mar a tha e.
base URL
Chan fheum na SDKan a chleachd thu atharrachadh ach an base URL gu na seòlaidhean gu h-ìosal. Tha an dà sheòladh eadar-dhealaichte a thaobh a bheil /v1 nam broinn.
| Sònrachadh | base URL | Riaghailt na slighe |
|---|---|---|
| Co-chòrdail ri OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Cuir /v1 a-steach don base URL. |
| Co-chòrdail ri Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Leis gu bheil an Anthropic SDK a’ cur /v1 ris an t-slighe leis fhèin, thig e gu crìch ro /v1. |
Dearbhadh dearbhaidh
Ma nì thu liosta nam modalan às dèidh dhut an iuchair agus an base URL a chur a-steach, chì thu sa bhad an deach dearbhadh a dhèanamh. Bidh na trì eisimpleirean gu h-ìosal a’ dèanamh an aon iarrtais le curl, OpenAI SDK agus Anthropic SDK.
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)Anns an àite sk-... cuir a-steach an iuchair a chaidh a chruthachadh air sgrìn iuchraichean API.
- Ma tha am freagairt 200, tha dearbhadh air a dhèanamh. Tha data a’ gabhail a-steach liosta nam modalan as urrainn dhut fònadh leis an iuchair seo.
- Ma tha am freagairt 401, dèan sgrùdadh a rèir òrdugh na h-earrainn “Fàilligeadh dearbhaidh” gu h-ìosal.
Bann-cinn a thèid a chleachdadh còmhla
Tha iad uile roghainneil. Airson duilgheadasan a lorg, ’s fheàrr X-Request-Id a chur a-steach.
| Ceann-cinn | Cleachdadh | Ma thèid fhàgail às |
|---|---|---|
| X-Request-Id | Dearbh-aithne airson iarrtasan a lorg. Ann am freagairtean a tha co-chòrdail ri Anthropic, thig e air ais mar cheann-cinn request-id. | Bidh an frithealaiche ga shònrachadh. |
| X-Region-Code | Roinn gairm | ’S e global a th’ ann. |
| X-Product-Sku (faodar product_sku a chleachdadh sa cheist cuideachd) | Sònraichidh seo gu dìreach an Product SKU a thèid a chleachdadh airson cunntas. Tha prìomhachas aig a’ cheann-chinn thairis air a’ cheist, agus tha e air a chleachdadh sa mhòr-chuid ann an slighean gutha·labhairt. | Tha feum air ann an slighean gutha. Bidh audio/speech agus audio/transcriptions a’ taghadh an Product leis an model sa bhodhaig. |
| anthropic-version / anthropic-beta | Thèid an cur air adhart mar a tha iad ann an slighean a tha co-chòrdail ri Anthropic. | ’S e 2023-06-01 an tionndadh. |
Dh’fhàillig dearbhadh
Ma chuireas tu iuchair a tha a dhìth, air tighinn gu crìch no air a cur dheth, gheibh thu 401. Ma chuireas tu gairm gun iuchair tro shlighe a tha co-chòrdail ri OpenAI, gheibh thu am bodhaig gu h-ìosal; ann an slighe a tha co-chòrdail ri Anthropic, ’s e authentication_error an error.type.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Thoir sùil air inbhe na h-iuchrach air sgrìn iuchraichean API. Ma tha i air tighinn gu crìch no air a cur dheth, cruthaich tè ùr.
- Dèan cinnteach gur e X-API-Key no Authorization ainm a’ chinn-chinn.
- Ma chleachdas tu Authorization ann an slighe a tha co-chòrdail ri OpenAI, dèan cinnteach gu bheil ro-leasachan Bearer ann.