API விசையால் அங்கீகரித்தல்

CLEVI நுழைவாயில், OpenAI இணக்கமான பாதையையும் Anthropic இணக்கமான பாதையையும் ஒரே API விசையால் அங்கீகரிக்கிறது.
கிளையண்டில் அமைக்க வேண்டிய மதிப்புகள் இரண்டு: விசையைக் கொண்டிருக்கும் அங்கீகாரத் தலைப்பு மற்றும் SDK-இன் base URL. அனுமதிக்கப்படும் தலைப்பு வடிவமும் base URL-மும் விவரக்குறிப்புக்கு ஏற்ப மாறுபடும்.
அமைப்பை முடித்த பிறகு, மாதிரிகளின் பட்டியலைக் கோருவதன் மூலம் அங்கீகாரம் வெற்றியடைந்ததா என்பதை உடனடியாகச் சரிபார்க்கலாம்.
அங்கீகாரம் தோல்வியடைந்தால் 401-ஐத் திருப்பி அளிக்கும்; அங்கீகாரம் வெற்றியடைந்த பிறகு அனுமதி அல்லது வரம்பு நிபந்தனைகளைப் பூர்த்தி செய்யாவிட்டால் 403-ஐத் திருப்பி அளிக்கும்.

API விசையை கன்சோலின் API விசைப் பக்கத்தில் வழங்கவும். அதே பக்கத்தில் விசையைத் திரும்பப் பெறுவதையும் அதன் பயன்பாட்டு வரம்பையும் நிர்வகிக்கலாம்.

அங்கீகாரத் தலைப்பு

இரண்டு விவரக்குறிப்புகளிலும், ஒரு கோரிக்கைத் தலைப்பில் API விசை சேர்க்கப்படுகிறது. X-API-Key தலைப்பு அல்லது Authorization தலைப்பில் ஒன்றைப் பயன்படுத்தவும்; அனுமதிக்கப்படும் வடிவம் விவரக்குறிப்புக்கு ஏற்ப மாறுபடும்.

OpenAI இணக்கமான பாதையில் Authorization தலைப்பைப் பயன்படுத்தும்போது, Bearer முன்னொட்டு தேவைப்படுகிறது. முன்னொட்டு இல்லாமல் விசையை மட்டும் அனுப்பினால், நுழைவாயில் கோரிக்கையை நிராகரிக்கும்.

தலைப்புப் பெயர்கள் பெரிய எழுத்து, சிறிய எழுத்து வேறுபாட்டைக் கருத்தில் கொள்ளாது. எனவே Anthropic SDK அனுப்பும் x-api-key தலைப்பும் அப்படியே செயல்படும். இரண்டு தலைப்புகளையும் குறிப்பிட்டால், X-API-Key மதிப்புக்கு முன்னுரிமை அளிக்கப்படும்.

base URL

ஏற்கனவே பயன்படுத்தி வரும் SDK-ஐ, base URL-ஐ மட்டும் கீழே உள்ள முகவரிக்கு மாற்றி அப்படியே பயன்படுத்தலாம். இரண்டு முகவரிகளும் /v1 சேர்க்கப்பட்டுள்ளதா என்பதில் வேறுபடுகின்றன; எனவே விவரக்குறிப்புக்கு ஏற்ற முகவரியை அப்படியே குறிப்பிடவும்.

அங்கீகாரத்தைச் சரிபார்த்தல்

விசை மற்றும் base URL-ஐ அமைத்த பிறகு, மாதிரிகளின் பட்டியலைப் பெறுவதன் மூலம் அங்கீகாரம் உள்ளதா என்பதைச் சரிபார்க்கலாம். கீழே உள்ள எடுத்துக்காட்டுகள் அதே கோரிக்கையை curl, OpenAI SDK மற்றும் Anthropic SDK மூலம் செயல்படுத்துகின்றன. sk-... இடத்தில் API விசை திரையில் வழங்கப்பட்ட விசையை உள்ளிடவும்.

curl மூலம் பட்டியலைப் பெறும்போது, இரு விவரக்குறிப்புகளுக்கும் /v1/models வரையிலான முழுப் பாதையைக் குறிப்பிடவும். முதல் கட்டளை OpenAI-யுடன் ஒத்துப்போகும் பாதையில் X-API-Key தலைப்பையும், இரண்டாவது கட்டளை Anthropic-யுடன் ஒத்துப்போகும் பாதையில் Authorization தலைப்பையும் பயன்படுத்துகிறது.

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"

OpenAI SDK-க்கு /v1-ஐ உள்ளடக்கிய முகவரியை 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)

Anthropic SDK-க்கு /v1-க்கு முன் முடியும் முகவரியை base_url-ல் குறிப்பிடவும்.
அங்கீகாரத்திற்கு SDK அனுப்பும் x-api-key தலைப்பையே பயன்படுத்தவும்.

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)

எந்த எடுத்துக்காட்டிலும் பதில் 200 ஆக இருந்தால், அங்கீகாரம் வெற்றிகரமாக முடிந்துள்ளது. பதிலின் data-வில் இந்த விசையால் அழைக்கக்கூடிய மாதிரிகளின் பட்டியல் அடங்கும். 401 எனில், அடுத்தப் பிரிவில் உள்ள வரிசைப்படி காரணத்தைச் சரிபார்க்கவும்.

அங்கீகாரத் தோல்வி

விசை இல்லாமல் அல்லது காலாவதியான/ரத்து செய்யப்பட்ட விசையை அனுப்பினால் 401 திருப்பி அனுப்பப்படும். OpenAI-யுடன் ஒத்துப்போகும் பாதையில் விசை இல்லாமல் அழைத்தால் கீழே உள்ள உடல் திருப்பி அனுப்பப்படும்; Anthropic-யுடன் ஒத்துப்போகும் பாதையில் error.type என்பது authentication_error ஆக இருக்கும்.

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

401 கிடைத்தால், பின்வரும் வரிசையில் சரிபார்க்கவும்.

1. API விசை திரையில் விசையின் நிலையைச் சரிபார்க்கவும். அது காலாவதியாகியிருந்தால் அல்லது ரத்து செய்யப்பட்டிருந்தால், புதிய விசையை வழங்கவும்.
2. தலைப்பின் பெயர் X-API-Key அல்லது Authorization என்பதைச் சரிபார்க்கவும்.
3. OpenAI-யுடன் ஒத்துப்போகும் பாதையில் Authorization தலைப்பைப் பயன்படுத்தினால், Bearer முன்னொட்டு உள்ளதா என்பதைச் சரிபார்க்கவும்.

திருத்திய பிறகு, அங்கீகாரத்தைச் சரிபார்க்கும் பிரிவில் உள்ள மாதிரிகளின் பட்டியல் பெறுதலை மீண்டும் செயல்படுத்தி, 200 கிடைக்கிறதா என்பதைச் சரிபார்க்கவும்.

ஒன்றாகப் பயன்படுத்தப்படும் தலைப்புகள்

பின்வரும் தலைப்புகள் அனைத்தும் விருப்பத்திற்குரியவை. சிக்கல்களைக் கண்காணிக்க, X-Request-Id-ஐ குறிப்பிடுமாறு பரிந்துரைக்கிறோம்.

5xx மீண்டும் மீண்டும் ஏற்பட்டால், உதவி மையம் மற்றும் தொடர்புப் படிவம் மூலம் X-Request-Id உடன் எங்களுக்குத் தெரிவிக்கவும். மதிப்பை நீங்களே குறிப்பிட்டிருந்தால், அதை கிளையன்ட் பதிவுடன் உடனடியாக ஒப்பிடலாம்.