Fíordheimhniú le heochair API

Fíordheimhníonn geata CLEVI cosáin atá comhoiriúnach le OpenAI agus cosáin atá comhoiriúnach le Anthropic le heochair API amháin.
Is iad an dá luach atá le socrú ar an gcliant ná an ceanntásc fíordheimhnithe ina gcuirtear an eochair agus base URL an SDK, agus bíonn an fhormáid cheadaithe don cheanntásc agus don base URL éagsúil de réir na sonraíochta.
Tar éis an socrú a chríochnú, is féidir leat a dheimhniú láithreach an bhfuil fíordheimhniú déanta trí liosta na múnlaí a fháil.
Má theipeann ar an bhfíordheimhniú, seoltar 401 ar ais; má éiríonn leis an bhfíordheimhniú ach mura gcomhlíontar na coinníollacha maidir le ceadanna nó teorainneacha, seoltar 403 ar ais.

Eisigh eochair API ó scáileán eochracha API an chonsóil. Ar an scáileán céanna, is féidir leat eochracha a chúlghairm agus a raon úsáide a bhainistiú.

Ceanntásc fíordheimhnithe

Cuireann an dá shonraíocht an eochair API i gceanntásc iarratais amháin. Úsáid ceann amháin de na ceanntásca X-API-Key agus Authorization, agus bíonn an fhormáid cheadaithe éagsúil de réir na sonraíochta.

Agus an ceanntásc Authorization á úsáid ar chosán atá comhoiriúnach le OpenAI, tá an réimír Bearer riachtanach. Má sheoltar an eochair amháin gan an réimír, diúltaíonn an geata don iarratas.

Ní dhéanann ainmneacha ceanntásca idirdhealú idir cás uachtair agus cás íochtair, mar sin oibríonn an ceanntásc x-api-key a sheolann an Anthropic SDK mar atá sé. Má shonraítear an dá cheanntásc, cuirtear luach X-API-Key i bhfeidhm mar thosaíocht.

base URL

Is féidir an SDK a bhí in úsáid agat cheana a úsáid mar atá sé ach an base URL a athrú chuig an seoladh thíos. Tá difríocht idir an dá sheoladh maidir le cibé an bhfuil /v1 iontu, mar sin sonraigh an seoladh cuí go díreach de réir na sonraíochta.

Seiceáil fíordheimhnithe

Tar éis an eochair agus an URL bonn a shocrú, is féidir leat stádas na fíordheimhnithe a dheimhniú trí liosta na samhlacha a fháil. Ritheann na samplaí thíos an fiosrúchán céanna le curl, OpenAI SDK agus Anthropic SDK. Cuir an eochair a eisíodh ar scáileán na n-eochracha in áit sk-....

Agus an fiosrúchán á rith le curl, sonraigh an cosán iomlán suas go /v1/models don dá shonraíocht. Úsáideann an chéad ordú an ceanntásc X-API-Key don chosán atá comhoiriúnach le OpenAI, agus úsáideann an dara hordú an ceanntásc Authorization don chosán atá comhoiriúnach le 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"

Sonraigh seoladh a chuimsíonn /v1 in base_url le OpenAI SDK.

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)

Sonraigh seoladh do base_url le Anthropic SDK a chríochnaíonn roimh /v1.
Le haghaidh fíordheimhnithe, bain úsáid as an gceanntásc x-api-key a sheolann an SDK mar atá.

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)

Má fhaightear freagra 200 ó aon sampla, ciallaíonn sé gur éirigh leis an bhfíordheimhniú, agus tá liosta na samhlacha is féidir a ghlaoch leis an eochair seo in data an fhreagra. Má fhaightear 401, seiceáil an chúis san ord sa chéad rannán eile.

Teip fíordheimhnithe

Má sheoltar eochair atá ar iarraidh, imithe in éag nó cúlghairthe, tugtar 401 ar ais. Má dhéantar glao gan eochair ar an gcosán atá comhoiriúnach le OpenAI, tugtar an corp thíos ar ais; ar an gcosán atá comhoiriúnach le Anthropic, is é authentication_error an error.type.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}

Má fhaigheann tú 401, seiceáil na nithe seo a leanas san ord seo.

1. Seiceáil stádas na heochrach ar scáileán na n-eochracha. Má tá sí imithe in éag nó cúlghairthe, eisigh eochair nua.
2. Seiceáil an é X-API-Key nó Authorization ainm an cheanntáisc.
3. Má tá ceanntásc Authorization á úsáid agat ar an gcosán atá comhoiriúnach le OpenAI, seiceáil an bhfuil an réimír Bearer ann.

Tar éis na hathruithe a dhéanamh, rith fiosrúchán liosta na samhlacha sa rannán fíordheimhnithe arís agus deimhnigh go bhfaightear 200.

Ceanntásca a úsáidtear le chéile

Tá na ceanntásca seo a leanas go léir roghnach. Molaimid X-Request-Id a shonrú chun fadhbanna a rianú.

Má tharlaíonn 5xx arís agus arís eile, cuir in iúl dúinn é trí na háiseanna cabhrach agus teagmhála, in éineacht le X-Request-Id. Más luach é a shonraigh tú go díreach, is féidir é a chur i gcomparáid láithreach le taifid an chliaint.