Developer guide
Έλεγχος ταυτότητας με κλειδί API
Η κεφαλίδα στην οποία τοποθετείται το κλειδί και το base URL που πρέπει να οριστεί στο SDK
Αυτή η σελίδα περιγράφει τον τρόπο ελέγχου ταυτότητας στην πύλη CLEVI με κλειδί API.
Τόσο η διαδρομή συμβατή με OpenAI όσο και η διαδρομή συμβατή με Anthropic χρησιμοποιούν ένα μόνο κλειδί για τον έλεγχο ταυτότητας,
αλλά διαφέρουν ως προς τις κεφαλίδες στις οποίες επιτρέπεται να τοποθετηθεί το κλειδί και ως προς το base URL που πρέπει να οριστεί στο SDK.
Κεφαλίδες ελέγχου ταυτότητας
Και οι δύο συμβατές προδιαγραφές χρησιμοποιούν ένα μόνο κλειδί API για τον έλεγχο ταυτότητας. Το κλειδί εκδίδεται από την οθόνη κλειδιών API στην κονσόλα, όπου μπορείτε επίσης να το ανακαλέσετε και να διαχειριστείτε το εύρος χρήσης του.
| Κεφαλίδα | Συμβατό με OpenAI | Συμβατό με Anthropic |
|---|---|---|
| X-API-Key: <κλειδί> | Υποστηρίζεται | Υποστηρίζεται |
| Authorization: Bearer <κλειδί> | Υποστηρίζεται | Υποστηρίζεται |
| Authorization: <κλειδί> (χωρίς Bearer) | Απορρίπτεται | Υποστηρίζεται |
Τα ονόματα των κεφαλίδων δεν κάνουν διάκριση μεταξύ πεζών και κεφαλαίων. Το x-api-key που αποστέλλεται από το Anthropic SDK λειτουργεί επίσης όπως είναι.
base URL
Το SDK που χρησιμοποιούσατε συνεχίζει να λειτουργεί αν αλλάξετε μόνο το base URL στις παρακάτω διευθύνσεις. Οι δύο διευθύνσεις διαφέρουν ως προς το αν περιλαμβάνουν το /v1.
| Προδιαγραφή | base URL | Κανόνας διαδρομής |
|---|---|---|
| Συμβατό με OpenAI | https://platform.clevi.net/api/v2/aiservice/openai/v1 | Συμπεριλάβετε έως και το /v1 στο base URL. |
| Συμβατό με Anthropic | https://platform.clevi.net/api/v2/aiservice/anthropic | Το Anthropic SDK προσθέτει αυτόματα το /v1 στη διαδρομή, επομένως η διεύθυνση τελειώνει πριν από το /v1. |
Επαλήθευση ελέγχου ταυτότητας
Μπορείτε να επιβεβαιώσετε αμέσως αν ο έλεγχος ταυτότητας είναι επιτυχής, εισάγοντας το κλειδί και το base URL και ανακτώντας τη λίστα μοντέλων. Τα τρία παρακάτω εκτελούν το ίδιο ερώτημα με curl, OpenAI SDK και 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)Στη θέση του sk-... εισαγάγετε το κλειδί που εκδόθηκε από την οθόνη κλειδιών API.
- Αν η απόκριση είναι 200, ο έλεγχος ταυτότητας ήταν επιτυχής. Το data περιέχει τη λίστα των μοντέλων που μπορείτε να καλέσετε με αυτό το κλειδί.
- Αν η απόκριση είναι 401, ακολουθήστε τη σειρά ελέγχου στην ενότητα Αποτυχία ελέγχου ταυτότητας παρακάτω.
Κεφαλίδες που χρησιμοποιούνται μαζί
Maent i gyd yn ddewisol. Er mwyn olrhain problemau, mae'n well cynnwys X-Request-Id.
| Pennawd | Diben | Os caiff ei hepgor |
|---|---|---|
| X-Request-Id | Dynodwr ar gyfer olrhain ceisiadau. Mewn ymatebion sy'n gydnaws ag Anthropic, caiff ei ddychwelyd fel y pennawd request-id. | Caiff ei gyhoeddi gan y gweinydd. |
| X-Region-Code | Rhanbarth yr alwad | global ydyw. |
| X-Product-Sku (mae product_sku yn yr ymholiad hefyd yn bosibl) | Yn nodi'r Product SKU i'w ddefnyddio ar gyfer bilio yn uniongyrchol. Mae'r pennawd yn cael blaenoriaeth dros yr ymholiad ac fe'i defnyddir yn bennaf ar lwybrau llais/voice. | Mae ei angen ar lwybrau voice. Ar gyfer audio/speech ac audio/transcriptions, dewiswch Product gyda model corff y cais. |
| anthropic-version / anthropic-beta | Caiff ei drosglwyddo fel y mae ar lwybrau sy'n gydnaws ag Anthropic. | Y fersiwn yw 2023-06-01. |
Methiant dilysu
Os anfonir allwedd sydd ar goll, wedi dod i ben neu wedi'i dirymu, dychwelir 401. Os gwneir galwad heb allwedd ar lwybr sy'n gydnaws ag OpenAI, dychwelir y corff isod, ac mae error.type y llwybr sy'n gydnaws ag Anthropic yn authentication_error.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- Gwiriwch statws yr allwedd ar sgrin allweddi API. Os yw'r allwedd wedi dod i ben neu wedi'i dirymu, cyhoeddwch un newydd.
- Gwiriwch ai X-API-Key neu Authorization yw enw'r pennawd.
- Os ydych yn defnyddio Authorization ar lwybr sy'n gydnaws ag OpenAI, gwiriwch y rhagddodiad Bearer.