Developer guide

Έλεγχος ταυτότητας με κλειδί API

Η κεφαλίδα όπου τοποθετείται το κλειδί 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Κανόνας διαδρομής
Συμβατό με OpenAIhttps://platform.clevi.net/api/v2/aiservice/openai/v1Συμπεριλάβετε το /v1 στο base URL.
Συμβατό με Anthropichttps://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, ελέγξτε τα στοιχεία με τη σειρά που περιγράφεται στην ενότητα αποτυχίας ελέγχου ταυτότητας παρακάτω.

Κεφαλίδες που χρησιμοποιούνται μαζί

Όλα είναι προαιρετικά. Για την παρακολούθηση προβλημάτων, συνιστάται να συμπεριλαμβάνετε το X-Request-Id.

ΚεφαλίδαΧρήσηΑν παραλειφθεί
X-Request-IdΑναγνωριστικό για την παρακολούθηση αιτημάτων. Σε συμβατές με Anthropic απαντήσεις επιστρέφεται ως κεφαλίδα request-id.Εκδίδεται από τον διακομιστή.
X-Region-CodeΠεριοχή κλήσηςΕίναι global.
X-Product-Sku (διατίθεται επίσης ως product_sku στο query)Καθορίζει απευθείας το Product SKU που θα χρησιμοποιηθεί για τη χρέωση. Η κεφαλίδα έχει προτεραιότητα έναντι του query και χρησιμοποιείται κυρίως σε διαδρομές φωνής.Απαιτείται στις διαδρομές φωνής. Τα audio/speech και audio/transcriptions επιλέγουν το Product μέσω του model στο σώμα.
anthropic-version / anthropic-betaΜεταβιβάζονται 그대로 στις συμβατές με Anthropic διαδρομές.Η έκδοση είναι 2023-06-01.

Αποτυχία ελέγχου ταυτότητας

Αν δεν υπάρχει κλειδί ή αποσταλεί κλειδί που έχει λήξει ή ανακληθεί, επιστρέφεται 401. Αν καλέσετε τη συμβατή με OpenAI διαδρομή χωρίς κλειδί, επιστρέφεται το παρακάτω σώμα, ενώ το error.type στη συμβατή με Anthropic διαδρομή είναι authentication_error.

{
  "error": {
    "message": "API key is required.",
    "type": "invalid_request_error"
  }
}
  1. Ελέγξτε την κατάσταση του κλειδιού στην οθόνη των API keys. Αν έχει λήξει ή ανακληθεί, εκδώστε νέο.
  2. Ελέγξτε αν το όνομα της κεφαλίδας είναι X-API-Key ή Authorization.
  3. Αν χρησιμοποιείτε Authorization στη συμβατή με OpenAI διαδρομή, ελέγξτε το πρόθεμα Bearer.
CLEVI

Γλώσσα και περιοχή

Οι γλώσσες που μεταφράζονται από μηχανή επισημαίνονται. Η διαθεσιμότητα ακολουθεί το δημοσιευμένο πακέτο ιστοτόπου.

136 γλώσσες

Προτεινόμενο

1

Ανατολική Ασία

7

Νοτιοανατολική Ασία

11

Νότια Ασία

18

Κεντρική Ασία

5

Μέση Ανατολή και Καύκασος

10

Δυτική Ευρώπη και Νότια Ευρώπη

16

Ηνωμένο Βασίλειο και Ιρλανδία

4

Βόρεια Ευρώπη

10

Κεντρική Ευρώπη και Βαλκάνια

14

Ανατολική Ευρώπη

5

Ανατολική Αφρική

8

Δυτική Αφρική και Μέση Αφρική

9

Νότιος Αφρική

8

Αμερική

5

Ωκεανία

5