Developer guide
Dearbhadh le iuchair API
An ceann-cinn anns a bheil an iuchair API agus an URL base ri shuidheachadh san SDK
Bidh geata CLEVI a’ dearbhadh an dà chuid slighean a tha co-chòrdail ri OpenAI agus slighean a tha co-chòrdail ri Anthropic le aon iuchair API.
Chan eil ann ach dà luach ri shuidheachadh air a’ chliant: ceann-cinn an dearbhaidh anns a bheil an iuchair agus URL base an SDK; tha cruthan nan cinn-cinn agus na URLan base ceadaichte eadar-dhealaichte a rèir na sònrachaidh.
An dèidh dhut an rèiteachadh a chrìochnachadh, faodaidh tu dearbhadh sa bhad a dhèanamh a bheil dearbhadh air a dhol troimhe le bhith a’ faighneachd airson liosta nam modalan.
Ma dh’fhàillig an dearbhadh, thèid 401 a thilleadh; ma thèid an dearbhadh troimhe ach nach tèid na cumhaichean cead no crìoch a choileanadh, thèid 403 a thilleadh.
Faigh an iuchair API agad bhon sgrìn iuchraichean API sa chonsòl. Air an aon sgrìn, faodaidh tu cùl-ghairm na h-iuchrach agus raon a cleachdaidh a stiùireadh.
Ceann-cinn dearbhaidh
Bidh an dà shònrachadh a’ cur an iuchair API ann an aon cheann-cinn iarrtais. Cleachd an ceann-cinn X-API-Key no an ceann-cinn Authorization; tha an cruth ceadaichte an urra ris an t-sònrachadh.
| Ceann-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: <키> (às aonais Bearer) | Air a dhiùltadh | Ri fhaighinn |
Nuair a chleachdas tu an ceann-cinn Authorization ann an slighe a tha co-chòrdail ri OpenAI, tha feum air ro-leasachan Bearer. Ma chuireas tu an iuchair leis fhèin gun ro-leasachan, diùlt geata an t-iarrtas.
Chan eil ainmean nan cinn-cinn mothachail do litrichean mòra is beaga, agus mar sin obraichidh an ceann-cinn x-api-key a chuireas an Anthropic SDK gun atharrachadh. Ma shònraicheas tu an dà cheann-cinn, thèid luach X-API-Key a chur an sàs an toiseach.
URL base
Faodar na SDKan a chleachd thu roimhe a chleachdadh mar a bha iad le bhith ag atharrachadh an URL base a-mhàin gu na seòlaidhean gu h-ìosal. Tha an dà sheòladh eadar-dhealaichte a thaobh a bheil /v1 air a ghabhail a-steach, mar sin sònraich an seòladh iomchaidh dìreach mar a tha e.
| Sònrachadh | URL base | Riaghailt slighe |
|---|---|---|
| Co-chòrdail ri OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Cuir /v1 a-steach san URL base. |
| 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 iarrtais fhèin, thig e gu crìch ro /v1. |
Dearbhadh dearbhaidh
Às dèidh dhut an iuchair agus an URL bunaiteach a shuidheachadh, faodaidh tu dearbhadh a bheil dearbhadh dearbh-aithne soirbheachail le bhith a’ faighinn liosta nam modalan. Tha na h-eisimpleirean gu h-ìosal a’ ruith an aon iarrtas le curl, OpenAI SDK agus Anthropic SDK. Cuir an iuchair a chaidh a chruthachadh air sgrìn nan iuchraichean an àite sk-....
Nuair a gheibh thu liosta le curl, sònraich an t-slighe iomlan gu /v1/models airson an dà shònrachadh. Cleachdaidh a’ chiad àithne bann-cinn X-API-Key airson na slighe a tha co-chòrdail ri OpenAI, agus cleachdaidh an dàrna àithne bann-cinn Authorization airson na slighe a tha co-chòrdail ri Anthropic.
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"Airson OpenAI SDK, sònraich seòladh anns a bheil /v1 ann an base_url.
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)Airson Anthropic SDK, sònraich seòladh ann am base_url a thig gu crìch ro /v1.
Airson dearbhadh dearbh-aithne, cleachd bann-cinn x-api-key a chuireas an SDK a-mach mar a tha e.
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)Ma tha an fhreagairt 200 ann an eisimpleir sam bith, tha dearbhadh dearbh-aithne soirbheachail, agus tha an data san fhreagairt a’ gabhail a-steach liosta nam modalan a ghabhas gairm leis an iuchair seo. Ma gheibh thu 401, thoir sùil air an adhbhar san òrdugh san ath earrann.
Dh’fhàillig dearbhadh dearbh-aithne
Ma chuireas tu iuchair nach eil ann, no iuchair a tha air tighinn gu crìch no air a cur à comas, tillidh e 401. Ma nì thu gairm gun iuchair air an t-slighe a tha co-chòrdail ri OpenAI, tillidh e an corp gu h-ìosal; air an t-slighe a tha co-chòrdail ri Anthropic, ’s e authentication_error a bhios ann an error.type.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}Ma gheibh thu 401, thoir sùil air na leanas san òrdugh seo.
- Thoir sùil air inbhe na h-iuchrach air sgrìn nan iuchraichean. Ma tha i air tighinn gu crìch no air a cur à comas, cruthaich iuchair ùr.
- Dèan cinnteach gur e X-API-Key no Authorization ainm a’ bhanna-chinn.
- Ma tha thu a’ cleachdadh bann-cinn Authorization air an t-slighe a tha co-chòrdail ri OpenAI, dèan cinnteach gu bheil ro-leasachan Bearer ann.
Às dèidh dhut na h-atharrachaidhean a dhèanamh, ruith a-rithist an t-iarrtas airson liosta nam modalan anns an earrann dearbhaidh dearbh-aithne agus dèan cinnteach gum faigh thu 200.
Bannan-cinn a chleachdar còmhla
Tha na bannan-cinn a leanas uile roghainneil. Airson duilgheadasan a lorg, tha sinn a’ moladh X-Request-Id a shònrachadh.
| Bann-cinn | Adhbhar cleachdaidh | Ma thèid fhàgail às |
|---|---|---|
| X-Request-Id | Seo an aithnichear airson lorg na h-iarrtais. Bidh slighe a tha co-chòrdail ri Anthropic a’ tilleadh an aon luach ann am bann-cinn request-id na freagairt. | Bidh an frithealaiche ga shònrachadh. |
| X-Region-Code | Sònraich an roinn far an tèid a’ ghairm a dhèanamh. | Is e global a th’ ann. |
| X-Product-Sku (faodar a shònrachadh cuideachd le product_sku sa cheist) | Sònraich an Product SKU a thèid a chleachdadh airson cunntasachadh gu dìreach. Tha am bann-cinn a’ faighinn prìomhachas thairis air a’ cheist agus tha e air a chleachdadh sa mhòr-chuid ann an slighean guth/voice. | Chan fhaodar fhàgail às ann an slighean guth. Bidh audio/speech agus audio/transcriptions a’ taghadh an Product leis a’ model ann am bodhaig na h-iarrtais. |
| anthropic-version / anthropic-beta | Cuir air adhart e gun atharrachadh ann an slighe a tha co-chòrdail ri Anthropic. | Is e 2023-06-01 an tionndadh. |
Ma thachras 5xx a-rithist is a-rithist, innis dhuinn tro Chuideachadh agus Fios thugainn còmhla ri X-Request-Id. Ma shònraich thu an luach gu dìreach, faodar a choimeas sa bhad ri clàran an neach-dèiligidh.