Developer guide
Autentimine API-võtmega
Päis, kuhu lisada API-võti, ja SDK-s seadistatav base URL
Sellel lehel käsitletakse CLEVI lüüsi autentimist API-võtmega.
Nii OpenAI-ga ühilduva kui ka Anthropicuga ühilduva tee puhul autentitakse ühe võtmega,
kuid võtme sisaldava päise lubatud ulatus ja SDK-s seadistatav base URL erinevad spetsifikatsiooniti.
Autentimispäis
Mõlema ühilduva spetsifikatsiooni puhul autentitakse ühe API-võtmega. Võtme väljastamine toimub konsooli API-võtmete lehel ning samal lehel saab hallata selle tühistamist ja kasutusulatust.
| Päis | OpenAI-ga ühilduv | Anthropicuga ühilduv |
|---|---|---|
| X-API-Key: <võti> | Saadaval | Saadaval |
| Authorization: Bearer <võti> | Saadaval | Saadaval |
| Authorization: <võti> (ilma Bearerita) | Tagasi lükatud | Saadaval |
Päise nimed ei ole tõstutundlikud. Ka Anthropic SDK saadetav x-api-key töötab muutmata kujul.
base URL
Kasutatav SDK töötab edasi, kui muudate ainult base URL-i allolevaks aadressiks. Need kaks aadressi erinevad selle poolest, kas need sisaldavad /v1.
| Spetsifikatsioon | base URL | Tee reegel |
|---|---|---|
| OpenAI-ga ühilduv | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Lisage /v1 base URL-i sisse. |
| Anthropicuga ühilduv | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK lisab /v1 tee lõppu ise, seega lõpeb URL enne /v1. |
Autentimise kontrollimine
Kui sisestate võtme ja base URL-i ning päringuga mudelite loendi, saate kohe teada, kas autentimine õnnestus. Allolevad kolm näidet teevad sama päringu curl-i, OpenAI SDK ja Anthropic SDK abil.
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)Asendage sk-... API-võtmete lehel väljastatud võtmega.
- Kui vastus on 200, on autentimine õnnestunud. Väljal data sisaldub mudelite loend, mida saab selle võtmega kutsuda.
- Kui vastus on 401, kontrollige allolevas autentimise ebaõnnestumise jaotises toodud järjekorras.
Ühiselt kasutatav päis
Kõik need on valikulised. Probleemide jälgimiseks on soovitatav X-Request-Id lisada.
| Päis | Kasutusotstarve | Kui välja jätta |
|---|---|---|
| X-Request-Id | Päringu jälgimiseks kasutatav identifikaator. Anthropicuga ühilduvas vastuses tagastatakse see request-id päisena. | Server väljastab selle. |
| X-Region-Code | Päringu piirkond | global. |
| X-Product-Sku (võimalik ka päringuparameetriga product_sku) | Määrab otse Product SKU, mida arveldamiseks kasutada. Päis on päringuparameetrist prioriteetsem ja seda kasutatakse peamiselt audio- ja voice-marsruutidel. | Voice-marsruutidel on see vajalik. audio/speech ja audio/transcriptions valivad Producti päringu kehas oleva model abil. |
| anthropic-version / anthropic-beta | Edastatakse Anthropicuga ühilduvatel marsruutidel muutmata kujul. | Versioon on 2023-06-01. |
Autentimise nurjumine
Kui võti puudub või saadate aegunud või tühistatud võtme, tagastatakse 401. Kui OpenAI-ga ühilduval marsruudil kutsutakse teenust ilma võtmeta, tagastatakse allolev sisu; Anthropicuga ühilduval marsruudil on error.type väärtus authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Kontrollige võtme olekut API võtmete lehel. Kui võti on aegunud või tühistatud, väljastage uus.
- Kontrollige, kas päise nimi on X-API-Key või Authorization.
- Kui kasutate OpenAI-ga ühilduval marsruudil Authorization päist, kontrollige Bearer-prefiksit.